Import-AzKeyVaultCertificate

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

証明書をキー コンテナーにインポートします。

構文

Import-AzKeyVaultCertificate
      [-VaultName] <String>
      [-Name] <String>
      -FilePath <String>
      [-Password <SecureString>]
      [-PolicyPath <String>]
      [-PolicyObject <PSKeyVaultCertificatePolicy>]
      [-Tag <Hashtable>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Import-AzKeyVaultCertificate
      [-VaultName] <String>
      [-Name] <String>
      -CertificateString <String>
      [-ContentType <String>]
      [-Password <SecureString>]
      [-PolicyPath <String>]
      [-PolicyObject <PSKeyVaultCertificatePolicy>]
      [-Tag <Hashtable>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Import-AzKeyVaultCertificate
      [-VaultName] <String>
      [-Name] <String>
      [-PolicyPath <String>]
      [-PolicyObject <PSKeyVaultCertificatePolicy>]
      [-CertificateCollection] <X509Certificate2Collection>
      [-Tag <Hashtable>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Import-AzKeyVaultCertificate コマンドレットは、証明書をキー コンテナーにインポートします。 次のいずれかの方法を使用して、インポートする証明書を作成できます。

例

例 1: キー コンテナー証明書をインポートする

$Password = ConvertTo-SecureString -String "123" -AsPlainText -Force
Import-AzKeyVaultCertificate -VaultName "ContosoKV01" -Name "ImportCert01" -FilePath "C:\Users\contosoUser\Desktop\import.pfx" -Password $Password

Name        : importCert01
Certificate : [Subject]
                CN=contoso.com

              [Issuer]
                CN=contoso.com

              [Serial Number]
                XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

              [Not Before]
                2/8/2016 3:11:45 PM

              [Not After]
                8/8/2016 4:21:45 PM

              [Thumbprint]
                XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Thumbprint  : XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Tags        :
Enabled     : True
Created     : 2/8/2016 11:50:43 PM
Updated     : 2/8/2016 11:50:43 PM

最初のコマンドでは、ConvertTo-SecureString コマンドレットを使用してセキュリティで保護されたパスワードを作成し、$Password変数に格納します。 2 番目のコマンドは、ImportCert01 という名前の証明書を CosotosoKV01 キー コンテナーにインポートします。

例 2: CertificateString によるキー コンテナー証明書のインポート

$Password = ConvertTo-SecureString -String "123" -AsPlainText -Force
$Base64String = [System.Convert]::ToBase64String([System.IO.File]::ReadAllBytes("import.pfx"))
Import-AzKeyVaultCertificate -VaultName "ContosoKV01" -Name "ImportCert01" -CertificateString $Base64String -Password $Password

Name        : importCert01
Certificate : [Subject]
                CN=contoso.com

              [Issuer]
                CN=contoso.com

              [Serial Number]
                XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

              [Not Before]
                2/8/2016 3:11:45 PM

              [Not After]
                8/8/2016 4:21:45 PM

              [Thumbprint]
                XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Thumbprint  : XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Tags        :
Enabled     : True
Created     : 2/8/2016 11:50:43 PM
Updated     : 2/8/2016 11:50:43 PM

最初のコマンドでは、ConvertTo-SecureString コマンドレットを使用してセキュリティで保護されたパスワードを作成し、$Password変数に格納します。 2 番目のコマンドは、Base64 でエンコードされた表現として証明書を読み取ります。 3 番目のコマンドは、ImportCert01 という名前の証明書を CosotosoKV01 キー コンテナーにインポートします。

例 3: PolicyFile を使用してキー コンテナー証明書をインポートする

$Password = ConvertTo-SecureString -String "123" -AsPlainText -Force
Import-AzKeyVaultCertificate -VaultName "ContosoKV01" -Name "ImportCert01" -FilePath "C:\Users\contosoUser\Desktop\import.pfx" -Password $Password -PolicyPath "C:\Users\contosoUser\Desktop\policy.json"

Name        : importCert01
Certificate : [Subject]
                CN=contoso.com

              [Issuer]
                CN=contoso.com

              [Serial Number]
                XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

              [Not Before]
                2/8/2016 3:11:45 PM

              [Not After]
                8/8/2016 4:21:45 PM

              [Thumbprint]
                XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

KeyId         : https://ContosoKV01.vault.azure.net/keys/ImportCert01/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
SecretId      : https://ContosoKV01.vault.azure.net/secrets/ImportCert01/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Thumbprint    : XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Policy        :
                Secret Content Type: application/x-pkcs12
                Issuer Name    : Unknown
                Created On     : 3/22/2023 6:00:52 AM
                Updated On     : 4/27/2023 9:52:53 AM
                ...
RecoveryLevel : Recoverable+Purgeable
Enabled       : True
Expires       : 6/9/2023 6:20:26 AM
NotBefore     : 3/11/2023 6:20:26 AM
Created       : 4/24/2023 9:05:51 AM
Updated       : 4/24/2023 9:05:51 AM
Tags          : {}
VaultName     : ContosoKV01
Name          : ImportCert01
Version       : XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Id            : https://ContosoKV01.vault.azure.net/certificates/ImportCert01/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

最初のコマンドでは、ConvertTo-SecureString コマンドレットを使用してセキュリティで保護されたパスワードを作成し、$Password変数に格納します。 2 番目のコマンドは、ImportCert01 という名前の証明書を、ファイルによって定義されたポリシーを使用して CosotosoKV01 キー コンテナーにインポートします。

パラメーター

-CertificateCollection

キー コンテナーに追加する証明書コレクションを指定します。

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

-CertificateString

インポートする証明書オブジェクトの Base64 エンコード表現。 この証明書には秘密キーが含まれている必要があります。

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

-Confirm

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

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

-ContentType

インポートする証明書の種類を指定します。 既定では、証明書文字列を PFX 形式と見なします。

Type:String
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

-FilePath

このコマンドレットがインポートする証明書ファイルのパスを指定します。

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

-Name

証明書名を指定します。 このコマンドレットは、キー コンテナー名、現在選択されている環境、および証明書名から証明書の完全修飾 doメイン 名 (FQDN) を構築します。

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

-Password

証明書ファイルのパスワードを指定します。

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

-PolicyObject

証明書の管理ポリシーを指定するメモリ内オブジェクト。 PolicyPath とは相互に排他的です。

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

-PolicyPath

JSON でエンコードされたポリシー定義を含む証明書の管理ポリシーを指定するファイル パス。 PolicyObject とは相互に排他的です。

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

-Tag

ハッシュ テーブルの形式のキーと値のペア。 例: @{key0="value0";key1=$null;key2="value2"}

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

-VaultName

このコマンドレットが証明書をインポートするキー コンテナー名を指定します。 このコマンドレットは、名前と現在選択されている環境に基づいて、キー コンテナーの完全修飾 doメイン 名前 (FQDN) を構築します。

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

-WhatIf

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

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

入力

String

X509Certificate2Collection

Hashtable

出力

PSKeyVaultCertificate