New-AzureRmSnapshotConfig

構成可能なスナップショット オブジェクトを作成します。

警告

AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。

AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。

構文

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

説明

New-AzureRmSnapshotConfig コマンドレットは、構成可能なスナップショット オブジェクトを作成します。

例 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;

最初のコマンドでは、ストレージ アカウントの種類でサイズが 5 GB のローカルの空のスナップショット オブジェクトStandard_LRS作成されます。 また、Windows OS の種類を設定し、暗号化設定を有効にします。 2 番目と 3 番目のコマンドは、スナップショット オブジェクトのディスク暗号化キーとキー暗号化キーの設定を設定します。 最後のコマンドは、スナップショット オブジェクトを取得し、リソース グループ 'ResourceGroup01' に 'Snapshot01' という名前のスナップショットを作成します。

パラメーター

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

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

-CreateOption

このコマンドレットで、プラットフォームまたはユーザー イメージから仮想マシンにディスクを作成するか、空のディスクを作成するか、既存のディスクを接続するかを指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DiskEncryptionKey

スナップショットのディスク暗号化キー オブジェクトを指定します。

Type:KeyVaultAndSecretReference
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DiskSizeGB

ディスクのサイズを GB 単位で指定します。

Type:Int32
Position:2
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-EncryptionSettingsEnabled

暗号化設定を有効にします。

Type:Nullable<T>[Boolean]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ImageReference

スナップショットのイメージ参照を指定します。

Type:ImageDiskReference
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-KeyEncryptionKey

スナップショットのキー暗号化キーを指定します。

Type:KeyVaultAndKeyReference
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Location

場所を指定します。

Type:String
Position:3
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-OsType

OS の種類を指定します。

Type:Nullable<T>[OperatingSystemTypes]
Accepted values:Windows, Linux
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SkuName

ストレージ アカウントの SKU 名を指定します。

Type:String
Aliases:AccountType
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SourceResourceId

ソース リソース ID を指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SourceUri

ソース URI を指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-StorageAccountId

ストレージ アカウント ID を指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Tag

ハッシュ テーブルの形式のキーと値のペア。 例: @{key0="value0";key1=$null;key2="value2"}

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

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

入力

String

Nullable<T>[[Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes, Microsoft.Azure.Management.Compute, Version=21.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]

Int32

Hashtable

ImageDiskReference

Nullable<T>[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

KeyVaultAndSecretReference

KeyVaultAndKeyReference

出力

PSSnapshot