Import-AzureRmApiManagementHostnameCertificate
API Management サービスの PFX 形式で証明書をインポートします。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Import-AzureRmApiManagementHostnameCertificate
-ResourceGroupName <String>
-Name <String>
-HostnameType <PsApiManagementHostnameType>
-PfxPath <String>
-PfxPassword <String>
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
説明
Import-AzureRmApiManagementHostnameCertificate コマンドレットは、API Management サービスの PFX 形式で証明書をインポートします。 証明書は、カスタム ホスト名の構成に使用されます。
例
例 1: API Management ホスト名証明書をインポートする
PS C:\>Import-AzureRmApiManagementHostnameCertificate -Name "ContosoApi" -ResourceGroupName Contoso -HostnameType "Proxy" -PfxPath "C:\proxycert.pfx" -PfxPassword "CertSecret"
このコマンドは、プロキシ カスタム ホスト名の証明書をインポートします。
パラメーター
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
型: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-HostnameType
このコマンドレットが証明書を読み込むホスト名の種類を指定します。 有効な値は次の通りです。
- 通信士
- ポータル
型: | PsApiManagementHostnameType |
指定可能な値: | Proxy, Portal, Management, Scm |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Name
このコマンドレットがインポートする API Management デプロイの名前を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-PassThru
作業中の項目を表すオブジェクトを返します。 既定では、このコマンドレットによる出力はありません。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-PfxPassword
.pfx 証明書ファイルのパスワードを指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-PfxPath
.pfx 証明書ファイルへのパスを指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ResourceGroupName
API Management デプロイが存在するリソース グループの名前を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
入力
出力
PsApiManagementHostnameCertificate