Microsoft Azure Skus API

openapi: 3.2.0
info:
  title: Microsoft Azure Skus API
  version: '1.0'
  description: 'Operations tagged Skus across 4 of this provider''s published API definitions: azure-ml-commitment-plans-management-client-openapi-original.yml, devcenterclient-openapi-original.yml, engagementfabric-openapi-original.yml, storage-cache-mgmt-client-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
- url: https://management.azure.com/
tags:
- name: Skus
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearning/skus:
    get:
      tags:
      - Skus
      operationId: microsoftAzureSkusList
      description: Lists the available commitment plan SKUs.
      x-ms-pageable:
        nextLinkName: null
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/APIVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SkuListResult'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft…
    servers:
    - url: https://management.azure.com
  /subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/skus:
    parameters:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
    - $ref: commonDefinitions.json#/parameters/SubscriptionIdParameter
    - $ref: commonDefinitions.json#/parameters/TopParameter
    get:
      tags:
      - Skus
      description: Lists the Microsoft.DevCenter SKUs available in a subscription
      operationId: microsoftAzureSkusListbysubscription
      responses:
        '200':
          description: OK. The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SkuListResult_2'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: commonDefinitions.json#/definitions/CloudError
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Skus_ListBySubscription:
          $ref: ./examples/Skus_ListBySubscription.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Devcenter…
      security:
      - azure_auth:
        - user_impersonation
    servers:
    - url: https://management.azure.com
  /subscriptions/{subscriptionId}/providers/Microsoft.EngagementFabric/skus:
    get:
      tags:
      - Skus
      summary: Microsoft Azure List Available Skus Of Engagementfabric Resource
      operationId: getSubscriptionsBySubscriptionIdProvidersMicrosoftEngagementFabricSkus
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter_2'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SkuDescriptionList'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-examples:
        SKUsListExample:
          $ref: ./examples/SKUsListExample.json
      x-ms-pageable:
        nextLinkName: null
      description: Needs a more full description created.
      x-operation-id-source: normalized
      x-operation-id-original: microsoftAzureSkusList
    servers:
    - url: https://management.azure.com
  /subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/skus:
    get:
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: A list of SKU descriptors.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceSkusResult'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError_2'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Skus_List:
          $ref: ./examples/Skus_List.json
      tags:
      - Skus
      description: Get the list of StorageCache.Cache SKUs available to this subscription.
      operationId: getSubscriptionsBySubscriptionIdProvidersMicrosoftStorageCacheSkus
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft…
      security:
      - azure_auth:
        - user_impersonation
      x-operation-id-source: normalized
      x-operation-id-original: microsoftAzureSkusList
    servers:
    - url: https://management.azure.com/
components:
  schemas:
    SkuCapability:
      type: object
      description: Describes The SKU capabilities object.
      properties:
        name:
          type: string
          readOnly: true
          description: The capability name.
        value:
          type: string
          readOnly: true
          description: The capability value.
    SkuRestrictions:
      properties:
        type:
          type: string
          readOnly: true
          description: The type of restrictions.
          enum:
          - location
          - zone
          x-ms-enum:
            name: ResourceSkuRestrictionsType
            modelAsString: true
        values:
          type: array
          readOnly: true
          items:
            type: string
          description: The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted.
        reasonCode:
          type: string
          readOnly: true
          description: The reason for restriction.
          enum:
          - QuotaId
          - NotAvailableForSubscription
          x-ms-enum:
            name: ResourceSkuRestrictionsReasonCode
            modelAsString: true
      description: Describes restrictions which would prevent a SKU from being used.
    SkuListResult:
      type: object
      description: The list of commitment plan SKUs.
      properties:
        value:
          readOnly: true
          type: array
          items:
            $ref: '#/components/schemas/CatalogSku'
          x-ms-identifiers: []
    SkuCost:
      type: object
      description: Describes metadata for SKU cost info.
      properties:
        meterID:
          type: string
          readOnly: true
          description: The meter used for this part of a SKU's cost.
        quantity:
          type: integer
          readOnly: true
          format: int64
          description: The multiplier for the meter ID.
        extendedUnit:
          type: string
          readOnly: true
          description: The overall duration represented by the quantity.
    SkuCapacity:
      type: object
      description: Describes scaling information of a SKU.
      properties:
        minimum:
          type: integer
          readOnly: true
          format: int64
          description: The minimum capacity.
        maximum:
          type: integer
          readOnly: true
          format: int64
          description: The maximum capacity that can be set.
        default:
          type: integer
          readOnly: true
          format: int64
          description: The default capacity.
        scaleType:
          type: string
          readOnly: true
          description: The scale type applicable to the sku.
          enum:
          - Automatic
          - Manual
          - None
          x-ms-enum:
            name: SkuCapacityScaleType
            modelAsString: true
    CatalogSku:
      type: object
      description: Details of a commitment plan SKU.
      properties:
        resourceType:
          readOnly: true
          type: string
          description: Resource type name
        name:
          readOnly: true
          type: string
          description: SKU name
        tier:
          readOnly: true
          type: string
          description: SKU tier
        locations:
          readOnly: true
          type: array
          items:
            type: string
          description: Regions where the SKU is available.
        capacity:
          readOnly: true
          description: SKU scaling information
          $ref: '#/components/schemas/SkuCapacity'
        capabilities:
          readOnly: true
          type: array
          items:
            $ref: '#/components/schemas/SkuCapability'
          x-ms-identifiers:
          - name
          description: The capability information for the specified SKU.
        costs:
          readOnly: true
          type: array
          items:
            $ref: '#/components/schemas/SkuCost'
          x-ms-identifiers: []
          description: The cost information for the specified SKU.
        restrictions:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/SkuRestrictions'
          x-ms-identifiers: []
          description: Restrictions which would prevent a SKU from being used. This is empty if there are no restrictions.
    SkuListResult_2:
      description: Results of the Microsoft.DevCenter SKU list operation.
      type: object
      properties:
        value:
          description: Current page of results.
          type: array
          items:
            $ref: commonDefinitions.json#/definitions/DevCenterSku
          x-ms-identifiers: []
          readOnly: true
        nextLink:
          description: URL to get the next set of results if there are any.
          type: string
          readOnly: true
    CloudError:
      description: The default error response
      type: object
      properties:
        error:
          $ref: '#/components/schemas/CloudErrorBody'
          description: Content of the error
      x-ms-external: true
    CloudErrorBody:
      description: Content of the default error response
      type: object
      properties:
        code:
          description: The error code
          type: string
        message:
          description: The error message
          type: string
        target:
          description: The target of the particular error
          type: string
        details:
          description: The list of additional details
          type: array
          items:
            $ref: '#/components/schemas/CloudErrorBody'
      x-ms-external: true
    SkuDescription:
      description: The EngagementFabric SKU description of given resource type
      type: object
      properties:
        resourceType:
          description: The fully qualified resource type
          type: string
          readOnly: true
        name:
          description: The name of the SKU
          type: string
          readOnly: true
        tier:
          description: The price tier of the SKU
          type: string
          readOnly: true
        locations:
          description: The set of locations that the SKU is available
          type: array
          items:
            type: string
          readOnly: true
        locationInfo:
          description: Locations and zones
          type: array
          items:
            $ref: '#/components/schemas/SkuLocationInfoItem'
          readOnly: true
        restrictions:
          description: The restrictions because of which SKU cannot be used
          type: array
          items:
            type: object
          readOnly: true
    SkuDescriptionList:
      description: The list of the EngagementFabric SKU descriptions
      type: object
      properties:
        value:
          description: SKU descriptions
          type: array
          items:
            $ref: '#/components/schemas/SkuDescription'
          readOnly: true
    SkuLocationInfoItem:
      description: The Locations and zones info for SKU
      type: object
      properties:
        location:
          description: The available location of the SKU
          type: string
        zones:
          description: The available zone of the SKU
          type: array
          items:
            type: string
    ResourceSkusResult:
      type: object
      description: The response from the List Cache SKUs operation.
      properties:
        nextLink:
          description: The URI to fetch the next page of cache SKUs.
          type: string
        value:
          description: The list of SKUs available for the subscription.
          readOnly: true
          items:
            $ref: '#/components/schemas/ResourceSku'
          type: array
          x-ms-identifiers: []
    Restriction:
      type: object
      properties:
        type:
          readOnly: true
          type: string
          description: The type of restrictions. In this version, the only possible value for this is location.
        values:
          readOnly: true
          type: array
          items:
            type: string
          description: The value of restrictions. If the restriction type is set to location, then this would be the different locations where the SKU is restricted.
        reasonCode:
          type: string
          enum:
          - QuotaId
          - NotAvailableForSubscription
          x-ms-enum:
            name: ReasonCode
            modelAsString: true
          description: The reason for the restriction. As of now this can be "QuotaId" or "NotAvailableForSubscription". "QuotaId" is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. "NotAvailableForSubscription" is related to capacity at the datacenter.
      description: The restrictions preventing this SKU from being used.
    CloudError_2:
      x-ms-external: true
      description: An error response.
      properties:
        error:
          description: The body of the error.
          $ref: '#/components/schemas/CloudErrorBody_2'
      type: object
    CloudErrorBody_2:
      description: An error response.
      properties:
        code:
          description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
          type: string
        details:
          description: A list of additional details about the error.
          items:
            $ref: '#/components/schemas/CloudErrorBody_2'
          type: array
          x-ms-identifiers: []
        message:
          description: A message describing the error, intended to be suitable for display in a user interface.
          type: string
        target:
          description: The target of the particular error. For example, the name of the property in error.
          type: string
      type: object
    ResourceSku:
      description: A resource SKU.
      properties:
        resourceType:
          readOnly: true
          type: string
          description: The type of resource the SKU applies to.
        capabilities:
          description: A list of capabilities of this SKU, such as throughput or ops/sec.
          items:
            $ref: '#/components/schemas/ResourceSkuCapabilities'
          type: array
          x-ms-identifiers:
          - name
        locations:
          readOnly: true
          type: array
          items:
            type: string
          description: The set of locations where the SKU is available. This is the supported and registered Azure Geo Regions (e.g., West US, East US, Southeast Asia, etc.).
        locationInfo:
          description: The set of locations where the SKU is available.
          items:
            $ref: '#/components/schemas/ResourceSkuLocationInfo'
          type: array
          x-ms-identifiers: []
        name:
          description: The name of this SKU.
          type: string
        restrictions:
          type: array
          items:
            $ref: '#/components/schemas/Restriction'
          description: The restrictions preventing this SKU from being used. This is empty if there are no restrictions.
          x-ms-identifiers: []
      type: object
    ResourceSkuCapabilities:
      description: A resource SKU capability.
      properties:
        name:
          description: Name of a capability, such as ops/sec.
          type: string
        value:
          description: Quantity, if the capability is measured by quantity.
          type: string
      type: object
    ResourceSkuLocationInfo:
      description: Resource SKU location information.
      properties:
        location:
          description: Location where this SKU is available.
          type: string
        zones:
          description: Zones if any.
          type: array
          items:
            type: string
      type: object
  parameters:
    APIVersionParameter:
      name: api-version
      description: The version of the Microsoft.MachineLearning resource provider API to use.
      in: query
      required: true
      schema:
        type: string
    SubscriptionIdParameter:
      name: subscriptionId
      description: Azure Subscription ID.
      in: path
      required: true
      schema:
        type: string
    ApiVersionParameter:
      name: api-version
      in: query
      description: API version
      required: true
      schema:
        type: string
    SubscriptionIdParameter_2:
      name: subscriptionId
      in: path
      description: Subscription ID
      required: true
      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 OAuth2 Flow
x-refined-from:
- azure-ml-commitment-plans-management-client-openapi-original.yml
- devcenterclient-openapi-original.yml
- engagementfabric-openapi-original.yml
- storage-cache-mgmt-client-openapi-original.yml
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'