Skip to content

Commit 7e4d862

Browse files
committed
Adding clarity to EAH docs around platform-managed keys. Acrolinx fixes.
1 parent a790434 commit 7e4d862

File tree

3 files changed

+44
-34
lines changed

3 files changed

+44
-34
lines changed

articles/virtual-machines/disks-enable-host-based-encryption-portal.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Use encryption at host to enable end-to-end encryption on your Azur
44
author: roygara
55
ms.service: storage
66
ms.topic: how-to
7-
ms.date: 01/19/2023
7+
ms.date: 03/28/2023
88
ms.author: rogarana
99
ms.subservice: disks
1010
ms.custom: references_regions
@@ -94,7 +94,7 @@ Once the feature is enabled, you need to set up an Azure Key Vault and a disk en
9494

9595
### Deploy a VM
9696

97-
Now that you've setup an Azure Key Vault and disk encryption set, you can deploy a VM and it uses encryption at host.
97+
Now that you have setup an Azure Key Vault and disk encryption set, you can deploy a VM and it uses encryption at host.
9898

9999
1. Sign in to the [Azure portal](https://portal.azure.com).
100100
1. Search for **Virtual Machines** and select **+ Add** to create a VM.

articles/virtual-machines/linux/disks-enable-host-based-encryption-cli.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Use encryption at host to enable end-to-end encryption on your Azur
44
author: roygara
55
ms.service: storage
66
ms.topic: how-to
7-
ms.date: 03/20/2023
7+
ms.date: 03/28/2023
88
ms.author: rogarana
99
ms.subservice: disks
1010
ms.custom: references_regions, devx-track-azurecli
@@ -14,7 +14,7 @@ ms.custom: references_regions, devx-track-azurecli
1414

1515
**Applies to:** :heavy_check_mark: Linux VMs :heavy_check_mark: Flexible scale sets
1616

17-
When you enable encryption at host, data stored on the VM host is encrypted at rest and flows encrypted to the Storage service. For conceptual information on encryption at host, as well as other managed disk encryption types, see [Encryption at host - End-to-end encryption for your VM data](../disk-encryption.md#encryption-at-host---end-to-end-encryption-for-your-vm-data).
17+
When you enable encryption at host, data stored on the VM host is encrypted at rest and flows encrypted to the Storage service. For conceptual information on encryption at host, and other managed disk encryption types, see [Encryption at host - End-to-end encryption for your VM data](../disk-encryption.md#encryption-at-host---end-to-end-encryption-for-your-vm-data).
1818

1919
## Restrictions
2020

@@ -23,7 +23,7 @@ When you enable encryption at host, data stored on the VM host is encrypted at r
2323
### Supported VM sizes
2424

2525
The complete list of supported VM sizes can be pulled programmatically. To learn how to retrieve them programmatically, see the [Finding supported VM sizes](#finding-supported-vm-sizes) section.
26-
Upgrading the VM size will result in validation to check if the new VM size supports the EncryptionAtHost feature.
26+
Upgrading the VM size results in validation to check if the new VM size supports the EncryptionAtHost feature.
2727

2828
## Prerequisites
2929

@@ -44,11 +44,16 @@ az feature show --namespace Microsoft.Compute --name EncryptionAtHost
4444

4545
### Create resources
4646

47-
Once the feature is enabled, you'll need to set up a DiskEncryptionSet and either an [Azure Key Vault](../../key-vault/general/overview.md) or an [Azure Key Vault Managed HSM](../../key-vault/managed-hsm/overview.md).
47+
> [!NOTE]
48+
> If you're using platform-managed keys, this section is optional. You can skip to the [Example scripts](#example-scripts) section.
49+
>
50+
> The [Create resources](#create-resources) section only applies to customer-managed keys.
51+
52+
Once the feature is enabled, you need to set up a DiskEncryptionSet and either an [Azure Key Vault](../../key-vault/general/overview.md) or an [Azure Key Vault Managed HSM](../../key-vault/managed-hsm/overview.md).
4853

4954
[!INCLUDE [virtual-machines-disks-encryption-create-key-vault-cli](../../../includes/virtual-machines-disks-encryption-create-key-vault-cli.md)]
5055

51-
## Examples
56+
## Example scripts
5257

5358
### Create a VM with encryption at host enabled with customer-managed keys.
5459

@@ -133,9 +138,9 @@ az vm update -n $vmName \
133138
--set securityProfile.encryptionAtHost=false
134139
```
135140

136-
### Create a virtual machine scale set with encryption at host enabled with customer-managed keys.
141+
### Create a Virtual Machine Scale Set with encryption at host enabled with customer-managed keys.
137142

138-
Create a virtual machine scale set with managed disks using the resource URI of the DiskEncryptionSet created earlier to encrypt cache of OS and data disks with customer-managed keys. The temp disks are encrypted with platform-managed keys.
143+
Create a Virtual Machine Scale Set with managed disks using the resource URI of the DiskEncryptionSet created earlier to encrypt cache of OS and data disks with customer-managed keys. The temp disks are encrypted with platform-managed keys.
139144

140145
```azurecli
141146
rgName=yourRGName
@@ -159,9 +164,9 @@ az vmss create -g $rgName \
159164
--data-disk-encryption-sets $diskEncryptionSetId $diskEncryptionSetId
160165
```
161166

162-
### Create a virtual machine scale set with encryption at host enabled with platform-managed keys.
167+
### Create a Virtual Machine Scale Set with encryption at host enabled with platform-managed keys.
163168

164-
Create a virtual machine scale set with encryption at host enabled to encrypt cache of OS/data disks and temp disks with platform-managed keys.
169+
Create a Virtual Machine Scale Set with encryption at host enabled to encrypt cache of OS/data disks and temp disks with platform-managed keys.
165170

166171
```azurecli
167172
rgName=yourRGName
@@ -180,7 +185,7 @@ az vmss create -g $rgName \
180185
--data-disk-sizes-gb 64 128 \
181186
```
182187

183-
### Update a virtual machine scale set to enable encryption at host.
188+
### Update a Virtual Machine Scale Set to enable encryption at host.
184189

185190
```azurecli
186191
rgName=yourRGName
@@ -191,7 +196,7 @@ az vmss update -n $vmssName \
191196
--set virtualMachineProfile.securityProfile.encryptionAtHost=true
192197
```
193198

194-
### Check the status of encryption at host for a virtual machine scale set
199+
### Check the status of encryption at host for a Virtual Machine Scale Set
195200

196201
```azurecli
197202
rgName=yourRGName
@@ -202,9 +207,9 @@ az vmss show -n $vmssName \
202207
--query [virtualMachineProfile.securityProfile.encryptionAtHost] -o tsv
203208
```
204209

205-
### Update a virtual machine scale set to disable encryption at host.
210+
### Update a Virtual Machine Scale Set to disable encryption at host.
206211

207-
You can disable encryption at host on your virtual machine scale set but, this will only affect VMs created after you disable encryption at host. For existing VMs, you must deallocate the VM, [disable encryption at host on that individual VM](#update-a-vm-to-disable-encryption-at-host), then reallocate the VM.
212+
You can disable encryption at host on your Virtual Machine Scale Set but, this will only affect VMs created after you disable encryption at host. For existing VMs, you must deallocate the VM, [disable encryption at host on that individual VM](#update-a-vm-to-disable-encryption-at-host), then reallocate the VM.
208213

209214
```azurecli
210215
rgName=yourRGName
@@ -217,7 +222,7 @@ az vmss update -n $vmssName \
217222

218223
## Finding supported VM sizes
219224

220-
Legacy VM Sizes are not supported. You can find the list of supported VM sizes by either using resource SKU APIs or the Azure PowerShell module. You can't find the supported sizes using the CLI.
225+
Legacy VM Sizes aren't supported. You can find the list of supported VM sizes by either using resource SKU APIs or the Azure PowerShell module. You can't find the supported sizes using the CLI.
221226

222227
When calling the [Resource Skus API](/rest/api/compute/resourceskus/list), check that the `EncryptionAtHostSupported` capability is set to **True**.
223228

articles/virtual-machines/windows/disks-enable-host-based-encryption-powershell.md

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: How to enable end-to-end encryption for your Azure VMs using encryp
44
author: roygara
55
ms.service: storage
66
ms.topic: how-to
7-
ms.date: 11/17/2021
7+
ms.date: 03/28/2023
88
ms.author: rogarana
99
ms.subservice: disks
1010
ms.custom: references_regions, devx-track-azurepowershell, ignite-fall-2021
@@ -14,7 +14,7 @@ ms.custom: references_regions, devx-track-azurepowershell, ignite-fall-2021
1414

1515
**Applies to:** :heavy_check_mark: Windows VMs
1616

17-
When you enable encryption at host, data stored on the VM host is encrypted at rest and flows encrypted to the Storage service. For conceptual information on encryption at host, as well as other managed disk encryption types, see [Encryption at host - End-to-end encryption for your VM data](../disk-encryption.md#encryption-at-host---end-to-end-encryption-for-your-vm-data).
17+
When you enable encryption at host, data stored on the VM host is encrypted at rest and flows encrypted to the Storage service. For conceptual information on encryption at host, and other managed disk encryption types, see [Encryption at host - End-to-end encryption for your VM data](../disk-encryption.md#encryption-at-host---end-to-end-encryption-for-your-vm-data).
1818

1919
## Restrictions
2020

@@ -24,19 +24,19 @@ When you enable encryption at host, data stored on the VM host is encrypted at r
2424
### Supported VM sizes
2525

2626
The complete list of supported VM sizes can be pulled programmatically. To learn how to retrieve them programmatically, refer to the [Finding supported VM sizes](#finding-supported-vm-sizes) section.
27-
Upgrading the VM size will result in validation to check if the new VM size supports the EncryptionAtHost feature.
27+
Upgrading the VM size results in validation to check if the new VM size supports the EncryptionAtHost feature.
2828

2929
## Prerequisites
3030

31-
You must enable the feature for your subscription before you use the EncryptionAtHost property for your VM/VMSS. Please follow the steps below to enable the feature for your subscription:
31+
You must enable the feature for your subscription before you use the EncryptionAtHost property for your VM/VMSS. Use the following steps to enable the feature for your subscription:
3232

3333
1. Execute the following command to register the feature for your subscription
3434

3535
```powershell
3636
Register-AzProviderFeature -FeatureName "EncryptionAtHost" -ProviderNamespace "Microsoft.Compute"
3737
```
3838

39-
2. Please check that the registration state is Registered (takes a few minutes) using the command below before trying out the feature.
39+
2. Check that the registration state is Registered (takes a few minutes) using the following command before trying out the feature.
4040

4141
```powershell
4242
Get-AzProviderFeature -FeatureName "EncryptionAtHost" -ProviderNamespace "Microsoft.Compute"
@@ -45,17 +45,22 @@ You must enable the feature for your subscription before you use the EncryptionA
4545

4646
### Create an Azure Key Vault and DiskEncryptionSet
4747

48-
Once the feature is enabled, you'll need to set up an Azure Key Vault and a DiskEncryptionSet, if you haven't already.
48+
> [!NOTE]
49+
> If you're using platform-managed keys, this section is optional. You can skip to the [Example scripts](#example-scripts) section.
50+
>
51+
> The [Create an Azure Key Vault and DiskEncryptionSet](#create-an-azure-key-vault-and-diskencryptionset) section only applies to customer-managed keys.
52+
53+
Once the feature is enabled, you need to set up an Azure Key Vault and a DiskEncryptionSet, if you haven't already.
4954

5055
[!INCLUDE [virtual-machines-disks-encryption-create-key-vault-powershell](../../../includes/virtual-machines-disks-encryption-create-key-vault-powershell.md)]
5156

52-
## Enable encryption at host for disks attached to VM and virtual machine scale sets
57+
## Enable encryption at host for disks attached to VM and Virtual Machine Scale Sets
5358

54-
You can enable encryption at host by setting a new property EncryptionAtHost under securityProfile of VMs or virtual machine scale sets using the API version **2020-06-01** and above.
59+
You can enable encryption at host by setting a new property EncryptionAtHost under securityProfile of VMs or Virtual Machine Scale Sets using the API version **2020-06-01** and above.
5560

5661
`"securityProfile": { "encryptionAtHost": "true" }`
5762

58-
## Examples
63+
## Example scripts
5964

6065
### Create a VM with encryption at host enabled with customer-managed keys.
6166

@@ -182,9 +187,9 @@ Stop-AzVM -ResourceGroupName $ResourceGroupName -Name $VMName -Force
182187
Update-AzVM -VM $VM -ResourceGroupName $ResourceGroupName -EncryptionAtHost $false
183188
```
184189

185-
### Create a virtual machine scale set with encryption at host enabled with customer-managed keys.
190+
### Create a Virtual Machine Scale Set with encryption at host enabled with customer-managed keys.
186191

187-
Create a virtual machine scale set with managed disks using the resource URI of the DiskEncryptionSet created earlier to encrypt cache of OS and data disks with customer-managed keys. The temp disks are encrypted with platform-managed keys.
192+
Create a Virtual Machine Scale Set with managed disks using the resource URI of the DiskEncryptionSet created earlier to encrypt cache of OS and data disks with customer-managed keys. The temp disks are encrypted with platform-managed keys.
188193

189194
```powershell
190195
$VMLocalAdminUser = "yourLocalAdminUser"
@@ -226,9 +231,9 @@ $VMSS = Set-AzVmssOsProfile $VMSS -ComputerNamePrefix $ComputerNamePrefix -Admin
226231
$VMSS = Add-AzVmssDataDisk -VirtualMachineScaleSet $VMSS -CreateOption Empty -Lun 1 -DiskSizeGB 128 -StorageAccountType Premium_LRS -DiskEncryptionSetId $diskEncryptionSet.Id
227232
```
228233

229-
### Create a virtual machine scale set with encryption at host enabled with platform-managed keys.
234+
### Create a Virtual Machine Scale Set with encryption at host enabled with platform-managed keys.
230235

231-
Create a virtual machine scale set with encryption at host enabled to encrypt cache of OS/data disks and temp disks with platform-managed keys.
236+
Create a Virtual Machine Scale Set with encryption at host enabled to encrypt cache of OS/data disks and temp disks with platform-managed keys.
232237

233238
```powershell
234239
$VMLocalAdminUser = "yourLocalAdminUser"
@@ -267,7 +272,7 @@ $Credential = New-Object System.Management.Automation.PSCredential ($VMLocalAdmi
267272
New-AzVmss -VirtualMachineScaleSet $VMSS -ResourceGroupName $ResourceGroupName -VMScaleSetName $VMScaleSetName
268273
```
269274

270-
### Update a virtual machine scale set to enable encryption at host.
275+
### Update a Virtual Machine Scale Set to enable encryption at host.
271276

272277
```powershell
273278
$ResourceGroupName = "yourResourceGroupName"
@@ -278,7 +283,7 @@ $VMSS = Get-AzVmss -ResourceGroupName $ResourceGroupName -Name $VMScaleSetName
278283
Update-AzVmss -VirtualMachineScaleSet $VMSS -Name $VMScaleSetName -ResourceGroupName $ResourceGroupName -EncryptionAtHost $true
279284
```
280285

281-
### Check the status of encryption at host for a virtual machine scale set
286+
### Check the status of encryption at host for a Virtual Machine Scale Set
282287

283288
```powershell
284289
$ResourceGroupName = "yourResourceGroupName"
@@ -289,9 +294,9 @@ $VMSS = Get-AzVmss -ResourceGroupName $ResourceGroupName -Name $VMScaleSetName
289294
$VMSS.VirtualMachineProfile.SecurityProfile.EncryptionAtHost
290295
```
291296

292-
### Update a virtual machine scale set to disable encryption at host.
297+
### Update a Virtual Machine Scale Set to disable encryption at host.
293298

294-
You can disable encryption at host on your virtual machine scale set but, this will only affect VMs created after you disable encryption at host. For existing VMs, you must deallocate the VM, [disable encryption at host on that individual VM](#disable-encryption-at-host), then reallocate the VM.
299+
You can disable encryption at host on your Virtual Machine Scale Set but, this will only affect VMs created after you disable encryption at host. For existing VMs, you must deallocate the VM, [disable encryption at host on that individual VM](#disable-encryption-at-host), then reallocate the VM.
295300

296301
```powershell
297302
$ResourceGroupName = "yourResourceGroupName"
@@ -304,7 +309,7 @@ Update-AzVmss -VirtualMachineScaleSet $VMSS -Name $VMScaleSetName -ResourceGroup
304309

305310
## Finding supported VM sizes
306311

307-
Legacy VM Sizes are not supported. You can find the list of supported VM sizes by either:
312+
Legacy VM Sizes aren't supported. You can find the list of supported VM sizes by either:
308313

309314
Calling the [Resource Skus API](/rest/api/compute/resourceskus/list) and checking that the `EncryptionAtHostSupported` capability is set to **True**.
310315

0 commit comments

Comments
 (0)