{
"swagger": "2.0",
"info": {
"title": "Azure Queue Storage",
"version": "2026-04-06",
"x-typespec-generated": [
{
"emitter": "@azure-tools/typespec-autorest"
}
]
},
"schemes": [
"https"
],
"x-ms-parameterized-host": {
"hostTemplate": "{url}",
"useSchemePrefix": false,
"parameters": [
{
"name": "url",
"in": "path",
"description": "The host name of the queue storage account, e.g. accountName.queue.core.windows.net",
"required": true,
"type": "string",
"format": "uri",
"x-ms-skip-url-encoding": true
}
]
},
"produces": [
"application/xml"
],
"consumes": [
"application/xml"
],
"security": [
{
"OAuth2Auth": [
"https://storage.azure.com/.default"
]
}
],
"securityDefinitions": {
"OAuth2Auth": {
"type": "oauth2",
"flow": "implicit",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"scopes": {
"https://storage.azure.com/.default": ""
}
}
},
"tags": [],
"paths": {
"/": {
"put": {
"operationId": "Queue_Create",
"description": "Creates a new queue. If a queue with the same name already exists, the operation succeeds when the metadata\nis identical. If the metadata differs, the operation fails.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see\nSetting Timeouts for Queue Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-meta",
"in": "header",
"description": "The metadata headers.",
"required": false,
"type": "string",
"x-ms-client-name": "metadata"
}
],
"responses": {
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "UTC date/time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"204": {
"description": "There is no content to send for this request, but the headers may be useful. ",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "UTC date/time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
},
"delete": {
"operationId": "Queue_Delete",
"description": "Permanently deletes the specified queue.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see\nSetting Timeouts for Queue Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful. ",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "UTC date/time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"/messages": {
"get": {
"operationId": "Queue_ReceiveMessages",
"description": "Retrieves one or more messages from the front of the queue.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "numofmessages",
"in": "query",
"description": "A nonzero integer value that specifies the number of messages to\nretrieve from the queue, up to a maximum of 32. If fewer are visible, the\nvisible messages are returned. By default, a single message is retrieved from\nthe queue with this operation.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 1,
"x-ms-client-name": "numberOfMessages"
},
{
"name": "visibilitytimeout",
"in": "query",
"description": "Specifies the new visibility timeout value, in seconds, relative to server time. A specified value must be\nlarger than or equal to 1 second, and cannot be larger than 7 days. The visibility timeout of a message\ncan be set to a value later than the expiry time.",
"required": false,
"type": "integer",
"format": "int32",
"maximum": 604800,
"x-ms-client-name": "visibilityTimeout"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see\nSetting Timeouts for Queue Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/ReceivedMessages"
},
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "UTC date/time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
},
"post": {
"operationId": "Queue_SendMessage",
"description": "Adds a new message to the back of the message queue. A visibility timeout\ncan also be specified to make the message invisible until the visibility timeout\nexpires.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "visibilitytimeout",
"in": "query",
"description": "Specifies the new visibility timeout value, in seconds, relative to server time. A specified value must be\nlarger than or equal to 1 second, and cannot be larger than 7 days. The visibility timeout of a message\ncan be set to a value later than the expiry time.",
"required": false,
"type": "integer",
"format": "int32",
"maximum": 604800,
"x-ms-client-name": "visibilityTimeout"
},
{
"name": "messagettl",
"in": "query",
"description": "Specifies the time-to-live interval for the message, in seconds.\nPrior to version 2017-07-29, the maximum time-to-live allowed is 7 days. For\nversion 2017-07-29 or later, the maximum time-to-live can be any positive\nnumber, as well as -1 indicating that the message does not expire. If this\nparameter is omitted, the default time-to-live is 7 days.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": -1,
"x-ms-client-name": "messageTimeToLive"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see\nSetting Timeouts for Queue Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "queueMessage",
"in": "body",
"description": "The queue message. The message must be in a format that can be included in an XML request with UTF-8\nencoding. The encoded message can be up to 64 KB in size.",
"required": true,
"schema": {
"$ref": "#/definitions/QueueMessage"
}
}
],
"responses": {
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"schema": {
"$ref": "#/definitions/ListOfSentMessage"
},
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "UTC date/time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
},
"delete": {
"operationId": "Queue_Clear",
"description": "Deletes all messages from the specified queue.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see\nSetting Timeouts for Queue Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful. ",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "UTC date/time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"/messages/{messageId}": {
"put": {
"operationId": "Queue_UpdateMessage",
"description": "Updates the visibility timeout of a message. This operation can also be used to update the contents of a message.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "messageId",
"in": "path",
"description": "The ID of the queue message.",
"required": true,
"type": "string"
},
{
"name": "popreceipt",
"in": "query",
"description": "An opaque value required to delete the message. If deletion fails using this\nPopReceipt then the message has been dequeued by another client.",
"required": true,
"type": "string",
"x-ms-client-name": "popReceipt"
},
{
"name": "visibilitytimeout",
"in": "query",
"description": "Specifies the new visibility timeout value, in seconds, relative to server time. A specified value must be\nlarger than or equal to 1 second, and cannot be larger than 7 days. The visibility timeout of a message\ncan be set to a value later than the expiry time.",
"required": true,
"type": "integer",
"format": "int32",
"maximum": 604800,
"x-ms-client-name": "visibilityTimeout"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see\nSetting Timeouts for Queue Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "queueMessage",
"in": "body",
"description": "The queue message. The message must be in a format that can be included in\nan XML request with UTF-8 encoding. The encoded message can be up to 64 KB in size.",
"required": false,
"schema": {
"$ref": "#/definitions/QueueMessage"
}
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful. ",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "UTC date/time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-popreceipt": {
"type": "string",
"description": "The pop receipt of the queue message."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-time-next-visible": {
"type": "string",
"format": "date-time-rfc7231",
"description": "A UTC date/time value that represents when the message will be visible on the queue."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
},
"delete": {
"operationId": "Queue_DeleteMessage",
"description": "Deletes the specified message.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "messageId",
"in": "path",
"description": "The ID of the queue message.",
"required": true,
"type": "string"
},
{
"name": "popreceipt",
"in": "query",
"description": "An opaque value required to delete the message. If deletion fails using this\nPopReceipt then the message has been dequeued by another client.",
"required": true,
"type": "string",
"x-ms-client-name": "popReceipt"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see\nSetting Timeouts for Queue Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful. ",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "UTC date/time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
}
},
"x-ms-paths": {
"?comp=acl": {
"get": {
"operationId": "Queue_GetAccessPolicy",
"description": "Gets the access policy for the specified queue.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see\nSetting Timeouts for Queue Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/SignedIdentifiers"
},
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "UTC date/time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=acl&_overload=setAccessPolicy": {
"put": {
"operationId": "Queue_SetAccessPolicy",
"description": "Sets the permissions for the specified queue.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see\nSetting Timeouts for Queue Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "queueAcl",
"in": "body",
"description": "The access control list.",
"required": false,
"schema": {
"$ref": "#/definitions/SignedIdentifiers"
}
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful. ",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "UTC date/time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=list": {
"get": {
"operationId": "Service_GetQueues",
"description": "Returns a list of queues.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "prefix",
"in": "query",
"description": "Filters the results to return only queues whose name begins with the specified prefix.",
"required": false,
"type": "string"
},
{
"name": "marker",
"in": "query",
"description": "Identifies the portion of the list of queues to be returned with the next listing operation. The operation\nreturns the marker value if the listing operation did not return all queues remaining. The marker value can\nbe used as the value for the marker parameter in a subsequent call to request the next page of list items.\nThe marker value is opaque to the client.",
"required": false,
"type": "string"
},
{
"name": "maxresults",
"in": "query",
"description": "Specifies the maximum number of queues to return. If the request does not specify maxresults, or specifies\na value greater than 5000, the server will return up to 5000 items.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 1
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see\nSetting Timeouts for Queue Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "include",
"in": "query",
"description": "Specify to include additional, optional information.",
"required": false,
"type": "array",
"items": {
"type": "string",
"enum": [
"metadata"
],
"x-ms-enum": {
"name": "ListQueuesIncludeType",
"modelAsString": false,
"values": [
{
"name": "metadata",
"value": "metadata",
"description": "Include queue metadata."
}
]
}
},
"collectionFormat": "csv"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/ListQueuesResponse"
},
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "UTC date/time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=metadata": {
"get": {
"operationId": "Queue_GetProperties",
"description": "Returns all user-defined metadata and system properties for the specified queue.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see\nSetting Timeouts for Queue Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "UTC date/time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-approximate-messages-count": {
"type": "integer",
"format": "int64",
"description": "The approximate number of messages in the queue. This number is not lower than the actual number of\nmessages in the queue, but could be higher."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-meta": {
"type": "string",
"description": "The metadata headers."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?comp=metadata&_overload=setMetadata": {
"put": {
"operationId": "Queue_SetMetadata",
"description": "Sets user-defined metadata for the specified queue.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see\nSetting Timeouts for Queue Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "x-ms-meta",
"in": "header",
"description": "The metadata headers.",
"required": false,
"type": "string",
"x-ms-client-name": "metadata"
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful. ",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "UTC date/time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?restype=service&comp=properties": {
"put": {
"operationId": "Service_SetProperties",
"description": "Sets properties for a storage account's Queue service endpoint, including properties for Storage Analytics\nand CORS (Cross-Origin Resource Sharing) rules.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see\nSetting Timeouts for Queue Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "queueServiceProperties",
"in": "body",
"description": "The storage service properties to set.",
"required": true,
"schema": {
"$ref": "#/definitions/QueueServiceProperties"
}
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "UTC date/time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?restype=service&comp=properties&_overload=getProperties": {
"get": {
"operationId": "Service_GetProperties",
"description": "Retrieves properties of a storage account's Queue service, including properties for Storage Analytics and\nCORS (Cross-Origin Resource Sharing) rules.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see\nSetting Timeouts for Queue Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/QueueServiceProperties"
},
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "UTC date/time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?restype=service&comp=stats": {
"get": {
"operationId": "Service_GetStatistics",
"description": "Retrieves statistics related to replication for the Queue service. It is only available on the secondary\nlocation endpoint when read-access geo-redundant replication is enabled for the storage account.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see\nSetting Timeouts for Queue Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/QueueServiceStats"
},
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "UTC date/time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"?restype=service&comp=userdelegationkey": {
"post": {
"operationId": "Service_GetUserDelegationKey",
"description": "Retrieves a user delegation key for the Queue service. This is only a valid operation when using bearer\ntoken authentication.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see\nSetting Timeouts for Queue Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
},
{
"name": "keyInfo",
"in": "body",
"description": "Key information.",
"required": true,
"schema": {
"$ref": "#/definitions/KeyInfo"
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/UserDelegationKey"
},
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "UTC date/time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
},
"/messages?peekonly=true": {
"get": {
"operationId": "Queue_PeekMessages",
"description": "Retrieves one or more messages from the front of the queue, but does not alter the visibility of the message.",
"parameters": [
{
"name": "x-ms-version",
"in": "header",
"description": "Specifies the version of the operation to use for this request.",
"required": true,
"type": "string",
"x-ms-client-name": "version"
},
{
"name": "x-ms-client-request-id",
"in": "header",
"description": "An opaque, globally-unique, client-generated string identifier for the request.",
"required": false,
"type": "string",
"format": "uuid",
"x-ms-client-name": "clientRequestId"
},
{
"name": "numofmessages",
"in": "query",
"description": "A nonzero integer value that specifies the number of messages to\nretrieve from the queue, up to a maximum of 32. If fewer are visible, the\nvisible messages are returned. By default, a single message is retrieved from\nthe queue with this operation.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 1,
"x-ms-client-name": "numberOfMessages"
},
{
"name": "timeout",
"in": "query",
"description": "The timeout parameter is expressed in seconds. For more information, see\nSetting Timeouts for Queue Service Operations.",
"required": false,
"type": "integer",
"format": "int32",
"minimum": 0
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/PeekedMessages"
},
"headers": {
"Date": {
"type": "string",
"format": "date-time-rfc7231",
"description": "UTC date/time value generated by the service that indicates the time at which the response was initiated."
},
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
},
"x-ms-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, server-generated string identifier for the request."
},
"x-ms-version": {
"type": "string",
"description": "Specifies the version of the operation to use for this request."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/Error"
},
"headers": {
"x-ms-error-code": {
"type": "string",
"description": "The error code."
}
}
}
}
}
}
},
"definitions": {
"AccessPolicy": {
"type": "object",
"description": "The access policy.",
"properties": {
"Start": {
"type": "string",
"format": "date-time",
"description": "The date-time the policy is active.",
"x-ms-client-name": "start"
},
"Expiry": {
"type": "string",
"format": "date-time",
"description": "The date-time the policy expires.",
"x-ms-client-name": "expiry"
},
"Permission": {
"type": "string",
"description": "The permissions for the policy.",
"x-ms-client-name": "permission"
}
}
},
"CorsRule": {
"type": "object",
"description": "The CORS rules.",
"properties": {
"AllowedOrigins": {
"type": "string",
"description": "The allowed origins.",
"x-ms-client-name": "allowedOrigins"
},
"AllowedMethods": {
"type": "string",
"description": "The allowed methods.",
"x-ms-client-name": "allowedMethods"
},
"AllowedHeaders": {
"type": "string",
"description": "The allowed headers.",
"x-ms-client-name": "allowedHeaders"
},
"ExposedHeaders": {
"type": "string",
"description": "The exposed headers.",
"x-ms-client-name": "exposedHeaders"
},
"MaxAgeInSeconds": {
"type": "integer",
"format": "int32",
"description": "The maximum age in seconds.",
"minimum": 0,
"x-ms-client-name": "maxAgeInSeconds"
}
},
"required": [
"AllowedOrigins",
"AllowedMethods",
"AllowedHeaders",
"ExposedHeaders",
"MaxAgeInSeconds"
]
},
"Error": {
"type": "object",
"description": "The error response.",
"properties": {
"Code": {
"$ref": "#/definitions/StorageErrorCode",
"description": "The error code.",
"x-ms-client-name": "code"
},
"Message": {
"type": "string",
"description": "The error message.",
"x-ms-client-name": "message"
}
}
},
"GeoReplication": {
"type": "object",
"description": "Geo replication information for the secondary storage location.",
"properties": {
"Status": {
"$ref": "#/definitions/GeoReplicationStatus",
"description": "The status of the secondary location.",
"x-ms-client-name": "status"
},
"LastSyncTime": {
"type": "string",
"format": "date-time-rfc7231",
"description": "A GMT date/time value, to the second. All primary writes preceding this value are guaranteed to be available\nfor read operations at the secondary. Primary writes after this point in time may or may not be available\nfor reads.",
"x-ms-client-name": "lastSyncTime"
}
},
"required": [
"Status",
"LastSyncTime"
]
},
"GeoReplicationStatus": {
"type": "string",
"description": "The geo replication status.",
"enum": [
"live",
"bootstrap",
"unavailable"
],
"x-ms-enum": {
"name": "GeoReplicationStatus",
"modelAsString": true,
"values": [
{
"name": "Live",
"value": "live",
"description": "The geo replication is live."
},
{
"name": "Bootstrap",
"value": "bootstrap",
"description": "The geo replication is bootstrap."
},
{
"name": "Unavailable",
"value": "unavailable",
"description": "The geo replication is unavailable."
}
]
}
},
"KeyInfo": {
"type": "object",
"description": "Key information for user delegation key.",
"properties": {
"Start": {
"type": "string",
"format": "date-time",
"description": "The date-time the key is active in ISO 8601 UTC time.",
"x-ms-client-name": "start"
},
"Expiry": {
"type": "string",
"format": "date-time",
"description": "The date-time the key expires in ISO 8601 UTC time.",
"x-ms-client-name": "expiry"
},
"DelegatedUserTid": {
"type": "string",
"description": "The delegated user tenant ID in Entra ID.",
"x-ms-client-name": "delegatedUserTid"
}
},
"required": [
"Expiry"
]
},
"ListOfSentMessage": {
"type": "object",
"description": "The response of send message.",
"properties": {
"QueueMessage": {
"type": "array",
"description": "The list of sent messages.",
"items": {
"$ref": "#/definitions/SentMessage"
},
"xml": {
"wrapped": false
},
"x-ms-client-name": "items"
}
},
"required": [
"QueueMessage"
],
"xml": {
"name": "QueueMessagesList"
}
},
"ListQueuesIncludeType": {
"type": "string",
"description": "Specify to include additional, optional information.",
"enum": [
"metadata"
],
"x-ms-enum": {
"name": "ListQueuesIncludeType",
"modelAsString": false,
"values": [
{
"name": "metadata",
"value": "metadata",
"description": "Include queue metadata."
}
]
}
},
"ListQueuesResponse": {
"type": "object",
"description": "The list queues response.",
"properties": {
"ServiceEndpoint": {
"type": "string",
"description": "The service endpoint.",
"xml": {
"attribute": true
},
"x-ms-client-name": "serviceEndpoint"
},
"Prefix": {
"type": "string",
"description": "The prefix of the queues.",
"x-ms-client-name": "prefix"
},
"Marker": {
"type": "string",
"description": "Identifies the current position in the list queues operation.",
"x-ms-client-name": "marker"
},
"MaxResults": {
"type": "integer",
"format": "int32",
"description": "The max results.",
"x-ms-client-name": "maxResults"
},
"Queues": {
"type": "array",
"description": "The list of queues.",
"items": {
"$ref": "#/definitions/QueueItem"
},
"xml": {
"wrapped": true
},
"x-ms-client-name": "queueItems"
},
"NextMarker": {
"type": "string",
"description": "Identifies the portion of the list of queues to be returned with the next listing operation.",
"x-ms-client-name": "nextMarker"
}
},
"required": [
"ServiceEndpoint",
"Prefix",
"MaxResults",
"NextMarker"
],
"xml": {
"name": "EnumerationResults"
}
},
"Logging": {
"type": "object",
"description": "Azure Analytics Logging settings.",
"properties": {
"Version": {
"type": "string",
"description": "The version of the logging properties.",
"x-ms-client-name": "version"
},
"Delete": {
"type": "boolean",
"description": "Whether delete operation is logged.",
"x-ms-client-name": "delete"
},
"Read": {
"type": "boolean",
"description": "Whether read operation is logged.",
"x-ms-client-name": "read"
},
"Write": {
"type": "boolean",
"description": "Whether write operation is logged.",
"x-ms-client-name": "write"
},
"RetentionPolicy": {
"$ref": "#/definitions/RetentionPolicy",
"description": "The retention policy of the logs.",
"x-ms-client-name": "retentionPolicy"
}
},
"required": [
"Version",
"Delete",
"Read",
"Write",
"RetentionPolicy"
]
},
"Metrics": {
"type": "object",
"description": "The metrics properties.",
"properties": {
"Version": {
"type": "string",
"description": "The version of the metrics properties.",
"x-ms-client-name": "version"
},
"Enabled": {
"type": "boolean",
"description": "Whether it is enabled.",
"x-ms-client-name": "enabled"
},
"IncludeAPIs": {
"type": "boolean",
"description": "Whether to include API in the metrics.",
"x-ms-client-name": "includeApis"
},
"RetentionPolicy": {
"$ref": "#/definitions/RetentionPolicy",
"description": "The retention policy of the metrics.",
"x-ms-client-name": "retentionPolicy"
}
},
"required": [
"Enabled"
]
},
"PeekedMessage": {
"type": "object",
"description": "The peeked queue message.",
"properties": {
"MessageId": {
"type": "string",
"description": "The ID of the message.",
"x-ms-client-name": "messageId"
},
"InsertionTime": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The time the message was inserted into the queue.",
"x-ms-client-name": "insertionTime"
},
"ExpirationTime": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The time that the message will expire and be automatically deleted.",
"x-ms-client-name": "expirationTime"
},
"DequeueCount": {
"type": "integer",
"format": "int64",
"description": "The number of times the message has been dequeued.",
"x-ms-client-name": "dequeueCount"
},
"MessageText": {
"type": "string",
"description": "The content of the message.",
"x-ms-client-name": "messageText"
}
},
"required": [
"MessageId",
"InsertionTime",
"ExpirationTime",
"DequeueCount",
"MessageText"
],
"xml": {
"name": "QueueMessage"
}
},
"PeekedMessages": {
"type": "object",
"description": "The response of peek messages.",
"properties": {
"QueueMessage": {
"type": "array",
"description": "The list of peeked messages.",
"items": {
"$ref": "#/definitions/PeekedMessage"
},
"xml": {
"wrapped": false
},
"x-ms-client-name": "items"
}
},
"required": [
"QueueMessage"
],
"xml": {
"name": "QueueMessagesList"
}
},
"QueueItem": {
"type": "object",
"description": "An Azure Storage Queue.",
"properties": {
"Name": {
"type": "string",
"description": "The name of the queue.",
"x-ms-client-name": "name"
},
"Metadata": {
"type": "object",
"description": "The metadata of the queue.",
"additionalProperties": {
"type": "string"
},
"x-ms-client-name": "metadata"
}
},
"required": [
"Name"
],
"xml": {
"name": "Queue"
}
},
"QueueMessage": {
"type": "object",
"description": "The queue message.",
"properties": {
"MessageText": {
"type": "string",
"description": "The content of the message.",
"x-ms-client-name": "messageText"
}
},
"required": [
"MessageText"
]
},
"QueueServiceProperties": {
"type": "object",
"description": "The service properties.",
"properties": {
"Logging": {
"$ref": "#/definitions/Logging",
"description": "The logging properties.",
"x-ms-client-name": "logging"
},
"HourMetrics": {
"$ref": "#/definitions/Metrics",
"description": "The hour metrics properties.",
"x-ms-client-name": "hourMetrics"
},
"MinuteMetrics": {
"$ref": "#/definitions/Metrics",
"description": "The minute metrics properties.",
"x-ms-client-name": "minuteMetrics"
},
"Cors": {
"type": "array",
"description": "The CORS properties.",
"items": {
"$ref": "#/definitions/CorsRule"
},
"xml": {
"wrapped": true
},
"x-ms-client-name": "cors"
}
},
"xml": {
"name": "StorageServiceProperties"
}
},
"QueueServiceStats": {
"type": "object",
"description": "Statistics for the storage queue service.",
"properties": {
"GeoReplication": {
"$ref": "#/definitions/GeoReplication",
"description": "The geo replication stats.",
"x-ms-client-name": "geoReplication"
}
}
},
"ReceivedMessage": {
"type": "object",
"description": "The received queue message.",
"properties": {
"MessageId": {
"type": "string",
"description": "The ID of the message.",
"x-ms-client-name": "messageId"
},
"InsertionTime": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The time the message was inserted into the queue.",
"x-ms-client-name": "insertionTime"
},
"ExpirationTime": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The time that the message will expire and be automatically deleted.",
"x-ms-client-name": "expirationTime"
},
"PopReceipt": {
"type": "string",
"description": "An opaque value required to delete the message. If deletion fails using this\nPopReceipt then the message has been dequeued by another client.",
"x-ms-client-name": "popReceipt"
},
"TimeNextVisible": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The time that the message will again become visible in the queue.",
"x-ms-client-name": "timeNextVisible"
},
"DequeueCount": {
"type": "integer",
"format": "int64",
"description": "The number of times the message has been dequeued.",
"x-ms-client-name": "dequeueCount"
},
"MessageText": {
"type": "string",
"description": "The content of the message.",
"x-ms-client-name": "messageText"
}
},
"required": [
"MessageId",
"InsertionTime",
"ExpirationTime",
"PopReceipt",
"TimeNextVisible",
"DequeueCount",
"MessageText"
],
"xml": {
"name": "QueueMessage"
}
},
"ReceivedMessages": {
"type": "object",
"description": "The response of receive messages.",
"properties": {
"QueueMessage": {
"type": "array",
"description": "The list of received messages.",
"items": {
"$ref": "#/definitions/ReceivedMessage"
},
"xml": {
"wrapped": false
},
"x-ms-client-name": "items"
}
},
"required": [
"QueueMessage"
],
"xml": {
"name": "QueueMessagesList"
}
},
"RetentionPolicy": {
"type": "object",
"description": "The retention policy.",
"properties": {
"Enabled": {
"type": "boolean",
"description": "Whether to enable the retention policy.",
"x-ms-client-name": "enabled"
},
"Days": {
"type": "integer",
"format": "int32",
"description": "The number of days to retain the logs.",
"minimum": 1,
"x-ms-client-name": "days"
}
},
"required": [
"Enabled"
]
},
"SentMessage": {
"type": "object",
"description": "The sent queue message.",
"properties": {
"MessageId": {
"type": "string",
"description": "The ID of the message.",
"x-ms-client-name": "messageId"
},
"InsertionTime": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The time the message was inserted into the queue.",
"x-ms-client-name": "insertionTime"
},
"ExpirationTime": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The time that the message will expire and be automatically deleted.",
"x-ms-client-name": "expirationTime"
},
"PopReceipt": {
"type": "string",
"description": "An opaque value required to delete the message. If deletion fails using this\nPopReceipt then the message has been dequeued by another client.",
"x-ms-client-name": "popReceipt"
},
"TimeNextVisible": {
"type": "string",
"format": "date-time-rfc7231",
"description": "The time that the message will again become visible in the queue.",
"x-ms-client-name": "timeNextVisible"
}
},
"required": [
"MessageId",
"InsertionTime",
"ExpirationTime",
"PopReceipt",
"TimeNextVisible"
],
"xml": {
"name": "QueueMessage"
}
},
"SignedIdentifier": {
"type": "object",
"description": "The signed identifier.",
"properties": {
"Id": {
"type": "string",
"description": "The unique ID for the signed identifier.",
"x-ms-client-name": "id"
},
"AccessPolicy": {
"$ref": "#/definitions/AccessPolicy",
"description": "The access policy for the signed identifier.",
"x-ms-client-name": "accessPolicy"
}
},
"required": [
"Id",
"AccessPolicy"
]
},
"SignedIdentifiers": {
"type": "object",
"description": "An array of signed identifiers.",
"properties": {
"SignedIdentifier": {
"type": "array",
"description": "The list of signed identifiers.",
"items": {
"$ref": "#/definitions/SignedIdentifier"
},
"xml": {
"wrapped": false
},
"x-ms-client-name": "items"
}
},
"required": [
"SignedIdentifier"
]
},
"StorageErrorCode": {
"type": "string",
"description": "Error codes returned by the service",
"enum": [
"AccountAlreadyExists",
"AccountBeingCreated",
"AccountIsDisabled",
"AuthenticationFailed",
"AuthorizationFailure",
"ConditionHeadersNotSupported",
"ConditionNotMet",
"EmptyMetadataKey",
"InsufficientAccountPermissions",
"InternalError",
"InvalidAuthenticationInfo",
"InvalidHeaderValue",
"InvalidHttpVerb",
"InvalidInput",
"InvalidMd5",
"InvalidMetadata",
"InvalidQueryParameterValue",
"InvalidRange",
"InvalidResourceName",
"InvalidUri",
"InvalidXmlDocument",
"InvalidXmlNodeValue",
"Md5Mismatch",
"MetadataTooLarge",
"MissingContentLengthHeader",
"MissingRequiredQueryParameter",
"MissingRequiredHeader",
"MissingRequiredXmlNode",
"MultipleConditionHeadersNotSupported",
"OperationTimedOut",
"OutOfRangeInput",
"OutOfRangeQueryParameterValue",
"RequestBodyTooLarge",
"ResourceTypeMismatch",
"RequestUrlFailedToParse",
"ResourceAlreadyExists",
"ResourceNotFound",
"ServerBusy",
"UnsupportedHeader",
"UnsupportedXmlNode",
"UnsupportedQueryParameter",
"UnsupportedHttpVerb",
"InvalidMarker",
"MessageNotFound",
"MessageTooLarge",
"PopReceiptMismatch",
"QueueAlreadyExists",
"QueueBeingDeleted",
"QueueDisabled",
"QueueNotEmpty",
"QueueNotFound",
"AuthorizationSourceIPMismatch",
"AuthorizationProtocolMismatch",
"AuthorizationPermissionMismatch",
"AuthorizationServiceMismatch",
"AuthorizationResourceTypeMismatch",
"FeatureVersionMismatch"
],
"x-ms-enum": {
"name": "StorageErrorCode",
"modelAsString": true,
"values": [
{
"name": "AccountAlreadyExists",
"value": "AccountAlreadyExists",
"description": "AccountAlreadyExists"
},
{
"name": "AccountBeingCreated",
"value": "AccountBeingCreated",
"description": "AccountBeingCreated"
},
{
"name": "AccountIsDisabled",
"value": "AccountIsDisabled",
"description": "AccountIsDisabled"
},
{
"name": "AuthenticationFailed",
"value": "AuthenticationFailed",
"description": "AuthenticationFailed"
},
{
"name": "AuthorizationFailure",
"value": "AuthorizationFailure",
"description": "AuthorizationFailure"
},
{
"name": "ConditionHeadersNotSupported",
"value": "ConditionHeadersNotSupported",
"description": "ConditionHeadersNotSupported"
},
{
"name": "ConditionNotMet",
"value": "ConditionNotMet",
"description": "ConditionNotMet"
},
{
"name": "EmptyMetadataKey",
"value": "EmptyMetadataKey",
"description": "EmptyMetadataKey"
},
{
"name": "InsufficientAccountPermissions",
"value": "InsufficientAccountPermissions",
"description": "InsufficientAccountPermissions"
},
{
"name": "InternalError",
"value": "InternalError",
"description": "InternalError"
},
{
"name": "InvalidAuthenticationInfo",
"value": "InvalidAuthenticationInfo",
"description": "InvalidAuthenticationInfo"
},
{
"name": "InvalidHeaderValue",
"value": "InvalidHeaderValue",
"description": "InvalidHeaderValue"
},
{
"name": "InvalidHttpVerb",
"value": "InvalidHttpVerb",
"description": "InvalidHttpVerb"
},
{
"name": "InvalidInput",
"value": "InvalidInput",
"description": "InvalidInput"
},
{
"name": "InvalidMd5",
"value": "InvalidMd5",
"description": "InvalidMd5"
},
{
"name": "InvalidMetadata",
"value": "InvalidMetadata",
"description": "InvalidMetadata"
},
{
"name": "InvalidQueryParameterValue",
"value": "InvalidQueryParameterValue",
"description": "InvalidQueryParameterValue"
},
{
"name": "InvalidRange",
"value": "InvalidRange",
"description": "InvalidRange"
},
{
"name": "InvalidResourceName",
"value": "InvalidResourceName",
"description": "InvalidResourceName"
},
{
"name": "InvalidUri",
"value": "InvalidUri",
"description": "InvalidUri"
},
{
"name": "InvalidXmlDocument",
"value": "InvalidXmlDocument",
"description": "InvalidXmlDocument"
},
{
"name": "InvalidXmlNodeValue",
"value": "InvalidXmlNodeValue",
"description": "InvalidXmlNodeValue"
},
{
"name": "Md5Mismatch",
"value": "Md5Mismatch",
"description": "Md5Mismatch"
},
{
"name": "MetadataTooLarge",
"value": "MetadataTooLarge",
"description": "MetadataTooLarge"
},
{
"name": "MissingContentLengthHeader",
"value": "MissingContentLengthHeader",
"description": "MissingContentLengthHeader"
},
{
"name": "MissingRequiredQueryParameter",
"value": "MissingRequiredQueryParameter",
"description": "MissingRequiredQueryParameter"
},
{
"name": "MissingRequiredHeader",
"value": "MissingRequiredHeader",
"description": "MissingRequiredHeader"
},
{
"name": "MissingRequiredXmlNode",
"value": "MissingRequiredXmlNode",
"description": "MissingRequiredXmlNode"
},
{
"name": "MultipleConditionHeadersNotSupported",
"value": "MultipleConditionHeadersNotSupported",
"description": "MultipleConditionHeadersNotSupported"
},
{
"name": "OperationTimedOut",
"value": "OperationTimedOut",
"description": "OperationTimedOut"
},
{
"name": "OutOfRangeInput",
"value": "OutOfRangeInput",
"description": "OutOfRangeInput"
},
{
"name": "OutOfRangeQueryParameterValue",
"value": "OutOfRangeQueryParameterValue",
"description": "OutOfRangeQueryParameterValue"
},
{
"name": "RequestBodyTooLarge",
"value": "RequestBodyTooLarge",
"description": "RequestBodyTooLarge"
},
{
"name": "ResourceTypeMismatch",
"value": "ResourceTypeMismatch",
"description": "ResourceTypeMismatch"
},
{
"name": "RequestUrlFailedToParse",
"value": "RequestUrlFailedToParse",
"description": "RequestUrlFailedToParse"
},
{
"name": "ResourceAlreadyExists",
"value": "ResourceAlreadyExists",
"description": "ResourceAlreadyExists"
},
{
"name": "ResourceNotFound",
"value": "ResourceNotFound",
"description": "ResourceNotFound"
},
{
"name": "ServerBusy",
"value": "ServerBusy",
"description": "ServerBusy"
},
{
"name": "UnsupportedHeader",
"value": "UnsupportedHeader",
"description": "UnsupportedHeader"
},
{
"name": "UnsupportedXmlNode",
"value": "UnsupportedXmlNode",
"description": "UnsupportedXmlNode"
},
{
"name": "UnsupportedQueryParameter",
"value": "UnsupportedQueryParameter",
"description": "UnsupportedQueryParameter"
},
{
"name": "UnsupportedHttpVerb",
"value": "UnsupportedHttpVerb",
"description": "UnsupportedHttpVerb"
},
{
"name": "InvalidMarker",
"value": "InvalidMarker",
"description": "InvalidMarker"
},
{
"name": "MessageNotFound",
"value": "MessageNotFound",
"description": "MessageNotFound"
},
{
"name": "MessageTooLarge",
"value": "MessageTooLarge",
"description": "MessageTooLarge"
},
{
"name": "PopReceiptMismatch",
"value": "PopReceiptMismatch",
"description": "PopReceiptMismatch"
},
{
"name": "QueueAlreadyExists",
"value": "QueueAlreadyExists",
"description": "QueueAlreadyExists"
},
{
"name": "QueueBeingDeleted",
"value": "QueueBeingDeleted",
"description": "QueueBeingDeleted"
},
{
"name": "QueueDisabled",
"value": "QueueDisabled",
"description": "QueueDisabled"
},
{
"name": "QueueNotEmpty",
"value": "QueueNotEmpty",
"description": "QueueNotEmpty"
},
{
"name": "QueueNotFound",
"value": "QueueNotFound",
"description": "QueueNotFound"
},
{
"name": "AuthorizationSourceIPMismatch",
"value": "AuthorizationSourceIPMismatch",
"description": "AuthorizationSourceIPMismatch"
},
{
"name": "AuthorizationProtocolMismatch",
"value": "AuthorizationProtocolMismatch",
"description": "AuthorizationProtocolMismatch"
},
{
"name": "AuthorizationPermissionMismatch",
"value": "AuthorizationPermissionMismatch",
"description": "AuthorizationPermissionMismatch"
},
{
"name": "AuthorizationServiceMismatch",
"value": "AuthorizationServiceMismatch",
"description": "AuthorizationServiceMismatch"
},
{
"name": "AuthorizationResourceTypeMismatch",
"value": "AuthorizationResourceTypeMismatch",
"description": "AuthorizationResourceTypeMismatch"
},
{
"name": "FeatureVersionMismatch",
"value": "FeatureVersionMismatch",
"description": "FeatureVersionMismatch"
}
]
}
},
"UserDelegationKey": {
"type": "object",
"description": "A user delegation key.",
"properties": {
"SignedOid": {
"type": "string",
"description": "The Entra ID object ID in GUID format.",
"x-ms-client-name": "signedOid"
},
"SignedTid": {
"type": "string",
"description": "The Entra ID tenant ID in GUID format.",
"x-ms-client-name": "signedTid"
},
"SignedStart": {
"type": "string",
"format": "date-time",
"description": "The date-time the key is active.",
"x-ms-client-name": "signedStart"
},
"SignedExpiry": {
"type": "string",
"format": "date-time",
"description": "The date-time the key expires.",
"x-ms-client-name": "signedExpiry"
},
"SignedService": {
"type": "string",
"description": "The service that created the key.",
"x-ms-client-name": "signedService"
},
"SignedVersion": {
"type": "string",
"description": "The service version used when creating the key.",
"x-ms-client-name": "signedVersion"
},
"SignedDelegatedUserTid": {
"type": "string",
"description": "The delegated user tenant ID in Entra ID. Return if DelegatedUserTid is specified.",
"x-ms-client-name": "signedDelegatedUserTid"
},
"Value": {
"type": "string",
"description": "The key as a base64 string.",
"x-ms-client-name": "value"
}
},
"required": [
"SignedOid",
"SignedTid",
"SignedStart",
"SignedExpiry",
"SignedService",
"SignedVersion",
"Value"
]
}
},
"parameters": {}
}