New-AzApiManagementCustomHostnameConfiguration
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 との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultSslBinding
値がシークレットかどうかと暗号化する必要があるかどうかを決定します。 このパラメーターは省略可能です。 既定値は false です。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Hostname
カスタム ホスト名
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HostNameCertificateInformation
既存の証明書の構成。
| Type: | PsApiManagementCertificateInformation |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-HostnameType
ホスト名の種類
| Type: | PsApiManagementHostnameType |
| Accepted values: | Proxy, Portal, Management, Scm, DeveloperPortal, Configuration, Data |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IdentityClientId
カスタム SSL 証明書をフェッチするために KeyVault に対する認証に使用されるユーザー割り当てマネージド ID ClientId。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-KeyVaultId
カスタム SSL 証明書を格納するシークレットへの KeyVaultId。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ManagedCertificate
ローテーションがプラットフォームによって管理されるマネージド証明書をプロビジョニングするかどうかを決定します
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NegotiateClientCertificate
値がシークレットかどうかと暗号化する必要があるかどうかを決定します。 このパラメーターは省略可能です。 既定値は false です。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PfxPassword
.pfx 証明書ファイルのパスワード。
| Type: | SecureString |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PfxPath
.pfx 証明書ファイルへのパス。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
入力
PsApiManagementCertificateInformation
出力
PsApiManagementCustomHostNameConfiguration
関連リンク
Azure PowerShell
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示