New-AzApiManagementCustomHostnameConfiguration
Cria uma instância de PsApiManagementCustomHostNameConfiguration
.
Sintaxe
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
O cmdlet New-AzApiManagementCustomHostnameConfiguration é um comando auxiliar que cria uma instância de PsApiManagementCustomHostNameConfiguration. Este comando é usado com os cmdlets New-AzApiManagement e Set-AzApiManagement.
Exemplos
Exemplo 1: Criar e inicializar uma instância de PsApiManagementCustomHostNameConfiguration usando um certificado Ssl do arquivo
$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
Este comando cria e inicializa uma instância de PsApiManagementCustomHostNameConfiguration for Portal. Em seguida, ele cria um novo serviço ApiManagement com configuração de nome de host personalizada.
Exemplo 2: Criar e inicializar uma instância de PsApiManagementCustomHostNameConfiguration usando um Secret from KeyVault Resource
$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
Este comando cria e inicializa uma instância de PsApiManagementCustomHostNameConfiguration.
Parâmetros
-DefaultProfile
As credenciais, a conta, o locatário e a assinatura usados para comunicação com o Azure.
Tipo: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-DefaultSslBinding
Determina se o valor é um segredo e deve ser criptografado ou não. Este parâmetro é opcional. O valor padrão é false.
Tipo: | SwitchParameter |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-Hostname
Nome de host personalizado
Tipo: | String |
Position: | Named |
Default value: | None |
Necessário: | True |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-HostNameCertificateInformation
Configuração de certificado existente.
Tipo: | PsApiManagementCertificateInformation |
Position: | Named |
Default value: | None |
Necessário: | True |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-HostnameType
Tipo de nome de host
Tipo: | PsApiManagementHostnameType |
Valores aceites: | Proxy, Portal, Management, Scm, DeveloperPortal, Configuration, Data |
Position: | Named |
Default value: | None |
Necessário: | True |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-IdentityClientId
User-Assigned Managed Identity ClientId usado para autenticar no KeyVault para buscar o certificado SSL personalizado.
Tipo: | String |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-KeyVaultId
KeyVaultId para o segredo que armazena o certificado SSL personalizado.
Tipo: | String |
Position: | Named |
Default value: | None |
Necessário: | True |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-ManagedCertificate
Determina se queremos provisionar um certificado gerenciado cuja rotação é gerenciada pela plataforma
Tipo: | SwitchParameter |
Position: | Named |
Default value: | None |
Necessário: | True |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-NegotiateClientCertificate
Determina se o valor é um segredo e deve ser criptografado ou não. Este parâmetro é opcional. O valor padrão é false.
Tipo: | SwitchParameter |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-PfxPassword
Senha para o arquivo de certificado .pfx.
Tipo: | SecureString |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-PfxPath
Caminho para um arquivo de certificado .pfx.
Tipo: | String |
Position: | Named |
Default value: | None |
Necessário: | True |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
Entradas
PsApiManagementCertificateInformation
Saídas
PsApiManagementCustomHostNameConfiguration