az apim nv

Gerenciar valores nomeados do Gerenciamento de API do Azure.

Comandos

Nome	Description	Tipo	Status
az apim nv create	Criar um valor nomeado de gerenciamento de API.	Core	GA
az apim nv delete	Excluir um valor nomeado do Gerenciamento de API.	Core	GA
az apim nv list	Listar valores nomeados do Gerenciamento de API.	Core	GA
az apim nv show	Mostrar detalhes de um Valor Nomeado do Gerenciamento de API.	Core	GA
az apim nv show-secret	Obtém o segredo de um Valor Nomeado do Gerenciamento de API.	Core	GA
az apim nv update	Atualize um valor nomeado de gerenciamento de API.	Core	GA
az apim nv wait	Coloque a CLI em um estado de espera até que uma condição de um valor nomeado de apim seja atendida.	Core	GA

az apim nv create

Editar

Criar um valor nomeado de gerenciamento de API.

az apim nv create --display-name
                  --named-value-id
                  --resource-group
                  --service-name
                  [--if-match]
                  [--no-wait]
                  [--secret {false, true}]
                  [--tags]
                  [--value]

Exemplos

Crie um valor nomeado.

az apim nv create --service-name MyApim -g MyResourceGroup --named-value-id MyNamedValue --display-name 'My Named Value' --value 'foo'

Parâmetros Exigidos

--display-name

O nome de exibição do valor nomeado.

--named-value-id

Nome exclusivo para o Valor Nomeado a ser criado.

Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--service-name -n

O nome da instância do serviço gerenciamento de API.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--if-match

ETag da Entidade.

--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade	Valor
Valor padrão:	False

--secret

Determina se o valor é um segredo e deve ser criptografado ou não. O valor padrão é falso.

Propriedade	Valor
Valor padrão:	False
Valores aceitos:	false, true

--tags

Marcas separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar marcas existentes.

--value

O valor do valor nomeado.

Parâmetros Globais

--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade	Valor
Valor padrão:	False

az apim nv delete

Editar

Excluir um valor nomeado do Gerenciamento de API.

az apim nv delete --named-value-id
                  --resource-group
                  --service-name
                  [--yes]

Parâmetros Exigidos

--named-value-id

Identificador do NamedValue.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--service-name -n

O nome da instância do serviço gerenciamento de API.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--yes -y

Não solicite confirmação.

Propriedade	Valor
Valor padrão:	False

Parâmetros Globais

--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade	Valor
Valor padrão:	False

az apim nv list

Editar

Listar valores nomeados do Gerenciamento de API.

az apim nv list --resource-group
                --service-name

Parâmetros Exigidos

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--service-name -n

O nome da instância do serviço gerenciamento de API.

Parâmetros Globais

--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade	Valor
Valor padrão:	False

az apim nv show

Editar

Mostrar detalhes de um Valor Nomeado do Gerenciamento de API.

az apim nv show --named-value-id
                --resource-group
                --service-name

Parâmetros Exigidos

--named-value-id

Identificador do NamedValue.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--service-name -n

O nome da instância do serviço gerenciamento de API.

Parâmetros Globais

--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade	Valor
Valor padrão:	False

az apim nv show-secret

Editar

Obtém o segredo de um Valor Nomeado do Gerenciamento de API.

az apim nv show-secret --named-value-id
                       --resource-group
                       --service-name

Parâmetros Exigidos

--named-value-id

Identificador do NamedValue.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--service-name -n

O nome da instância do serviço gerenciamento de API.

Parâmetros Globais

--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade	Valor
Valor padrão:	False

az apim nv update

Editar

Atualize um valor nomeado de gerenciamento de API.

az apim nv update --named-value-id
                  --resource-group
                  --service-name
                  [--add]
                  [--force-string]
                  [--if-match]
                  [--remove]
                  [--secret {false, true}]
                  [--set]
                  [--tags]
                  [--value]

Exemplos

Crie uma API básica.

az apim nv update --service-name MyApim -g MyResourceGroup --named-value-id MyNamedValue --value foo

Parâmetros Exigidos

--named-value-id

Nome exclusivo da api a ser criada.

Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--service-name -n

O nome da instância do serviço gerenciamento de API.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments
Valor padrão:	[]

--force-string

Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter em JSON.

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments
Valor padrão:	False

--if-match

ETag da Entidade.

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments
Valor padrão:	[]

--secret

Determina se o valor é um segredo e deve ser criptografado ou não. O valor padrão é falso.

Propriedade	Valor
Valores aceitos:	false, true

--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>.

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments
Valor padrão:	[]

--tags

Marcas separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar marcas existentes.

--value

O valor do valor nomeado.

Parâmetros Globais

--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade	Valor
Valor padrão:	False

az apim nv wait

Editar

Coloque a CLI em um estado de espera até que uma condição de um valor nomeado de apim seja atendida.

az apim nv wait --named-value-id
                --resource-group
                --service-name
                [--created]
                [--custom]
                [--deleted]
                [--exists]
                [--interval]
                [--timeout]
                [--updated]

Exemplos

Coloque a CLI em um estado de espera até que uma condição de uma api apim seja atendida.

az apim nv wait --created --service-name MyApim -g MyResourceGroup --named-value-id MyNamedValue --resource-group MyResourceGroup

Parâmetros Exigidos

--named-value-id

Identificador do NamedValue.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--service-name -n

O nome da instância do serviço gerenciamento de API.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	False

--custom

Aguarde até que a condição atenda a uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments

--deleted

Aguarde até ser excluído.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	False

--exists

Aguarde até que o recurso exista.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	False

--interval

Intervalo de sondagem em segundos.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	30

--timeout

Espera máxima em segundos.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	3600

--updated

Aguarde até que seja atualizado com provisioningState em 'Succeeded'.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	False

Parâmetros Globais

--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade	Valor
Valor padrão:	False

Comentários

Esta página foi útil?

Compartilhar via

az apim nv

Comandos

az apim nv create

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az apim nv delete

Parâmetros Exigidos

Parâmetros Opcionais

az apim nv list

Parâmetros Exigidos

az apim nv show

Parâmetros Exigidos

az apim nv show-secret

Parâmetros Exigidos

az apim nv update

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az apim nv wait

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

Comentários