New-AzSnapshotConfig

Syntax

Default (Default)

New-AzSnapshotConfig
 [[-SkuName] <String>]
 [[-OsType] <OperatingSystemTypes>]
 [[-DiskSizeGB] <Int32>]
 [[-Location] <String>]
 [-EdgeZone <String>]
 [-HyperVGeneration <String>]
 [-Incremental]
 [-Tag <Hashtable>]
 [-CreateOption <String>]
 [-StorageAccountId <String>]
 [-PurchasePlan <PSPurchasePlan>]
 [-SupportsHibernation <Boolean>]
 [-ImageReference <ImageDiskReference>]
 [-SourceUri <String>]
 [-SourceResourceId <String>]
 [-EncryptionSettingsEnabled <Boolean>]
 [-DiskEncryptionKey <KeyVaultAndSecretReference>]
 [-KeyEncryptionKey <KeyVaultAndKeyReference>]
 [-DiskEncryptionSetId <String>]
 [-EncryptionType <String>]
 [-DiskAccessId <String>]
 [-NetworkAccessPolicy <String>]
 [-PublicNetworkAccess <String>]
 [-AcceleratedNetwork <Boolean>]
 [-DataAccessAuthMode <String>]
 [-Architecture <String>]
 [-ElasticSanResourceId <String>]
 [-TierOption <String>]
 [-InstantAccessDurationMinutes <Int32>]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Description

Examples

Example 1

$snapshotconfig = New-AzSnapshotConfig -Location 'Central US' -DiskSizeGB 5 -AccountType StandardLRS -OsType Windows -CreateOption Empty -EncryptionSettingsEnabled $true;
$secretUrl = 'https://myvault.vault-int.azure-int.net/secrets/123/';
$secretId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault123';
$keyUrl = 'https://myvault.vault-int.azure-int.net/keys/456';
$keyId = '/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.KeyVault/vaults/TestVault456';
$snapshotconfig = Set-AzSnapshotDiskEncryptionKey -Snapshot $snapshotconfig -SecretUrl $secretUrl -SourceVaultId $secretId;
$snapshotconfig = Set-AzSnapshotKeyEncryptionKey -Snapshot $snapshotconfig -KeyUrl $keyUrl -SourceVaultId $keyId;
New-AzSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Snapshot $snapshotconfig;

Example 2

$elasticSanVolumeSnapshotResourceId = "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.ElasticSan/elasticSans/san1/volumeGroups/volumegroup1/snapshots/snapshot1"
$snapshotconfig = New-AzSnapshotConfig -Location 'France Central' -AccountType Standard_LRS -CreateOption CopyFromSanSnapshot -ElasticSanResourceId $elasticSanVolumeSnapshotResourceId
New-AzSnapshot -ResourceGroupName 'ResourceGroup01' -SnapshotName 'Snapshot01' -Snapshot $snapshotconfig;

Example 3

New-AzSnapshotConfig -CreateOption Empty -Location 'Central US' -SourceUri 'https://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd'

Parameters

-AcceleratedNetwork

True if the image from which the OS disk is created supports accelerated networking.

Parameter properties

Parameter sets

-Architecture

CPU architecture supported by an OS disk. Possible values are "X64" and "Arm64".

Parameter properties

Parameter sets

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Parameter sets

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

Parameter properties

Parameter sets

-DataAccessAuthMode

Additional authentication requirements when exporting or uploading to a disk or snapshot.

Parameter properties

Parameter sets

-DefaultProfile

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

Parameter properties

Parameter sets

-DiskAccessId

Gets or sets ARM id of the DiskAccess resource for using private endpoints on.

Parameter properties

Parameter sets

-DiskEncryptionKey

Specifies the disk encryption key object on a snapshot.

Parameter properties

Parameter sets

-DiskEncryptionSetId

Specifies the resource Id of the disk encryption set to use for enabling encryption at rest.

Parameter properties

Parameter sets

-DiskSizeGB

Specifies the size of the disk in GB.

Parameter properties

Parameter sets

-EdgeZone

Sets the edge zone name. If set, the query will be routed to the specified edgezone instead of the main region.

Parameter properties

Parameter sets

-ElasticSanResourceId

Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot.

Parameter properties

Parameter sets

-EncryptionSettingsEnabled

Enable encryption settings.

Parameter properties

Parameter sets

-EncryptionType

The type of key used to encrypt the data of the disk. Available values are: 'EncryptionAtRestWithPlatformKey', 'EncryptionAtRestWithCustomerKey'

Parameter properties

Parameter sets

-HyperVGeneration

The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Allowed values are V1 and V2.

Parameter properties

Parameter sets

-ImageReference

Specifies the image reference on a snapshot.

Parameter properties

Parameter sets

-Incremental

Specifies an incremental snapshot. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.

Parameter properties

Parameter sets

-InstantAccessDurationMinutes

For snapshots created from Premium SSD v2 or Ultra disk, this property determines the time in minutes the snapshot is retained for instant access to enable faster restore.

Parameter properties

Parameter sets

-KeyEncryptionKey

Specifies the Key encryption key on a snapshot.

Parameter properties

Parameter sets

-Location

Specifies a location.

Parameter properties

Parameter sets

-NetworkAccessPolicy

Network access policy defines the network access policy. Possible values include: 'AllowAll', 'AllowPrivate', 'DenyAll'

Parameter properties

Parameter sets

-OsType

Specifies the OS type.

Parameter properties

Parameter sets

-PublicNetworkAccess

Policy for controlling export on the disk.

Parameter properties

Parameter sets

-PurchasePlan

Sets the purchase plan for the snapshot. Used for establishing the purchase context of any 3rd Party artifact through Marketplace.

Parameter properties

Parameter sets

-SkuName

Specifies the Sku name of the storage account.

Parameter properties

Parameter sets

-SourceResourceId

Specifies the source resource ID.

Parameter properties

Parameter sets

-SourceUri

Specifies the source Uri.

Parameter properties

Parameter sets

-StorageAccountId

Specifies the storage account ID.

Parameter properties

Parameter sets

-SupportsHibernation

Indicates if the OS on the snapshot supports hibernation with $true or $false

Parameter properties

Parameter sets

-Tag

Key-value pairs in the form of a hash table. For example: @{key0="value0";key1=$null;key2="value2"}

Parameter properties

Parameter sets

-TierOption

When createOption CopyStart, the snapshot will be copied at a quicker speed. Possible values include: 'None', 'Enhanced'

Parameter properties

Parameter sets

-WhatIf

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

Parameter properties

Parameter sets

CommonParameters

Inputs

String

Nullable<T>

Int32

Hashtable

ImageDiskReference

Nullable<T>

KeyVaultAndSecretReference

KeyVaultAndKeyReference

Outputs

PSSnapshot