New-AzApiManagementCertificate

バックエンドでの認証時に使用する API Management 証明書を作成します。

構文

New-AzApiManagementCertificate
   -Context <PsApiManagementContext>
   [-CertificateId <String>]
   [-PfxFilePath <String>]
   [-PfxPassword <String>]
   [-KeyVault <PsApiManagementKeyVaultEntity>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
New-AzApiManagementCertificate
   -Context <PsApiManagementContext>
   [-CertificateId <String>]
   [-PfxBytes <Byte[]>]
   [-PfxPassword <String>]
   [-KeyVault <PsApiManagementKeyVaultEntity>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

説明

New-AzApiManagementCertificate コマンドレットは、Azure API Management 証明書を作成します。

例 1: 証明書を作成してアップロードする

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementCertificate -Context $ApiMgmtContext -PfxFilePath "C:\contoso\certificates\apimanagement.pfx" -PfxPassword "1111"

このコマンドは、Api Management に証明書をアップロードします。 この証明書は、ポリシーを使用したバックエンドとの相互認証に使用できます。

例 2

バックエンドでの認証時に使用する API Management 証明書を作成します。 (自動生成)

New-AzApiManagementCertificate -CertificateId '0123456789' -Context <PsApiManagementContext> -PfxFilePath 'C:\contoso\certificates\apimanagement.pfx' -PfxPassword '1111'

例 3: keyVault 証明書を作成する

$secretIdentifier = 'https://contoso.vault.azure.net/secrets/xxxx'
$keyvault = New-AzApiManagementKeyVaultObject -SecretIdentifier $secretIdentifier
$keyVaultcert = New-AzApiManagementCertificate -Context $context -CertificateId $kvcertId -KeyVault $keyvault

最初のコマンドでは、keyvault が作成されます。 2 番目のコマンドは、この keyvault のシークレットを使用して証明書を作成します。

パラメーター

-CertificateId

作成する証明書の ID を指定します。 このパラメーターを指定しない場合は、ID が生成されます。

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

-Context

PsApiManagementContext オブジェクトを指定します。

Type:PsApiManagementContext
Position:Named
Default value:None
Required:True
Accept pipeline input:True
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

-KeyVault

証明書データのフェッチに使用される KeyVault。-PfxFilePath が指定されていない場合は、このパラメーターが必要です。 詳細については、New-AzApiManagementKeyVaultObject を参照してください。

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

-PfxBytes

証明書ファイルのバイト配列を .pfx 形式で指定します。 PfxFilePath パラメーターを指定しない場合は、このパラメーターが必要です。

Type:Byte[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-PfxFilePath

作成およびアップロードする証明書ファイルのパスを .pfx 形式で指定します。 PfxBytes パラメーターを指定しない場合は、このパラメーターが 必要です

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

-PfxPassword

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

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

入力

PsApiManagementContext

String

Byte[]

出力

PsApiManagementCertificate