Backup-AzKeyVaultKey

キー コンテナー内のキーをバックアップします。

構文

Backup-AzKeyVaultKey
      [-VaultName] <String>
      [-Name] <String>
      [[-OutputFile] <String>]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Backup-AzKeyVaultKey
      -HsmName <String>
      [-Name] <String>
      [[-OutputFile] <String>]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Backup-AzKeyVaultKey
      [-InputObject] <PSKeyVaultKeyIdentityItem>
      [[-OutputFile] <String>]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Backup-AzKeyVaultKey コマンドレットは、指定されたキーをダウンロードしてファイルに格納することで、キー コンテナーにバックアップします。 キーのバージョンが複数ある場合は、すべてのバージョンがバックアップに含まれます。 ダウンロードしたコンテンツは暗号化されているため、Azure Key Vaultの外部では使用できません。 バックアップされたキーは、バックアップ元のサブスクリプション内の任意のキー コンテナーに復元できます。 このコマンドレットを使用する一般的な理由は次のとおりです。

  • キー コンテナー内のキーを誤って削除した場合に備えてオフライン コピーを作成できるように、キーのコピーをエスクローする必要があります。

  • Key Vaultを使用してキーを作成し、分散アプリケーションのすべてのインスタンスからキーを使用できるように、キーを別の Azure リージョンに複製する必要があります。 Backup-AzKeyVaultKey コマンドレットを使用して暗号化された形式でキーを取得し、Restore-AzKeyVaultKey コマンドレットを使用して、2 番目のリージョンでキー コンテナーを指定します。

例 1: 自動的に生成されたファイル名を使用してキーをバックアップする

Backup-AzKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'

C:\Users\username\mykeyvault-mykey-1527029447.01191

このコマンドは、MyKeyVault という名前のキー コンテナーから MyKey という名前のキーを取得し、そのキーのバックアップを自動的に名前が付けられたファイルに保存し、ファイル名を表示します。

例 2: 指定したファイル名にキーをバックアップする

Backup-AzKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey' -OutputFile 'C:\Backup.blob'

C:\Backup.blob

このコマンドは、Key vaultnamed MyKeyVault から MyKey という名前のキーを取得し、そのキーのバックアップを Backup.blob という名前のファイルに保存します。

例 3: 以前に取得したキーを指定したファイル名にバックアップし、プロンプトを表示せずにコピー先ファイルを上書きします。

$key = Get-AzKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'
Backup-AzKeyVaultKey -Key $key -OutputFile 'C:\Backup.blob' -Force

C:\Backup.blob

このコマンドは、$keyという名前のキーのバックアップを作成します。$keyという名前のコンテナー内の名前。VaultName を Backup.blob という名前のファイルに保存し、ファイルが既に存在する場合は自動的に上書きします。

パラメーター

-Confirm

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

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

-DefaultProfile

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

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

-Force

指定されたファイルが存在する場合は上書きする

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

-HsmName

HSM 名。 コマンドレットは、名前と現在選択されている環境に基づいて、マネージド HSM の FQDN を構築します。

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

-InputObject

取得呼び出しの出力からパイプライン化された、バックアップするキー バンドル。

Type:PSKeyVaultKeyIdentityItem
Aliases:Key
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-Name

バックアップするキーの名前を指定します。

Type:String
Aliases:KeyName
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-OutputFile

バックアップ BLOB が格納される出力ファイルを指定します。 このパラメーターを指定しない場合、このコマンドレットによってファイル名が生成されます。 既存の出力ファイルの名前を指定した場合、操作は完了せず、バックアップ ファイルが既に存在することを示すエラー メッセージが返されます。

Type:String
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-VaultName

バックアップするキーを含むキー コンテナーの名前を指定します。

Type:String
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

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

入力

PSKeyVaultKeyIdentityItem

出力

String