Compartilhar via

az apim api

  • Referência

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

Editar

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

--api-id

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.

--display-name

Nome para exibição da API a ser criada.

--path

Caminho para a 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 da instância do serviço de Gerenciamento de API.

Parâmetros Opcionais

--api-type

O tipo da API.

Valores aceitos: graphql, http, soap, websocket
--authorization-scope

Especifica o escopo de operações OAuth.

--authorization-server-id

Especifica a ID do servidor de autorização OAuth.

--bearer-token-sending-methods

Especifica os métodos de envio para o token de portador.

--description

A descrição da API. Pode incluir marcas de formatação HTML.

--no-wait

Não aguarde a conclusão da operação de execução longa.

Valor padrão: False
--open-id-provider-id

Especifica o openid na configuração de autenticação.

--protocols

Descreve em quais protocolos as operações nessa API podem ser invocadas.

Valores aceitos: http, https, ws, wss
--service-url

A URL absoluta do serviço de back-end implementado esta API. Não pode ter mais de 2000 caracteres.

--subscription-key-header-name

Especifica o nome do cabeçalho da chave de assinatura.

--subscription-key-query-param-name

Especifica o nome do parâmetro da cadeia de caracteres de consulta da chave de assinatura.

--subscription-key-required

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.

--subscription-required

Se true, a API requer uma chave de assinatura nas solicitações.

Valores aceitos: false, true
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 apim api delete

Editar

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

--api-id

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.

--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 da instância do serviço de Gerenciamento de API.

Parâmetros Opcionais

--delete-revisions

Exclua todas as revisões da Api.

--if-match

ETag da entidade.

--no-wait

Não aguarde a conclusão da operação de execução longa.

Valor padrão: False
--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 apim api export

Editar

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

--api-id

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: ^[^*#&+:<>?] +$.

--ef --export-format

Especifique o formato da API de exportação.

Valores aceitos: OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl
--resource-group -g

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

--service-name -n

O nome da instância do serviço de gerenciamento de api.

Parâmetros Opcionais

--file-path -f

Caminho do arquivo especificado para exportar a 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 apim api import

Editar

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

--path

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.

--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 da instância do serviço de gerenciamento de api.

--specification-format

Especifique o formato da API importada.

Valores aceitos: GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl

Parâmetros Opcionais

--api-id

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.

--api-revision

Descreve a revisão da api. Se nenhum valor for fornecido, a revisão padrão 1 será criada.

--api-type

O tipo da API.

Valores aceitos: graphql, http, soap, websocket
--api-version

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.

--api-version-set-id

Descreve o conjunto de versões a ser usado com a API.

--description

A descrição da API. Pode incluir marcas de formatação HTML.

--display-name

Nome de exibição desta API.

--no-wait

Não aguarde a conclusão da operação de execução longa.

Valor padrão: False
--protocols

Descreve em quais protocolos (um ou mais) as operações nesta API podem ser invocadas.

Valores aceitos: http, https, ws, wss
--service-url

A URL absoluta do serviço de back-end implementado esta API. Não pode ter mais de 2000 caracteres.

--soap-api-type

O tipo de API quando o formato de arquivo é WSDL.

--specification-path

Caminho do arquivo especificado para importar a API.

--specification-url

URL especificado para importar a API.

--subscription-key-header-name

Especifica o nome do cabeçalho da chave de assinatura.

--subscription-key-query-param-name

Especifica o nome do parâmetro da cadeia de caracteres de consulta da chave de assinatura.

--subscription-required

Se true, a API requer uma chave de assinatura nas solicitações.

Valores aceitos: false, true
--wsdl-endpoint-name

Nome local do ponto de extremidade WSDL (porta) a ser importado.

--wsdl-service-name

Nome local do Serviço WSDL a ser importado.

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 apim api list

Editar

Listar APIs de Gerenciamento de APIs.

az apim api list --resource-group
                 --service-name
                 [--filter-display-name]
                 [--skip]
                 [--top]

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 da instância do serviço de Gerenciamento de API.

Parâmetros Opcionais

--filter-display-name

Filtro de APIs por displayName.

--skip

Número de registros a serem ignorados.

--top

Número de registros a serem retornados.

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 apim api show

Editar

Mostrar detalhes de uma API de Gerenciamento de API.

az apim api show --api-id
                 --resource-group
                 --service-name

Parâmetros Exigidos

--api-id

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.

--resource-group -g

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

--service-name

O nome da instância do serviço de Gerenciamento de 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 apim api update

Editar

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

--api-id

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.

--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 da instância do serviço de Gerenciamento de API.

Parâmetros Opcionais

--add

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

Valor padrão: []
--api-type

O tipo da API.

Valores aceitos: graphql, http, soap, websocket
--description

A descrição da API. Pode incluir marcas de formatação HTML.

--display-name

Nome da API. Deve ter de 1 a 300 caracteres.

--force-string

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

Valor padrão: False
--if-match

ETag da entidade. Não é necessário ao criar uma entidade, mas é necessário ao atualizar uma entidade. O valor padrão é Nenhum.

--no-wait

Não aguarde a conclusão da operação de execução longa.

Valor padrão: False
--path

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.

--protocols

Descreve em quais protocolos as operações nessa API podem ser invocadas.

Valores aceitos: http, https, ws, wss
--remove

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

Valor padrão: []
--service-url

A URL absoluta do serviço de back-end implementado esta API. Não pode ter mais de 2000 caracteres.

--set

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

Valor padrão: []
--subscription-key-header-name

Especifica o nome do cabeçalho da chave de assinatura.

--subscription-key-query-param-name

Especifica o nome do parâmetro da cadeia de caracteres de consulta da chave de assinatura.

--subscription-required

Se true, a API requer uma chave de assinatura nas solicitações.

Valores aceitos: false, true
--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar as tags existentes.

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 apim api wait

Editar

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

--api-id

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.

--name -n

O nome da instância do serviço de gerenciamento de api.

--resource-group -g

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

Parâmetros Opcionais

--created

Aguarde até criar com 'provisioningState' em 'Succeeded'.

Valor padrão: False
--custom

Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Aguarde até ser excluído.

Valor padrão: False
--exists

Aguarde até que o recurso exista.

Valor padrão: False
--interval

Intervalo de sondagem em segundos.

Valor padrão: 30
--timeout

Espera máxima em segundos.

Valor padrão: 3600
--updated

Aguarde até que seja atualizado com provisioningState em 'Succeeded'.

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.