Backup-AzureKeyVaultKey

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

重要

Az PowerShell モジュール で AzureRM PowerShell モジュールのすべての機能およびその他を利用できるようになったため、2024 年 2 月 29 日に AzureRM PowerShell モジュールは廃止になります。

サービスの中断を回避するために、2024 年 2 月 29 日までに、AzureRM PowerShell モジュールを使用するスクリプトを更新して、Az PowerShell モジュールを使用するようにしてください。 スクリプトを自動的に更新するには、 クイックスタート ガイドに従ってください。

構文

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

説明

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

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

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

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

PS C:\Users\username\> Backup-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'

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

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

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

PS C:\> Backup-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey' -OutputFile 'C:\Backup.blob'

C:\Backup.blob

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

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

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

C:\Backup.blob

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

パラメーター

-Confirm

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

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

-DefaultProfile

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

Type:IAzureContextContainer
Aliases: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

-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

パラメーター: InputObject (ByValue)

出力

String