< Back
New-AzureRmSnapshotConfig
Post
NAME New-AzureRmSnapshotConfig
SYNOPSIS
Creates a configurable snapshot object.
SYNTAX
New-AzureRmSnapshotConfig [[-SkuName] <String>] [[-OsType] {Windows | Linux}] [[-DiskSizeGB] <Int32>] [[-Location] <String>] [-CreateOption
<String>] [-DefaultProfile <IAzureContextContainer>] [-DiskEncryptionKey <KeyVaultAndSecretReference>] [-EncryptionSettingsEnabled <Boolean>]
[-ImageReference <ImageDiskReference>] [-KeyEncryptionKey <KeyVaultAndKeyReference>] [-SourceResourceId <String>] [-SourceUri <String>]
[-StorageAccountId <String>] [-Tag <Hashtable>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The New-AzureRmSnapshotConfig cmdlet creates a configurable snapshot object.
PARAMETERS
-CreateOption <String>
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.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-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
-ImageReference <ImageDiskReference>
Specifies the image reference on a snapshot.
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
-Location <String>
Specifies a location.
Required? false
Position? 3
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
-SourceResourceId <String>
Specifies the source resource ID.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SourceUri <String>
Specifies the source Uri.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-StorageAccountId <String>
Specifies the storage account ID.
Required? false
Position? named
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? named
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.PSSnapshot
NOTES
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'.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... shotconfig
SYNOPSIS
Creates a configurable snapshot object.
SYNTAX
New-AzureRmSnapshotConfig [[-SkuName] <String>] [[-OsType] {Windows | Linux}] [[-DiskSizeGB] <Int32>] [[-Location] <String>] [-CreateOption
<String>] [-DefaultProfile <IAzureContextContainer>] [-DiskEncryptionKey <KeyVaultAndSecretReference>] [-EncryptionSettingsEnabled <Boolean>]
[-ImageReference <ImageDiskReference>] [-KeyEncryptionKey <KeyVaultAndKeyReference>] [-SourceResourceId <String>] [-SourceUri <String>]
[-StorageAccountId <String>] [-Tag <Hashtable>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The New-AzureRmSnapshotConfig cmdlet creates a configurable snapshot object.
PARAMETERS
-CreateOption <String>
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.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-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
-ImageReference <ImageDiskReference>
Specifies the image reference on a snapshot.
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
-Location <String>
Specifies a location.
Required? false
Position? 3
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
-SourceResourceId <String>
Specifies the source resource ID.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SourceUri <String>
Specifies the source Uri.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-StorageAccountId <String>
Specifies the storage account ID.
Required? false
Position? named
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? named
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.PSSnapshot
NOTES
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'.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... shotconfig