Backup-AzKeyVaultCertificate

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

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

構文

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

説明

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

  • コンテナーから誤って元の証明書を削除した場合に備えて、証明書のオフライン コピーを保持する必要があります。

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

例

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

Backup-AzKeyVaultCertificate -VaultName 'mykeyvault' -Name 'mycert'

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

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

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

Backup-AzKeyVaultCertificate -VaultName 'MyKeyVault' -Name 'MyCert' -OutputFile 'C:\Backup.blob'

C:\Backup.blob

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

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

$cert = Get-AzKeyVaultCertificate -VaultName 'MyKeyVault' -Name 'MyCert'
Backup-AzKeyVaultCertificate -Certificate $cert -OutputFile 'C:\Backup.blob' -Force

C:\Backup.blob

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

パラメーター

-Confirm

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

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

-DefaultProfile

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

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

-Force

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

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

-InputObject

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

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

-Name

シークレット名。 コマンドレットは、コンテナー名 (現在選択されている環境とシークレット名) からシークレットの FQDN を構築します。

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

-OutputFile

出力ファイル。 証明書のバックアップを格納する出力ファイル。 指定しない場合は、既定のファイル名が生成されます。

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

-VaultName

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

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

-WhatIf

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

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

入力

PSKeyVaultCertificateIdentityItem

出力

String