Partager via

New-AzApiManagementCustomHostnameConfiguration

  • Référence
Module:
Az.ApiManagement

Crée une instance de PsApiManagementCustomHostNameConfiguration.

Syntaxe

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

L’applet de commande New-AzApiManagementCustomHostnameConfiguration est une commande d’assistance qui crée une instance de PsApiManagementCustomHostNameConfiguration. Cette commande est utilisée avec l’applet de commande New-AzApiManagement et Set-AzApiManagement.

Exemples

Exemple 1 : Créer et initialiser une instance de PsApiManagementCustomHostNameConfiguration à l’aide d’un certificat Ssl à partir d’un fichier

$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

Cette commande crée et initialise une instance de PsApiManagementCustomHostNameConfiguration for Portal. Ensuite, il crée un service ApiManagement avec une configuration de nom d’hôte personnalisée.

Exemple 2 : Créer et initialiser une instance de PsApiManagementCustomHostNameConfiguration à l’aide d’un secret à partir d’une ressource 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

Cette commande crée et initialise une instance de PsApiManagementCustomHostNameConfiguration.

Paramètres

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.

Type:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-DefaultSslBinding

Détermine si la valeur est un secret et doit être chiffrée ou non. Ce paramètre est facultatif. La valeur par défaut est false.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Hostname

Nom d’hôte personnalisé

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-HostNameCertificateInformation

Configuration de certificat existante.

Type:PsApiManagementCertificateInformation
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-HostnameType

Type de nom d’hôte

Type:PsApiManagementHostnameType
Valeurs acceptées:Proxy, Portal, Management, Scm, DeveloperPortal, Configuration, Data
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-IdentityClientId

User-Assigned Managed Identity ClientId utilisé pour s’authentifier auprès de KeyVault pour récupérer un certificat SSL personnalisé.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-KeyVaultId

KeyVaultId vers le secret stockant le certificat SSL personnalisé.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ManagedCertificate

Détermine si nous voulons approvisionner un certificat managé dont la rotation est gérée par la plateforme

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-NegotiateClientCertificate

Détermine si la valeur est un secret et doit être chiffrée ou non. Ce paramètre est facultatif. La valeur par défaut est false.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-PfxPassword

Mot de passe pour le fichier de certificat .pfx.

Type:SecureString
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-PfxPath

Chemin d’accès à un fichier de certificat .pfx.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

PsApiManagementCertificateInformation

Sorties

PsApiManagementCustomHostNameConfiguration