New-AzureRmSnapshotUpdateConfig

NAME New-AzureRmSnapshotUpdateConfig



SYNOPSIS

Creates a configurable snapshot update object.





SYNTAX

New-AzureRmSnapshotUpdateConfig [[-SkuName] <String>] [[-OsType] {Windows | Linux}] [[-DiskSizeGB] <Int32>] [[-Tag] <Hashtable>] [-DefaultProfile

<IAzureContextContainer>] [-DiskEncryptionKey <KeyVaultAndSecretReference>] [-EncryptionSettingsEnabled <Boolean>] [-KeyEncryptionKey

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





DESCRIPTION

The New-AzureRmSnapshotUpdateConfig cmdlet creates a configurable 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



-DiskEncryptionKey <KeyVaultAndSecretReference>

Specifies the disk encryption key object on a snapshot.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DiskSizeGB <Int32>

Specifies the size of the disk in GB.



Required? false

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-EncryptionSettingsEnabled <Boolean>

Enable encryption settings.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-KeyEncryptionKey <KeyVaultAndKeyReference>

Specifies the Key encryption key on a snapshot.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-OsType <OperatingSystemTypes>

Specifies the OS type.



Required? false

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-SkuName <String>

Specifies the Sku name of the storage account.



Required? false

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Tag <Hashtable>

Key-value pairs in the form of a hash table. For example:



@{key0="value0";key1=$null;key2="value2"}



Required? false

Position? 3

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

None

This cmdlet does not accept any input.





OUTPUTS

Microsoft.Azure.Commands.Compute.Automation.Models.PSSnapshotUpdate







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





Example 2



PS C:\\> New-AzureRmSnapshotUpdateConfig -DiskSizeGB 10 | Update-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01';



This command updates an existing snapshot with name 'Snapshot01' in resource group 'ResourceGroup01' to 10 GB disk size.







RELATED LINKS

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