Microsoft Azure QuotaRequests API

openapi: 3.2.0
info:
  title: Microsoft Azure Quota Requests API
  version: '1.0'
  description: 'Operations tagged QuotaRequests across 2 of this provider''s published API definitions: azure-quota-extension-api-openapi-original.yml, azure-reservation-api-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: QuotaRequests
paths:
  /{scope}/providers/Microsoft.Quota/quotaRequests/{id}:
    get:
      tags:
      - QuotaRequests
      x-ms-examples:
        QuotaRequestStatus:
          $ref: ./examples/getQuotaRequestStatusById.json
        QuotaRequestInProgress:
          $ref: ./examples/getQuotaRequestStatusInProgress.json
        QuotaRequestFailed:
          $ref: ./examples/getQuotaRequestStatusFailed.json
      description: Get the quota request details and status by quota request ID for the resources of the resource provider at a specific location. The quota request ID **id** is returned in the response of the PUT operation.
      operationId: microsoftAzureQuotarequeststatusGet
      parameters:
      - $ref: '#/components/parameters/RequestIdInParameters'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/ScopeInPath'
      responses:
        '200':
          description: OK. Returning the status for the quota request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuotaRequestDetails'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionResponse'
      summary: Microsoft Azure Get Scope Providers Microsoft Quota Quotarequests Id
    servers:
    - url: https://management.azure.com
  /{scope}/providers/Microsoft.Quota/quotaRequests:
    get:
      tags:
      - QuotaRequests
      x-ms-examples:
        QuotaRequestHistory:
          $ref: ./examples/getQuotaRequestsHistory.json
      description: For the specified scope, get the current quota requests for a one year period ending at the time is made. Use the **oData** filter to select quota requests.
      operationId: microsoftAzureQuotarequeststatusList
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/ScopeInPath'
      - name: $filter
        in: query
        required: false
        description: "| Field                    | Supported operators  \n|---------------------|------------------------\n\n|requestSubmitTime | ge, le, eq, gt, lt\n |provisioningState eq {QuotaRequestState}\n |resourceName eq {resourceName}\n"
        schema:
          type: string
      - $ref: '#/components/parameters/TopQueryParameter'
      - $ref: '#/components/parameters/SkipTokenParameter'
      responses:
        '200':
          description: OK. Sending quota request status and details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuotaRequestDetailsList'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Scope Providers Microsoft Quota Quotarequests
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/providers/Microsoft.Capacity/resourceProviders/{providerId}/locations/{location}/serviceLimitsRequests/{id}
  : get:
      tags:
      - QuotaRequests
      x-ms-examples:
        QuotaRequestStatus:
          $ref: ./examples/getQuotaRequestStatusById.json
        QuotaRequestInProgress:
          $ref: ./examples/getQuotaRequestStatusInProgress.json
        QuotaRequestFailed:
          $ref: ./examples/getQuotaRequestStatusFailed.json
      description: Gets the QuotaRequest details and status by the quota request Id for the resources for the resource provider at a specific location. The requestId is returned as response to the Put requests for serviceLimits.
      operationId: getSubscriptionsBySubscriptionIdProvidersMicrosoftCapacityResourceProvidersByProviderIdLocationsByLocationServiceLimitsRequestsById
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdInParameters'
      - $ref: '#/components/parameters/ApiVersionParameter_2'
      - $ref: '#/components/parameters/ProviderIdInParameters'
      - $ref: '#/components/parameters/LocationIdInParameters'
      - $ref: '#/components/parameters/RequestIdInParameters_2'
      responses:
        '200':
          description: Ok. Returning the status for the quota request .
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuotaRequestDetails_2'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionResponse_2'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Capacity…
      x-operation-id-source: normalized
      x-operation-id-original: microsoftAzureQuotarequeststatusGet
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/providers/Microsoft.Capacity/resourceProviders/{providerId}/locations/{location}/serviceLimitsRequests
  : get:
      tags:
      - QuotaRequests
      x-ms-examples:
        QuotaRequestHistory:
          $ref: ./examples/getQuotaRequestsHistory.json
      description: For the specified location and Resource provider gets the current quota requests under the subscription over the time period of one year ago from now to one year back. oData filter can be used to select quota requests.
      operationId: getSubscriptionsBySubscriptionIdProvidersMicrosoftCapacityResourceProvidersByProviderIdLocationsByLocationServiceLimitsRequests
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdInParameters'
      - $ref: '#/components/parameters/ApiVersionParameter_2'
      - $ref: '#/components/parameters/ProviderIdInParameters'
      - $ref: '#/components/parameters/LocationIdInParameters'
      - name: $filter
        in: query
        required: false
        description: '| Field | Supported operators |

          |---------------------|------------------------|

          |requestSubmitTime | ge, le, eq, gt, lt |'
        schema:
          type: string
      - $ref: '#/components/parameters/TopQueryParameter'
      - $ref: '#/components/parameters/SkipTokenParameter_2'
      responses:
        '200':
          description: Ok. Sending Quota request status and details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuotaRequestDetailsList_2'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionResponse_2'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Capacity…
      x-operation-id-source: normalized
      x-operation-id-original: microsoftAzureQuotarequeststatusList
    servers:
    - url: https://management.azure.com
components:
  schemas:
    QuotaRequestProperties:
      type: object
      description: Quota request properties.
      properties:
        provisioningState:
          description: The quota request status.
          $ref: '#/components/schemas/QuotaRequestState'
        message:
          description: User-friendly status message.
          type: string
          readOnly: true
        error:
          description: Error details of the quota request.
          $ref: '#/components/schemas/ServiceErrorDetail'
        requestSubmitTime:
          description: 'The quota request submission time. The date conforms to the following format specified by the ISO 8601 standard: yyyy-MM-ddTHH:mm:ssZ'
          type: string
          readOnly: true
          format: date-time
        value:
          description: Quota request details.
          type: array
          items:
            $ref: '#/components/schemas/SubRequest'
          x-ms-identifiers:
          - subRequestId
    ServiceError:
      description: API error details.
      type: object
      properties:
        code:
          type: string
          description: Error code.
        message:
          type: string
          description: Error message.
        details:
          type: array
          items:
            $ref: '#/components/schemas/ServiceErrorDetail'
          x-ms-identifiers:
          - code
          description: List of error details.
          readOnly: true
    QuotaRequestState:
      description: Quota request status.
      enum:
      - Accepted
      - Invalid
      - Succeeded
      - Failed
      - InProgress
      readOnly: true
      type: string
      x-ms-enum:
        name: QuotaRequestState
        modelAsString: true
    SubRequest:
      type: object
      description: Request property.
      properties:
        name:
          description: Resource name.
          $ref: '#/components/schemas/ResourceName'
        resourceType:
          description: Resource type for which the quota properties were requested.
          type: string
          readOnly: true
        unit:
          description: ' Quota limit units, such as Count and Bytes. When requesting quota, use the **unit** value returned in the GET response in the request body of your PUT operation.'
          type: string
        provisioningState:
          description: The quota request status.
          $ref: '#/components/schemas/QuotaRequestState'
        message:
          description: User-friendly status message.
          type: string
          readOnly: true
        subRequestId:
          description: Quota request ID.
          type: string
          readOnly: true
        limit:
          description: Resource quota limit properties.
          $ref: '#/components/schemas/LimitJsonObject'
    LimitObjectTypes:
      description: The limit object type.
      enum:
      - LimitValue
      type: string
      x-ms-enum:
        name: limitType
        modelAsString: true
    QuotaRequestDetailsList:
      description: Quota request information.
      type: object
      properties:
        value:
          description: Quota request details.
          type: array
          items:
            $ref: '#/components/schemas/QuotaRequestDetails'
        nextLink:
          description: The URI for fetching the next page of quota limits. When there are no more pages, this string is null.
          type: string
    QuotaRequestDetails:
      type: object
      description: List of quota requests with details.
      properties:
        id:
          description: Quota request ID.
          type: string
          readOnly: true
        name:
          description: Quota request name.
          type: string
          readOnly: true
        type:
          type: string
          readOnly: true
          description: Resource type. "Microsoft.Quota/quotas".
        properties:
          description: Quota request details.
          x-ms-client-flatten: true
          $ref: '#/components/schemas/QuotaRequestProperties'
    ExceptionResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ServiceError'
          description: API error details.
      description: Error.
    ServiceErrorDetail:
      description: Error details.
      type: object
      properties:
        code:
          type: string
          readOnly: true
          description: Error code.
        message:
          type: string
          readOnly: true
          description: Error message.
    LimitJsonObject:
      description: LimitJson abstract class.
      required:
      - limitObjectType
      type: object
      properties:
        limitObjectType:
          $ref: '#/components/schemas/LimitObjectTypes'
      discriminator:
        propertyName: limitObjectType
    ResourceName:
      type: object
      description: Name of the resource provided by the resource Provider. When requesting quota, use this property name.
      properties:
        value:
          description: Resource name.
          type: string
          readOnly: false
        localizedValue:
          description: Resource display name.
          type: string
          readOnly: true
    QuotaRequestProperties_2:
      type: object
      description: The details of quota request.
      properties:
        provisioningState:
          description: The quota request status.
          $ref: '#/components/schemas/QuotaRequestState_2'
        message:
          description: User friendly status message.
          type: string
          readOnly: true
        requestSubmitTime:
          description: 'The quota request submit time. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.'
          type: string
          readOnly: true
          format: date-time
        value:
          description: The quotaRequests.
          type: array
          items:
            $ref: '#/components/schemas/SubRequest_2'
    ServiceError_2:
      description: The api error details.
      type: object
      properties:
        code:
          type: string
          description: The error code.
        message:
          type: string
          description: The error message.
        details:
          type: array
          items:
            $ref: '#/components/schemas/ServiceErrorDetail_2'
          description: The list of error details.
          readOnly: true
    QuotaRequestState_2:
      description: The quota request status.
      enum:
      - Accepted
      - Invalid
      - Succeeded
      - Failed
      - InProgress
      x-ms-enum:
        name: QuotaRequestState
        modelAsString: true
    SubRequest_2:
      type: object
      description: The sub-request submitted with the quota request.
      properties:
        limit:
          description: The Resource limit.
          type: integer
          readOnly: true
        name:
          description: The Resource name.
          $ref: '#/components/schemas/ResourceName_2'
        resourceType:
          description: Resource type for which the quota check was made.
          type: string
          readOnly: true
        unit:
          description: ' The units of the limit, such as - Count, Bytes, etc. Use the unit field provided in the Get quota response.'
          type: string
        provisioningState:
          description: The quota request status.
          $ref: '#/components/schemas/QuotaRequestState_2'
        message:
          description: User friendly status message.
          type: string
          readOnly: true
        subRequestId:
          description: Sub request id for individual request.
          type: string
          readOnly: true
    QuotaRequestDetailsList_2:
      description: Quota requests information.
      type: object
      properties:
        value:
          description: The quota Requests.
          type: array
          items:
            $ref: '#/components/schemas/QuotaRequestDetails_2'
        nextLink:
          description: The uri to fetch the next page of quota limits. When there are no more pages, this is null.
          type: string
    QuotaRequestDetails_2:
      type: object
      description: The details of the quota Request.
      x-ms-azure-resource: true
      properties:
        id:
          description: The quota request Id.
          type: string
          readOnly: true
        name:
          description: The name of the quota request.
          type: string
          readOnly: true
        properties:
          description: The quota request details.
          x-ms-client-flatten: true
          $ref: '#/components/schemas/QuotaRequestProperties_2'
        type:
          type: string
          readOnly: true
          description: Type of resource. "Microsoft.Capacity/ServiceLimits"
    ExceptionResponse_2:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ServiceError_2'
          description: The api error details.
      description: The api error.
    ServiceErrorDetail_2:
      description: The error details.
      type: object
      properties:
        code:
          type: string
          readOnly: true
          description: The error code.
        message:
          type: string
          readOnly: true
          description: The error message.
    ResourceName_2:
      description: Name of the resource provide by the resource Provider. Please use this name property for quotaRequests.
      properties:
        value:
          description: Resource name.
          type: string
          readOnly: false
        localizedValue:
          description: Resource display name.
          type: string
          readOnly: true
  parameters:
    SkipTokenParameter:
      name: $skiptoken
      in: query
      required: false
      description: The **Skiptoken** parameter is used only if a previous operation returned a partial result. If a previous response contains a **nextLink** element, its value includes a **skiptoken** parameter that specifies a starting point to use for subsequent calls.
      x-ms-parameter-location: method
      schema:
        type: string
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: The API version to use for this operation.
      schema:
        type: string
        minLength: 1
    RequestIdInParameters:
      name: id
      in: path
      required: true
      description: Quota request ID.
      x-ms-parameter-location: method
      schema:
        type: string
    TopQueryParameter:
      name: $top
      in: query
      required: false
      description: Number of records to return.
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
        minimum: 1
    ScopeInPath:
      name: scope
      description: The target Azure resource URI. For example, `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/qms-test/providers/Microsoft.Batch/batchAccounts/testAccount/`. This is the target Azure resource URI for the List GET operation. If a `{resourceName}` is added after `/quotas`, then it's the target Azure resource URI in the GET operation for the specific resource.
      in: path
      required: true
      x-ms-parameter-location: method
      x-ms-skip-url-encoding: true
      schema:
        type: string
    SkipTokenParameter_2:
      name: $skiptoken
      in: query
      required: false
      description: Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls
      x-ms-parameter-location: method
      schema:
        type: string
    SubscriptionIdInParameters:
      name: subscriptionId
      x-ms-parameter-location: method
      in: path
      required: true
      description: Azure subscription id.
      schema:
        type: string
    ApiVersionParameter_2:
      name: api-version
      in: query
      required: true
      description: API version.
      schema:
        type: string
    RequestIdInParameters_2:
      name: id
      in: path
      required: true
      description: Quota Request id.
      x-ms-parameter-location: method
      schema:
        type: string
    ProviderIdInParameters:
      name: providerId
      in: path
      required: true
      description: Azure resource provider id.
      x-ms-parameter-location: method
      schema:
        type: string
    LocationIdInParameters:
      name: location
      in: path
      required: true
      description: Azure region.
      x-ms-parameter-location: method
      schema:
        type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: Impersonate your user account.
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth 2.0 authorization
x-refined-from:
- azure-quota-extension-api-openapi-original.yml
- azure-reservation-api-openapi-original.yml
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'