Compartilhar via


Set-AzApiManagementNamedValue

Modifica um valor nomeado de gerenciamento de API.

Sintaxe

Set-AzApiManagementNamedValue
   -Context <PsApiManagementContext>
   -NamedValueId <String>
   [-Name <String>]
   [-Value <String>]
   [-Secret <Boolean>]
   [-Tag <String[]>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

O cmdlet Set-AzApiManagementNamedValue modifica um Valor Nomeado do Gerenciamento de API do Azure.

Exemplos

Exemplo 1: Alterar as tags no valor nomeado

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

O primeiro comando atribui dois valores à variável $Tags. O segundo comando modifica o valor nomeado que tem a ID Property11. O comando atribui as strings em $Tags como tags no valor nomeado.

Exemplo 2: Modificar o valor nomeado para ter um valor secreto

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementNamedValue -Context $apimContext -NamedValueId "Property12" -Secret $True -PassThru

Esse comando altera o valor nomeado para ser criptografado.

Exemplo 3

Modifica um valor nomeado de gerenciamento de API. (gerado automaticamente)

Set-AzApiManagementNamedValue -Context <PsApiManagementContext> -Name 'ContosoApi' -NamedValueId 'Property11' -Secret $true -Tag <String[]> -Value 'Property Value'

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

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

-NamedValueId

Identificador do valor nomeado a ser atualizado. Este parâmetro é obrigatório.

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

-PassThru

Se especificado, a instância do tipo Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProperty que representa a propriedade modificada será gravada na saída.

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

-Secret

Se o valor nomeado é um segredo e seu valor deve ser criptografado. Esse parâmetro é opcional.

Tipo:Nullable<T>[Boolean]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Tag

Tags 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. 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

-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

Nullable<T>[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

String[]

SwitchParameter

Saídas

PsApiManagementNamedValue