Skip to content

Commit f623a91

Browse files
prmerger-automator[bot]prmerger-automator[bot]
authored
Merge pull request #208569 from joshdmcc/jmccarthy/updateimdsdocs
Adding missing information to the IMDS public docs
2 parents 194de57 + 0fc1414 commit f623a91

File tree

2 files changed

+106
-8
lines changed

2 files changed

+106
-8
lines changed

‎includes/virtual-machines-imds-full-instance-response.md

Lines changed: 44 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@ ms.reviewer: azmetadatadev
1414
{
1515
"compute": {
1616
"azEnvironment": "AZUREPUBLICCLOUD",
17+
"additionalCapabilities": {
18+
"hibernationEnabled": "true"
19+
},
20+
"hostGroup": {
21+
"id": "testHostGroupId"
22+
},
1723
"extendedLocation": {
1824
"type": "edgeZone",
1925
"name": "microsoftlosangeles"
@@ -54,7 +60,9 @@ ms.reviewer: azmetadatadev
5460
"resourceId": "/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx/resourceGroups/macikgo-test-may-23/providers/Microsoft.Compute/virtualMachines/examplevmname",
5561
"securityProfile": {
5662
"secureBootEnabled": "true",
57-
"virtualTpmEnabled": "false"
63+
"virtualTpmEnabled": "false",
64+
"encryptionAtHost": "true",
65+
"securityType": "TrustedLaunch"
5866
},
5967
"sku": "2019-Datacenter",
6068
"storageProfile": {
@@ -96,7 +104,19 @@ ms.reviewer: azmetadatadev
96104
"option": "Local"
97105
},
98106
"encryptionSettings": {
99-
"enabled": "false"
107+
"enabled": "false",
108+
"diskEncryptionKey": {
109+
"sourceVault": {
110+
"id": "/subscriptions/test-source-guid/resourceGroups/testrg/providers/Microsoft.KeyVault/vaults/test-kv"
111+
},
112+
"secretUrl": "https://test-disk.vault.azure.net/secrets/xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx/xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx"
113+
},
114+
"keyEncryptionKey": {
115+
"sourceVault": {
116+
"id": "/subscriptions/test-key-guid/resourceGroups/testrg/providers/Microsoft.KeyVault/vaults/test-kv"
117+
},
118+
"keyUrl": "https://test-key.vault.azure.net/secrets/xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx/xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx"
119+
}
100120
},
101121
"image": {
102122
"uri": ""
@@ -155,6 +175,12 @@ ms.reviewer: azmetadatadev
155175
{
156176
"compute": {
157177
"azEnvironment": "AZUREPUBLICCLOUD",
178+
"additionalCapabilities": {
179+
"hibernationEnabled": "true"
180+
},
181+
"hostGroup": {
182+
"id": "testHostGroupId"
183+
},
158184
"extendedLocation": {
159185
"type": "edgeZone",
160186
"name": "microsoftlosangeles"
@@ -195,7 +221,9 @@ ms.reviewer: azmetadatadev
195221
"resourceId": "/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx/resourceGroups/macikgo-test-may-23/providers/Microsoft.Compute/virtualMachines/examplevmname",
196222
"securityProfile": {
197223
"secureBootEnabled": "true",
198-
"virtualTpmEnabled": "false"
224+
"virtualTpmEnabled": "false",
225+
"encryptionAtHost": "true",
226+
"securityType": "TrustedLaunch"
199227
},
200228
"sku": "18.04-LTS",
201229
"storageProfile": {
@@ -237,7 +265,19 @@ ms.reviewer: azmetadatadev
237265
"option": "Local"
238266
},
239267
"encryptionSettings": {
240-
"enabled": "false"
268+
"enabled": "false",
269+
"diskEncryptionKey": {
270+
"sourceVault": {
271+
"id": "/subscriptions/test-source-guid/resourceGroups/testrg/providers/Microsoft.KeyVault/vaults/test-kv"
272+
},
273+
"secretUrl": "https://test-disk.vault.azure.net/secrets/xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx/xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx"
274+
},
275+
"keyEncryptionKey": {
276+
"sourceVault": {
277+
"id": "/subscriptions/test-key-guid/resourceGroups/testrg/providers/Microsoft.KeyVault/vaults/test-kv"
278+
},
279+
"keyUrl": "https://test-key.vault.azure.net/secrets/xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx/xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx"
280+
}
241281
},
242282
"image": {
243283
"uri": ""

‎includes/virtual-machines-imds.md

Lines changed: 62 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -340,10 +340,13 @@ Schema breakdown:
340340
| Data | Description | Version introduced |
341341
|------|-------------|--------------------|
342342
| `azEnvironment` | Azure Environment where the VM is running in | 2018-10-01
343+
| `additionalCapabilities.hibernationEnabled` | Identifies if hibernation is enabled on the VM | 2021-11-01†
343344
| `customData` | This feature is deprecated and disabled [in IMDS](#frequently-asked-questions). It has been superseded by `userData` | 2019-02-01
344345
| `evictionPolicy` | Sets how a [Spot VM](../articles/virtual-machines/spot-vms.md) will be evicted. | 2020-12-01
345346
| `extendedLocation.type` | Type of the extended location of the VM. | 2021-03-01
346347
| `extendedLocation.name` | Name of the extended location of the VM | 2021-03-01
348+
| `host.id` | Name of the host of the VM. Note that a VM will either have a host or a hostGroup but not both. | 2021-11-15†
349+
| `hostGroup.id` | Name of the hostGroup of the VM. Note that a VM will either have a host or a hostGroup but not both. | 2021-11-15†
347350
| `isHostCompatibilityLayerVm` | Identifies if the VM runs on the Host Compatibility Layer | 2020-06-01
348351
| `licenseType` | Type of license for [Azure Hybrid Benefit](https://azure.microsoft.com/pricing/hybrid-benefit). This is only present for AHB-enabled VMs | 2020-09-01
349352
| `location` | Azure Region the VM is running in | 2017-04-02
@@ -367,6 +370,8 @@ Schema breakdown:
367370
| `sku` | Specific SKU for the VM image | 2017-04-02
368371
| `securityProfile.secureBootEnabled` | Identifies if UEFI secure boot is enabled on the VM | 2020-06-01
369372
| `securityProfile.virtualTpmEnabled` | Identifies if the virtual Trusted Platform Module (TPM) is enabled on the VM | 2020-06-01
373+
| `securityProfile.encryptionAtHost` | Identifies if [Encryption at Host](../articles/virtual-machines/disks-enable-host-based-encryption-portal.md) is enabled on the VM | 2021-11-01†
374+
| `securityProfile.securityType` | Identifies if the VM is a [Trusted VM](../articles/virtual-machines/trusted-launch.md) or a [Confidential VM](../articles/confidential-computing/confidential-vm-overview.md) | 2021-12-13†
370375
| `storageProfile` | See Storage Profile below | 2019-06-01
371376
| `subscriptionId` | Azure subscription for the Virtual Machine | 2017-08-01
372377
| `tags` | [Tags](../articles/azure-resource-manager/management/tag-resources.md) for your Virtual Machine | 2017-08-01
@@ -379,6 +384,8 @@ Schema breakdown:
379384
| `vmSize` | [VM size](../articles/virtual-machines/sizes.md) | 2017-04-02
380385
| `zone` | [Availability Zone](../articles/availability-zones/az-overview.md) of your virtual machine | 2017-12-01
381386

387+
† This version is not fully available yet and may not be supported in all regions.
388+
382389
**Storage profile**
383390

384391
The storage profile of a VM is divided into three categories: image reference, OS disk, and data disks, plus an additional object for the local temporary disk.
@@ -431,6 +438,17 @@ Data | Description | Version introduced |
431438

432439
\* These fields are only populated for Ultra Disks; they will be empty strings from non-Ultra Disks.
433440

441+
The encryption settings blob contains data about how the disk is encrypted (if it is encrypted):
442+
443+
Data | Description | Version introduced |
444+
|------|-----------|--------------------|
445+
| `diskEncryptionKey.sourceVault.id` | The location of the disk encryption key | 2021-11-01†
446+
| `diskEncryptionKey.secretUrl` | The location of the secret | 2021-11-01†
447+
| `keyEncryptionKey.sourceVault.id` | The location of the key encryption key | 2021-11-01†
448+
| `keyEncryptionKey.keyUrl` | The location of the key | 2021-11-01†
449+
450+
\† This version is not fully available yet and may not be supported in all regions.
451+
434452
The resource disk object contains the size of the [Local Temp Disk](../articles/virtual-machines/managed-disks-overview.md#temporary-disk) attached to the VM, if it has one, in kilobytes.
435453
If there is [no local temp disk for the VM](../articles/virtual-machines/azure-vms-no-temp-disk.yml), this value is 0.
436454

@@ -660,6 +678,12 @@ curl -H Metadata:true --noproxy "*" "http://169.254.169.254/metadata/instance/co
660678
"name": "microsoftlosangeles"
661679
},
662680
"evictionPolicy": "",
681+
"additionalCapabilities": {
682+
"hibernationEnabled": "false"
683+
},
684+
"hostGroup": {
685+
"id": "testHostGroupId"
686+
},
663687
"isHostCompatibilityLayerVm": "true",
664688
"licenseType": "Windows_Client",
665689
"location": "westus",
@@ -694,7 +718,9 @@ curl -H Metadata:true --noproxy "*" "http://169.254.169.254/metadata/instance/co
694718
"resourceId": "/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx/resourceGroups/macikgo-test-may-23/providers/Microsoft.Compute/virtualMachines/examplevmname",
695719
"securityProfile": {
696720
"secureBootEnabled": "true",
697-
"virtualTpmEnabled": "false"
721+
"virtualTpmEnabled": "false",
722+
"encryptionAtHost": "true",
723+
"securityType": "TrustedLaunch"
698724
},
699725
"sku": "2019-Datacenter",
700726
"storageProfile": {
@@ -736,7 +762,19 @@ curl -H Metadata:true --noproxy "*" "http://169.254.169.254/metadata/instance/co
736762
"option": "Local"
737763
},
738764
"encryptionSettings": {
739-
"enabled": "false"
765+
"enabled": "false",
766+
"diskEncryptionKey": {
767+
"sourceVault": {
768+
"id": "/subscriptions/test-source-guid/resourceGroups/testrg/providers/Microsoft.KeyVault/vaults/test-kv"
769+
},
770+
"secretUrl": "https://test-disk.vault.azure.net/secrets/xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx/xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx"
771+
},
772+
"keyEncryptionKey": {
773+
"sourceVault": {
774+
"id": "/subscriptions/test-key-guid/resourceGroups/testrg/providers/Microsoft.KeyVault/vaults/test-kv"
775+
},
776+
"keyUrl": "https://test-key.vault.azure.net/secrets/xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx/xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx"
777+
}
740778
},
741779
"image": {
742780
"uri": ""
@@ -778,6 +816,12 @@ curl -H Metadata:true --noproxy "*" "http://169.254.169.254/metadata/instance/co
778816
"name": "microsoftlosangeles"
779817
},
780818
"evictionPolicy": "",
819+
"additionalCapabilities": {
820+
"hibernationEnabled": "false"
821+
},
822+
"hostGroup": {
823+
"id": "testHostGroupId"
824+
},
781825
"isHostCompatibilityLayerVm": "true",
782826
"licenseType": "Windows_Client",
783827
"location": "westus",
@@ -812,7 +856,9 @@ curl -H Metadata:true --noproxy "*" "http://169.254.169.254/metadata/instance/co
812856
"resourceId": "/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx/resourceGroups/macikgo-test-may-23/providers/Microsoft.Compute/virtualMachines/examplevmname",
813857
"securityProfile": {
814858
"secureBootEnabled": "true",
815-
"virtualTpmEnabled": "false"
859+
"virtualTpmEnabled": "false",
860+
"encryptionAtHost": "true",
861+
"securityType": "TrustedLaunch"
816862
},
817863
"sku": "18.04-LTS",
818864
"storageProfile": {
@@ -854,7 +900,19 @@ curl -H Metadata:true --noproxy "*" "http://169.254.169.254/metadata/instance/co
854900
"option": "Local"
855901
},
856902
"encryptionSettings": {
857-
"enabled": "false"
903+
"enabled": "false",
904+
"diskEncryptionKey": {
905+
"sourceVault": {
906+
"id": "/subscriptions/test-source-guid/resourceGroups/testrg/providers/Microsoft.KeyVault/vaults/test-kv"
907+
},
908+
"secretUrl": "https://test-disk.vault.azure.net/secrets/xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx/xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx"
909+
},
910+
"keyEncryptionKey": {
911+
"sourceVault": {
912+
"id": "/subscriptions/test-key-guid/resourceGroups/testrg/providers/Microsoft.KeyVault/vaults/test-kv"
913+
},
914+
"keyUrl": "https://test-key.vault.azure.net/secrets/xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx/xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx"
915+
}
858916
},
859917
"image": {
860918
"uri": ""

0 commit comments

Comments
 (0)