az apim api
Gerenciar APIs de Gerenciamento de API do Azure.
Comandos
Nome | Description | Tipo | Status |
---|---|---|---|
az apim api create |
Crie uma API de Gerenciamento de API. |
Núcleo | GA |
az apim api delete |
Exclua uma API de Gerenciamento de API. |
Núcleo | GA |
az apim api export |
Exporte uma API de Gerenciamento de API. |
Núcleo | GA |
az apim api import |
Importe uma API de Gerenciamento de API. |
Núcleo | GA |
az apim api list |
Listar APIs de Gerenciamento de APIs. |
Núcleo | GA |
az apim api operation |
Gerenciar operações de API de gerenciamento de API do Azure. |
Núcleo | GA |
az apim api operation create |
Cria uma nova operação na API. |
Núcleo | GA |
az apim api operation delete |
Exclui a operação especificada na API. |
Núcleo | GA |
az apim api operation list |
Liste uma coleção das operações para a API especificada. |
Núcleo | GA |
az apim api operation show |
Obtém os detalhes da Operação de API especificada por seu identificador. |
Núcleo | GA |
az apim api operation update |
Atualiza os detalhes da operação na API especificada por seu identificador. |
Núcleo | GA |
az apim api release |
Gerenciar a versão da API de gerenciamento de API do Azure. |
Núcleo | GA |
az apim api release create |
Cria uma versão para a API. |
Núcleo | GA |
az apim api release delete |
Exclui a versão especificada na API. |
Núcleo | GA |
az apim api release list |
Lista todas as versões de uma API. |
Núcleo | GA |
az apim api release show |
Retorna os detalhes de uma versão da API. |
Núcleo | GA |
az apim api release update |
Atualiza os detalhes da versão da API especificada por seu identificador. |
Núcleo | GA |
az apim api revision |
Gerenciar a revisão da API de Gerenciamento de API do Azure. |
Núcleo | GA |
az apim api revision create |
Criar revisão de API. |
Núcleo | GA |
az apim api revision list |
Lista todas as revisões de uma API. |
Núcleo | GA |
az apim api schema |
Gerenciar esquemas de API de gerenciamento de API do Azure. |
Núcleo | GA |
az apim api schema create |
Crie um esquema de API de gerenciamento de API. |
Núcleo | GA |
az apim api schema delete |
Exclua um esquema de API de gerenciamento de API. |
Núcleo | GA |
az apim api schema get-etag |
Obtenha etag de um esquema de API de Gerenciamento de API. |
Núcleo | GA |
az apim api schema list |
Listar esquemas de API de Gerenciamento de API. |
Núcleo | GA |
az apim api schema show |
Mostrar detalhes de um esquema de API de gerenciamento de API. |
Núcleo | GA |
az apim api schema wait |
Coloque a CLI em um estado de espera até que uma condição de um esquema apim api seja atendida. |
Núcleo | GA |
az apim api show |
Mostrar detalhes de uma API de Gerenciamento de API. |
Núcleo | GA |
az apim api update |
Atualize uma API de Gerenciamento de API. |
Núcleo | GA |
az apim api versionset |
Gerenciar o conjunto de versões da API de Gerenciamento de API do Azure. |
Núcleo | GA |
az apim api versionset create |
Cria um conjunto de versões de API. |
Núcleo | GA |
az apim api versionset delete |
Exclui o conjunto de versões de API específico. |
Núcleo | GA |
az apim api versionset list |
Lista uma coleção de conjuntos de versão de API na instância de serviço especificada. |
Núcleo | GA |
az apim api versionset show |
Obtém os detalhes do Conjunto de Versão da Api especificado por seu identificador. |
Núcleo | GA |
az apim api versionset update |
Atualiza os detalhes do Api VersionSet especificado por seu identificador. |
Núcleo | GA |
az apim api wait |
Coloque a CLI em um estado de espera até que uma condição de uma apim apim seja atendida. |
Núcleo | GA |
az apim api create
Crie uma API de Gerenciamento de API.
az apim api create --api-id
--display-name
--path
--resource-group
--service-name
[--api-type {graphql, http, soap, websocket}]
[--authorization-scope]
[--authorization-server-id]
[--bearer-token-sending-methods]
[--description]
[--no-wait]
[--open-id-provider-id]
[--protocols {http, https, ws, wss}]
[--service-url]
[--subscription-key-header-name]
[--subscription-key-query-param-name]
[--subscription-key-required]
[--subscription-required {false, true}]
Exemplos
Crie uma API básica.
az apim api create --service-name MyApim -g MyResourceGroup --api-id MyApi --path '/myapi' --display-name 'My API'
Parâmetros Exigidos
Nome exclusivo da api a ser criada.
Identificador de revisão de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. Revisão não corrente tem ; rev=n como um sufixo onde n é o número da revisão.
Nome para exibição da API a ser criada.
Caminho para a API.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
O nome da instância do serviço de Gerenciamento de API.
Parâmetros Opcionais
O tipo da API.
Especifica o escopo de operações OAuth.
Especifica a ID do servidor de autorização OAuth.
Especifica os métodos de envio para o token de portador.
A descrição da API. Pode incluir marcas de formatação HTML.
Não aguarde a conclusão da operação de execução longa.
Especifica o openid na configuração de autenticação.
Descreve em quais protocolos as operações nessa API podem ser invocadas.
A URL absoluta do serviço de back-end implementado esta API. Não pode ter mais de 2000 caracteres.
Especifica o nome do cabeçalho da chave de assinatura.
Especifica o nome do parâmetro da cadeia de caracteres de consulta da chave de assinatura.
Especifica se a chave de assinatura é necessária durante a chamada para esta API, true - API é incluída somente em produtos fechados, false - API é incluída apenas em produtos abertos, null - há uma mistura de produtos.
Se true, a API requer uma chave de assinatura nas solicitações.
Parâmetros Globais
Aumente o detalhamento 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.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az apim api delete
Exclua uma API de Gerenciamento de API.
az apim api delete --api-id
--resource-group
--service-name
[--delete-revisions]
[--if-match]
[--no-wait]
[--yes]
Parâmetros Exigidos
Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. Revisão não corrente tem ; rev=n como um sufixo onde n é o número da revisão.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
O nome da instância do serviço de Gerenciamento de API.
Parâmetros Opcionais
Exclua todas as revisões da Api.
ETag da entidade.
Não aguarde a conclusão da operação de execução longa.
Não solicite confirmação.
Parâmetros Globais
Aumente o detalhamento 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.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az apim api export
Exporte uma API de Gerenciamento de API.
az apim api export --api-id
--ef {OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl}
--resource-group
--service-name
[--file-path]
Exemplos
Exporte uma API de Gerenciamento de API para um arquivo ou retorne uma resposta contendo um link da exportação.
az apim api export -g MyResourceGroup --service-name MyApim --api-id MyApi --export-format OpenApiJson --file-path path
Parâmetros Exigidos
Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. Revisão não corrente tem ; rev=n como um sufixo onde n é o número da revisão. Padrão Regex: ^[^*#&+:<>?] +$.
Especifique o formato da API de exportação.
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
O nome da instância do serviço de gerenciamento de api.
Parâmetros Opcionais
Caminho do arquivo especificado para exportar a API.
Parâmetros Globais
Aumente o detalhamento 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.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az apim api import
Importe uma API de Gerenciamento de API.
az apim api import --path
--resource-group
--service-name
--specification-format {GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl}
[--api-id]
[--api-revision]
[--api-type {graphql, http, soap, websocket}]
[--api-version]
[--api-version-set-id]
[--description]
[--display-name]
[--no-wait]
[--protocols {http, https, ws, wss}]
[--service-url]
[--soap-api-type]
[--specification-path]
[--specification-url]
[--subscription-key-header-name]
[--subscription-key-query-param-name]
[--subscription-required {false, true}]
[--wsdl-endpoint-name]
[--wsdl-service-name]
Exemplos
Importar uma API de gerenciamento de API de um arquivo ou URL
az apim api import -g MyResourceGroup --service-name MyApim --path MyApi --specification-url https://MySpecificationURL --specification-format OpenApiJson
Parâmetros Exigidos
Obrigatório. A URL relativa que identifica exclusivamente esta API e todos os seus caminhos de recurso dentro da instância do serviço de Gerenciamento de API.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
O nome da instância do serviço de gerenciamento de api.
Especifique o formato da API importada.
Parâmetros Opcionais
Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. Revisão não corrente tem ; rev=n como um sufixo onde n é o número da revisão.
Descreve a revisão da api. Se nenhum valor for fornecido, a revisão padrão 1 será criada.
O tipo da API.
Descreve a versão da api. Se você adicionar uma versão a uma API sem versão, uma versão original será criada automaticamente e responderá na URL padrão.
Descreve o conjunto de versões a ser usado com a API.
A descrição da API. Pode incluir marcas de formatação HTML.
Nome de exibição desta API.
Não aguarde a conclusão da operação de execução longa.
Descreve em quais protocolos (um ou mais) as operações nesta API podem ser invocadas.
A URL absoluta do serviço de back-end implementado esta API. Não pode ter mais de 2000 caracteres.
O tipo de API quando o formato de arquivo é WSDL.
Caminho do arquivo especificado para importar a API.
URL especificado para importar a API.
Especifica o nome do cabeçalho da chave de assinatura.
Especifica o nome do parâmetro da cadeia de caracteres de consulta da chave de assinatura.
Se true, a API requer uma chave de assinatura nas solicitações.
Nome local do ponto de extremidade WSDL (porta) a ser importado.
Nome local do Serviço WSDL a ser importado.
Parâmetros Globais
Aumente o detalhamento 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.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az apim api list
Listar APIs de Gerenciamento de APIs.
az apim api list --resource-group
--service-name
[--filter-display-name]
[--skip]
[--top]
Parâmetros Exigidos
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
O nome da instância do serviço de Gerenciamento de API.
Parâmetros Opcionais
Filtro de APIs por displayName.
Número de registros a serem ignorados.
Número de registros a serem retornados.
Parâmetros Globais
Aumente o detalhamento 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.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az apim api show
Mostrar detalhes de uma API de Gerenciamento de API.
az apim api show --api-id
--resource-group
--service-name
Parâmetros Exigidos
Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. Revisão não corrente tem ; rev=n como um sufixo onde n é o número da revisão.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
O nome da instância do serviço de Gerenciamento de API.
Parâmetros Globais
Aumente o detalhamento 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.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az apim api update
Atualize uma API de Gerenciamento de API.
az apim api update --api-id
--resource-group
--service-name
[--add]
[--api-type {graphql, http, soap, websocket}]
[--description]
[--display-name]
[--force-string]
[--if-match]
[--no-wait]
[--path]
[--protocols {http, https, ws, wss}]
[--remove]
[--service-url]
[--set]
[--subscription-key-header-name]
[--subscription-key-query-param-name]
[--subscription-required {false, true}]
[--tags]
Exemplos
Crie uma API básica.
az apim api update --service-name MyApim -g MyResourceGroup --api-id MyApi --description foo
Parâmetros Exigidos
Nome exclusivo da api a ser criada.
Identificador de revisão de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. Revisão não corrente tem ; rev=n como um sufixo onde n é o número da revisão.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
O nome da instância do serviço de Gerenciamento de API.
Parâmetros Opcionais
Adicione um objeto a uma lista de objetos especificando um caminho e pares de valores de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>
.
O tipo da API.
A descrição da API. Pode incluir marcas de formatação HTML.
Nome da API. Deve ter de 1 a 300 caracteres.
Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter para JSON.
ETag da entidade. Não é necessário ao criar uma entidade, mas é necessário ao atualizar uma entidade. O valor padrão é Nenhum.
Não aguarde a conclusão da operação de execução longa.
Obrigatório. A URL relativa que identifica exclusivamente esta API e todos os seus caminhos de recurso dentro da instância do serviço de Gerenciamento de API.
Descreve em quais protocolos as operações nessa API podem ser invocadas.
Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove>
OU --remove propertyToRemove
.
A URL absoluta do serviço de back-end implementado esta API. Não pode ter mais de 2000 caracteres.
Atualize um objeto especificando um caminho de propriedade e um valor a serem definidos. Exemplo: --set property1.property2=<value>
.
Especifica o nome do cabeçalho da chave de assinatura.
Especifica o nome do parâmetro da cadeia de caracteres de consulta da chave de assinatura.
Se true, a API requer uma chave de assinatura nas solicitações.
Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar as tags existentes.
Parâmetros Globais
Aumente o detalhamento 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.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az apim api wait
Coloque a CLI em um estado de espera até que uma condição de uma apim apim seja atendida.
az apim api wait --api-id
--name
--resource-group
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]
Exemplos
Coloque a CLI em um estado de espera até que uma condição de uma apim apim seja atendida. (gerado automaticamente)
az apim api wait --created --api-id MyApi --name MyApim --resource-group MyResourceGroup
Parâmetros Exigidos
Identificador de revisão de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. Revisão não corrente tem ; rev=n como um sufixo onde n é o número da revisão. Obrigatório.
O nome da instância do serviço de gerenciamento de api.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Parâmetros Opcionais
Aguarde até criar com 'provisioningState' em 'Succeeded'.
Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Aguarde até ser excluído.
Aguarde até que o recurso exista.
Intervalo de sondagem em segundos.
Espera máxima em segundos.
Aguarde até que seja atualizado com provisioningState em 'Succeeded'.
Parâmetros Globais
Aumente o detalhamento 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.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.