Microsoft Azure
Microsoft Azure BareMetalInfrastructure API

The BareMetalInfrastructure API from Microsoft Azure — 2 operation(s) for baremetalinfrastructure.
Documentation GitHub OpenAPI
OpenAPI Specification

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector BareMetalInfrastructure API
schemes:
- https
tags:
- name: BareMetalInfrastructure
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances:
    get:
      tags:
      - BareMetalInfrastructure
      operationId: microsoftAzureAzurebaremetalinstancesListbysubscription
      summary: Microsoft Azure Gets A List Of Azure Baremetal Instances In The Specified Subscription
      description: Gets a list of AzureBareMetal instances in the specified subscription. The operations returns various properties of each Azure BareMetal instance.
      x-ms-examples:
        List all AzureBareMetal instances in a subscription:
          $ref: ./examples/AzureBareMetalInstances_ListBySubscription.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/AzureBareMetalInstancesListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}
  : get:
      tags:
      - BareMetalInfrastructure
      operationId: microsoftAzureAzurebaremetalinstancesGet
      summary: Microsoft Azure Gets An Azure Baremetal Instance
      description: Gets an Azure BareMetal instance for the specified subscription, resource group, and instance name.
      x-ms-examples:
        Get an AzureBareMetal instance:
          $ref: ./examples/AzureBareMetalInstances_Get.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/AzureBareMetalInstanceNameParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/AzureBareMetalInstance'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
    delete:
      tags:
      - BareMetalInfrastructure
      operationId: microsoftAzureAzurebaremetalinstancesDelete
      x-ms-long-running-operation: true
      summary: Microsoft Azure Deletes A Azure Baremetal Instance
      description: Deletes a Azure BareMetal instance with the specified subscription, resource group, and instance name.
      x-ms-examples:
        Delete an AzureBareMetal instance:
          $ref: ./examples/AzureBareMetalInstances_Delete.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/AzureBareMetalInstanceNameParameter'
      responses:
        '200':
          description: Deleted AzureBareMetalInstance
        '202':
          description: Deleting AzureBareMetalInstance
        '204':
          description: No AzureBareMetalInstance to delete
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
    patch:
      tags:
      - BareMetalInfrastructure
      operationId: microsoftAzureAzurebaremetalinstancesUpdate
      summary: Microsoft Azure Patches The Tags Field Of A Azure Baremetal Instance
      description: Patches the Tags field of a Azure BareMetal instance for the specified subscription, resource group, and instance name.
      x-ms-examples:
        Update Tags field of an AzureBareMetal instance:
          $ref: ./examples/AzureBareMetalInstances_PatchTags.json
        Delete Tags field of an AzureBareMetal instance:
          $ref: ./examples/AzureBareMetalInstances_PatchTags_Delete.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/AzureBareMetalInstanceNameParameter'
      - $ref: '#/parameters/TagsParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/AzureBareMetalInstance'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
definitions:
  OSProfile:
    properties:
      computerName:
        type: string
        description: Specifies the host OS name of the AzureBareMetal instance.
      osType:
        readOnly: true
        type: string
        description: This property allows you to specify the type of the OS.
      version:
        readOnly: true
        type: string
        description: Specifies version of operating system.
      sshPublicKey:
        type: string
        description: Specifies the SSH public key used to access the operating system.
    description: Specifies the operating system settings for the AzureBareMetal instance.
  ErrorResponse:
    description: Error response.
    properties:
      error:
        $ref: '#/definitions/ErrorDefinition'
        description: The error details.
  ErrorDefinition:
    description: Error definition.
    properties:
      code:
        description: Service specific error code which serves as the substatus for the HTTP error code.
        type: string
        readOnly: true
      message:
        description: Description of the error.
        type: string
        readOnly: true
      details:
        description: Internal error details.
        type: array
        items:
          $ref: '#/definitions/ErrorDefinition'
        x-ms-identifiers: []
        readOnly: true
  Tags:
    type: object
    properties:
      tags:
        type: object
        additionalProperties:
          type: string
        description: Tags field of the AzureBareMetal instance.
    description: Tags field of the AzureBareMetal instance.
  NetworkProfile:
    properties:
      networkInterfaces:
        type: array
        items:
          $ref: '#/definitions/IpAddress'
        x-ms-identifiers:
        - ipAddress
        description: Specifies the network interfaces for the AzureBareMetal instance.
      circuitId:
        readOnly: true
        type: string
        description: Specifies the circuit id for connecting to express route.
    description: Specifies the network settings for the AzureBareMetal instance disks.
  AzureBareMetalInstancesListResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/AzureBareMetalInstance'
        description: The list of Azure BareMetal instances.
      nextLink:
        type: string
        description: The URL to get the next set of AzureBareMetal instances.
    description: The response from the List AzureBareMetal Instances operation.
  IpAddress:
    properties:
      ipAddress:
        type: string
        description: Specifies the IP address of the network interface.
    description: Specifies the IP address of the network interface.
  HardwareProfile:
    properties:
      hardwareType:
        readOnly: true
        type: string
        enum:
        - Cisco_UCS
        - HPE
        x-ms-enum:
          name: AzureBareMetalHardwareTypeNamesEnum
          modelAsString: true
        description: Name of the hardware type (vendor and/or their product name)
      azureBareMetalInstanceSize:
        readOnly: true
        type: string
        enum:
        - S72m
        - S144m
        - S72
        - S144
        - S192
        - S192m
        - S192xm
        - S96
        - S112
        - S224
        - S224m
        - S224om
        - S224oo
        - S224oom
        - S224ooo
        - S384
        - S384m
        - S384xm
        - S384xxm
        - S448
        - S448m
        - S448om
        - S448oo
        - S448oom
        - S448ooo
        - S576m
        - S576xm
        - S672
        - S672m
        - S672om
        - S672oo
        - S672oom
        - S672ooo
        - S768
        - S768m
        - S768xm
        - S896
        - S896m
        - S896om
        - S896oo
        - S896oom
        - S896ooo
        - S960m
        x-ms-enum:
          name: azureBareMetalInstanceSizeNamesEnum
          modelAsString: true
        description: Specifies the AzureBareMetal instance SKU.
    description: Specifies the hardware settings for the AzureBareMetal instance.
  StorageProfile:
    properties:
      nfsIpAddress:
        readOnly: true
        type: string
        description: IP Address to connect to storage.
      osDisks:
        type: array
        items:
          $ref: '#/definitions/Disk'
        x-ms-identifiers:
        - name
        description: Specifies information about the operating system disk used by baremetal instance.
    description: Specifies the storage settings for the AzureBareMetal instance disks.
  Disk:
    properties:
      name:
        type: string
        description: The disk name.
      diskSizeGB:
        type: integer
        format: int32
        description: Specifies the size of an empty data disk in gigabytes.
      lun:
        readOnly: true
        type: integer
        format: int32
        description: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
    description: Specifies the disk information fo the AzureBareMetal instance
  AzureBareMetalInstanceProperties:
    properties:
      hardwareProfile:
        $ref: '#/definitions/HardwareProfile'
        description: Specifies the hardware settings for the AzureBareMetal instance.
      storageProfile:
        $ref: '#/definitions/StorageProfile'
        description: Specifies the storage settings for the AzureBareMetal instance disks.
      osProfile:
        $ref: '#/definitions/OSProfile'
        description: Specifies the operating system settings for the AzureBareMetal instance.
      networkProfile:
        $ref: '#/definitions/NetworkProfile'
        description: Specifies the network settings for the AzureBareMetal instance.
      azureBareMetalInstanceId:
        readOnly: true
        type: string
        description: Specifies the AzureBareMetal instance unique ID.
      powerState:
        readOnly: true
        type: string
        enum:
        - starting
        - started
        - stopping
        - stopped
        - restarting
        - unknown
        x-ms-enum:
          name: AzureBareMetalInstancePowerStateEnum
          modelAsString: true
        description: Resource power state
      proximityPlacementGroup:
        readOnly: true
        type: string
        description: Resource proximity placement group
      hwRevision:
        readOnly: true
        type: string
        description: Hardware revision of an AzureBareMetal instance
      partnerNodeId:
        type: string
        description: ARM ID of another AzureBareMetalInstance that will share a network with this AzureBareMetalInstance
      provisioningState:
        readOnly: true
        type: string
        enum:
        - Accepted
        - Creating
        - Updating
        - Failed
        - Succeeded
        - Deleting
        - Migrating
        x-ms-enum:
          name: AzureBareMetalProvisioningStatesEnum
          modelAsString: true
        description: State of provisioning of the AzureBareMetalInstance
    description: Describes the properties of an AzureBareMetal instance.
  AzureBareMetalInstance:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/AzureBareMetalInstanceProperties'
        description: AzureBareMetal instance properties
    allOf:
    - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource
    description: AzureBareMetal instance info on Azure (ARM properties and AzureBareMetal properties)
parameters:
  AzureBareMetalInstanceNameParameter:
    name: azureBareMetalInstanceName
    in: path
    required: true
    type: string
    description: Name of the Azure BareMetal on Azure instance.
    x-ms-parameter-location: method
  TagsParameter:
    name: tagsParameter
    in: body
    required: true
    schema:
      $ref: '#/definitions/Tags'
    description: Request body that only contains the new Tags field
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'
Microsoft Azure BareMetalInfrastructure API

Documentation

Specifications

Other Resources

OpenAPI Specification
