你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
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 cmdlet 是一个帮助程序命令，用于创建 PsApiManagementCustomHostNameConfiguration 的实例。 此命令用于 New-AzApiManagement 和 Set-AzApiManagement cmdlet。
示例
示例 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 |
| 别名: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-DefaultSslBinding
确定值是否为密钥以及是否应加密。 此参数是可选的。 默认值为 false。
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-Hostname
自定义主机名
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | False |
| 接受通配符: | False |
-HostNameCertificateInformation
现有证书配置。
| 类型: | PsApiManagementCertificateInformation |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | True |
| 接受通配符: | False |
-HostnameType
主机名类型
| 类型: | PsApiManagementHostnameType |
| 接受的值: | Proxy, Portal, Management, Scm, DeveloperPortal, Configuration, Data |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | False |
| 接受通配符: | False |
-IdentityClientId
用户分配的托管标识 ClientId 用于向 KeyVault 进行身份验证以提取自定义 SSL 证书。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-KeyVaultId
KeyVaultId 到存储自定义 SSL 证书的机密。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | False |
| 接受通配符: | False |
-ManagedCertificate
确定是否要预配由平台管理其轮换的托管证书
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | False |
| 接受通配符: | False |
-NegotiateClientCertificate
确定值是否为密钥以及是否应加密。 此参数是可选的。 默认值为 false。
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-PfxPassword
.pfx 证书文件的密码。
| 类型: | SecureString |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-PfxPath
.pfx 证书文件的路径。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | False |
| 接受通配符: | False |
输入
PsApiManagementCertificateInformation
输出
PsApiManagementCustomHostNameConfiguration
