New-AzApiManagementCustomHostnameConfiguration

モジュール:

Az.ApiManagement

PsApiManagementCustomHostNameConfiguration のインスタンスを作成します。

構文

New-AzApiManagementCustomHostnameConfiguration
   -Hostname <String>
   -HostnameType <PsApiManagementHostnameType>
   -HostNameCertificateInformation <PsApiManagementCertificateInformation>
   [-DefaultSslBinding]
   [-NegotiateClientCertificate]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

New-AzApiManagementCustomHostnameConfiguration
   -Hostname <String>
   -HostnameType <PsApiManagementHostnameType>
   -PfxPath <String>
   [-PfxPassword <SecureString>]
   [-DefaultSslBinding]
   [-NegotiateClientCertificate]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

New-AzApiManagementCustomHostnameConfiguration
   -Hostname <String>
   -HostnameType <PsApiManagementHostnameType>
   -KeyVaultId <String>
   [-IdentityClientId <String>]
   [-DefaultSslBinding]
   [-NegotiateClientCertificate]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

New-AzApiManagementCustomHostnameConfiguration
   -Hostname <String>
   -HostnameType <PsApiManagementHostnameType>
   [-DefaultSslBinding]
   [-NegotiateClientCertificate]
   [-ManagedCertificate]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

説明

New-AzApiManagementCustomHostnameConfiguration コマンドレットは、PsApiManagementCustomHostNameConfiguration のインスタンスを作成するヘルパー コマンドです。 このコマンドは、New-AzApiManagement コマンドレットと Set-AzApiManagement コマンドレットで使用されます。

例

例 1: ファイルの Ssl 証明書を使用して PsApiManagementCustomHostNameConfiguration のインスタンスを作成して初期化する

$portal = New-AzApiManagementCustomHostnameConfiguration -Hostname "portal.contoso.com" -HostnameType Portal -PfxPath "C:\contoso\certificates\apimanagement.pfx" -PfxPassword "1111" -DefaultSslBinding
$customConfig = @($portal)
New-AzApiManagement -ResourceGroupName "ContosoGroup" -Location "West US" -Name "ContosoApi" -Organization Contoso -AdminEmail admin@contoso.com -CustomHostnameConfiguration $customConfig

このコマンドは、ポータルの PsApiManagementCustomHostNameConfiguration のインスタンスを作成して初期化します。 次に、カスタム ホスト名構成を使用して新しい ApiManagement サービスを作成します。

例 2: KeyVault リソースのシークレットを使用して PsApiManagementCustomHostNameConfiguration のインスタンスを作成して初期化する

$portal = New-AzApiManagementCustomHostnameConfiguration -Hostname "portal.contoso.com" -HostnameType Portal -KeyVaultId "https://apim-test-keyvault.vault.azure.net/secrets/api-portal-custom-ssl.pfx"

$customConfig = @($portal)
New-AzApiManagement -ResourceGroupName "ContosoGroup" -Location "West US" -Name "ContosoApi" -Organization Contoso -AdminEmail admin@contoso.com -CustomHostnameConfiguration $customConfig -SystemAssignedIdentity

このコマンドは、 PsApiManagementCustomHostNameConfiguration のインスタンスを作成して初期化します。

パラメーター

-DefaultProfile

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

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

-DefaultSslBinding

値がシークレットかどうかと暗号化する必要があるかどうかを決定します。 このパラメーターは省略可能です。 既定値は false です。

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

-Hostname

カスタム ホスト名

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

-HostNameCertificateInformation

既存の証明書の構成。

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

-HostnameType

ホスト名の種類

型:	PsApiManagementHostnameType
指定可能な値:	Proxy, Portal, Management, Scm, DeveloperPortal, Configuration, Data
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-IdentityClientId

カスタム SSL 証明書をフェッチするために KeyVault に対する認証に使用されるユーザー割り当てマネージド ID ClientId。

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

-KeyVaultId

カスタム SSL 証明書を格納するシークレットへの KeyVaultId。

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

-ManagedCertificate

ローテーションがプラットフォームによって管理されるマネージド証明書をプロビジョニングするかどうかを決定します

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

-NegotiateClientCertificate

値がシークレットかどうかと暗号化する必要があるかどうかを決定します。 このパラメーターは省略可能です。 既定値は false です。

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

-PfxPassword

.pfx 証明書ファイルのパスワード。

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

-PfxPath

.pfx 証明書ファイルへのパス。

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

入力

PsApiManagementCertificateInformation

出力

PsApiManagementCustomHostNameConfiguration

関連リンク

• New-AzApiManagement
• Set-AzApiManagement