Share via

New-AzApiManagementCustomHostnameConfiguration

  • Referentie
Module:
Az.ApiManagement

Hiermee maakt u een exemplaar van 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

De cmdlet New-AzApiManagementCustomHostnameConfiguration is een helper-opdracht waarmee een exemplaar van PsApiManagementCustomHostNameConfiguration wordt gemaakt. Deze opdracht wordt gebruikt met de cmdlet New-AzApiManagement en Set-AzApiManagement.

Voorbeelden

Voorbeeld 1: Een exemplaar van PsApiManagementCustomHostNameConfiguration maken en initialiseren met behulp van een SSL-certificaat uit bestand

$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

Met deze opdracht maakt en initialiseert u een exemplaar van PsApiManagementCustomHostNameConfiguration voor portal. Vervolgens wordt er een nieuwe ApiManagement-service gemaakt met aangepaste hostnaamconfiguratie.

Voorbeeld 2: Een exemplaar van PsApiManagementCustomHostNameConfiguration maken en initialiseren met behulp van een geheim uit 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

Met deze opdracht maakt en initialiseert u een exemplaar van PsApiManagementCustomHostNameConfiguration.

Parameters

-DefaultProfile

De referenties, accounts, tenants en abonnementen die worden gebruikt voor communicatie met Azure.

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

-DefaultSslBinding

Bepaalt of de waarde een geheim is en of niet moet worden versleuteld. Deze parameter is optioneel. De standaardwaarde is onwaar.

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

-Hostname

Aangepaste hostnaam

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

-HostNameCertificateInformation

Bestaande certificaatconfiguratie.

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

-HostnameType

Hostnaamtype

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

Door de gebruiker toegewezen beheerde identiteitsclient-id die wordt gebruikt om te verifiëren bij KeyVault om een aangepast SSL-certificaat op te halen.

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

-KeyVaultId

KeyVaultId naar het geheim dat het aangepaste SSL-certificaat opslaat.

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

-ManagedCertificate

Bepaalt of we een beheerd certificaat willen inrichten waarvan de rotatie wordt beheerd door het platform

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

-NegotiateClientCertificate

Bepaalt of de waarde een geheim is en of niet moet worden versleuteld. Deze parameter is optioneel. De standaardwaarde is onwaar.

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

-PfxPassword

Wachtwoord voor het PFX-certificaatbestand.

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

-PfxPath

Pad naar een PFX-certificaatbestand.

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

Invoerwaarden

PsApiManagementCertificateInformation

Uitvoerwaarden

PsApiManagementCustomHostNameConfiguration