次の方法で共有

Set-AzureRmApiManagementHostnames

  • リファレンス
モジュール:
AzureRM.ApiManagement

API Management サービス プロキシまたはポータルのカスタム ホスト名構成を設定します。

警告

AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。

AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。

構文

Set-AzureRmApiManagementHostnames
   -ResourceGroupName <String>
   -Name <String>
   [-PortalHostnameConfiguration <PsApiManagementHostnameConfiguration>]
   [-ProxyHostnameConfiguration <PsApiManagementHostnameConfiguration>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Set-AzureRmApiManagementHostnames
   -ApiManagement <PsApiManagement>
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

説明

Set-AzureRmApiManagementHostnames コマンドレットは、API Management サービス プロキシまたはポータルのカスタム ホスト名構成を適用します。

例

例 1: プロキシとポータルのカスタム ホスト名構成を設定する

PS C:\>Set-AzureRmApiManagementHostnames -Name ContosoApi -ResourceGroupName Contoso -PortalHostnameConfiguration $portalHostnameConf -ProxyHostnameConfiguration $proxyHostnameConf

このコマンドは、プロキシとポータルのカスタム ホスト名の構成を設定します。

例 2: プロキシとポータルのカスタム ホスト名を構成する

PS C:\>Import-AzureRmApiManagementHostnameCertificate -Name ContosoApi -ResourceGroupName "Contoso" -HostnameType "Proxy" -PfxPath "C:\proxycert.pfx" -PfxPassword "CertSecret"
PS C:\> Import-AzureRmApiManagementHostnameCertificate -Name "ContosoApi" -ResourceGroupName "Contoso" -HostnameType "Portal" -PfxPath "C:\portalcert.pfx" -PfxPassword "CertSecret"
PS C:\> $PortalHostnameConf = New-AzureRmApiManagementHostnameConfiguration -Hostname "portal.contoso.com" -CertificateThumbprint "33CC47C6FCA848DC9B14A6F071C1EF7C"
PS C:\> $ProxyHostnameConf = New-AzureRmApiManagementHostnameConfiguration -Hostname "proxy.contoso.com" -CertificateThumbprint "5DD7CCF6A1E74E0987DD2873406B7264"
PS C:\> Set-AzureRmApiManagementHostnames -Name "ContosoApi" -ResourceGroupName "Contoso" -PortalHostnameConfiguration $PortalHostnameConf -ProxyHostnameConfiguration $ProxyHostnameConf

この例では、プロキシとポータルのカスタム ホスト名を構成します。 対応する証明書をインポートし、カスタム ホスト名を適用する必要があります。

パラメーター

-ApiManagement

このコマンドレットが PortalHostnameConfiguration パラメーターと ProxyHostnameConfiguration パラメーターを取得する PsApiManagement インスタンスを指定します。

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

-DefaultProfile

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

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

-Name

API Management インスタンスの名前を指定します。

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

-PassThru

作業中の項目を表すオブジェクトを返します。 既定では、このコマンドレットによる出力はありません。

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

-PortalHostnameConfiguration

カスタム ポータルのホスト名の構成を指定します。 コマンドレットに$nullを渡すと、既定のホスト名が設定されます。

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

-ProxyHostnameConfiguration

カスタム プロキシホスト名の構成を指定します。 $null渡すと、既定のホスト名が設定されます。

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

-ResourceGroupName

API Management インスタンスが存在するリソース グループの名前を指定します。

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

入力

PsApiManagement

パラメーター: ApiManagement (ByValue)

String

PsApiManagementHostnameConfiguration

出力

PsApiManagement