Partilhar via

az apim nv

  • Referência

Gerencie os valores nomeados do Gerenciamento de API do Azure.

Comandos

Name Description Tipo Status
az apim nv create

Crie um valor chamado de gerenciamento de API.

 Principal GA
az apim nv delete

Exclua um valor nomeado de gerenciamento de API.

 Principal GA
az apim nv list

Listar valores nomeados de gerenciamento de API.

 Principal GA
az apim nv show

Mostrar detalhes de um valor nomeado de gerenciamento de API.

 Principal GA
az apim nv show-secret

Obtém o segredo de um valor nomeado de gerenciamento de API.

 Principal GA
az apim nv update

Atualize um valor nomeado de gerenciamento de API.

 Principal GA
az apim nv wait

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

 Principal GA

az apim nv create

Editar

Crie um valor chamado 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 Obrigatórios

--display-name

O nome para exibição do valor nomeado.

--named-value-id

Nome exclusivo para o Valor Nomeado a ser criado.

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

--resource-group -g

o 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 de Gerenciamento de API.

Parâmetros Opcionais

--if-match

ETag da Entidade.

--no-wait

Não espere que a operação de longa duração termine.

Default value: False
--secret

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

Valores aceites: false, true
Default value: False
--tags

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

--value

O valor do Valor Nomeado.

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az apim nv delete

Editar

Exclua um valor nomeado de gerenciamento de API.

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

Parâmetros Obrigatórios

--named-value-id

Identificador do NamedValue.

--resource-group -g

o 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 de Gerenciamento de API.

Parâmetros Opcionais

--yes -y

Não solicite confirmação.

Default value: False
Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az apim nv list

Editar

Listar valores nomeados de gerenciamento de API.

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

Parâmetros Obrigatórios

--resource-group -g

o 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 de Gerenciamento de API.

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az apim nv show

Editar

Mostrar detalhes de um valor nomeado de gerenciamento de API.

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

Parâmetros Obrigatórios

--named-value-id

Identificador do NamedValue.

--resource-group -g

o 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 de Gerenciamento de API.

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az apim nv show-secret

Editar

Obtém o segredo de um valor nomeado de gerenciamento de API.

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

Parâmetros Obrigatórios

--named-value-id

Identificador do NamedValue.

--resource-group -g

o 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 de Gerenciamento de API.

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

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 Obrigatórios

--named-value-id

Nome exclusivo da api a ser criada.

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

--resource-group -g

o 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 de Gerenciamento de API.

Parâmetros Opcionais

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

Default value: []
--force-string

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

Default value: False
--if-match

ETag da Entidade.

--remove

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

Default value: []
--secret

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

Valores aceites: false, true
--set

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

Default value: []
--tags

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

--value

O valor do Valor Nomeado.

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az apim nv wait

Editar

Coloque a CLI em um estado de espera até que uma condição de um valor nomeado 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 Obrigatórios

--named-value-id

Identificador do NamedValue.

--resource-group -g

o 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 de Gerenciamento de API.

Parâmetros Opcionais

--created

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

Default value: False
--custom

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

--deleted

Aguarde até ser excluído.

Default value: False
--exists

Aguarde até que o recurso exista.

Default value: False
--interval

Intervalo de sondagem em segundos.

Default value: 30
--timeout

Espera máxima em segundos.

Default value: 3600
--updated

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

Default value: False
Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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