Share via

az apic api version

  • Referência

Nota

Essa referência faz parte da extensão apic-extension para a CLI do Azure (versão 2.57.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az apic api version . Saiba mais sobre extensões.

Comandos para gerenciar versões de API no Centro de APIs.

Comandos

Name Description Tipo Estado
az apic api version create

Crie uma nova versão da API ou atualize uma versão da API existente.

 Extensão GA
az apic api version delete

Exclua a versão especificada da API.

 Extensão GA
az apic api version list

Liste uma coleção de versões da API.

 Extensão GA
az apic api version show

Obtenha detalhes da versão da API.

 Extensão GA
az apic api version update

Atualize a versão existente da API.

 Extensão GA

az apic api version create

Crie uma nova versão da API ou atualize uma versão da API existente.

az apic api version create --api-id
                           --lifecycle-stage {deprecated, design, development, preview, production, retired, testing}
                           --resource-group
                           --service
                           --title
                           --version-id

Exemplos

Criar versão da API

az apic api version create -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --title "2023-01-01"

Parâmetros Obrigatórios

--api-id

A id da API.

--lifecycle-stage

Estágio atual do ciclo de vida da API.

valores aceites: deprecated, design, development, preview, production, retired, testing
--resource-group -g

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

--service --service-name -s

O nome do serviço do Centro de APIs.

--title

Versão da API.

--version-id

O id da versão da 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
valor predefinido: 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 apic api version delete

Exclua a versão especificada da API.

az apic api version delete [--api-id]
                           [--ids]
                           [--resource-group]
                           [--service]
                           [--subscription]
                           [--version-id]
                           [--yes]

Exemplos

Excluir versão da API

az apic api version delete -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01

Parâmetros Opcionais

--api-id

A id da API.

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--resource-group -g

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

--service --service-name -s

O nome do serviço do Centro de APIs.

--subscription

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

--version-id

O id da versão da API.

--yes -y

Não solicite confirmação.

valor predefinido: 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
valor predefinido: 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 apic api version list

Liste uma coleção de versões da API.

az apic api version list --api-id
                         --resource-group
                         --service
                         [--filter]
                         [--max-items]
                         [--next-token]

Exemplos

Listar versões da API

az apic api version list -g api-center-test -s contosoeuap --api-id echo-api

Parâmetros Obrigatórios

--api-id

A id da API.

--resource-group -g

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

--service --service-name -s

O nome do serviço do Centro de APIs.

Parâmetros Opcionais

--filter

Parâmetro de filtro OData.

--max-items

Número total de itens a serem retornados na saída do comando. Se o número total de itens disponíveis for maior do que o valor especificado, um token será fornecido na saída do comando. Para retomar a paginação, forneça o valor do token no --next-token argumento de um comando subsequente.

--next-token

Token para especificar por onde começar a paginar. Este é o valor de token de uma resposta truncada anteriormente.

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
valor predefinido: 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 apic api version show

Obtenha detalhes da versão da API.

az apic api version show [--api-id]
                         [--ids]
                         [--resource-group]
                         [--service]
                         [--subscription]
                         [--version-id]

Exemplos

Mostrar detalhes da versão da API

az apic api version show -g api-center-test -s contoso --api-id echo-api --version-id 2023-01-01

Parâmetros Opcionais

--api-id

A id da API.

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--resource-group -g

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

--service --service-name -s

O nome do serviço do Centro de APIs.

--subscription

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

--version-id

O id da versão da 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
valor predefinido: 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 apic api version update

Atualize a versão existente da API.

az apic api version update [--add]
                           [--api-id]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--ids]
                           [--lifecycle-stage {deprecated, design, development, preview, production, retired, testing}]
                           [--remove]
                           [--resource-group]
                           [--service]
                           [--set]
                           [--subscription]
                           [--title]
                           [--version-id]

Exemplos

Atualizar versão da API

az apic api version update -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --title "2023-01-01"

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 ou JSON string>.

--api-id

A id da API.

--force-string

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

valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--lifecycle-stage

Estágio atual do ciclo de vida da API.

valores aceites: deprecated, design, development, preview, production, retired, testing
--remove

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

--resource-group -g

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

--service --service-name -s

O nome do serviço do Centro de APIs.

--set

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

--subscription

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

--title

Versão da API.

--version-id

O id da versão da 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
valor predefinido: 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.