Microsoft.QueueStorage (stable:2018-03-28)

2025/03/19 • 16 updated methods

Service_SetProperties (updated)
Description :  Sets properties for a storage account's Queue service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules
Reference :  Link ¶

⚶ Changes

{
  "#id": "Service_SetProperties",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations.",
        "old": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /?restype=service&comp=properties
{
StorageServiceProperties:
{
Description: The StorageService properties. ,
Required: True ,
}
{
Logging:
{
Description: Azure Analytics Logging settings ,
Required: False ,
}
{
Version:
{
Description: The version of Storage Analytics to configure. ,
Required: True ,
}
string ,
Delete:
{
Description: Indicates whether all delete requests should be logged. ,
Required: True ,
}
boolean ,
Read:
{
Description: Indicates whether all read requests should be logged. ,
Required: True ,
}
boolean ,
Write:
{
Description: Indicates whether all write requests should be logged. ,
Required: True ,
}
boolean ,
RetentionPolicy:
{
Description: the retention policy ,
Required: True ,
}
{
Enabled:
{
Description: Indicates whether a retention policy is enabled for the storage service ,
Required: True ,
}
boolean ,
Days:
{
Description: Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted ,
Required: False ,
}
integer ,
}
,
}
,
HourMetrics:
{
Description: A summary of request statistics grouped by API in hourly aggregates for queues ,
Required: False ,
}
{
Version:
{
Description: The version of Storage Analytics to configure. ,
Required: False ,
}
string ,
Enabled:
{
Description: Indicates whether metrics are enabled for the Queue service. ,
Required: True ,
}
boolean ,
IncludeAPIs:
{
Description: Indicates whether metrics should generate summary statistics for called API operations. ,
Required: False ,
}
boolean ,
RetentionPolicy:
{
Description: the retention policy ,
Required: False ,
}
{
Enabled:
{
Description: Indicates whether a retention policy is enabled for the storage service ,
Required: True ,
}
boolean ,
Days:
{
Description: Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted ,
Required: False ,
}
integer ,
}
,
}
,
MinuteMetrics:
{
Description: a summary of request statistics grouped by API in minute aggregates for queues ,
Required: False ,
}
{
Version:
{
Description: The version of Storage Analytics to configure. ,
Required: False ,
}
string ,
Enabled:
{
Description: Indicates whether metrics are enabled for the Queue service. ,
Required: True ,
}
boolean ,
IncludeAPIs:
{
Description: Indicates whether metrics should generate summary statistics for called API operations. ,
Required: False ,
}
boolean ,
RetentionPolicy:
{
Description: the retention policy ,
Required: False ,
}
{
Enabled:
{
Description: Indicates whether a retention policy is enabled for the storage service ,
Required: True ,
}
boolean ,
Days:
{
Description: Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted ,
Required: False ,
}
integer ,
}
,
}
,
Cors:
{
Description: The set of CORS rules. ,
Required: False ,
}
[
{
AllowedOrigins:
{
Description: The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS. ,
Required: True ,
}
string ,
AllowedMethods:
{
Description: The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated) ,
Required: True ,
}
string ,
AllowedHeaders:
{
Description: the request headers that the origin domain may specify on the CORS request. ,
Required: True ,
}
string ,
ExposedHeaders:
{
Description: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer ,
Required: True ,
}
string ,
MaxAgeInSeconds:
{
Description: The maximum amount time that a browser should cache the preflight OPTIONS request. ,
Required: True ,
}
integer ,
}
,
]
,
}
,
timeout:
{
Description: The The timeout parameter is expressed in seconds. For more information, see ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Service_GetProperties (updated)
Description :  gets the properties of a storage account's Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Service_GetProperties",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations.",
        "old": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations."
      }
    }
  ]
}

⚼ Request

GET:  /?restype=service&comp=properties
{
timeout:
{
Description: The The timeout parameter is expressed in seconds. For more information, see ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. ,
}
string ,
}
,
$schema:
{
Description: Storage Service Properties. ,
}
{
Logging:
{
Description: Azure Analytics Logging settings ,
Required: False ,
}
{
Version:
{
Description: The version of Storage Analytics to configure. ,
Required: True ,
}
string ,
Delete:
{
Description: Indicates whether all delete requests should be logged. ,
Required: True ,
}
boolean ,
Read:
{
Description: Indicates whether all read requests should be logged. ,
Required: True ,
}
boolean ,
Write:
{
Description: Indicates whether all write requests should be logged. ,
Required: True ,
}
boolean ,
RetentionPolicy:
{
Description: the retention policy ,
Required: True ,
}
{
Enabled:
{
Description: Indicates whether a retention policy is enabled for the storage service ,
Required: True ,
}
boolean ,
Days:
{
Description: Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted ,
Required: False ,
}
integer ,
}
,
}
,
HourMetrics:
{
Description: A summary of request statistics grouped by API in hourly aggregates for queues ,
Required: False ,
}
{
Version:
{
Description: The version of Storage Analytics to configure. ,
Required: False ,
}
string ,
Enabled:
{
Description: Indicates whether metrics are enabled for the Queue service. ,
Required: True ,
}
boolean ,
IncludeAPIs:
{
Description: Indicates whether metrics should generate summary statistics for called API operations. ,
Required: False ,
}
boolean ,
RetentionPolicy:
{
Description: the retention policy ,
Required: False ,
}
{
Enabled:
{
Description: Indicates whether a retention policy is enabled for the storage service ,
Required: True ,
}
boolean ,
Days:
{
Description: Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted ,
Required: False ,
}
integer ,
}
,
}
,
MinuteMetrics:
{
Description: a summary of request statistics grouped by API in minute aggregates for queues ,
Required: False ,
}
{
Version:
{
Description: The version of Storage Analytics to configure. ,
Required: False ,
}
string ,
Enabled:
{
Description: Indicates whether metrics are enabled for the Queue service. ,
Required: True ,
}
boolean ,
IncludeAPIs:
{
Description: Indicates whether metrics should generate summary statistics for called API operations. ,
Required: False ,
}
boolean ,
RetentionPolicy:
{
Description: the retention policy ,
Required: False ,
}
{
Enabled:
{
Description: Indicates whether a retention policy is enabled for the storage service ,
Required: True ,
}
boolean ,
Days:
{
Description: Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted ,
Required: False ,
}
integer ,
}
,
}
,
Cors:
{
Description: The set of CORS rules. ,
Required: False ,
}
[
{
AllowedOrigins:
{
Description: The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS. ,
Required: True ,
}
string ,
AllowedMethods:
{
Description: The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated) ,
Required: True ,
}
string ,
AllowedHeaders:
{
Description: the request headers that the origin domain may specify on the CORS request. ,
Required: True ,
}
string ,
ExposedHeaders:
{
Description: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer ,
Required: True ,
}
string ,
MaxAgeInSeconds:
{
Description: The maximum amount time that a browser should cache the preflight OPTIONS request. ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Service_GetStatistics (updated)
Description :  Retrieves statistics related to replication for the Queue service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Service_GetStatistics",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations.",
        "old": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations."
      }
    }
  ]
}

⚼ Request

GET:  /?restype=service&comp=stats
{
timeout:
{
Description: The The timeout parameter is expressed in seconds. For more information, see ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
}
,
$schema:
{
Description: Stats for the storage service. ,
}
{
GeoReplication:
{
Description: Geo-Replication information for the Secondary Storage Service ,
Required: False ,
}
{
Status:
{
Description: The status of the secondary location ,
Enum:
{
live: No description available. ,
bootstrap: No description available. ,
unavailable: No description available. ,
}
,
Required: True ,
}
enum ,
LastSyncTime:
{
Description: A GMT date/time value, to the second. All primary writes preceding this value are guaranteed to be available for read operations at the secondary. Primary writes after this point in time may or may not be available for reads. ,
Format: date-time-rfc1123 ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Service_ListQueuesSegment (updated)
Description :  The List Queues Segment operation returns a list of the queues under the specified account
Reference :  Link ¶

⚶ Changes

{
  "#id": "Service_ListQueuesSegment",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations.",
        "old": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations."
      }
    }
  ]
}

⚼ Request

GET:  /?comp=list
{
prefix:
{
Description: Filters the results to return only queues whose name begins with the specified prefix. ,
Required: False ,
}
string ,
marker:
{
Description: A string value that identifies the portion of the list of queues to be returned with the next listing operation. The operation returns the NextMarker value within the response body if the listing operation did not return all queues remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client. ,
Required: False ,
}
string ,
maxresults:
{
Description: Specifies the maximum number of queues to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000. ,
Required: False ,
}
integer ,
include:
{
Description: Include this parameter to specify that the queues' metadata be returned as part of the response body. ,
Required: False ,
}
array ,
timeout:
{
Description: The The timeout parameter is expressed in seconds. For more information, see ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
}
,
$schema:
{
Description: The object returned when calling List Queues on a Queue Service. ,
}
{
ServiceEndpoint:
{
Required: True ,
}
string ,
Prefix:
{
Required: True ,
}
string ,
Marker:
{
Required: False ,
}
string ,
MaxResults:
{
Required: True ,
}
integer ,
QueueItems:
{
Required: False ,
}
[
{
Name:
{
Description: The name of the Queue. ,
Required: True ,
}
string ,
Metadata:
{
Required: False ,
}
object ,
}
,
]
,
NextMarker:
{
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Queue_Create (updated)
Description :  creates a new queue under the given account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Queue_Create",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations.",
        "old": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{queueName}
{
timeout:
{
Description: The The timeout parameter is expressed in seconds. For more information, see ,
Required: False ,
}
integer ,
x-ms-meta:
{
Description: Optional. Include this parameter to specify that the queue's metadata be returned as part of the response body. Note that metadata requested with this parameter must be stored in accordance with the naming restrictions imposed by the 2009-09-19 version of the Queue service. Beginning with this version, all metadata names must adhere to the naming conventions for C# identifiers. ,
Required: False ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
}

⚐ Response (204)

{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Queue_Delete (updated)
Description :  operation permanently deletes the specified queue
Reference :  Link ¶

⚶ Changes

{
  "#id": "Queue_Delete",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations.",
        "old": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations."
      }
    }
  ]
}

⚼ Request

DELETE:  /{queueName}
{
timeout:
{
Description: The The timeout parameter is expressed in seconds. For more information, see ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
}

⚐ Response (204)

{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Queue_GetProperties (updated)
Description :  Retrieves user-defined metadata and queue properties on the specified queue. Metadata is associated with the queue as name-values pairs.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Queue_GetProperties",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations.",
        "old": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations."
      }
    }
  ]
}

⚼ Request

GET:  /{queueName}?comp=metadata
{
timeout:
{
Description: The The timeout parameter is expressed in seconds. For more information, see ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
x-ms-meta: string ,
x-ms-approximate-messages-count:
{
Description: The approximate number of messages in the queue. This number is not lower than the actual number of messages in the queue, but could be higher. ,
}
integer ,
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Queue_SetMetadata (updated)
Description :  sets user-defined metadata on the specified queue. Metadata is associated with the queue as name-value pairs.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Queue_SetMetadata",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations.",
        "old": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{queueName}?comp=metadata
{
timeout:
{
Description: The The timeout parameter is expressed in seconds. For more information, see ,
Required: False ,
}
integer ,
x-ms-meta:
{
Description: Optional. Include this parameter to specify that the queue's metadata be returned as part of the response body. Note that metadata requested with this parameter must be stored in accordance with the naming restrictions imposed by the 2009-09-19 version of the Queue service. Beginning with this version, all metadata names must adhere to the naming conventions for C# identifiers. ,
Required: False ,
}
string ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
}

⚐ Response (204)

{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Queue_GetAccessPolicy (updated)
Description :  returns details about any stored access policies specified on the queue that may be used with Shared Access Signatures.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Queue_GetAccessPolicy",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations.",
        "old": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations."
      }
    }
  ]
}

⚼ Request

GET:  /{queueName}?comp=acl
{
timeout:
{
Description: The The timeout parameter is expressed in seconds. For more information, see ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
}
,
$schema:
{
Description: a collection of signed identifiers ,
}
{
Id:
{
Description: a unique id ,
Required: True ,
}
string ,
AccessPolicy:
{
Description: The access policy ,
Required: True ,
}
{
Start:
{
Description: the date-time the policy is active ,
Format: date-time ,
Required: False ,
}
string ,
Expiry:
{
Description: the date-time the policy expires ,
Format: date-time ,
Required: False ,
}
string ,
Permission:
{
Description: the permissions for the acl policy ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Queue_SetAccessPolicy (updated)
Description :  sets stored access policies for the queue that may be used with Shared Access Signatures
Reference :  Link ¶

⚶ Changes

{
  "#id": "Queue_SetAccessPolicy",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations.",
        "old": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{queueName}?comp=acl
{
queueAcl:
{
Description: the acls for the queue ,
Required: False ,
}
{
Id:
{
Description: a unique id ,
Required: True ,
}
string ,
AccessPolicy:
{
Description: The access policy ,
Required: True ,
}
{
Start:
{
Description: the date-time the policy is active ,
Format: date-time ,
Required: False ,
}
string ,
Expiry:
{
Description: the date-time the policy expires ,
Format: date-time ,
Required: False ,
}
string ,
Permission:
{
Description: the permissions for the acl policy ,
Required: False ,
}
string ,
}
,
}
,
timeout:
{
Description: The The timeout parameter is expressed in seconds. For more information, see ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
}

⚐ Response (204)

{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Messages_Dequeue (updated)
Description :  The Dequeue operation retrieves one or more messages from the front of the queue.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Messages_Dequeue",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations.",
        "old": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations."
      }
    }
  ]
}

⚼ Request

GET:  /{queueName}/messages
{
numofmessages:
{
Description: Optional. A nonzero integer value that specifies the number of messages to retrieve from the queue, up to a maximum of 32. If fewer are visible, the visible messages are returned. By default, a single message is retrieved from the queue with this operation. ,
Required: False ,
}
integer ,
visibilitytimeout:
{
Description: Optional. Specifies the new visibility timeout value, in seconds, relative to server time. The default value is 30 seconds. A specified value must be larger than or equal to 1 second, and cannot be larger than 7 days, or larger than 2 hours on REST protocol versions prior to version 2011-08-18. The visibility timeout of a message can be set to a value later than the expiry time. ,
Required: False ,
}
integer ,
timeout:
{
Description: The The timeout parameter is expressed in seconds. For more information, see ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
}
,
$schema:
{
Description: The object returned when calling Get Messages on a Queue ,
}
{
MessageId:
{
Description: The Id of the Message. ,
Required: True ,
}
string ,
InsertionTime:
{
Description: The time the Message was inserted into the Queue. ,
Format: date-time-rfc1123 ,
Required: True ,
}
string ,
ExpirationTime:
{
Description: The time that the Message will expire and be automatically deleted. ,
Format: date-time-rfc1123 ,
Required: True ,
}
string ,
PopReceipt:
{
Description: This value is required to delete the Message. If deletion fails using this popreceipt then the message has been dequeued by another client. ,
Required: True ,
}
string ,
TimeNextVisible:
{
Description: The time that the message will again become visible in the Queue. ,
Format: date-time-rfc1123 ,
Required: True ,
}
string ,
DequeueCount:
{
Description: The number of times the message has been dequeued. ,
Format: int64 ,
Required: True ,
}
integer ,
MessageText:
{
Description: The content of the Message. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Messages_Clear (updated)
Description :  The Clear operation deletes all messages from the specified queue.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Messages_Clear",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations.",
        "old": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations."
      }
    }
  ]
}

⚼ Request

DELETE:  /{queueName}/messages
{
timeout:
{
Description: The The timeout parameter is expressed in seconds. For more information, see ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
}

⚐ Response (204)

{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Messages_Enqueue (updated)
Description :  The Enqueue operation adds a new message to the back of the message queue. A visibility timeout can also be specified to make the message invisible until the visibility timeout expires. A message must be in a format that can be included in an XML request with UTF-8 encoding. The encoded message can be up to 64 KB in size for versions 2011-08-18 and newer, or 8 KB in size for previous versions.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Messages_Enqueue",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations.",
        "old": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations."
      }
    }
  ]
}

⚼ Request

POST:  /{queueName}/messages
{
QueueMessage:
{
Description: A Message object which can be stored in a Queue ,
Required: True ,
}
{
MessageText:
{
Description: The content of the message ,
Required: True ,
}
string ,
}
,
visibilitytimeout:
{
Description: Optional. If specified, the request must be made using an x-ms-version of 2011-08-18 or later. If not specified, the default value is 0. Specifies the new visibility timeout value, in seconds, relative to server time. The new value must be larger than or equal to 0, and cannot be larger than 7 days. The visibility timeout of a message cannot be set to a value later than the expiry time. visibilitytimeout should be set to a value smaller than the time-to-live value. ,
Required: False ,
}
integer ,
messagettl:
{
Description: Optional. Specifies the time-to-live interval for the message, in seconds. Prior to version 2017-07-29, the maximum time-to-live allowed is 7 days. For version 2017-07-29 or later, the maximum time-to-live can be any positive number, as well as -1 indicating that the message does not expire. If this parameter is omitted, the default time-to-live is 7 days. ,
Required: False ,
}
integer ,
timeout:
{
Description: The The timeout parameter is expressed in seconds. For more information, see ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
}
,
$schema:
{
Description: The object returned when calling Put Message on a Queue ,
}
{
MessageId:
{
Description: The Id of the Message. ,
Required: True ,
}
string ,
InsertionTime:
{
Description: The time the Message was inserted into the Queue. ,
Format: date-time-rfc1123 ,
Required: True ,
}
string ,
ExpirationTime:
{
Description: The time that the Message will expire and be automatically deleted. ,
Format: date-time-rfc1123 ,
Required: True ,
}
string ,
PopReceipt:
{
Description: This value is required to delete the Message. If deletion fails using this popreceipt then the message has been dequeued by another client. ,
Required: True ,
}
string ,
TimeNextVisible:
{
Description: The time that the message will again become visible in the Queue. ,
Format: date-time-rfc1123 ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
Messages_Peek (updated)
Description :  The Peek operation retrieves one or more messages from the front of the queue, but does not alter the visibility of the message.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Messages_Peek",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations.",
        "old": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations."
      }
    }
  ]
}

⚼ Request

GET:  /{queueName}/messages?peekonly=true
{
numofmessages:
{
Description: Optional. A nonzero integer value that specifies the number of messages to retrieve from the queue, up to a maximum of 32. If fewer are visible, the visible messages are returned. By default, a single message is retrieved from the queue with this operation. ,
Required: False ,
}
integer ,
timeout:
{
Description: The The timeout parameter is expressed in seconds. For more information, see ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
}
,
$schema:
{
Description: The object returned when calling Peek Messages on a Queue ,
}
{
MessageId:
{
Description: The Id of the Message. ,
Required: True ,
}
string ,
InsertionTime:
{
Description: The time the Message was inserted into the Queue. ,
Format: date-time-rfc1123 ,
Required: True ,
}
string ,
ExpirationTime:
{
Description: The time that the Message will expire and be automatically deleted. ,
Format: date-time-rfc1123 ,
Required: True ,
}
string ,
DequeueCount:
{
Description: The number of times the message has been dequeued. ,
Format: int64 ,
Required: True ,
}
integer ,
MessageText:
{
Description: The content of the Message. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
MessageId_Update (updated)
Description :  The Update operation was introduced with version 2011-08-18 of the Queue service API. The Update Message operation updates the visibility timeout of a message. You can also use this operation to update the contents of a message. A message must be in a format that can be included in an XML request with UTF-8 encoding, and the encoded message can be up to 64KB in size.
Reference :  Link ¶

⚶ Changes

{
  "#id": "MessageId_Update",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations.",
        "old": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations."
      }
    }
  ]
}

⚼ Request

PUT:  /{queueName}/messages/{messageid}
{
QueueMessage:
{
Description: A Message object which can be stored in a Queue ,
Required: False ,
}
{
MessageText:
{
Description: The content of the message ,
Required: True ,
}
string ,
}
,
popreceipt:
{
Description: Required. Specifies the valid pop receipt value returned from an earlier call to the Get Messages or Update Message operation. ,
Required: True ,
}
string ,
visibilitytimeout:
{
Description: Optional. Specifies the new visibility timeout value, in seconds, relative to server time. The default value is 30 seconds. A specified value must be larger than or equal to 1 second, and cannot be larger than 7 days, or larger than 2 hours on REST protocol versions prior to version 2011-08-18. The visibility timeout of a message can be set to a value later than the expiry time. ,
Required: True ,
}
integer ,
timeout:
{
Description: The The timeout parameter is expressed in seconds. For more information, see ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
}

⚐ Response (204)

{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
x-ms-popreceipt:
{
Description: The pop receipt of the queue message. ,
}
string ,
x-ms-time-next-visible:
{
Description: A UTC date/time value that represents when the message will be visible on the queue. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}
MessageId_Delete (updated)
Description :  The Delete operation deletes the specified message.
Reference :  Link ¶

⚶ Changes

{
  "#id": "MessageId_Delete",
  "$parameters": [
    {
      "#name": "timeout",
      "Description": {
        "new": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations.",
        "old": "The The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations."
      }
    }
  ]
}

⚼ Request

DELETE:  /{queueName}/messages/{messageid}
{
popreceipt:
{
Description: Required. Specifies the valid pop receipt value returned from an earlier call to the Get Messages or Update Message operation. ,
Required: True ,
}
string ,
timeout:
{
Description: The The timeout parameter is expressed in seconds. For more information, see ,
Required: False ,
}
integer ,
x-ms-version:
{
Description: Specifies the version of the operation to use for this request. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. ,
Required: False ,
}
string ,
}

⚐ Response (204)

{
x-ms-request-id:
{
Description: This header uniquely identifies the request that was made and can be used for troubleshooting the request. ,
}
string ,
x-ms-version:
{
Description: Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. ,
}
string ,
date:
{
Description: UTC date/time value generated by the service that indicates the time at which the response was initiated ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
Message:
{
Required: False ,
}
string ,
}
,
}