Compartilhar via


New-AzApiManagementNamedValue

Cria um novo valor nomeado.

Sintaxe

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

Description

O cmdlet New-AzApiManagementNamedValue cria um Valor Nomeado do Gerenciamento de API do Azure.

Exemplos

Exemplo 1: Criar um valor nomeado que inclui marcas

$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

O primeiro comando atribui dois valores à variável $Tags. O segundo comando cria um valor nomeado e atribui as cadeias de caracteres em $Tags como tags na propriedade.

Exemplo 2: Criar um valor nomeado que tenha um valor secreto

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

Esse comando cria um Valor nomeado que tem um valor criptografado.

Exemplo 3: Criar um 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

O primeiro comando cria um cofre de chaves. O segundo comando cria um valor nomeado usando o segredo deste cofre de chaves.

Parâmetros

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Context

Instância de PsApiManagementContext. Este parâmetro é obrigatório.

Tipo:PsApiManagementContext
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para a comunicação com o Azure.

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-KeyVault

KeyVault usado para buscar dados Namedvalue. Esse parâmetro será necessário se Value não for especificado. Consulte New-AzApiManagementKeyVaultObject para obter detalhes.

Tipo:PsApiManagementKeyVaultEntity
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Name

Nome do valor nomeado. O comprimento máximo é de 100 caracteres. Ele pode conter apenas letras, dígitos, ponto, traço e caracteres de sublinhado. Este parâmetro é obrigatório.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-NamedValueId

Identificador do novo valor nomeado. Esse parâmetro é opcional. Se não for especificado, será gerado.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Secret

Determina se o valor é um segredo e se deve ser criptografado ou não. Esse parâmetro é opcional. O valor padrão é false.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Tag

Tags a serem associadas ao valor nomeado. Esse parâmetro é opcional.

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Value

Valor do valor nomeado. Pode conter expressões de política. O comprimento máximo é de 1000 caracteres. Ele não pode ficar vazio ou conter apenas espaços em branco. Este parâmetro é obrigatório.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

PsApiManagementContext

String

SwitchParameter

String[]

Saídas

PsApiManagementNamedValue