az apic api

  • Referência

Observação

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 . Saiba mais sobre extensões.

Comandos para gerenciar APIs no API Center.

Comandos

Nome Description Tipo Status
az apic api create

Registre uma nova API ou atualize uma API existente.

 Extensão GA
az apic api definition

Comandos para gerenciar definições de API no Centro de APIs.

 Extensão GA
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 delete

Exclua a API especificada.

 Extensão GA
az apic api deployment

Comandos para gerenciar implantações de API no Centro de APIs.

 Extensão GA
az apic api deployment create

Crie uma nova implantação de API ou atualize uma implantação de API existente.

 Extensão GA
az apic api deployment delete

Exclua a implantação da API.

 Extensão GA
az apic api deployment list

Liste uma coleção de implantações de API.

 Extensão GA
az apic api deployment show

Obtenha detalhes da implantação da API.

 Extensão GA
az apic api deployment update

Atualize a implantação de API existente.

 Extensão GA
az apic api list

Liste uma coleção de APIs.

 Extensão GA
az apic api register

Registra uma nova API com versão, definição e implantações associadas usando o arquivo de especificação como a fonte da verdade. Por enquanto, oferecemos suporte apenas ao formato OpenAPI JSON/YAML.

 Extensão Visualizar
az apic api show

Obtenha detalhes da API.

 Extensão GA
az apic api update

Atualize a API existente.

 Extensão GA
az apic api version

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

 Extensão GA
az apic api version create

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

 Extensão GA
az apic api version delete

Exclua a versão da API especificada.

 Extensão GA
az apic api version list

Liste uma coleção de versões de 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 create

Registre uma nova API ou atualize uma API existente.

az apic api create --api-id
                   --resource-group
                   --service-name
                   --title
                   --type {graphql, grpc, rest, soap, webhook, websocket}
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--license]
                   [--summary]

Exemplos

Criar API

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST

Criar API com propriedades personalizadas

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '{"public-facing":true}'

Parâmetros Exigidos

--api-id

O id da 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 do serviço do Centro de API do Azure.

--title

Título da API.

--type

Tipo de API.

Valores aceitos: graphql, grpc, rest, soap, webhook, websocket

Parâmetros Opcionais

--contacts

As informações de contato da API. Suporte a sintaxe abreviada, json-file e yaml-file. Tente "??" para mostrar mais.

--custom-properties

Os metadados personalizados definidos para entidades de catálogo de API. Suporte json-file e yaml-file.

--description

A descrição da API.

--external-documentation

Documentação externa adicional para a API. Suporte a sintaxe abreviada, json-file e yaml-file. Tente "??" para mostrar mais.

--license

As informações de licença para a API. Suporte a sintaxe abreviada, json-file e yaml-file. Tente "??" para mostrar mais.

--summary

Breve descrição da API.

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az apic api delete

Exclua a API especificada.

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

Exemplos

Excluir API

az apic api delete -g contoso-resources -n contoso --api-id echo-api

Parâmetros Opcionais

--api-id

O id da API.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de "ID do recurso". Você deve fornecer --ids ou outros argumentos de "ID do recurso".

--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 do serviço do Centro de API do Azure.

--subscription

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

--yes -y

Não solicite confirmação.

Valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az apic api list

Liste uma coleção de APIs.

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

Exemplos

Listar APIs

az apic api list -g contoso-resources -n contoso

Listar APIs com filtro

az apic api list -g contoso-resources -n contoso --filter "kind eq 'rest'"

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 do serviço do Centro de API do Azure.

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 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. Esse é o valor do token de uma resposta truncada anteriormente.

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az apic api register

Versão Prévia

Esse comando está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Registra uma nova API com versão, definição e implantações associadas usando o arquivo de especificação como a fonte da verdade. Por enquanto, oferecemos suporte apenas ao formato OpenAPI JSON/YAML.

az apic api register --api-location
                     --resource-group
                     --service-name
                     [--environment-id]

Exemplos

Registre a API fornecendo o arquivo de especificação.

az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.yml" --environment-id public

Parâmetros Exigidos

--api-location -l

Localização do arquivo de especificação.

--resource-group -g

Nome do grupo de recursos.

--service-name -n

APICenter Catálogo ou Nome do serviço.

Parâmetros Opcionais

--environment-id

ID do ambiente criado antes.

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az apic api show

Obtenha detalhes da API.

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

Exemplos

Mostrar detalhes da API

az apic api show -g contoso-resources -n contoso --api-id echo-api

Parâmetros Opcionais

--api-id

O id da API.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de "ID do recurso". Você deve fornecer --ids ou outros argumentos de "ID do recurso".

--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 do serviço do Centro de API do Azure.

--subscription

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

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az apic api update

Atualize a API existente.

az apic api update [--add]
                   [--api-id]
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                   [--ids]
                   [--license]
                   [--remove]
                   [--resource-group]
                   [--service-name]
                   [--set]
                   [--subscription]
                   [--summary]
                   [--title]
                   [--type {graphql, grpc, rest, soap, webhook, websocket}]

Exemplos

Atualizar API

az apic api update -g contoso-resources -n contoso --api-id echo-api --summary "Basic REST API service"

Atualizar propriedades personalizadas

az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '{"public-facing":true}'

Parâmetros Opcionais

--add

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

--api-id

O id da API.

--contacts

As informações de contato da API. Suporte a sintaxe abreviada, json-file e yaml-file. Tente "??" para mostrar mais.

--custom-properties

Os metadados personalizados definidos para entidades de catálogo de API. Suporte json-file e yaml-file.

--description

A descrição da API.

--external-documentation

Documentação externa adicional para a API. Suporte a sintaxe abreviada, json-file e yaml-file. Tente "??" para mostrar mais.

--force-string

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

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de "ID do recurso". Você deve fornecer --ids ou outros argumentos de "ID do recurso".

--license

As informações de licença para a API. Suporte a sintaxe abreviada, json-file e yaml-file. Tente "??" para mostrar mais.

--remove

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

--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 do serviço do Centro de API do Azure.

--set

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

--subscription

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

--summary

Breve descrição da API.

--title

Título da API.

--type

Tipo de API.

Valores aceitos: graphql, grpc, rest, soap, webhook, websocket
Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.