swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Instance API
schemes:
- https
tags:
- name: Instance
paths:
  /instance:
    get:
      operationId: microsoftAzureInstancesGetmetadata
      description: Get Instance Metadata for the Virtual Machine.
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/MetadataParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Instance'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Get Instance Metadata for the VM:
          $ref: ./examples/GetInstanceMetadata.json
      summary: Microsoft Azure Get Instance
      tags:
      - Instance
definitions:
  DiffDiskSettings:
    type: object
    description: This is the ephemeral disk settings.
    properties:
      option:
        type: string
        description: This specifies the ephemeral disk settings.
  PublicKeysProperties:
    type: object
    description: This contains the data about the public key.
    properties:
      path:
        type: string
        description: This specifies the full path on the VM where the SSH public key is stored.
      keyData:
        type: string
        description: This is the SSH public key certificate used to authenticate with the VM.
  Compute:
    type: object
    properties:
      azEnvironment:
        type: string
        description: This is the name of the environment in which the VM is running.
      isHostCompatibilityLayerVm:
        type: string
        description: Identifies if the VM runs on the Host Compatibility Layer.
      licenseType:
        type: string
        description: Type of license for Azure Hybrid Benefit. Note that this is only present for AHB-enabled VMs.
      location:
        type: string
        description: This is the Azure Region in which the VM is running.
      name:
        type: string
        description: This is the name of the VM.
      offer:
        type: string
        description: This is the offer information for the VM image. This value is only present for images deployed from the Azure Image Gallery.
      osProfile:
        type: object
        description: This contains the data about the OS.
        $ref: '#/definitions/OsProfile'
      osType:
        type: string
        description: This value indicates the type of OS the VM is running, either Linux or Windows.
      placementGroupId:
        type: string
        description: This is the placement group of your Virtual Machine Scale Set.
      plan:
        type: object
        description: This contains the data about the plan.
        $ref: '#/definitions/PlanProperties'
      publicKeys:
        type: array
        items:
          $ref: '#/definitions/PublicKeysProperties'
        description: This is information about the SSH certificate
      platformFaultDomain:
        type: string
        description: This is the fault domain in which the VM.
      platformUpdateDomain:
        type: string
        description: This is the update domain in which the VM.
      provider:
        type: string
        description: This is the provider of the VM.
      publisher:
        type: string
        description: This is the publisher of the VM image.
      resourceGroupName:
        type: string
        description: This is the resource group for the VM.
      resourceId:
        type: string
        description: This is the fully qualified ID for the VM.
      securityProfile:
        description: This contains the data about the security profile associated with the VM.
        $ref: '#/definitions/SecurityProfile'
      sku:
        type: string
        description: This is the specific SKU for the VM image.
      storageProfile:
        type: object
        description: This contains the data about the storage disks associated with the VM.
        $ref: '#/definitions/StorageProfile'
      subscriptionId:
        type: string
        description: This is the Azure subscription for the VM.
      tags:
        type: string
        description: This is the list of tags for your VM.
      tagsList:
        type: array
        items:
          $ref: '#/definitions/TagsProperties'
        description: This is the list of tags for your VM formatted as a JSON array for easier programmatic parsing.
      version:
        type: string
        description: This is the version of the VM image.
      vmId:
        type: string
        description: This is the unique identifier for the VM.
      vmScaleSetName:
        type: string
        description: This is the resource name of the VMSS.
      vmSize:
        type: string
        description: This is the size of the VM.
      zone:
        type: string
        description: This is the availability zone of the VM.
    description: Compute Metadata
  ManagedDisk:
    type: object
    description: This is managed disk parameters.
    properties:
      id:
        type: string
        description: This is the resource ID.
      storageAccountType:
        type: string
        description: This is the storage account type for the managed disk.
  NetworkInterface:
    type: object
    description: This contains data about the network interface.
    properties:
      ipv4:
        type: object
        description: This contains the IPv4 address.
        properties:
          ipAddress:
            type: array
            description: This is the IP address
            items:
              type: object
              description: This contains the IPv4 properties.
              $ref: '#/definitions/Ipv4Properties'
          subnet:
            type: array
            description: This is the subnet
            items:
              type: object
              description: This contains the subnet properties.
              $ref: '#/definitions/SubnetProperties'
      ipv6:
        type: object
        description: This contains the IPv6 address.
        properties:
          ipAddress:
            type: array
            description: This is the IP address
            items:
              type: object
              description: This contains the IPv6 properties.
              $ref: '#/definitions/Ipv6Properties'
      macAddress:
        type: string
        description: This is the MAC address of the interface.
  DiskImage:
    type: object
    description: This is the source user image virtual hard disk.
    properties:
      uri:
        type: string
        description: This is the uri of the virtual hard disk.
  Instance:
    type: object
    description: This is the response from the Instance_GetMetadata operation.
    properties:
      compute:
        $ref: '#/definitions/Compute'
        description: Compute Metadata
      network:
        $ref: '#/definitions/Network'
        description: Network Metadata
  ImageReference:
    type: object
    description: This contains information about the OS image.
    properties:
      id:
        type: string
        description: This is the resource ID.
      offer:
        type: string
        description: This is the offer of the platform or marketplace image.
      publisher:
        type: string
        description: This is the image publisher.
      sku:
        type: string
        description: This is the image SKU.
      version:
        type: string
        description: This is the version of the platform or marketplace image.
  StorageProfile:
    type: object
    description: This contains the data about the storage disks associated with the VM.
    properties:
      imageReference:
        type: object
        $ref: '#/definitions/ImageReference'
        description: Image information
      osDisk:
        type: object
        $ref: '#/definitions/OsDisk'
        description: OS disk information
      dataDisks:
        type: array
        description: Data disk information
        items:
          type: object
          description: This contains information about the data disk.
          $ref: '#/definitions/DataDisk'
  DataDisk:
    type: object
    description: This contains information about the data disk.
    properties:
      caching:
        type: string
        description: This is the caching requirements.
      createOption:
        type: string
        description: This is information about how the VM was created.
      diskSizeGB:
        type: string
        description: This is the size of the disk in GB.
      image:
        type: object
        description: This is the source user image virtual hard disk.
        $ref: '#/definitions/DiskImage'
      lun:
        type: string
        description: This is the logical unit number of the disk.
      managedDisk:
        type: object
        description: This is managed disk parameters.
        $ref: '#/definitions/ManagedDisk'
      name:
        type: string
        description: This is the disk name.
      vhd:
        type: object
        description: This is the virtual hard disk.
        $ref: '#/definitions/VirtualHardDisk'
      writeAcceleratorEnabled:
        type: string
        description: This specifies whether or not writeAccelerator is enabled on the disk.
  Ipv6Properties:
    type: object
    description: This contains the IPv6 properties.
    properties:
      privateIpAddress:
        type: string
        description: This is the private IPv6 address assigned to the interface.
  OsDisk:
    type: object
    description: This contains information about the OS disk used by the VM.
    properties:
      caching:
        type: string
        description: This is the caching requirements.
      createOption:
        type: string
        description: This is information about how the VM was created.
      diffDiskSettings:
        type: object
        description: This is the ephemeral disk settings.
        $ref: '#/definitions/DiffDiskSettings'
      diskSizeGB:
        type: string
        description: This is the size of the disk in GB.
      encryptionSettings:
        type: object
        description: This is the encryption settings for the disk.
        $ref: '#/definitions/EncryptionSettings'
      image:
        type: object
        description: This is the source user image virtual hard disk.
        $ref: '#/definitions/DiskImage'
      managedDisk:
        type: object
        description: This is managed disk parameters.
        $ref: '#/definitions/ManagedDisk'
      name:
        type: string
        description: This is the disk name.
      osType:
        type: string
        description: This is the type of OS included in the disk.
      vhd:
        type: object
        description: This is the virtual hard disk.
        $ref: '#/definitions/VirtualHardDisk'
      writeAcceleratorEnabled:
        type: string
        description: This specifies whether or not writeAccelerator is enabled on the disk.
  OsProfile:
    type: object
    description: This contains the data about the OS.
    properties:
      adminUsername:
        type: string
        description: This is admin account.
      computerName:
        type: string
        description: This is the name of the VM.
  TagsProperties:
    type: object
    description: This contains the properties of the tags in a tagsList.
    properties:
      name:
        type: string
        description: This is the name of the tag. It is equivalent to the key in the key-value pair format.
      value:
        type: string
        description: This is the value of the tag. It is, as expected, equivalent to the value in the key-value pair format.
  PlanProperties:
    type: object
    description: This contains the data about the plan.
    properties:
      name:
        type: string
        description: This is the Plan ID.
      publisher:
        type: string
        description: This is the publisher ID.
      product:
        type: string
        description: This is the product of the image from the Marketplace.
  SubnetProperties:
    type: object
    description: This contains the properties of the subnet.
    properties:
      address:
        type: string
        description: This is the address range of the subnet.
      prefix:
        type: string
        description: This is the prefix of the subnet.
  EncryptionSettings:
    type: object
    description: This is the encryption settings for the disk.
    properties:
      enabled:
        type: string
        description: This specifies whether or not disk encryption is enabled on the VM.
  VirtualHardDisk:
    type: object
    description: This is the virtual hard disk.
    properties:
      uri:
        type: string
        description: This is the uri of the virtual hard disk.
  ErrorResponse:
    description: This is the response from an operation in the case an error occurs.
    type: object
    properties:
      error:
        description: Error message indicating why the operation failed.
        type: string
  SecurityProfile:
    type: object
    description: This contains the data about the security profile associated with the VM.
    properties:
      secureBootEnabled:
        type: string
        description: Identifies if UEFI secure boot is enabled on the VM
      virtualTpmEnabled:
        type: string
        description: Identifies if the virtual Trusted Platform Module (TPM) is enabled on the VM
  Ipv4Properties:
    type: object
    description: This contains the IPv4 properties.
    properties:
      privateIpAddress:
        type: string
        description: This is the private IP address assigned to the interface.
      publicIpAddress:
        type: string
        description: This is the public IP address assigned to the interface.
  Network:
    type: object
    properties:
      interface:
        type: array
        description: This contains data about the network interface.
        items:
          type: object
          $ref: '#/definitions/NetworkInterface'
    description: Network Metadata
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    type: string
    enum:
    - '2018-10-01'
    description: This is the API version to use.
    required: true
    x-ms-enum:
      name: ApiVersion
      modelAsString: true
  MetadataParameter:
    name: Metadata
    in: header
    type: string
    enum:
    - 'true'
    description: This must be set to 'true'.
    required: true
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'