New-AzApiManagementCustomHostnameConfiguration

Modul:

Az.ApiManagement

Skapar en instans av 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

cmdleten New-AzApiManagementCustomHostnameConfiguration är ett hjälpkommando som skapar en instans av PsApiManagementCustomHostNameConfiguration. Det här kommandot används med cmdleten New-AzApiManagement och Set-AzApiManagement.

Exempel

Exempel 1: Skapa och initiera en instans av PsApiManagementCustomHostNameConfiguration med hjälp av ett Ssl-certifikat från en fil

$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

Det här kommandot skapar och initierar en instans av PsApiManagementCustomHostNameConfiguration för portalen. Sedan skapas en ny ApiManagement-tjänst med anpassad värdnamnskonfiguration.

Exempel 2: Skapa och initiera en instans av PsApiManagementCustomHostNameConfiguration med hjälp av en hemlighet från KeyVault-resurs

$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

Det här kommandot skapar och initierar en instans av PsApiManagementCustomHostNameConfiguration.

Parametrar

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure.

Typ:	IAzureContextContainer
Alias:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-DefaultSslBinding

Avgör om värdet är en hemlighet och ska krypteras eller inte. Den här parametern är valfri. Standardvärdet är falskt.

Typ:	SwitchParameter
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-Hostname

Anpassat värdnamn

Typ:	String
Position:	Named
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-HostNameCertificateInformation

Befintlig certifikatkonfiguration.

Typ:	PsApiManagementCertificateInformation
Position:	Named
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-HostnameType

Typ av värdnamn

Typ:	PsApiManagementHostnameType
Godkända värden:	Proxy, Portal, Management, Scm, DeveloperPortal, Configuration, Data
Position:	Named
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-IdentityClientId

User-Assigned ClientId för hanterad identitet som används för att autentisera till KeyVault för att hämta anpassat SSL-certifikat.

Typ:	String
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-KeyVaultId

KeyVaultId till hemligheten som lagrar det anpassade SSL-certifikatet.

Typ:	String
Position:	Named
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-ManagedCertificate

Avgör om vi vill etablera ett hanterat certifikat vars rotation hanteras av plattformen

Typ:	SwitchParameter
Position:	Named
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-NegotiateClientCertificate

Avgör om värdet är en hemlighet och ska krypteras eller inte. Den här parametern är valfri. Standardvärdet är falskt.

Typ:	SwitchParameter
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-PfxPassword

Lösenord för .pfx-certifikatfilen.

Typ:	SecureString
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-PfxPath

Sökväg till en .pfx-certifikatfil.

Typ:	String
Position:	Named
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

Indata

PsApiManagementCertificateInformation

Utdata

PsApiManagementCustomHostNameConfiguration

Relaterade länkar

• New-AzApiManagement
• Set-AzApiManagement