Share via

New-AzApiManagementCustomHostnameConfiguration

  • Ссылка
Модуль:
Az.ApiManagement

Создает экземпляр класса PsApiManagementCustomHostNameConfiguration.

Синтаксис

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

Описание

Командлет New-AzApiManagementCustomHostnameConfiguration является вспомогательной командой, которая создает экземпляр PsApiManagementCustomHostNameConfiguration. Эта команда используется с командлетом New-AzApiManagement и Set-AzApiManagement.

Примеры

Пример 1. Создание и инициализация экземпляра PsApiManagementCustomHostNameConfiguration с помощью ssl-сертификата из файла

$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

Эта команда создает и инициализирует экземпляр PsApiManagementCustomHostNameConfiguration для портала. Затем он создает новую службу ApiManagement с настраиваемой конфигурацией имени узла.

Пример 2. Создание и инициализация экземпляра PsApiManagementCustomHostNameConfiguration с помощью секрета из ресурса 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

Эта команда создает и инициализирует экземпляр PsApiManagementCustomHostNameConfiguration.

Параметры

-DefaultProfile

Учетные данные, учетная запись, клиент и подписка, используемые для взаимодействия с Azure.

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

-DefaultSslBinding

Определяет, является ли значение секретом и должно ли быть зашифровано. Это необязательный параметр. Значение по умолчанию равно false.

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

-Hostname

Пользовательское имя узла

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

-HostNameCertificateInformation

Существующая конфигурация сертификата.

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

-HostnameType

Тип имени узла

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

Идентификатор клиента управляемого удостоверения, назначаемого пользователем, используется для проверки подлинности в KeyVault для получения пользовательского SSL-сертификата.

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

-KeyVaultId

KeyVaultId к секрету, в котором хранится пользовательский SSL-сертификат.

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

-ManagedCertificate

Определяет, нужно ли подготавливать управляемый сертификат, смена которого управляется платформой.

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

-NegotiateClientCertificate

Определяет, является ли значение секретом и должно ли быть зашифровано. Это необязательный параметр. Значение по умолчанию равно false.

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

-PfxPassword

Пароль для PFX-файла сертификата.

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

-PfxPath

Путь к PFX-файлу сертификата.

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

Входные данные

PsApiManagementCertificateInformation

Выходные данные

PsApiManagementCustomHostNameConfiguration