swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector AvailabilityUsages API
  description: operations related to availability and usage
schemes:
- https
tags:
- description: operations related to availability and usage
  name: AvailabilityUsages
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/availabilities:
    get:
      description: Returns list of available resources in region
      produces:
      - application/json
      tags:
      - AvailabilityUsages
      summary: Microsoft Azure Implements Skuavailability List Method
      operationId: microsoftAzureSkusavailabilityList
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/regionId'
      - type: string
        description: sku id, if no sku is passed availability for all skus will be returned
        name: skuId
        in: query
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/SkuAvailabilityListResponse'
        default:
          description: General Error
          schema:
            $ref: '#/definitions/CSRPError'
      x-ms-examples:
        ListAvailabilities:
          $ref: ./examples/ListAvailabilities.json
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/usages:
    get:
      description: Returns list of usage in region
      produces:
      - application/json
      tags:
      - AvailabilityUsages
      summary: Microsoft Azure Implements Usages List Method
      operationId: microsoftAzureUsagesList
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/regionId'
      - type: string
        description: The filter to apply on the list operation. only name.value is allowed here as a filter e.g. $filter=name.value eq 'xxxx'
        name: $filter
        in: query
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/UsageListResponse'
        default:
          description: General Error
          schema:
            $ref: '#/definitions/CSRPError'
      x-ms-examples:
        ListUsages:
          $ref: ./examples/ListUsages.json
      x-ms-pageable:
        nextLinkName: nextLink
definitions:
  SkuAvailabilityListResponse:
    description: List of SKU availabilities
    properties:
      nextLink:
        description: Link for next list of DedicatedCloudNode
        type: string
      value:
        description: Results of the DedicatedPlacementGroupSkuAvailability list
        type: array
        items:
          $ref: '#/definitions/SkuAvailability'
        x-ms-identifiers:
        - dedicatedAvailabilityZoneId
        - dedicatedPlacementGroupId
        - skuId
  UsageName:
    description: User name model
    properties:
      localizedValue:
        description: e.g. "Virtual Machines"
        type: string
      value:
        description: resource type or resource type sku name, e.g. virtualMachines
        type: string
  UsageListResponse:
    description: List of usages
    properties:
      nextLink:
        description: Link for next list of DedicatedCloudNode
        type: string
      value:
        description: The list of usages
        type: array
        items:
          $ref: '#/definitions/Usage'
        x-ms-identifiers:
        - /name/value
        readOnly: true
  CSRPError:
    description: General error model
    properties:
      error:
        description: Error's body
        $ref: '#/definitions/CSRPErrorBody'
  Usage:
    description: Usage model
    required:
    - currentValue
    - limit
    properties:
      currentValue:
        description: The current usage value
        type: integer
        default: 0
      limit:
        description: limit of a given sku in a region for a subscription. The maximum permitted value for the usage quota. If there is no limit, this value will be -1
        type: integer
        default: 0
      name:
        description: Usage name value and localized name
        $ref: '#/definitions/UsageName'
      unit:
        description: The usages' unit
        type: string
        enum:
        - Count
        - Bytes
        - Seconds
        - Percent
        - CountPerSecond
        - BytesPerSecond
        x-ms-enum:
          modelAsString: false
          name: UsageCount
  CSRPErrorBody:
    description: Error properties
    properties:
      code:
        description: Error's code
        type: string
        readOnly: true
      details:
        description: Error's details
        type: array
        items:
          $ref: '#/definitions/CSRPErrorBody'
        x-ms-identifiers: []
        readOnly: true
      message:
        description: Error's message
        type: string
        readOnly: true
      target:
        description: Error's target
        type: string
  SkuAvailability:
    description: SKU availability model
    required:
    - limit
    properties:
      dedicatedAvailabilityZoneId:
        description: CloudSimple Availability Zone id
        type: string
      dedicatedAvailabilityZoneName:
        description: CloudSimple Availability Zone Name
        type: string
      dedicatedPlacementGroupId:
        description: CloudSimple Placement Group Id
        type: string
      dedicatedPlacementGroupName:
        description: CloudSimple Placement Group name
        type: string
      limit:
        description: indicates how many resources of a given SKU is available in a AZ->PG
        type: integer
      resourceType:
        description: resource type e.g. DedicatedCloudNodes
        type: string
      skuId:
        description: sku id
        type: string
      skuName:
        description: sku name
        type: string
parameters:
  subscriptionId:
    type: string
    description: The subscription ID.
    name: subscriptionId
    in: path
    required: true
  api-version:
    type: string
    description: Client API version.
    name: api-version
    in: query
    required: true
  regionId:
    type: string
    x-ms-parameter-location: method
    description: The region Id (westus, eastus)
    name: regionId
    in: path
    required: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'