Backup-AzKeyVaultSecret

  • リファレンス
モジュール:
Az.KeyVault

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

構文

Backup-AzKeyVaultSecret
      [-VaultName] <String>
      [-Name] <String>
      [[-OutputFile] <String>]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Backup-AzKeyVaultSecret
      [-InputObject] <PSKeyVaultSecretIdentityItem>
      [[-OutputFile] <String>]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

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

  • キー コンテナー内のシークレットを誤って削除した場合に備えてオフライン コピーを作成できるように、シークレットのコピーをエスクローする必要があります。
  • キー コンテナーにシークレットを追加し、そのシークレットを別の Azure リージョンに複製して、分散アプリケーションのすべてのインスタンスから使用できるようにします。 Backup-AzKeyVaultSecret コマンドレットを使用して暗号化された形式でシークレットを取得し、Restore-AzKeyVaultSecret コマンドレットを使用して、2 番目のリージョンにキー コンテナーを指定します。 (リージョンは同じ地域に属している必要があることに注意してください)。

例

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

Backup-AzKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'

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

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

例 2: 指定したファイル名にシークレットをバックアップし、プロンプトを表示せずに既存のファイルを上書きする

Backup-AzKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret' -OutputFile 'C:\Backup.blob' -Force

C:\Backup.blob

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

例 3: 以前に取得したシークレットを指定したファイル名にバックアップする

$secret = Get-AzKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
Backup-AzKeyVaultSecret -Secret $secret -OutputFile 'C:\Backup.blob'

C:\Backup.blob

このコマンドでは、$secret オブジェクトのコンテナー名と名前を使用してシークレットを取得し、そのバックアップを Backup.blob という名前のファイルに保存します。

パラメーター

-Confirm

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

型:SwitchParameter
Aliases:cf
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-DefaultProfile

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

型:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Force

出力ファイルが存在する場合は、上書きする前に確認を求められます。

型:SwitchParameter
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-InputObject

バックアップするシークレット。取得呼び出しの出力からパイプライン化されます。

型:PSKeyVaultSecretIdentityItem
Aliases:Secret
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Name

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

型:String
Aliases:SecretName
配置: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
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

PSKeyVaultSecretIdentityItem

出力

String