Set-AzureRmSnapshotUpdateKeyEncryptionKey

NAME Set-AzureRmSnapshotUpdateKeyEncryptionKey



SYNOPSIS

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





SYNTAX

Set-AzureRmSnapshotUpdateKeyEncryptionKey [-SnapshotUpdate] <PSSnapshotUpdate> [[-KeyUrl] <String>] [[-SourceVaultId] <String>] [-DefaultProfile

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





DESCRIPTION

The Set-AzureRmSnapshotUpdateKeyEncryptionKey cmdlet sets the key encryption key properties on a snapshot 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



-KeyUrl <String>

Specifes the key Url.



Required? false

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-SnapshotUpdate <PSSnapshotUpdate>

Specifies a local snapshot update object.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName, ByValue)

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.SnapshotUpdate

System.String





OUTPUTS

Microsoft.Azure.Management.Compute.Models.SnapshotUpdate







NOTES









Example 1



PS C:\\> $snapshotupdateconfig = New-AzureRmSnapshotUpdateConfig -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:\\> $snapshotupdateconfig = Set-AzureRmSnapshotUpdateDiskEncryptionKey -SnapshotUpdate $snapshotupdateconfig -SecretUrl $secretUrl

-SourceVaultId $secretId;

PS C:\\> $snapshotupdateconfig = Set-AzureRmSnapshotUpdateKeyEncryptionKey -SnapshotUpdate $snapshotupdateconfig -KeyUrl $keyUrl -SourceVaultId

$keyId;

PS C:\\> Update-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -SnapshotUpdate $snapshotupdateconfig;



The first command creates a local empty snapshot 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 snapshot update

object. The last command takes the snapshot update object and updates an existing snapshot with name 'Snapshot01' in resource group

'ResourceGroup01'.







RELATED LINKS

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