Skip to content

6.0.0 test #561

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 1, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,18 @@ Enables encryption on a running IaaS virtual machine in Azure.

## SYNTAX

### AADClientSecretParameterSet (Default)
### SinglePassParameterSet (Default)
```
Set-AzureRmVMDiskEncryptionExtension [-ResourceGroupName] <String> [-VMName] <String>
[-DiskEncryptionKeyVaultUrl] <String> [-DiskEncryptionKeyVaultId] <String> [[-KeyEncryptionKeyUrl] <String>]
[[-KeyEncryptionKeyVaultId] <String>] [[-KeyEncryptionAlgorithm] <String>] [[-VolumeType] <String>]
[[-SequenceVersion] <String>] [[-TypeHandlerVersion] <String>] [[-Name] <String>] [[-Passphrase] <String>]
[-Force] [-DisableAutoUpgradeMinorVersion] [-SkipVmBackup] [-ExtensionType <String>]
[-ExtensionPublisherName <String>] [-EncryptFormatAll] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```

### AADClientSecretParameterSet
```
Set-AzureRmVMDiskEncryptionExtension [-ResourceGroupName] <String> [-VMName] <String> [-AadClientID] <String>
[-AadClientSecret] <String> [-DiskEncryptionKeyVaultUrl] <String> [-DiskEncryptionKeyVaultId] <String>
Expand Down Expand Up @@ -46,7 +57,37 @@ It is advised that you save your work on the virtual machine before you run this

## EXAMPLES

### Example 1: Enable encryption using Azure AD Client ID and Client Secret
### Example 1: Enable encryption
```
$RGName = "MyResourceGroup"
$VMName = "MyTestVM"
$VaultName= "MyKeyVault"
$KeyVault = Get-AzureRmKeyVault -VaultName $VaultName -ResourceGroupName $RGName
$DiskEncryptionKeyVaultUrl = $KeyVault.VaultUri
$KeyVaultResourceId = $KeyVault.ResourceId
Set-AzureRmVMDiskEncryptionExtension -ResourceGroupName $RGName -VMName $VMName -DiskEncryptionKeyVaultUrl $DiskEncryptionKeyVaultUrl -DiskEncryptionKeyVaultId $KeyVaultResourceId
```

This example demonstrates enabling encryption without specifying AD credentials.

### Example 2: Enable encryption with pipelined input
```
$params = New-Object PSObject -Property @{
ResourceGroupName = "[resource-group-name]"
VMName = "[vm-name]"
DiskEncryptionKeyVaultId = "/subscriptions/[subscription-id-guid]/resourceGroups/[resource-group-name]/providers/Microsoft.KeyVault/vaults/[keyvault-name]"
DiskEncryptionKeyVaultUrl = "https://[keyvault-name].vault.azure.net"
KeyEncryptionKeyVaultId = "/subscriptions/[subscription-id-guid]/resourceGroups/[resource-group-name]/providers/Microsoft.KeyVault/vaults/[keyvault-name]"
KeyEncryptionKeyUrl = "https://[keyvault-name].vault.azure.net/keys/[kekname]/[kek-unique-id]"
VolumeType = "All"
}

$params | Set-AzureRmVmDiskEncryptionExtension
```

This example demonstrates sending parameters using pipelined input to enable encryption without specifying AD credentials.

### Example 3: Enable encryption using Azure AD Client ID and Client Secret
```
$RGName = "MyResourceGroup"
$VMName = "MyTestVM"
Expand All @@ -61,7 +102,7 @@ Set-AzureRmVMDiskEncryptionExtension -ResourceGroupName $RGName -VMName $VMName

This example enables encryption using Azure AD client ID, and client secret.

### Example 2: Enable encryption using Azure AD client ID and client certification thumbprint
### Example 4: Enable encryption using Azure AD client ID and client certification thumbprint
```
$RGName = "MyResourceGroup"
$VMName = "MyTestVM"
Expand Down Expand Up @@ -113,7 +154,7 @@ Set-AzureRmVMDiskEncryptionExtension -ResourceGroupName $RGName -VMName $VMName

This example enables encryption using Azure AD client ID and client certification thumbprints.

### Example 3: Enable encryption using Azure AD client ID, client secret, and wrap disk encryption key by using key encryption key
### Example 5: Enable encryption using Azure AD client ID, client secret, and wrap disk encryption key by using key encryption key
```
$RGName = "MyResourceGroup"
$VMName = "MyTestVM"
Expand All @@ -134,7 +175,7 @@ Set-AzureRmVMDiskEncryptionExtension -ResourceGroupName $RGName -VMName $VMName

This example enables encryption using Azure AD client ID, client secret, and wrap disk encryption key by using the key encryption key.

### Example 4: Enable encryption using Azure AD client ID, client cert thumbprint, and wrap disk encryptionkey by using key encryption key
### Example 6: Enable encryption using Azure AD client ID, client cert thumbprint, and wrap disk encryptionkey by using key encryption key
```
$RGName = "MyResourceGroup"
$VMName = "MyTestVM"
Expand Down Expand Up @@ -213,7 +254,7 @@ Specifies the client ID of the Azure AD application that has permissions to writ

```yaml
Type: String
Parameter Sets: (All)
Parameter Sets: AADClientSecretParameterSet, AADClientCertParameterSet
Aliases:

Required: True
Expand All @@ -239,7 +280,7 @@ Accept wildcard characters: False
```

### -DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
The credentials, account, tenant, and subscription used for communication with Azure.

```yaml
Type: IAzureContextContainer
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ A string,string dictionary of tags associated with this account
```yaml
Type: Hashtable
Parameter Sets: (All)
Aliases: Tags
Aliases:

Required: False
Position: 4
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ A string,string dictionary of tags associated with this account that should repl
```yaml
Type: Hashtable
Parameter Sets: (All)
Aliases: Tags
Aliases:

Required: False
Position: 1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ Adds a trusted identity provider to the specified Data Lake Store account.
### [Enable-AzureRmDataLakeStoreKeyVault](Enable-AzureRmDataLakeStoreKeyVault.md)
Attempts to enable a user managed Key Vault for encryption of the specified Data Lake Store account.

### [Export-AzureRmDataLakeStoreChildItemProperties](Export-AzureRmDataLakeStoreChildItemProperties.md)
Exports the properties (Disk usage and Acl) for the entire tree from the specified path to a ouput path

### [Export-AzureRmDataLakeStoreItem](Export-AzureRmDataLakeStoreItem.md)
Downloads a file from Data Lake Store.

Expand All @@ -34,6 +37,9 @@ Gets details of a Data Lake Store account.
### [Get-AzureRmDataLakeStoreChildItem](Get-AzureRmDataLakeStoreChildItem.md)
Gets the list of items in a folder in Data Lake Store.

### [Get-AzureRmDataLakeStoreChildItemSummary](Get-AzureRmDataLakeStoreChildItemSummary.md)
Gets the summary of total size, files and directories contained in the path specified

### [Get-AzureRmDataLakeStoreFirewallRule](Get-AzureRmDataLakeStoreFirewallRule.md)
Gets the specified firewall rules in the specified Data Lake Store.
If no firewall rule is specified, then lists all firewall rules for the account.
Expand Down
Loading