az apic

Note

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.	Extension	disponibilidade geral
az apic api-analysis	Gerencie os recursos de análise de api de serviço do Centro de API do Azure.	Extension	Preview
az apic api-analysis create	Crie novas configurações ou atualize a configuração existente do analisador de API.	Extension	Preview
az apic api-analysis delete	Excluir exclui a configuração do analisador de API.	Extension	Preview
az apic api-analysis export-ruleset	Exporta o conjunto de regras do analisador de API.	Extension	Preview
az apic api-analysis import-ruleset	Importa o conjunto de regras do analisador de API.	Extension	Preview
az apic api-analysis list	Listar configurações do analisador de API.	Extension	Preview
az apic api-analysis show	Obtenha detalhes da configuração do analisador de API.	Extension	Preview
az apic api-analysis update	Atualize a configuração do analisador de API novo ou atualize a existente.	Extension	Preview
az apic api create	Registre uma nova API ou atualize uma API existente.	Extension	disponibilidade geral
az apic api definition	Comandos para gerenciar definições de API na Central de APIs.	Extension	disponibilidade geral
az apic api definition create	Crie uma nova definição de API ou atualize uma definição de API existente.	Extension	disponibilidade geral
az apic api definition delete	Exclua a definição de API especificada.	Extension	disponibilidade geral
az apic api definition export-specification	Exporta a especificação da API.	Extension	disponibilidade geral
az apic api definition import-specification	Importa a especificação da API.	Extension	disponibilidade geral
az apic api definition list	Liste uma coleção de definições de API.	Extension	disponibilidade geral
az apic api definition show	Obtenha detalhes da definição da API.	Extension	disponibilidade geral
az apic api definition update	Atualize a definição de API existente.	Extension	disponibilidade geral
az apic api delete	Exclua a API especificada.	Extension	disponibilidade geral
az apic api deployment	Comandos para gerenciar implantações de API na Central de APIs.	Extension	disponibilidade geral
az apic api deployment create	Crie uma nova implantação de API ou atualize uma implantação de API existente.	Extension	disponibilidade geral
az apic api deployment delete	Exclua a implantação da API.	Extension	disponibilidade geral
az apic api deployment list	Listar uma coleção de implantações de API.	Extension	disponibilidade geral
az apic api deployment show	Obtenha detalhes da implantação da API.	Extension	disponibilidade geral
az apic api deployment update	Atualize a implantação da API existente.	Extension	disponibilidade geral
az apic api list	Liste uma coleção de APIs.	Extension	disponibilidade geral
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.	Extension	Preview
az apic api show	Obtenha detalhes da API.	Extension	disponibilidade geral
az apic api update	Atualize a API existente.	Extension	disponibilidade geral
az apic api version	Comandos para gerenciar versões de API no Centro de APIs.	Extension	disponibilidade geral
az apic api version create	Crie uma nova versão da API ou atualize uma versão da API existente.	Extension	disponibilidade geral
az apic api version delete	Exclua a versão especificada da API.	Extension	disponibilidade geral
az apic api version list	Liste uma coleção de versões da API.	Extension	disponibilidade geral
az apic api version show	Obtenha detalhes da versão da API.	Extension	disponibilidade geral
az apic api version update	Atualize a versão existente da API.	Extension	disponibilidade geral
az apic create	Cria uma instância ou atualiza uma instância existente de um serviço do Centro de API do Azure.	Extension	disponibilidade geral
az apic delete	Exclui uma instância de um serviço da Central de API do Azure.	Extension	disponibilidade geral
az apic environment	Comandos para gerenciar ambientes na Central de APIs.	Extension	disponibilidade geral
az apic environment create	Crie um novo ambiente ou atualize um ambiente existente.	Extension	disponibilidade geral
az apic environment delete	Elimine o ambiente.	Extension	disponibilidade geral
az apic environment list	Liste uma coleção de ambientes.	Extension	disponibilidade geral
az apic environment show	Obtenha detalhes do ambiente.	Extension	disponibilidade geral
az apic environment update	Atualize o ambiente existente.	Extension	disponibilidade geral
az apic integration	Gerencia integrações na Central de APIs do Azure.	Extension	disponibilidade geral
az apic integration create	Gerencie os serviços da Central de API do Azure.	Extension	disponibilidade geral
az apic integration create apim	Adicione a API do Azure como uma fonte de API.	Extension	disponibilidade geral
az apic integration create aws	Adicione o Amazon API Gateway como uma fonte de API.	Extension	disponibilidade geral
az apic integration delete	Exclua a fonte de API especificada.	Extension	disponibilidade geral
az apic integration list	Liste uma coleção de fontes de API.	Extension	disponibilidade geral
az apic integration show	Obtenha detalhes da origem da API.	Extension	disponibilidade geral
az apic list	Lista os serviços do Centro de API do Azure em uma assinatura do Azure.	Extension	disponibilidade geral
az apic metadata	Comandos para gerenciar esquemas de metadados na Central de APIs.	Extension	disponibilidade geral
az apic metadata create	Crie um novo esquema de metadados ou atualize um esquema de metadados existente.	Extension	disponibilidade geral
az apic metadata delete	Exclua o esquema de metadados especificado.	Extension	disponibilidade geral
az apic metadata export	Exporta o esquema de metadados.	Extension	disponibilidade geral
az apic metadata list	Listar uma coleção de esquemas de metadados.	Extension	disponibilidade geral
az apic metadata show	Obtenha detalhes do esquema de metadados.	Extension	disponibilidade geral
az apic metadata update	Atualize o esquema de metadados existente.	Extension	disponibilidade geral
az apic show	Mostrar detalhes de uma instância de serviço do Centro de API do Azure.	Extension	disponibilidade geral
az apic update	Atualize uma instância de um serviço do Centro de API do Azure.	Extension	disponibilidade geral

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 exemplo de serviço

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

Criar serviço com exemplo de identidade atribuída pelo sistema

az apic create -g contoso-resources -n contoso -l eastus --identity '{type:systemassigned}'

Parâmetros Obrigatórios

--name -n

O nome do serviço do Centro de APIs.

--resource-group -g

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

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

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

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

Propriedade	Valor
Default value:	False

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

Excluir serviço

az apic delete -n contoso -g contoso-resources

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--ids

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

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--name -n

O nome do serviço do Centro de APIs.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--resource-group -g

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

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--subscription

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

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--yes -y

Não solicite confirmação.

Propriedade	Valor
Default value:	False

Parâmetros de Globais

--debug

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

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Propriedade	Valor
Default value:	False

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--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 em --next-token argumento de um comando subsequente.

Propriedade	Valor
Grupo de parâmetros:	Pagination Arguments

--next-token

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

Propriedade	Valor
Grupo de parâmetros:	Pagination Arguments

--resource-group -g

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.

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

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

Propriedade	Valor
Default value:	False

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--ids

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--name -n

O nome do serviço do Centro de APIs.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--resource-group -g

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

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--subscription

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

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

Parâmetros de Globais

--debug

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

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Propriedade	Valor
Default value:	False

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

Exemplo de serviço de atualização com identidade atribuída pelo sistema

az apic update -g contoso-resources -n contoso --identity '{type:systemassigned}'

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

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

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments

--force-string

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

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments
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

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--name -n

O nome do serviço do Centro de APIs.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--remove

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

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments

--resource-group -g

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

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--set

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

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments

--subscription

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

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

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

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Propriedade	Valor
Default value:	False

Feedback

Esta página foi útil?

Partilhar via

az apic

Comandos

az apic create

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az apic delete

Exemplos

Parâmetros Opcionais

az apic list

Exemplos

Parâmetros Opcionais

az apic show

Exemplos

Parâmetros Opcionais

az apic update

Exemplos

Parâmetros Opcionais

Feedback