Condividi tramite

New-AzApiManagementCustomHostnameConfiguration

  • Riferimento
Modulo:
Az.ApiManagement

Crea un'istanza di PsApiManagementCustomHostNameConfiguration.

Sintassi

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>]

Descrizione

Il cmdlet New-AzApiManagementCustomHostnameConfiguration è un comando helper che crea un'istanza di PsApiManagementCustomHostNameConfiguration. Questo comando viene usato con il cmdlet New-AzApiManagement e Set-AzApiManagement.

Esempio

Esempio 1: Creare e inizializzare un'istanza di PsApiManagementCustomHostNameConfiguration usando un certificato SSL dal file

$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

Questo comando crea e inizializza un'istanza di PsApiManagementCustomHostNameConfiguration per il portale. Crea quindi un nuovo servizio ApiManagement con la configurazione del nome host personalizzato.

Esempio 2: Creare e inizializzare un'istanza di PsApiManagementCustomHostNameConfiguration usando un segreto dalla risorsa 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

Questo comando crea e inizializza un'istanza di PsApiManagementCustomHostNameConfiguration.

Parametri

-DefaultProfile

Le credenziali, l’account, il tenant e la sottoscrizione usati per comunicare con Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultSslBinding

Determina se il valore è un segreto e se deve essere crittografato. Il parametro è facoltativo. Il valore predefinito è false.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Hostname

Nome host personalizzato

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-HostNameCertificateInformation

Configurazione del certificato esistente.

Type:PsApiManagementCertificateInformation
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-HostnameType

Tipo nome host

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

ClientId identità gestita assegnata dall'utente usato per eseguire l'autenticazione a KeyVault per recuperare un certificato SSL personalizzato.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-KeyVaultId

KeyVaultId nel segreto in cui è archiviato il certificato SSL personalizzato.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ManagedCertificate

Determina se si vuole effettuare il provisioning di un certificato gestito la cui rotazione è gestita dalla piattaforma

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-NegotiateClientCertificate

Determina se il valore è un segreto e se deve essere crittografato. Il parametro è facoltativo. Il valore predefinito è false.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PfxPassword

Password per il file di certificato pfx.

Type:SecureString
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PfxPath

Percorso di un file di certificato con estensione pfx.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Input

PsApiManagementCertificateInformation

Output

PsApiManagementCustomHostNameConfiguration