Azure Queue Storage Service API

openapi: 3.2.0
info:
  title: Azure Queue Storage Service API
  version: '2026-04-06'
  x-ms-code-generation-settings:
    header: MIT
    strictSpecAdherence: false
  description: Azure Queue Storage data-plane REST API (version 2026-04-06), converted from Swagger 2.0 to OpenAPI 3.0.
  x-source: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/storage/data-plane/QueueStorage/stable/2026-04-06/queue.json
  x-ownership: Published by Microsoft in its official Azure/azure-rest-api-specs repository; info.title Azure Queue Storage; host template {accountName}.queue.core.windows.net is the documented Queue service endpoint.
servers:
- url: https://{accountName}.queue.core.windows.net
  variables:
    accountName:
      default: myaccount
      description: Storage account name
tags:
- name: Service
paths:
  /?restype=service&comp=properties:
    parameters:
    - name: restype
      description: restype
      in: query
      required: true
      schema:
        type: string
        enum:
        - service
    - name: comp
      description: comp
      in: query
      required: true
      schema:
        type: string
        enum:
        - properties
    put:
      tags:
      - Service
      operationId: Service_SetProperties
      description: Sets properties for a storage account's Queue service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules
      parameters:
      - $ref: '#/components/parameters/Timeout'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/ClientRequestId'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/StorageServiceProperties'
        description: The StorageService properties.
        required: true
        x-ms-parameter-location: method
      responses:
        '202':
          description: Success (Accepted)
          headers:
            x-ms-request-id:
              x-ms-client-name: RequestId
              description: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
              schema:
                type: string
            x-ms-version:
              x-ms-client-name: 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.
              schema:
                type: string
        default:
          description: Failure
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/StorageError'
      summary: Service set properties
      x-summary-source: derived
    get:
      tags:
      - Service
      operationId: Service_GetProperties
      description: gets the properties of a storage account's Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
      parameters:
      - $ref: '#/components/parameters/Timeout'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/ClientRequestId'
      responses:
        '200':
          description: Success.
          headers:
            x-ms-request-id:
              x-ms-client-name: RequestId
              description: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
              schema:
                type: string
            x-ms-version:
              x-ms-client-name: 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.
              schema:
                type: string
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/StorageServiceProperties'
        default:
          description: Failure
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/StorageError'
      summary: Service get properties
      x-summary-source: derived
  /?restype=service&comp=stats:
    parameters:
    - name: restype
      description: restype
      in: query
      required: true
      schema:
        type: string
        enum:
        - service
    - name: comp
      description: comp
      in: query
      required: true
      schema:
        type: string
        enum:
        - stats
    get:
      tags:
      - Service
      operationId: Service_GetStatistics
      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.
      parameters:
      - $ref: '#/components/parameters/Timeout'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/ClientRequestId'
      responses:
        '200':
          description: Success.
          headers:
            x-ms-request-id:
              x-ms-client-name: RequestId
              description: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
              schema:
                type: string
            x-ms-version:
              x-ms-client-name: 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.
              schema:
                type: string
            Date:
              description: UTC date/time value generated by the service that indicates the time at which the response was initiated
              schema:
                type: string
                format: date-time-rfc1123
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/StorageServiceStats'
        default:
          description: Failure
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/StorageError'
      summary: Service get statistics
      x-summary-source: derived
  /?restype=service&comp=userdelegationkey:
    parameters:
    - name: restype
      description: restype
      in: query
      required: true
      schema:
        type: string
        enum:
        - service
    - name: comp
      description: comp
      in: query
      required: true
      schema:
        type: string
        enum:
        - userdelegationkey
    post:
      tags:
      - Service
      operationId: Service_GetUserDelegationKey
      description: Retrieves a user delegation key for the Queue service. This is only a valid operation when using bearer token authentication.
      parameters:
      - $ref: '#/components/parameters/Timeout'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/ClientRequestId'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/KeyInfo'
        description: Key information
        required: true
        x-ms-parameter-location: method
      responses:
        '200':
          description: Success.
          headers:
            x-ms-client-request-id:
              x-ms-client-name: ClientRequestId
              description: If a client request id header is sent in the request, this header will be present in the response with the same value.
              schema:
                type: string
            x-ms-request-id:
              x-ms-client-name: RequestId
              description: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
              schema:
                type: string
            x-ms-version:
              x-ms-client-name: Version
              description: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.
              schema:
                type: string
            Date:
              description: UTC date/time value generated by the service that indicates the time at which the response was initiated
              schema:
                type: string
                format: date-time-rfc1123
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/UserDelegationKey'
        default:
          description: Failure
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/StorageError'
      summary: Service get user delegation key
      x-summary-source: derived
  /?comp=list:
    parameters:
    - name: comp
      description: comp
      in: query
      required: true
      schema:
        type: string
        enum:
        - list
    get:
      tags:
      - Service
      operationId: Service_ListQueuesSegment
      description: The List Queues Segment operation returns a list of the queues under the specified account
      parameters:
      - $ref: '#/components/parameters/Prefix'
      - $ref: '#/components/parameters/Marker'
      - $ref: '#/components/parameters/MaxResults'
      - $ref: '#/components/parameters/ListQueuesInclude'
      - $ref: '#/components/parameters/Timeout'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/ClientRequestId'
      responses:
        '200':
          description: Success.
          headers:
            x-ms-request-id:
              x-ms-client-name: RequestId
              description: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
              schema:
                type: string
            x-ms-version:
              x-ms-client-name: 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.
              schema:
                type: string
            Date:
              description: UTC date/time value generated by the service that indicates the time at which the response was initiated
              schema:
                type: string
                format: date-time-rfc1123
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/ListQueuesSegmentResponse'
        default:
          description: Failure
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/StorageError'
      x-ms-pageable:
        nextLinkName: NextMarker
      summary: Service list queues segment
      x-summary-source: derived
  /{queueName}:
    parameters:
    - $ref: '#/components/parameters/QueueName'
    put:
      tags:
      - Service
      operationId: Queue_Create
      description: creates a new queue under the given account.
      parameters:
      - $ref: '#/components/parameters/Timeout'
      - $ref: '#/components/parameters/Metadata'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/ClientRequestId'
      responses:
        '201':
          description: Success, queue created.
          headers:
            x-ms-request-id:
              x-ms-client-name: RequestId
              description: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
              schema:
                type: string
            x-ms-version:
              x-ms-client-name: 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.
              schema:
                type: string
            Date:
              description: UTC date/time value generated by the service that indicates the time at which the response was initiated
              schema:
                type: string
                format: date-time-rfc1123
        '204':
          description: Success, queue created.
          headers:
            x-ms-request-id:
              x-ms-client-name: RequestId
              description: This header uniquely identifies the request that was made and can be used for troubleshooting the request.
              schema:
                type: string
            x-ms-version:
              x-ms-client-name: 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.
              schema:
                type: string
            Date:
              description: UTC date/time value generated by the service that indicates the time at which the response was initiated
              schema:
                type: string
                format: date-time-rfc1123
        default:
          description: Failure
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/StorageError'
      summary: Queue create
      x-summary-source: derived
components:
  parameters:
    ListQueuesInclude:
      name: include
      in: query
      required: false
      x-ms-parameter-location: method
      description: Include this parameter to specify that the queues' metadata be returned as part of the response body.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          enum:
          - metadata
          x-ms-enum:
            name: ListQueuesIncludeType
            modelAsString: false
    ApiVersionParameter:
      name: x-ms-version
      x-ms-parameter-location: client
      x-ms-client-name: version
      in: header
      required: true
      description: Specifies the version of the operation to use for this request.
      schema:
        type: string
    ClientRequestId:
      name: x-ms-client-request-id
      x-ms-client-name: requestId
      in: header
      required: false
      x-ms-parameter-location: method
      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.
      schema:
        type: string
    MaxResults:
      name: maxresults
      in: query
      required: false
      x-ms-parameter-location: method
      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.
      schema:
        type: integer
        minimum: 1
    Timeout:
      name: timeout
      in: query
      required: false
      x-ms-parameter-location: method
      description: The The timeout parameter is expressed in seconds. For more information, see <a href="https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-queue-service-operations>Setting Timeouts for Queue Service Operations.</a>
      schema:
        type: integer
        minimum: 0
    Metadata:
      name: x-ms-meta
      x-ms-client-name: metadata
      in: header
      required: false
      x-ms-parameter-location: method
      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.
      x-ms-header-collection-prefix: x-ms-meta-
      schema:
        type: string
    Marker:
      name: marker
      in: query
      required: false
      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.
      x-ms-parameter-location: method
      schema:
        type: string
    QueueName:
      name: queueName
      in: path
      required: true
      x-ms-parameter-location: method
      description: The queue name.
      schema:
        type: string
    Prefix:
      name: prefix
      in: query
      required: false
      description: Filters the results to return only queues whose name begins with the specified prefix.
      x-ms-parameter-location: method
      schema:
        type: string
  schemas:
    ListQueuesSegmentResponse:
      xml:
        name: EnumerationResults
      description: The object returned when calling List Queues on a Queue Service.
      type: object
      required:
      - ServiceEndpoint
      - Prefix
      - MaxResults
      - NextMarker
      properties:
        ServiceEndpoint:
          type: string
          xml:
            attribute: true
        Prefix:
          type: string
        Marker:
          type: string
        MaxResults:
          type: integer
        QueueItems:
          xml:
            wrapped: true
            name: Queues
          type: array
          items:
            $ref: '#/components/schemas/QueueItem'
        NextMarker:
          type: string
    UserDelegationKey:
      type: object
      required:
      - SignedOid
      - SignedTid
      - SignedStart
      - SignedExpiry
      - SignedService
      - SignedVersion
      - Value
      description: A user delegation key
      properties:
        SignedOid:
          description: The Azure Active Directory object ID in GUID format.
          type: string
        SignedTid:
          description: The Azure Active Directory tenant ID in GUID format
          type: string
        SignedStart:
          description: The date-time the key is active
          type: string
          format: date-time
        SignedExpiry:
          description: The date-time the key expires
          type: string
          format: date-time
        SignedService:
          description: Abbreviation of the Azure Storage service that accepts the key
          type: string
        SignedVersion:
          description: The service version that created the key
          type: string
        SignedDelegatedUserTid:
          description: The delegated user tenant id in Azure AD. Return if DelegatedUserTid is specified.
          type: string
        Value:
          description: The key as a base64 string
          type: string
    Metadata:
      type: object
      additionalProperties:
        type: string
    CorsRule:
      description: CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain
      type: object
      required:
      - AllowedOrigins
      - AllowedMethods
      - AllowedHeaders
      - ExposedHeaders
      - MaxAgeInSeconds
      properties:
        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.
          type: string
        AllowedMethods:
          description: The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated)
          type: string
        AllowedHeaders:
          description: the request headers that the origin domain may specify on the CORS request.
          type: 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
          type: string
        MaxAgeInSeconds:
          description: The maximum amount time that a browser should cache the preflight OPTIONS request.
          type: integer
          minimum: 0
    StorageServiceStats:
      description: Stats for the storage service.
      type: object
      properties:
        GeoReplication:
          $ref: '#/components/schemas/GeoReplication'
    GeoReplication:
      type: object
      required:
      - Status
      - LastSyncTime
      properties:
        Status:
          description: The status of the secondary location
          type: string
          enum:
          - live
          - bootstrap
          - unavailable
          x-ms-enum:
            name: GeoReplicationStatusType
            modelAsString: true
        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.
          type: string
          format: date-time-rfc1123
    Logging:
      description: Azure Analytics Logging settings.
      type: object
      required:
      - Version
      - Delete
      - Read
      - Write
      - RetentionPolicy
      properties:
        Version:
          description: The version of Storage Analytics to configure.
          type: string
        Delete:
          description: Indicates whether all delete requests should be logged.
          type: boolean
        Read:
          description: Indicates whether all read requests should be logged.
          type: boolean
        Write:
          description: Indicates whether all write requests should be logged.
          type: boolean
        RetentionPolicy:
          $ref: '#/components/schemas/RetentionPolicy'
    StorageServiceProperties:
      description: Storage Service Properties.
      type: object
      properties:
        Logging:
          $ref: '#/components/schemas/Logging'
        HourMetrics:
          $ref: '#/components/schemas/Metrics'
        MinuteMetrics:
          $ref: '#/components/schemas/Metrics'
        Cors:
          description: The set of CORS rules.
          type: array
          items:
            $ref: '#/components/schemas/CorsRule'
          xml:
            wrapped: true
    RetentionPolicy:
      description: the retention policy
      type: object
      required:
      - Enabled
      properties:
        Enabled:
          description: Indicates whether a retention policy is enabled for the storage service
          type: 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
          type: integer
          minimum: 1
    StorageError:
      type: object
      properties:
        Message:
          type: string
    Metrics:
      description: a summary of request statistics grouped by API in hour or minute aggregates for queues
      required:
      - Enabled
      properties:
        Version:
          description: The version of Storage Analytics to configure.
          type: string
        Enabled:
          description: Indicates whether metrics are enabled for the Queue service.
          type: boolean
        IncludeAPIs:
          description: Indicates whether metrics should generate summary statistics for called API operations.
          type: boolean
        RetentionPolicy:
          $ref: '#/components/schemas/RetentionPolicy'
    KeyInfo:
      type: object
      required:
      - Expiry
      description: Key information
      properties:
        Start:
          description: The date-time the key is active in ISO 8601 UTC time
          type: string
        Expiry:
          description: The date-time the key expires in ISO 8601 UTC time
          type: string
        DelegatedUserTid:
          description: The delegated user tenant id in Azure AD
          type: string
    QueueItem:
      description: An Azure Storage Queue.
      type: object
      required:
      - Name
      properties:
        Name:
          type: string
          description: The name of the Queue.
        Metadata:
          $ref: '#/components/schemas/Metadata'
      xml:
        name: Queue
  securitySchemes:
    queue_shared_key:
      type: apiKey
      name: Authorization
      in: header