swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector DeviceCapacityCheck API
schemes:
- https
tags:
- name: DeviceCapacityCheck
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/deviceCapacityCheck
  : post:
      tags:
      - DeviceCapacityCheck
      description: Posts the device capacity request info to check feasibility.
      operationId: microsoftAzureDevicecapacitycheckCheckresourcecreationfeasibility
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: deviceCapacityRequestInfo
        in: body
        description: The device capacity request info.
        required: true
        schema:
          $ref: '#/definitions/DeviceCapacityRequestInfo'
      - name: capacityName
        in: query
        description: The capacity name.
        required: false
        type: string
      responses:
        '200':
          description: Successfully checked the feasibility of resource creation.
        '202':
          description: Accepted the request to check the feasibility of resource creation.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        DeviceCapacityRequestPost:
          $ref: ./examples/DeviceCapacityRequestPost.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Devicecapacitycheck
definitions:
  VmPlacementRequestResult:
    description: List of VM sizes being checked for creation on appliance along with corresponding result.
    type: object
    properties:
      vmSize:
        description: List of VM sizes being checked.
        uniqueItems: false
        type: array
        items:
          type: string
      isFeasible:
        description: Boolean value indicating if the VM(s) in VmSize can be created.
        type: boolean
      messageCode:
        description: MessageCode indicating reason for success or failure.
        type: string
      message:
        description: Localized message to be displayed to the user to explain the check result.
        type: string
  DeviceCapacityRequestInfo:
    description: Object for Capturing DeviceCapacityRequestInfo
    required:
    - properties
    type: object
    properties:
      properties:
        $ref: '#/definitions/DeviceCapacityRequestInfoProperties'
        description: The properties of the Device Capacity Request.
        x-ms-client-flatten: 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
  DeviceCapacityRequestInfoProperties:
    description: Properties of Device Capacity Request Info containing VM's to be checked and their corresponding results.
    required:
    - vmPlacementQuery
    type: object
    properties:
      vmPlacementQuery:
        description: Array containing the sizes of the VMs for checking if its feasible to create them on the appliance.
        uniqueItems: false
        type: array
        items:
          uniqueItems: false
          type: array
          items:
            type: string
        x-ms-identifiers: []
      vmPlacementResults:
        description: Array of the VMs of the sizes in VmSizes can be provisioned on the appliance.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/VmPlacementRequestResult'
        x-ms-identifiers: []
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
  resourceGroupNameParameter:
    name: resourceGroupName
    in: path
    description: The resource group name.
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'