swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector DeviceCapacityInfo API
schemes:
- https
tags:
- name: DeviceCapacityInfo
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/deviceCapacityInfo/default
  : get:
      tags:
      - DeviceCapacityInfo
      description: Gets the properties of the specified device capacity info.
      operationId: microsoftAzureDevicecapacityinfoGetdevicecapacityinfo
      parameters:
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      responses:
        '200':
          description: The device capacity info result.
          schema:
            $ref: '#/definitions/DeviceCapacityInfo'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        DeviceCapacityGet:
          $ref: ./examples/DeviceCapacityGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Devicecapacityinfo Default
definitions:
  ClusterStorageViewData:
    description: Cluster Storage Data.
    type: object
    properties:
      clusterTotalStorageMb:
        format: double
        description: Total storage on the cluster in MB.
        type: number
      clusterFreeStorageMb:
        format: double
        description: The available or free storage on the cluster in MB.
        type: number
  VmMemory:
    description: VmMemory Data.
    type: object
    properties:
      startupMemoryMB:
        format: int64
        description: The total amount of RAM in the virtual machine, as seen by the guest  operating system. For a virtual machine with dynamic memory enabled, this represents the initial memory available at startup.
        type: integer
      currentMemoryUsageMB:
        format: int64
        description: The current memory used by the virtual machine.
        type: integer
  ARMBaseModel:
    description: Represents the base class for all object models.
    type: object
    properties:
      id:
        description: The path ID that uniquely identifies the object.
        type: string
        readOnly: true
      name:
        description: The object name.
        type: string
        readOnly: true
      type:
        description: The hierarchical type of the object.
        type: string
        readOnly: true
    x-ms-azure-resource: true
  CloudError:
    description: An error response from the service.
    type: object
    properties:
      error:
        $ref: '#/definitions/CloudErrorBody'
        description: The error details.
    x-ms-external: true
  HostCapacity:
    description: Host Capacity Data.
    type: object
    properties:
      hostName:
        description: The name of the host.
        type: string
      effectiveAvailableMemoryMbOnHost:
        format: int64
        description: The available memory on the host accounting for VM placement size and any host VM reservations.
        type: integer
      availableGpuCount:
        format: int32
        description: The available amount of GPUs on the host to use after accounting for GPUS used by reservations on the host.
        type: integer
      vmUsedMemory:
        description: The VM used memory per VmId.
        type: object
        additionalProperties:
          $ref: '#/definitions/VmMemory'
      gpuType:
        description: The GPU type of the VM.
        type: string
      numaNodesData:
        description: The numa nodes information for Hpn VMs.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/NumaNodeData'
        x-ms-identifiers: []
  DeviceCapacityInfo:
    description: Object for Capturing DeviceCapacityInfo
    type: object
    allOf:
    - $ref: '#/definitions/ARMBaseModel'
    properties:
      properties:
        $ref: '#/definitions/DeviceCapacityInfoProperties'
        description: The device capacity properties.
        x-ms-client-flatten: true
      systemData:
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
        description: Metadata pertaining to device capacity info.
        readOnly: true
  NumaNodeData:
    description: NUMA node data.
    type: object
    properties:
      numaNodeIndex:
        format: int32
        description: The NUMA node index.
        type: integer
      totalMemoryInMb:
        format: int64
        description: The total memory on the NUMA node.
        type: integer
      logicalCoreCountPerCore:
        format: int32
        description: The logical cores per core count.
        type: integer
      effectiveAvailableMemoryInMb:
        format: int64
        description: The effective available memory on the NUMA node in MB.
        type: integer
      freeVCpuIndexesForHpn:
        description: The free VCPU indices for the Hpn VMs.
        uniqueItems: false
        type: array
        items:
          format: int32
          type: integer
      vCpuIndexesForHpn:
        description: The VCPU indices for Hpn VMs
        uniqueItems: false
        type: array
        items:
          format: int32
          type: integer
      vCpuIndexesForRoot:
        description: The VCPU indices for the root.
        uniqueItems: false
        type: array
        items:
          format: int32
          type: integer
  DeviceCapacityInfoProperties:
    description: The properties of Device Capacity Info
    type: object
    properties:
      timeStamp:
        format: date-time
        description: Timestamp of request in UTC
        type: string
      clusterStorageCapacityInfo:
        $ref: '#/definitions/ClusterStorageViewData'
        description: Cluster capacity data for storage resources (CSV).
      clusterComputeCapacityInfo:
        $ref: '#/definitions/ClusterCapacityViewData'
        description: Cluster capacity data for compute resources (Memory and GPU).
      nodeCapacityInfos:
        description: The dictionary of individual node names and node capacities in the cluster.
        type: object
        additionalProperties:
          $ref: '#/definitions/HostCapacity'
  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
  ClusterMemoryCapacity:
    description: NodeCapacityInfo defines the required information to determine the placement of a VM.
    type: object
    properties:
      clusterFreeMemoryMb:
        format: double
        description: The free memory in the cluster in MB.
        type: number
      clusterUsedMemoryMb:
        format: double
        description: The used memory in the cluster in MB.
        type: number
      clusterFailoverMemoryMb:
        format: double
        description: The failover memory in the cluster in MB.
        type: number
      clusterFragmentationMemoryMb:
        format: double
        description: The fragmentation memory in the cluster in MB.
        type: number
      clusterHypervReserveMemoryMb:
        format: double
        description: The memory reserved for Hyper-V in the cluster in MB.
        type: number
      clusterInfraVmMemoryMb:
        format: double
        description: The memory of the Infra VM in the cluster in MB.
        type: number
      clusterTotalMemoryMb:
        format: double
        description: The total memory in the cluster in MB.
        type: number
      clusterNonFailoverVmMb:
        format: double
        description: The non-failover memory in the cluster in MB.
        type: number
      clusterMemoryUsedByVmsMb:
        format: double
        description: The memory used by VMs in the cluster in MB.
        type: number
  ClusterGpuCapacity:
    description: Cluster GPU Data.
    type: object
    properties:
      gpuType:
        description: The cluster GPU Type.
        type: string
      gpuUsedUnitsCount:
        format: int32
        description: The used GPU units count in the cluster.
        type: integer
      gpuFreeUnitsCount:
        format: int32
        description: The free GPU units count in the cluster.
        type: integer
      gpuReservedForFailoverUnitsCount:
        format: int32
        description: The GPU units count reserved for failover in the cluster.
        type: integer
      gpuTotalUnitsCount:
        format: int32
        description: The total GPU units count in the cluster.
        type: integer
  ClusterCapacityViewData:
    description: Cluster Compute Data.
    type: object
    properties:
      fqdn:
        description: The FQDN of the cluster.
        type: string
      gpuCapacity:
        $ref: '#/definitions/ClusterGpuCapacity'
        description: The cluster's GPU capacity.
      memoryCapacity:
        $ref: '#/definitions/ClusterMemoryCapacity'
        description: The cluster's memory capacity.
      lastRefreshedTime:
        format: date-time
        description: The last time at which the ClusterCapacityViewData was set.
        type: string
      totalProvisionedNonHpnCores:
        format: int64
        description: 'The total # of vCPUs provisioned by non-HPN VM per appliance.'
        type: integer
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'