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
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| 型: | SwitchParameter |
| Aliases: | cf |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
| 型: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Force
指定されたファイルが存在する場合は上書きする
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-HsmName
HSM 名。 コマンドレットは、名前と現在選択されている環境に基づいて、マネージド HSM の FQDN を構築します。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-InputObject
取得呼び出しの出力からパイプライン化された、バックアップするキー バンドル。
| 型: | PSKeyVaultKeyIdentityItem |
| Aliases: | Key |
| 配置: | 0 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Name
バックアップするキーの名前を指定します。
| 型: | String |
| Aliases: | KeyName |
| 配置: | 1 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-OutputFile
バックアップ BLOB が格納される出力ファイルを指定します。 このパラメーターを指定しない場合、このコマンドレットによってファイル名が生成されます。 既存の出力ファイルの名前を指定した場合、操作は完了せず、バックアップ ファイルが既に存在するというエラー メッセージが返されます。
| 型: | String |
| 配置: | 2 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-VaultName
バックアップするキーを含むキー コンテナーの名前を指定します。
| 型: | String |
| 配置: | 0 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| 型: | SwitchParameter |
| Aliases: | wi |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |