Sdílet prostřednictvím

New-AzApiManagementCustomHostnameConfiguration

  • Reference
Modul:
Az.ApiManagement

Vytvoří instanci 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

Rutina New-AzApiManagementCustomHostnameConfiguration je pomocný příkaz, který vytvoří instanci PsApiManagementCustomHostNameConfiguration. Tento příkaz se používá s rutinou New-AzApiManagement a Set-AzApiManagement.

Příklady

Příklad 1: Vytvoření a inicializace instance PsApiManagementCustomHostNameConfiguration pomocí certifikátu SSL ze souboru

$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

Tento příkaz vytvoří a inicializuje instanci PsApiManagementCustomHostNameConfiguration pro portál. Pak vytvoří novou službu ApiManagement s vlastní konfigurací názvu hostitele.

Příklad 2: Vytvoření a inicializace instance PsApiManagementCustomHostNameConfiguration pomocí tajného klíče z prostředku 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

Tento příkaz vytvoří a inicializuje instanci PsApiManagementCustomHostNameConfiguration.

Parametry

-DefaultProfile

Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure.

Typ:IAzureContextContainer
Aliasy:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-DefaultSslBinding

Určuje, zda je hodnota tajný klíč a má být zašifrována, nebo ne. Tento parametr je volitelný. Výchozí hodnota je false.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Hostname

Vlastní název hostitele

Typ:String
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-HostNameCertificateInformation

Existující konfigurace certifikátu

Typ:PsApiManagementCertificateInformation
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-HostnameType

Typ názvu hostitele

Typ:PsApiManagementHostnameType
Přípustné hodnoty:Proxy, Portal, Management, Scm, DeveloperPortal, Configuration, Data
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-IdentityClientId

User-Assigned ID klienta spravované identity použité k ověření ve službě KeyVault k načtení vlastního certifikátu SSL.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-KeyVaultId

KeyVaultId tajného kódu, který ukládá vlastní certifikát SSL.

Typ:String
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-ManagedCertificate

Určuje, jestli chceme zřídit spravovaný certifikát, jehož rotaci spravuje platforma.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-NegotiateClientCertificate

Určuje, zda je hodnota tajný klíč a má být zašifrována, nebo ne. Tento parametr je volitelný. Výchozí hodnota je false.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-PfxPassword

Heslo pro soubor certifikátu .pfx.

Typ:SecureString
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-PfxPath

Cesta k souboru certifikátu .pfx

Typ:String
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

Vstupy

PsApiManagementCertificateInformation

Výstupy

PsApiManagementCustomHostNameConfiguration