New-​Azure​Rm​Snapshot​Config

Creates a configurable snapshot object.

Syntax

New-AzureRmSnapshotConfig
   [[-AccountType] <StorageAccountTypes>]
   [[-OsType] <OperatingSystemTypes>]
   [[-EncryptionSettingsEnabled] <Boolean>]
   [[-DiskEncryptionKey] <KeyVaultAndSecretReference>]
   [[-KeyEncryptionKey] <KeyVaultAndKeyReference>]
   [[-DiskSizeGB] <Int32>]
   [[-Location] <String>]
   [[-Tag] <Hashtable>]
   [[-CreateOption] <DiskCreateOption>]
   [[-StorageAccountId] <String>]
   [[-ImageReference] <ImageDiskReference>]
   [[-SourceUri] <String>]
   [[-SourceResourceId] <String>]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]

Description

The New-AzureRmSnapshotConfig cmdlet creates a configurable snapshot object.

Examples

Example 1

PS C:\> $snapshotconfig = New-AzureRmSnapshotConfig -Location 'Central US' -DiskSizeGB 5 -AccountType StandardLRS -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:\> $snapshotconfig = Set-AzureRmSnapshotDiskEncryptionKey -Snapshot $snapshotconfig -SecretUrl $secretUrl -SourceVaultId $secretId;
PS C:\> $snapshotconfig = Set-AzureRmSnapshotKeyEncryptionKey -Snapshot $snapshotconfig -KeyUrl $keyUrl -SourceVaultId $keyId;
PS C:\> New-AzureRmSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Snapshot $snapshotconfig;

The first command creates a local empty snapshot object with size 5GB in Standard_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 object. The last command takes the snapshot object and creates a snapshot with name 'Snapshot01' in resource group 'ResourceGroup01'.

Optional Parameters

-AccountType

Specifies the storage account type.

Type:StorageAccountTypes
Parameter Sets:StandardLRS, PremiumLRS
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CreateOption

Specifies whether this cmdlet creates a disk in the virtual machine from a platform or user image, creates an empty disk, or attaches an existing disk.

Type:DiskCreateOption
Parameter Sets:Empty, Attach, FromImage, Import, Copy, Restore
Position:5
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-DiskEncryptionKey

Specifies the disk encryption key object on a snapshot.

Type:KeyVaultAndSecretReference
Position:11
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-DiskSizeGB

Specifies the size of the disk in GB.

Type:Int32
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-EncryptionSettingsEnabled

Enable encryption settings.

Type:Boolean
Position:10
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ImageReference

Specifies the image reference on a snapshot.

Type:ImageDiskReference
Position:7
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-KeyEncryptionKey

Specifies the Key encryption key on a snapshot.

Type:KeyVaultAndKeyReference
Position:12
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Location

Specifies a location.

Type:String
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-OsType

Specifies the OS type.

Type:OperatingSystemTypes
Parameter Sets:Windows, Linux
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-SourceResourceId

Specifies the source resource ID.

Type:String
Position:9
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-SourceUri

Specifies the source Uri.

Type:String
Position:8
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-StorageAccountId

Specifies the storage account ID.

Type:String
Position:6
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Tag

Specifies that resources and resource groups can be tagged with a set of name-value pairs.

Type:Hashtable
Position:4
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

System.Nullable`1[[Microsoft.Azure.Management.Compute.Models.StorageAccountTypes, Microsoft.Azure.Management.Compute, Version=14.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]

Outputs

Microsoft.Azure.Management.Compute.Models.Snapshot