@@ -15,7 +15,18 @@ Enables encryption on a running IaaS virtual machine in Azure.
15
15
16
16
## SYNTAX
17
17
18
- ### AADClientSecretParameterSet (Default)
18
+ ### SinglePassParameterSet (Default)
19
+ ```
20
+ Set-AzureRmVMDiskEncryptionExtension [-ResourceGroupName] <String> [-VMName] <String>
21
+ [-DiskEncryptionKeyVaultUrl] <String> [-DiskEncryptionKeyVaultId] <String> [[-KeyEncryptionKeyUrl] <String>]
22
+ [[-KeyEncryptionKeyVaultId] <String>] [[-KeyEncryptionAlgorithm] <String>] [[-VolumeType] <String>]
23
+ [[-SequenceVersion] <String>] [[-TypeHandlerVersion] <String>] [[-Name] <String>] [[-Passphrase] <String>]
24
+ [-Force] [-DisableAutoUpgradeMinorVersion] [-SkipVmBackup] [-ExtensionType <String>]
25
+ [-ExtensionPublisherName <String>] [-EncryptFormatAll] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
26
+ [-Confirm] [<CommonParameters>]
27
+ ```
28
+
29
+ ### AADClientSecretParameterSet
19
30
```
20
31
Set-AzureRmVMDiskEncryptionExtension [-ResourceGroupName] <String> [-VMName] <String> [-AadClientID] <String>
21
32
[-AadClientSecret] <String> [-DiskEncryptionKeyVaultUrl] <String> [-DiskEncryptionKeyVaultId] <String>
@@ -46,7 +57,37 @@ It is advised that you save your work on the virtual machine before you run this
46
57
47
58
## EXAMPLES
48
59
49
- ### Example 1: Enable encryption using Azure AD Client ID and Client Secret
60
+ ### Example 1: Enable encryption
61
+ ```
62
+ $RGName = "MyResourceGroup"
63
+ $VMName = "MyTestVM"
64
+ $VaultName= "MyKeyVault"
65
+ $KeyVault = Get-AzureRmKeyVault -VaultName $VaultName -ResourceGroupName $RGName
66
+ $DiskEncryptionKeyVaultUrl = $KeyVault.VaultUri
67
+ $KeyVaultResourceId = $KeyVault.ResourceId
68
+ Set-AzureRmVMDiskEncryptionExtension -ResourceGroupName $RGName -VMName $VMName -DiskEncryptionKeyVaultUrl $DiskEncryptionKeyVaultUrl -DiskEncryptionKeyVaultId $KeyVaultResourceId
69
+ ```
70
+
71
+ This example demonstrates enabling encryption without specifying AD credentials.
72
+
73
+ ### Example 2: Enable encryption with pipelined input
74
+ ```
75
+ $params = New-Object PSObject -Property @{
76
+ ResourceGroupName = "[resource-group-name]"
77
+ VMName = "[vm-name]"
78
+ DiskEncryptionKeyVaultId = "/subscriptions/[subscription-id-guid]/resourceGroups/[resource-group-name]/providers/Microsoft.KeyVault/vaults/[keyvault-name]"
79
+ DiskEncryptionKeyVaultUrl = "https://[keyvault-name].vault.azure.net"
80
+ KeyEncryptionKeyVaultId = "/subscriptions/[subscription-id-guid]/resourceGroups/[resource-group-name]/providers/Microsoft.KeyVault/vaults/[keyvault-name]"
81
+ KeyEncryptionKeyUrl = "https://[keyvault-name].vault.azure.net/keys/[kekname]/[kek-unique-id]"
82
+ VolumeType = "All"
83
+ }
84
+
85
+ $params | Set-AzureRmVmDiskEncryptionExtension
86
+ ```
87
+
88
+ This example demonstrates sending parameters using pipelined input to enable encryption without specifying AD credentials.
89
+
90
+ ### Example 3: Enable encryption using Azure AD Client ID and Client Secret
50
91
```
51
92
$RGName = "MyResourceGroup"
52
93
$VMName = "MyTestVM"
@@ -61,7 +102,7 @@ Set-AzureRmVMDiskEncryptionExtension -ResourceGroupName $RGName -VMName $VMName
61
102
62
103
This example enables encryption using Azure AD client ID, and client secret.
63
104
64
- ### Example 2 : Enable encryption using Azure AD client ID and client certification thumbprint
105
+ ### Example 4 : Enable encryption using Azure AD client ID and client certification thumbprint
65
106
```
66
107
$RGName = "MyResourceGroup"
67
108
$VMName = "MyTestVM"
@@ -113,7 +154,7 @@ Set-AzureRmVMDiskEncryptionExtension -ResourceGroupName $RGName -VMName $VMName
113
154
114
155
This example enables encryption using Azure AD client ID and client certification thumbprints.
115
156
116
- ### Example 3 : Enable encryption using Azure AD client ID, client secret, and wrap disk encryption key by using key encryption key
157
+ ### Example 5 : Enable encryption using Azure AD client ID, client secret, and wrap disk encryption key by using key encryption key
117
158
```
118
159
$RGName = "MyResourceGroup"
119
160
$VMName = "MyTestVM"
@@ -134,7 +175,7 @@ Set-AzureRmVMDiskEncryptionExtension -ResourceGroupName $RGName -VMName $VMName
134
175
135
176
This example enables encryption using Azure AD client ID, client secret, and wrap disk encryption key by using the key encryption key.
136
177
137
- ### Example 4 : Enable encryption using Azure AD client ID, client cert thumbprint, and wrap disk encryptionkey by using key encryption key
178
+ ### Example 6 : Enable encryption using Azure AD client ID, client cert thumbprint, and wrap disk encryptionkey by using key encryption key
138
179
```
139
180
$RGName = "MyResourceGroup"
140
181
$VMName = "MyTestVM"
@@ -213,7 +254,7 @@ Specifies the client ID of the Azure AD application that has permissions to writ
213
254
214
255
` ` ` yaml
215
256
Type : String
216
- Parameter Sets : (All)
257
+ Parameter Sets : AADClientSecretParameterSet, AADClientCertParameterSet
217
258
Aliases :
218
259
219
260
Required : True
@@ -239,7 +280,7 @@ Accept wildcard characters: False
239
280
` ` `
240
281
241
282
### -DefaultProfile
242
- The credentials, account, tenant, and subscription used for communication with azure .
283
+ The credentials, account, tenant, and subscription used for communication with Azure .
243
284
244
285
` ` ` yaml
245
286
Type : IAzureContextContainer
0 commit comments