az apic

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

Gerencie os serviços da Central de API do Azure.

Comandos

Name	Description	Tipo	Status
az apic api	Comandos para gerenciar APIs na Central de APIs.	Extensão	GA
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 na Central 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 na Central 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	Listar 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 da 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, suportamos apenas o formato OpenAPI JSON/YAML.	Extensão	Pré-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 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 create	Cria uma instância ou atualiza uma instância existente de um serviço do Centro de API do Azure.	Extensão	GA
az apic delete	Exclui uma instância de um serviço da Central de API do Azure.	Extensão	GA
az apic environment	Comandos para gerenciar ambientes na Central de APIs.	Extensão	GA
az apic environment create	Crie um novo ambiente ou atualize um ambiente existente.	Extensão	GA
az apic environment delete	Elimine o ambiente.	Extensão	GA
az apic environment list	Liste uma coleção de ambientes.	Extensão	GA
az apic environment show	Obtenha detalhes do ambiente.	Extensão	GA
az apic environment update	Atualize o ambiente existente.	Extensão	GA
az apic import-from-apim	Importa APIs de uma instância de serviço de Gerenciamento de API do Azure.	Extensão	GA
az apic list	Lista os serviços do Centro de API do Azure em uma assinatura do Azure.	Extensão	GA
az apic metadata	Comandos para gerenciar esquemas de metadados na Central de APIs.	Extensão	GA
az apic metadata create	Crie um novo esquema de metadados ou atualize um esquema de metadados existente.	Extensão	GA
az apic metadata delete	Exclua o esquema de metadados especificado.	Extensão	GA
az apic metadata export	Exporta o esquema de metadados.	Extensão	GA
az apic metadata list	Listar uma coleção de esquemas de metadados.	Extensão	GA
az apic metadata show	Obtenha detalhes do esquema de metadados.	Extensão	GA
az apic metadata update	Atualize o esquema de metadados existente.	Extensão	GA
az apic show	Mostrar detalhes de uma instância de serviço do Centro de API do Azure.	Extensão	GA
az apic update	Atualize uma instância de um serviço do Centro de API do Azure.	Extensão	GA

az apic create

Cria uma instância ou atualiza uma instância existente de um serviço do Centro de API do Azure.

az apic create --name
               --resource-group
               [--identity]
               [--location]
               [--tags]

Exemplos

Criar serviço Exemplo 1

az apic create -g contoso-resources -n contoso -l eastus

Criar Exemplo de Serviço 2

az apic create --resource-group contoso-resources --name contoso --location eastus

Parâmetros Obrigatórios

--name -n

O nome do serviço do Centro de APIs.

--resource-group -g

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

Parâmetros Opcionais

--identity

As identidades de serviço gerenciado atribuídas a este recurso. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--location -l

A localização geográfica onde o recurso reside Quando não especificada, a localização do grupo de recursos será usada.

--tags

Tags de recursos. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

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 apic delete

Exclui uma instância de um serviço da Central de API do Azure.

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

Exemplos

Eliminar serviço

az apic delete -n contoso -g contoso-resources

Parâmetros Opcionais

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

--name -n

O nome do serviço do Centro de APIs.

--resource-group -g

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

--subscription

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

--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 apic import-from-apim

Importa APIs de uma instância de serviço de Gerenciamento de API do Azure.

az apic import-from-apim --apim-apis
                         --apim-name
                         [--apim-resource-group]
                         [--apim-subscription]
                         [--ids]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--resource-group]
                         [--service-name]
                         [--subscription]

Exemplos

Importar todas as APIs do APIM no mesmo grupo de recursos

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis *

Importar APIs selecionadas do APIM no mesmo grupo de recursos

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis [echo,foo]

Importar todas as APIs do APIM em outra assinatura e grupo de recursos

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-subscription 00000000-0000-0000-0000-000000000000 --apim-resource-group apim-rg --apim-name contoso-apim --apim-apis *

Parâmetros Obrigatórios

--apim-apis

As APIs a serem importadas. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--apim-name

O nome da instância do APIM de origem.

Parâmetros Opcionais

--apim-resource-group

O grupo de recursos da instância APIM de origem.

--apim-subscription

A ID de assinatura da instância APIM de origem.

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

--no-wait

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

Valores aceites: 0, 1, f, false, n, no, t, true, y, yes

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

--subscription

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

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 apic list

Lista os serviços do Centro de API do Azure em uma assinatura do Azure.

Há um problema conhecido de que listar todos os recursos em uma assinatura não funciona. Liste os recursos por grupo de recursos.

az apic list [--max-items]
             [--next-token]
             [--resource-group]

Exemplos

Listar serviços no grupo de recursos

az apic list -g contoso-resources

Parâmetros Opcionais

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

--resource-group -g

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

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 apic show

Mostrar detalhes de uma instância de serviço do Centro de API do Azure.

az apic show [--ids]
             [--name]
             [--resource-group]
             [--subscription]

Exemplos

Mostrar detalhes do serviço

az apic show -g contoso-resources -n contoso

Parâmetros Opcionais

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

--name -n

O nome do serviço do Centro de APIs.

--resource-group -g

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

--subscription

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

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 apic update

Atualize uma instância de um serviço do Centro de API do Azure.

az apic update [--add]
               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
               [--identity]
               [--ids]
               [--name]
               [--remove]
               [--resource-group]
               [--set]
               [--subscription]
               [--tags]

Exemplos

Atualizar detalhes do serviço

az apic update -g contoso-resources -n contoso

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

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

--identity

As identidades de serviço gerenciado atribuídas a este recurso. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

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

--name -n

O nome do serviço do Centro de APIs.

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

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

--tags

Tags de recursos. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

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.