< Back

Set-AzureRmDiskUpdateKeyEncryptionKey

Tue Jan 29, 2019 9:39 pm

NAME Set-AzureRmDiskUpdateKeyEncryptionKey



SYNOPSIS

Sets the key encryption key properties on a disk update object.





SYNTAX

Set-AzureRmDiskUpdateKeyEncryptionKey [-DiskUpdate] <PSDiskUpdate> [[-KeyUrl] <String>] [[-SourceVaultId] <String>] [-DefaultProfile

<IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Set-AzureRmDiskUpdateKeyEncryptionKey cmdlet sets the key encryption key properties on a disk update object.





PARAMETERS

-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-DiskUpdate <PSDiskUpdate>

Specifies a local disk update object.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName, ByValue)

Accept wildcard characters? false



-KeyUrl <String>

Specifes the key Url.



Required? false

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-SourceVaultId <String>

Specifies the source vault ID.



Required? false

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

Microsoft.Azure.Management.Compute.Models.DiskUpdate

System.String





OUTPUTS

Microsoft.Azure.Management.Compute.Models.DiskUpdate







NOTES









Example 1



PS C:\\> $diskupdateconfig = New-AzureRmDiskUpdateConfig -DiskSizeGB 10 -AccountType PremiumLRS -OsType Windows -CreateOption Empty

-EncryptionSettingsEnabled $true;

PS C:\\> $secretUrl = https://myvault.vault-int.azure-int.net/secrets/123/;

PS C:\\> $secretId =

'/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123';

PS C:\\> $keyUrl = https://myvault.vault-int.azure-int.net/keys/456;

PS C:\\> $keyId =

'/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456';

PS C:\\> $diskupdateconfig = Set-AzureRmDiskUpdateDiskEncryptionKey -DiskUpdate $diskupdateconfig -SecretUrl $secretUrl -SourceVaultId $secretId;

PS C:\\> $diskupdateconfig = Set-AzureRmDiskUpdateKeyEncryptionKey -DiskUpdate $diskupdateconfig -KeyUrl $keyUrl -SourceVaultId $keyId;

PS C:\\> Update-AzureRmDisk -ResourceGroupName 'ResourceGroup01' -DiskName 'Disk01' -DiskUpdate $diskupdateconfig;



The first command creates a local empty disk update object with size 10GB in Premium_LRS storage account type. It also sets Windows OS type and

enables encryption settings. The second and third commands set the disk encryption key and key encryption key settings for the disk update object.

The last command takes the disk update object and updates an existing disk with name 'Disk01' in resource group 'ResourceGroup01'.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... ryptionkey