Compartir a través de

New-AzApiManagementCustomHostnameConfiguration

  • Referencia
Módulo:
Az.ApiManagement

Crea una instancia de PsApiManagementCustomHostNameConfiguration.

Sintaxis

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

El cmdlet New-AzApiManagementCustomHostnameConfiguration es un comando auxiliar que crea una instancia de PsApiManagementCustomHostNameConfiguration. Este comando se usa con el cmdlet New-AzApiManagement y Set-AzApiManagement.

Ejemplos

Ejemplo 1: Creación e inicialización de una instancia de PsApiManagementCustomHostNameConfiguration mediante un certificado Ssl del archivo

$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 crea e inicializa una instancia de PsApiManagementCustomHostNameConfiguration para Portal. A continuación, crea un nuevo servicio ApiManagement con la configuración de nombre de host personalizada.

Ejemplo 2: Creación e inicialización de una instancia de PsApiManagementCustomHostNameConfiguration mediante un secreto del recurso KeyVault

$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 crea e inicializa una instancia de PsApiManagementCustomHostNameConfiguration.

Parámetros

-DefaultProfile

Credenciales, cuenta, inquilino y suscripción usados para la comunicación con Azure.

Tipo:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-DefaultSslBinding

Determina si el valor es secreto y si se debe cifrar. Este parámetro es opcional. El valor predeterminado es false.

Tipo:SwitchParameter
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Hostname

Nombre de host personalizado

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-HostNameCertificateInformation

Configuración de certificado existente.

Tipo:PsApiManagementCertificateInformation
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-HostnameType

Tipo de nombre de host

Tipo:PsApiManagementHostnameType
Valores aceptados:Proxy, Portal, Management, Scm, DeveloperPortal, Configuration, Data
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-IdentityClientId

ClientId de identidad administrada asignada por el usuario que se usa para autenticarse en KeyVault para capturar el certificado SSL personalizado.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-KeyVaultId

KeyVaultId en el secreto que almacena el certificado SSL personalizado.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-ManagedCertificate

Determina si queremos aprovisionar un certificado administrado cuya rotación está administrada por la plataforma.

Tipo:SwitchParameter
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-NegotiateClientCertificate

Determina si el valor es secreto y si se debe cifrar. Este parámetro es opcional. El valor predeterminado es false.

Tipo:SwitchParameter
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-PfxPassword

Contraseña del archivo de certificado .pfx.

Tipo:SecureString
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-PfxPath

Ruta de acceso a un archivo de certificado .pfx.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

Entradas

PsApiManagementCertificateInformation

Salidas

PsApiManagementCustomHostNameConfiguration