InstanceMetadataClient (stable:2023-07-01)

2025/10/23 • 5 new methods

GetVersions (new)
Description :  Get supported API versions.
Reference :  Link ¶

⚼ Request

GET:  /versions
{}

⚐ Response (200)

{
apiVersions:
{
Description: List of API versions supported. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Instances_GetMetadata (new)
Description :  Get Instance Metadata for the Virtual Machine.
Reference :  Link ¶

⚼ Request

GET:  /instance
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
Metadata:
{
Description: This must be set to 'true'. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
compute:
{
Description: Compute Metadata ,
Required: False ,
}
{
azEnvironment:
{
Description: This is the name of the environment in which the VM is running. ,
Required: False ,
}
string ,
evictionPolicy:
{
Description: Describes how the VM will be evicted if space needs to be freed up. Only applicable to Spot VMs. For a non-spot VM, this will be an empty string. ,
Required: False ,
}
string ,
extendedLocation:
{
Description: Describes the extended location of the VM ,
Required: False ,
}
{
type:
{
Description: The type of the extended location of the VM ,
Required: False ,
}
string ,
name:
{
Description: The name of the extended location of the VM ,
Required: False ,
}
string ,
}
,
isHostCompatibilityLayerVm:
{
Description: Identifies if the VM runs on the Host Compatibility Layer. ,
Required: False ,
}
string ,
licenseType:
{
Description: Type of license for Azure Hybrid Benefit. Note that this is only present for AHB-enabled VMs. ,
Required: False ,
}
string ,
location:
{
Description: This is the Azure Region in which the VM is running. ,
Required: False ,
}
string ,
name:
{
Description: This is the name of the VM. ,
Required: False ,
}
string ,
offer:
{
Description: This is the offer information for the VM image. This value is only present for images deployed from the Azure Image Gallery. ,
Required: False ,
}
string ,
osProfile:
{
Description: This contains the data about the OS. ,
Required: False ,
}
{
adminUsername:
{
Description: This is admin account. ,
Required: False ,
}
string ,
computerName:
{
Description: This is the name of the VM. ,
Required: False ,
}
string ,
disablePasswordAuthentication:
{
Description: This specifies whether or not password authentication is disabled. Note that this is present only for Linux VMs. For a Windows VM, this value will be the empty string. ,
Required: False ,
}
string ,
}
,
osType:
{
Description: This value indicates the type of OS the VM is running, either Linux or Windows. ,
Required: False ,
}
string ,
placementGroupId:
{
Description: This is the placement group of your Virtual Machine Scale Set. ,
Required: False ,
}
string ,
plan:
{
Description: This contains the data about the plan. ,
Required: False ,
}
{
name:
{
Description: This is the Plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: This is the publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: This is the product of the image from the Marketplace. ,
Required: False ,
}
string ,
}
,
publicKeys:
{
Description: This is information about the SSH certificate ,
Required: False ,
}
[
{
path:
{
Description: This specifies the full path on the VM where the SSH public key is stored. ,
Required: False ,
}
string ,
keyData:
{
Description: This is the SSH public key certificate used to authenticate with the VM. ,
Required: False ,
}
string ,
}
,
]
,
platformFaultDomain:
{
Description: This is the fault domain the VM resides in. ,
Required: False ,
}
string ,
platformSubFaultDomain:
{
Description: This is the sub fault domain the VM resides in, if applicable. ,
Required: False ,
}
string ,
platformUpdateDomain:
{
Description: This is the update domain the VM resides in. ,
Required: False ,
}
string ,
priority:
{
Description: This is the priority of the VM. ,
Required: False ,
}
string ,
provider:
{
Description: This is the provider of the VM. ,
Required: False ,
}
string ,
publisher:
{
Description: This is the publisher of the VM image. ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: This is the resource group for the VM. ,
Required: False ,
}
string ,
resourceId:
{
Description: This is the fully qualified ID for the VM. ,
Required: False ,
}
string ,
securityProfile:
{
Description: This contains the data about the security profile associated with the VM. ,
Required: False ,
}
{
secureBootEnabled:
{
Description: Identifies if UEFI secure boot is enabled on the VM ,
Required: False ,
}
string ,
virtualTpmEnabled:
{
Description: Identifies if the virtual Trusted Platform Module (TPM) is enabled on the VM ,
Required: False ,
}
string ,
encryptionAtHost:
{
Description: Identifies if encryption at host is enabled on the VM ,
Required: False ,
}
string ,
securityType:
{
Description: Identifies if the VM is a Trusted VM or a Confidential VM ,
Required: False ,
}
string ,
}
,
host:
{
Description: This contains the data about the host of VM. ,
Required: False ,
}
{
id:
{
Description: This is the name of the host of VM. Note that a VM will either have a host or a hostGroup but not both ,
Required: False ,
}
string ,
}
,
hostGroup:
{
Description: This contains the data about the host group of VM. ,
Required: False ,
}
{
id:
{
Description: This is the name of the host group of VM. Note that a VM will either have a host or a hostGroup but not both ,
Required: False ,
}
string ,
}
,
sku:
{
Description: This is the specific SKU for the VM image. ,
Required: False ,
}
string ,
storageProfile:
{
Description: This contains the data about the storage disks associated with the VM. ,
Required: False ,
}
{
imageReference:
{
Description: Image information ,
Required: False ,
}
{
id:
{
Description: This is the resource ID. ,
Required: False ,
}
string ,
offer:
{
Description: This is the offer of the platform or marketplace image. ,
Required: False ,
}
string ,
publisher:
{
Description: This is the image publisher. ,
Required: False ,
}
string ,
sku:
{
Description: This is the image SKU. ,
Required: False ,
}
string ,
version:
{
Description: This is the version of the platform or marketplace image. ,
Required: False ,
}
string ,
communityGalleryImageId:
{
Description: This is the resource ID when using a community image. ,
Required: False ,
}
string ,
sharedGalleryImageId:
{
Description: This is the resource ID when using a direct shared image. ,
Required: False ,
}
string ,
exactVersion:
{
Description: This is the version of the community or direct shared image. ,
Required: False ,
}
string ,
}
,
osDisk:
{
Description: OS disk information ,
Required: False ,
}
{
caching:
{
Description: This is the caching requirements. ,
Required: False ,
}
string ,
createOption:
{
Description: This is information about how the VM was created. ,
Required: False ,
}
string ,
diffDiskSettings:
{
Description: This is the ephemeral disk settings. ,
Required: False ,
}
{
option:
{
Description: This specifies the ephemeral disk settings. ,
Required: False ,
}
string ,
}
,
diskSizeGB:
{
Description: This is the size of the disk in GB. ,
Required: False ,
}
string ,
encryptionSettings:
{
Description: This is the encryption settings for the disk. ,
Required: False ,
}
{
enabled:
{
Description: This specifies whether or not disk encryption is enabled on the VM. ,
Required: False ,
}
string ,
diskEncryptionKey:
{
Description: This is the key used for encrypting the disk. ,
Required: False ,
}
{
sourceVault:
{
Description: This specifies keyvault used to store the encryption key. ,
Required: False ,
}
{
id:
{
Description: This specifies the resource ID of the keyvault. ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: This specifies the secret Url of the key stored in keyvault. ,
Required: False ,
}
string ,
}
,
keyEncryptionKey:
{
Description: This is the key used for encrypting the disk encryption key. ,
Required: False ,
}
{
sourceVault:
{
Description: This specifies keyvault used to store the encryption key. ,
Required: False ,
}
{
id:
{
Description: This specifies the resource ID of the keyvault. ,
Required: False ,
}
string ,
}
,
keyUrl:
{
Description: This specifies the secret Url of the key stored in keyvault. ,
Required: False ,
}
string ,
}
,
}
,
image:
{
Description: This is the source user image virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: This is the uri of the virtual hard disk. ,
Required: False ,
}
string ,
}
,
managedDisk:
{
Description: This is managed disk parameters. ,
Required: False ,
}
{
id:
{
Description: This is the resource ID. ,
Required: False ,
}
string ,
storageAccountType:
{
Description: This is the storage account type for the managed disk. ,
Required: False ,
}
string ,
}
,
name:
{
Description: This is the disk name. ,
Required: False ,
}
string ,
osType:
{
Description: This is the type of OS included in the disk. ,
Required: False ,
}
string ,
vhd:
{
Description: This is the virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: This is the uri of the virtual hard disk. ,
Required: False ,
}
string ,
}
,
writeAcceleratorEnabled:
{
Description: This specifies whether or not writeAccelerator is enabled on the disk. ,
Required: False ,
}
string ,
}
,
dataDisks:
{
Description: Data disk information ,
Required: False ,
}
[
{
bytesPerSecondThrottle:
{
Description: Disk read/write quota in bytes; only populated for Ultra Disks ,
Required: False ,
}
string ,
caching:
{
Description: This is the caching requirements. ,
Required: False ,
}
string ,
createOption:
{
Description: This is information about how the VM was created. ,
Required: False ,
}
string ,
diskCapacityBytes:
{
Description: Size of disk in bytes; only populated for Ultra Disks ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: This is the size of the disk in GB. ,
Required: False ,
}
string ,
image:
{
Description: This is the source user image virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: This is the uri of the virtual hard disk. ,
Required: False ,
}
string ,
}
,
isSharedDisk:
{
Description: Identifies if the disk is shared between resources; only populated for Ultra Disks ,
Required: False ,
}
string ,
isUltraDisk:
{
Description: Identifies if the data disk is an Ultra Disk ,
Required: False ,
}
string ,
lun:
{
Description: This is the logical unit number of the disk. ,
Required: False ,
}
string ,
managedDisk:
{
Description: This is managed disk parameters. ,
Required: False ,
}
{
id:
{
Description: This is the resource ID. ,
Required: False ,
}
string ,
storageAccountType:
{
Description: This is the storage account type for the managed disk. ,
Required: False ,
}
string ,
}
,
name:
{
Description: This is the disk name. ,
Required: False ,
}
string ,
opsPerSecondThrottle:
{
Description: Disk read/write quota in IOPS; only populated for Ultra Disks ,
Required: False ,
}
string ,
vhd:
{
Description: This is the virtual hard disk. ,
Required: False ,
}
{
uri:
{
Description: This is the uri of the virtual hard disk. ,
Required: False ,
}
string ,
}
,
writeAcceleratorEnabled:
{
Description: This specifies whether or not writeAccelerator is enabled on the disk. ,
Required: False ,
}
string ,
}
,
]
,
resourceDisk:
{
Description: This contains data for the size of local temp disk of the VM, if it exists. ,
Required: False ,
}
{
size:
{
Description: The size of the local temp disk of the VM if it exists, in kilobytes. If the VM has no local temp disk, this value is 0. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: This is the Azure subscription for the VM. ,
Required: False ,
}
string ,
tags:
{
Description: This is the list of tags for your VM. ,
Required: False ,
}
string ,
tagsList:
{
Description: This is the list of tags for your VM formatted as a JSON array for easier programmatic parsing. ,
Required: False ,
}
[
{
name:
{
Description: This is the name of the tag. It is equivalent to the key in the key-value pair format. ,
Required: False ,
}
string ,
value:
{
Description: This is the value of the tag. It is, as expected, equivalent to the value in the key-value pair format. ,
Required: False ,
}
string ,
}
,
]
,
userData:
{
Description: The set of data specified when the VM was created for use during or after provisioning (Base64 encoded) ,
Required: False ,
}
string ,
version:
{
Description: This is the version of the VM image. ,
Required: False ,
}
string ,
virtualMachineScaleSet:
{
Description: Information about the VMSS the VM belongs to (if applicable) ,
Required: False ,
}
{
id:
{
Description: This is the ID of the VMSS the VM belongs to (if applicable) ,
Required: False ,
}
string ,
}
,
vmId:
{
Description: This is the unique identifier for the VM. ,
Required: False ,
}
string ,
vmScaleSetName:
{
Description: This is the resource name of the VMSS. ,
Required: False ,
}
string ,
vmSize:
{
Description: This is the size of the VM. ,
Required: False ,
}
string ,
zone:
{
Description: This is the availability zone of the VM. ,
Required: False ,
}
string ,
additionalCapabilities:
{
Description: These are additional capabilities defined for VM. ,
Required: False ,
}
{
hibernationEnabled:
{
Description: This specifies if hibernation is enabled for VM. ,
Required: False ,
}
string ,
}
,
}
,
network:
{
Description: Network Metadata ,
Required: False ,
}
{
interface:
{
Description: This contains data about the network interface. ,
Required: False ,
}
[
{
ipv4:
{
Description: This contains the IPv4 address. ,
Required: False ,
}
{
ipAddress:
{
Description: This is the IP address ,
Required: False ,
}
[
{
privateIpAddress:
{
Description: This is the private IP address assigned to the interface. ,
Required: False ,
}
string ,
publicIpAddress:
{
Description: This is the public IP address assigned to the interface. ,
Required: False ,
}
string ,
}
,
]
,
subnet:
{
Description: This is the subnet ,
Required: False ,
}
[
{
address:
{
Description: This is the address range of the subnet. ,
Required: False ,
}
string ,
prefix:
{
Description: This is the prefix of the subnet. ,
Required: False ,
}
string ,
}
,
]
,
}
,
ipv6:
{
Description: This contains the IPv6 address. ,
Required: False ,
}
{
ipAddress:
{
Description: This is the IP address ,
Required: False ,
}
[
{
privateIpAddress:
{
Description: This is the private IPv6 address assigned to the interface. ,
Required: False ,
}
string ,
}
,
]
,
}
,
macAddress:
{
Description: This is the MAC address of the interface. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Attested_GetDocument (new)
Description :  Get Attested Data for the Virtual Machine.
Reference :  Link ¶

⚼ Request

GET:  /attested/document
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
nonce:
{
Description: This is a string of up to 32 random alphanumeric characters. ,
Required: False ,
}
string ,
Metadata:
{
Description: This must be set to 'true'. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
signature:
{
Description: This is the encoded string containing the VM ID, SKU, plan information, public key, timestamp, and nonce value. ,
Required: False ,
}
string ,
encoding:
{
Description: This is the encoding scheme of the signature. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Identity_GetToken (new)
Description :  Get a Token from Azure AD
Reference :  Link ¶

⚼ Request

GET:  /identity/oauth2/token
{
Metadata:
{
Description: This must be set to 'true'. ,
Required: True ,
}
string ,
resource:
{
Description: This is the urlencoded identifier URI of the sink resource for the requested Azure AD token. The resulting token contains the corresponding aud for this resource. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
client_id:
{
Description: This identifies, by Azure AD client id, a specific explicit identity to use when authenticating to Azure AD. Mutually exclusive with object_id and msi_res_id. ,
Required: False ,
}
string ,
object_id:
{
Description: This identifies, by Azure AD object id, a specific explicit identity to use when authenticating to Azure AD. Mutually exclusive with client_id and msi_res_id. ,
Required: False ,
}
string ,
msi_res_id:
{
Description: This identifies, by urlencoded ARM resource id, a specific explicit identity to use when authenticating to Azure AD. Mutually exclusive with client_id and object_id. ,
Required: False ,
}
string ,
authority:
{
Description: This indicates the authority to request AAD tokens from. Defaults to the known authority of the identity to be used. ,
Required: False ,
}
string ,
bypass_cache:
{
Description: If provided, the value must be 'true'. This indicates to the server that the token must be retrieved from Azure AD and cannot be retrieved from an internal cache. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
access_token:
{
Description: This is the requested access token. The app can use this token to authenticate to the sink resource. ,
Required: False ,
}
string ,
expires_in:
{
Description: This is how long the access token is valid (in seconds). ,
Required: False ,
}
string ,
expires_on:
{
Description: This is the time when the access token expires. The date is represented as the number of seconds from 1970-01-01T0:0:0Z UTC until the expiration time. This value is used to determine the lifetime of cached tokens. ,
Required: False ,
}
string ,
ext_expires_in:
{
Description: This indicates the extended lifetime of the token (in seconds). ,
Required: False ,
}
string ,
not_before:
{
Description: This is the time when the access token becomes effective. The date is represented as the number of seconds from 1970-01-01T0:0:0Z UTC until the expiration time. ,
Required: False ,
}
string ,
resource:
{
Description: This is the app ID URI of the sink resource. ,
Required: False ,
}
string ,
token_type:
{
Description: This indicates the token type value. ,
Required: False ,
}
string ,
client_id:
{
Description: This is the client_id specified in the request, if any. ,
Required: False ,
}
string ,
object_id:
{
Description: This is the object_id specified in the request, if any. ,
Required: False ,
}
string ,
msi_res_id:
{
Description: This is the msi_res_id specified in the request, if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
www-authenticate:
{
Description: This is the response header containing a challenge for the Basic scheme with a realm value ,
}
string ,
}
,
$schema:
{
Description: This is the response from an Identity operation in the case an error occurs. ,
}
{
error:
{
Description: Error code ,
Enum:
{
invalid_request: No description available. ,
unauthorized_client: No description available. ,
access_denied: No description available. ,
unsupported_response_type: No description available. ,
invalid_scope: No description available. ,
server_error: No description available. ,
service_unavailable: No description available. ,
bad_request: No description available. ,
forbidden: No description available. ,
not_found: No description available. ,
method_not_allowed: No description available. ,
too_many_requests: No description available. ,
}
,
Required: False ,
}
enum ,
error_description:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Identity_GetInfo (new)
Description :  Get information about AAD Metadata
Reference :  Link ¶

⚼ Request

GET:  /identity/info
{
Metadata:
{
Description: This must be set to 'true'. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tenantId:
{
Description: This is the AAD tenantId of the identity of the system assigned managed identity. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error code ,
Enum:
{
invalid_request: No description available. ,
unauthorized_client: No description available. ,
access_denied: No description available. ,
unsupported_response_type: No description available. ,
invalid_scope: No description available. ,
server_error: No description available. ,
service_unavailable: No description available. ,
bad_request: No description available. ,
forbidden: No description available. ,
not_found: No description available. ,
method_not_allowed: No description available. ,
too_many_requests: No description available. ,
}
,
Required: False ,
}
enum ,
error_description:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}