New-AzApiManagementCustomHostnameConfiguration
建立 PsApiManagementCustomHostNameConfiguration 的執行個體。
Syntax
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>] Description
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 通訊的認證、帳戶、租用戶和訂用帳戶。
| 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
使用者指派的受控識別用戶端標識符，用來向 KeyVault 進行驗證，以擷取自定義 SSL 憑證。
| 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