Поделиться через


New-AzApiManagementNamedValue

Создает новое именованное значение.

Синтаксис

New-AzApiManagementNamedValue
   -Context <PsApiManagementContext>
   [-NamedValueId <String>]
   [-Name <String>]
   [-Value <String>]
   [-Secret]
   [-Tag <String[]>]
   [-KeyVault <PsApiManagementKeyVaultEntity>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Описание

Командлет New-AzApiManagementNamedValue создает именованногозначения управления API Azure.

Примеры

Пример 1. Создание именованного значения, включающего теги

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
$Tags = 'sdk', 'powershell'
New-AzApiManagementNamedValue -Context $apimContext -NamedValueId "Property11" -Name "Property Name" -Value "Property Value" -Tag $Tags

Первая команда назначает два значения переменной $Tags. Вторая команда создает именованное значение и назначает строки в $Tags в качестве тегов в свойстве.

Пример 2. Создание именованного значения с секретным значением

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementNamedValue -Context $apimContext -NamedValueId "Property12" -Name "Secret Property" -Value "Secret Property Value" -Secret

Эта команда создает именованное значение с зашифрованным значением.

Пример 3. Создание keyVault Namedvalue

$secretIdentifier = 'https://contoso.vault.azure.net/secrets/xxxx'
$keyvault = New-AzApiManagementKeyVaultObject -SecretIdentifier $secretIdentifier 
$keyVaultNamedValue = New-AzApiManagementNamedValue -Context $context -NamedValueId $keyVaultNamedValueId -Name $keyVaultNamedValueName -keyVault $keyvault -Secret

Первая команда создает ключи. Вторая команда создает именованное значение с помощью секрета из этого keyvault.

Параметры

-Confirm

Запрашивает подтверждение перед запуском командлета.

Тип:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Context

Экземпляр PsApiManagementContext. Этот параметр является обязательным.

Тип:PsApiManagementContext
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-DefaultProfile

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

Тип:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-KeyVault

KeyVault используется для получения данных Именованного значения. Этот параметр требуется, если значение не указано. Дополнительные сведения см. в New-AzApiManagementKeyVaultObject.

Тип:PsApiManagementKeyVaultEntity
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-Name

Имя именованного значения. Максимальная длина — 100 символов. Он может содержать только буквы, цифры, точки, дефисы и символы подчеркивания. Этот параметр является обязательным.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-NamedValueId

Идентификатор нового именованного значения. Этот параметр является необязательным. Если не указано, будет создано.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-Secret

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

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-Tag

Теги, связанные с именованным значением. Этот параметр является необязательным.

Тип:String[]
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-Value

Значение именованного значения. Может содержать выражения политики. Максимальная длина — 1000 символов. Она может быть не пустой или состоять только из пробелов. Этот параметр является обязательным.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-WhatIf

Показывает, что произойдет, если командлет выполняется. Командлет не выполняется.

Тип:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

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

PsApiManagementContext

String

SwitchParameter

String[]

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

PsApiManagementNamedValue