swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector AvailableSkus API
schemes:
- https
tags:
- name: AvailableSkus
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/availableSkus:
    get:
      tags:
      - AvailableSkus
      summary: Microsoft Azure List All The Available Skus And Information Related To Them
      operationId: microsoftAzureAvailableskusList
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Lists the available Skus and information related to them.
          schema:
            $ref: '#/definitions/DataBoxEdgeSkuList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        AvailableSkus:
          $ref: ./examples/AvailableSkusList.json
      description: Needs a more full description created.
definitions:
  SkuLocationInfo:
    description: The location info.
    type: object
    properties:
      location:
        description: The location.
        type: string
        readOnly: true
      zones:
        description: The zones.
        uniqueItems: false
        type: array
        items:
          type: string
        readOnly: true
        x-ms-identifiers: []
      sites:
        description: The sites.
        uniqueItems: false
        type: array
        items:
          type: string
        readOnly: true
        x-ms-identifiers: []
  DataBoxEdgeSku:
    description: The Sku information.
    type: object
    properties:
      resourceType:
        description: The type of the resource.
        type: string
        readOnly: true
      name:
        description: The Sku name.
        enum:
        - Gateway
        - Edge
        - TEA_1Node
        - TEA_1Node_UPS
        - TEA_1Node_Heater
        - TEA_1Node_UPS_Heater
        - TEA_4Node_Heater
        - TEA_4Node_UPS_Heater
        - TMA
        - TDC
        - TCA_Small
        - GPU
        - TCA_Large
        - EdgeP_Base
        - EdgeP_High
        - EdgePR_Base
        - EdgePR_Base_UPS
        - EP2_64_1VPU_W
        - EP2_128_1T4_Mx1_W
        - EP2_256_2T4_W
        - EdgeMR_Mini
        - RCA_Small
        - RCA_Large
        - RDC
        - Management
        - EP2_64_Mx1_W
        - EP2_128_GPU1_Mx1_W
        - EP2_256_GPU2_Mx1
        - EdgeMR_TCP
        type: string
        readOnly: true
        x-ms-enum:
          name: SkuName
          modelAsString: true
      kind:
        description: The Sku kind.
        type: string
        readOnly: true
      tier:
        description: The Sku tier.
        enum:
        - Standard
        type: string
        readOnly: true
        x-ms-enum:
          name: SkuTier
          modelAsString: true
      size:
        description: The Sku kind.
        type: string
        readOnly: true
      family:
        description: The Sku family.
        type: string
        readOnly: true
      locations:
        description: Availability of the Sku for the region.
        uniqueItems: false
        type: array
        items:
          type: string
        readOnly: true
        x-ms-identifiers: []
      apiVersions:
        description: The API versions in which Sku is available.
        uniqueItems: false
        type: array
        items:
          type: string
        readOnly: true
        x-ms-identifiers: []
      locationInfo:
        description: Availability of the Sku for the location/zone/site.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/SkuLocationInfo'
        x-ms-identifiers:
        - location
        readOnly: true
      costs:
        description: The pricing info of the Sku.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/SkuCost'
        x-ms-identifiers:
        - meterId
        readOnly: true
      signupOption:
        description: Sku can be signed up by customer or not.
        enum:
        - None
        - Available
        type: string
        readOnly: true
        x-ms-enum:
          name: SkuSignupOption
          modelAsString: true
      version:
        description: Availability of the Sku as preview/stable.
        enum:
        - Stable
        - Preview
        type: string
        readOnly: true
        x-ms-enum:
          name: SkuVersion
          modelAsString: true
      availability:
        description: Links to the next set of results
        enum:
        - Available
        - Unavailable
        type: string
        readOnly: true
        x-ms-enum:
          name: SkuAvailability
          modelAsString: true
      shipmentTypes:
        description: List of Shipment Types supported by this SKU
        uniqueItems: false
        type: array
        items:
          enum:
          - NotApplicable
          - ShippedToCustomer
          - SelfPickup
          type: string
          x-ms-enum:
            name: ShipmentType
            modelAsString: true
        readOnly: true
        x-ms-identifiers: []
      capabilities:
        description: The capability info of the SKU.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/SkuCapability'
        x-ms-identifiers:
        - name
        readOnly: true
  DataBoxEdgeSkuList:
    description: List of SKU Information objects.
    type: object
    properties:
      value:
        description: List of ResourceType Sku
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/DataBoxEdgeSku'
        x-ms-identifiers:
        - name
        - resourceType
        readOnly: true
      nextLink:
        description: Links to the next set of results
        type: string
        readOnly: true
  SkuCost:
    description: The metadata for retrieving price info.
    type: object
    properties:
      meterId:
        description: Used for querying price from commerce.
        type: string
        readOnly: true
      quantity:
        format: int64
        description: The cost quantity.
        type: integer
        readOnly: true
      extendedUnit:
        description: The extended unit.
        type: string
        readOnly: true
  CloudError:
    description: An error response from the service.
    type: object
    properties:
      error:
        $ref: '#/definitions/CloudErrorBody'
        description: The error details.
    x-ms-external: true
  CloudErrorBody:
    description: An error response from the service.
    type: object
    properties:
      code:
        description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
        type: string
      message:
        description: A message describing the error, intended to be suitable for display in a user interface.
        type: string
      details:
        description: A list of additional details about the error.
        type: array
        items:
          $ref: '#/definitions/CloudErrorBody'
        x-ms-identifiers: []
    x-ms-external: true
  SkuCapability:
    description: The metadata to describe the capability.
    type: object
    properties:
      name:
        description: An invariant to describe the feature.
        type: string
        readOnly: true
      value:
        description: An invariant if the feature is measured by quantity.
        type: string
        readOnly: true
parameters:
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: The subscription ID.
    required: true
    type: string
  apiVersionParameter:
    name: api-version
    in: query
    description: The API version.
    required: true
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'