az apic api definition
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 definition . Saiba mais sobre extensões.
Comandos para gerenciar definições de API na Central de APIs.
Comandos
| Name | Description | Tipo | Status |
|---|---|---|---|
| az apic api definition create |
Crie uma nova definição de API ou atualize uma definição de API existente. |
Extensão | GA |
| az apic api definition delete |
Exclua a definição de API especificada. |
Extensão | GA |
| az apic api definition export-specification |
Exporta a especificação da API. |
Extensão | GA |
| az apic api definition import-specification |
Importa a especificação da API. |
Extensão | GA |
| az apic api definition list |
Liste uma coleção de definições de API. |
Extensão | GA |
| az apic api definition show |
Obtenha detalhes da definição da API. |
Extensão | GA |
| az apic api definition update |
Atualize a definição de API existente. |
Extensão | GA |
az apic api definition create
Crie uma nova definição de API ou atualize uma definição de API existente.
az apic api definition create --api-id
--definition-id
--resource-group
--service-name
--title
--version-id
[--description]Exemplos
Criar definição de API
az apic api definition create -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"Parâmetros Obrigatórios
A id da API.
A id da definição da API.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
O nome do serviço Central de API do Azure.
Versão da API.
O id da versão da API.
Parâmetros Opcionais
Descrição da definição da API.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az apic api definition delete
Exclua a definição de API especificada.
az apic api definition delete [--api-id]
[--definition-id]
[--ids]
[--resource-group]
[--service-name]
[--subscription]
[--version-id]
[--yes]Exemplos
Excluir definição de API
az apic api definition delete -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"Parâmetros Opcionais
A id da API.
A id da definição da API.
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'.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
O nome do serviço Central de API do Azure.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .
O id da versão da API.
Não solicite confirmação.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az apic api definition export-specification
Exporta a especificação da API.
az apic api definition export-specification --file-name
[--api-id]
[--definition-id]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--service-name]
[--subscription]
[--version-id]Exemplos
Especificação de exportação
az apic api definition export-specification -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id default --file-name filename.jsonParâmetros Obrigatórios
Nome do arquivo para o qual exportar a especificação.
Parâmetros Opcionais
A id da API.
A id da definição da API.
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'.
Não espere que a operação de longa duração termine.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
O nome do serviço Central de API do Azure.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .
O id da versão da API.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az apic api definition import-specification
Importa a especificação da API.
az apic api definition import-specification --format {inline, link}
--specification
--value
[--api-id]
[--definition-id]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--service-name]
[--subscription]
[--version-id]Exemplos
Exemplo de especificação de importação 1
az apic api definition import-specification -g api-center-test -n contosoeuap --api-id echo-api-2 --version-id 2023-08-01 --definition-id openapi3 --format "inline" --value '{"openapi":"3.0.1","info":{"title":"httpbin.org","description":"API Management facade for a very handy and free online HTTP tool.","version":"1.0"}}' --specification '{"name":"openapi","version":"3.0.0"}'Exemplo de especificação de importação 2
az apic api definition import-specification -g api-center-test -n contoso --api-id echo-api --version-id 2023-11-01 --definition-id openapi --format "link" --value 'https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json' --specification '{"name":"openapi","version":"3.0.0"}'Parâmetros Obrigatórios
Formato da fonte de especificação da API.
Detalhes da especificação da API. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.
Valor da fonte de especificação da API.
Parâmetros Opcionais
A id da API.
A id da definição da API.
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'.
Não espere que a operação de longa duração termine.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
O nome do serviço Central de API do Azure.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .
O id da versão da API.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az apic api definition list
Liste uma coleção de definições de API.
az apic api definition list --api-id
--resource-group
--service-name
--version-id
[--filter]
[--max-items]
[--next-token]Exemplos
Listar definições de API
az apic api definition list -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01Parâmetros Obrigatórios
A id da API.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
O nome do serviço Central de API do Azure.
O id da versão da API.
Parâmetros Opcionais
Parâmetro de filtro OData.
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.
Token para especificar por onde começar a paginar. Este é o valor de token de uma resposta truncada anteriormente.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az apic api definition show
Obtenha detalhes da definição da API.
az apic api definition show [--api-id]
[--definition-id]
[--ids]
[--resource-group]
[--service-name]
[--subscription]
[--version-id]Exemplos
Mostrar detalhes da definição da API
az apic api definition show -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"Parâmetros Opcionais
A id da API.
A id da definição da API.
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'.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
O nome do serviço Central de API do Azure.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .
O id da versão da API.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az apic api definition update
Atualize a definição de API existente.
az apic api definition update [--add]
[--api-id]
[--definition-id]
[--description]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--remove]
[--resource-group]
[--service-name]
[--set]
[--subscription]
[--title]
[--version-id]Exemplos
Atualizar definição de API
az apic api definition update -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"Parâmetros Opcionais
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>.
A id da API.
A id da definição da API.
Descrição da definição da API.
Ao usar 'set' ou 'add', preserve literais de string em vez de tentar converter para JSON.
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'.
Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list OR --remove propertyToRemove.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
O nome do serviço Central de API do Azure.
Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .
Título da versão da API.
O id da versão da API.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
