az apim api

Gerencie APIs de Gerenciamento de API do Azure.

Comandos

Name	Description	Tipo	Status
az apim api create	Crie uma API de gerenciamento de API.	Core	disponibilidade geral
az apim api delete	Exclua uma API de gerenciamento de API.	Core	disponibilidade geral
az apim api export	Exporte uma API de gerenciamento de API.	Core	disponibilidade geral
az apim api import	Importe uma API de gerenciamento de API.	Core	disponibilidade geral
az apim api list	Listar APIs de gerenciamento de APIs.	Core	disponibilidade geral
az apim api operation	Gerencie as operações da API de Gerenciamento de API do Azure.	Core	disponibilidade geral
az apim api operation create	Cria uma nova operação na API.	Core	disponibilidade geral
az apim api operation delete	Exclui a operação especificada na API.	Core	disponibilidade geral
az apim api operation list	Liste uma coleção das operações para a API especificada.	Core	disponibilidade geral
az apim api operation show	Obtém os detalhes da operação da API especificada por seu identificador.	Core	disponibilidade geral
az apim api operation update	Atualiza os detalhes da operação na API especificada por seu identificador.	Core	disponibilidade geral
az apim api release	Gerencie a versão da API de Gerenciamento de API do Azure.	Core	disponibilidade geral
az apim api release create	Cria uma nova versão para a API.	Core	disponibilidade geral
az apim api release delete	Exclui a versão especificada na API.	Core	disponibilidade geral
az apim api release list	Lista todas as versões de uma API.	Core	disponibilidade geral
az apim api release show	Retorna os detalhes de uma versão da API.	Core	disponibilidade geral
az apim api release update	Atualiza os detalhes da versão da API especificada por seu identificador.	Core	disponibilidade geral
az apim api revision	Gerencie a revisão da API de Gerenciamento de API do Azure.	Core	disponibilidade geral
az apim api revision create	Crie uma revisão de API.	Core	disponibilidade geral
az apim api revision list	Lista todas as revisões de uma API.	Core	disponibilidade geral
az apim api schema	Gerencie o esquema da API de Gerenciamento de API do Azure.	Core	disponibilidade geral
az apim api schema create	Crie um esquema de API de gerenciamento de API.	Core	disponibilidade geral
az apim api schema delete	Exclua um esquema de API de gerenciamento de API.	Core	disponibilidade geral
az apim api schema get-etag	Obtenha etag de um esquema de API de Gerenciamento de API.	Core	disponibilidade geral
az apim api schema list	Listar esquemas de API de Gerenciamento de API.	Core	disponibilidade geral
az apim api schema show	Mostrar detalhes de um esquema de API de gerenciamento de API.	Core	disponibilidade geral
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.	Core	disponibilidade geral
az apim api show	Mostrar detalhes de uma API de gerenciamento de API.	Core	disponibilidade geral
az apim api update	Atualize uma API de gerenciamento de API.	Core	disponibilidade geral
az apim api versionset	Gerencie o conjunto de versões da API de Gerenciamento de API do Azure.	Core	disponibilidade geral
az apim api versionset create	Cria um conjunto de versões da api.	Core	disponibilidade geral
az apim api versionset delete	Exclui o conjunto de versões da API específico.	Core	disponibilidade geral
az apim api versionset list	Lista uma coleção de conjuntos de versões de API na instância de serviço especificada.	Core	disponibilidade geral
az apim api versionset show	Obtém os detalhes do Api Version set especificado por seu identificador.	Core	disponibilidade geral
az apim api versionset update	Atualiza os detalhes do Api VersionSet especificado por seu identificador.	Core	disponibilidade geral
az apim api wait	Coloque a CLI em um estado de espera até que uma condição de uma apim api seja atendida.	Core	disponibilidade geral

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 Obrigatórios

--api-id

Nome exclusivo da api a ser criada.

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--display-name

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

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--path

Caminho para a API.

Propriedade	Valor
Grupo de parâmetros:	API Arguments

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

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.

--api-type

O tipo da API.

Propriedade	Valor
Grupo de parâmetros:	API Arguments
Valores aceites:	graphql, http, soap, websocket

--authorization-scope

Especifica o escopo das operações OAuth.

--authorization-server-id

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

--bearer-token-sending-methods

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

--description

Descrição da API. Pode incluir tags de formatação HTML.

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--no-wait

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

Propriedade	Valor
Default value:	False

--open-id-provider-id

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

--protocols

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

Propriedade	Valor
Grupo de parâmetros:	API Arguments
Valores aceites:	http, https, ws, wss

--service-url

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

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--subscription-key-header-name

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

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--subscription-key-query-param-name

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

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--subscription-key-required

Especifica se a chave de assinatura é necessária durante a chamada para esta API, true - a API está incluída apenas em produtos fechados, false - a API está incluída apenas em produtos abertos, null - há uma combinação de produtos.

--subscription-required

Se verdadeiro, a API requer uma chave de assinatura em solicitações.

Propriedade	Valor
Grupo de parâmetros:	API Arguments
Default value:	False
Valores aceites:	false, true

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 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 Obrigatórios

--api-id

Identificador de API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

Propriedade	Valor
Grupo de parâmetros:	API Arguments

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

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.

--delete-revisions

Exclua todas as revisões da Api.

--if-match

ETag da Entidade.

--no-wait

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

Propriedade	Valor
Default value:	False

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

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

Editar

Exporte uma API de gerenciamento de API.

az apim api export --api-id
                   --ef --export-format {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 Obrigatórios

--api-id

Identificador de API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão. Padrão Regex: ^[^*#&+:<>?]+$.

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--ef --export-format

Especifique o formato da API de exportação.

Propriedade	Valor
Valores aceites:	OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl

--resource-group -g

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

--service-name -n

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

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.

--file-path -f

Caminho do arquivo especificado para exportar a API.

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 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 Obrigatórios

--path

Required. URL relativa que identifica exclusivamente essa API e todos os seus caminhos de recursos dentro da instância do serviço de Gerenciamento de API.

Propriedade	Valor
Grupo de parâmetros:	API Arguments

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

Propriedade	Valor
Valores aceites:	GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl

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.

--api-id

Identificador de API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--api-revision

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

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--api-type

O tipo da API.

Propriedade	Valor
Grupo de parâmetros:	API Arguments
Valores aceites:	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.

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--api-version-set-id

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

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--description

Descrição da API. Pode incluir tags de formatação HTML.

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--display-name

Nome de exibição desta API.

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--no-wait

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

Propriedade	Valor
Default value:	False

--protocols

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

Propriedade	Valor
Grupo de parâmetros:	API Arguments
Valores aceites:	http, https, ws, wss

--service-url

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

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--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 especificada para importar a API.

--subscription-key-header-name

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

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--subscription-key-query-param-name

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

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--subscription-required

Se verdadeiro, a API requer uma chave de assinatura em solicitações.

Propriedade	Valor
Grupo de parâmetros:	API Arguments
Valores aceites:	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 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 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 Obrigatórios

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

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.

--filter-display-name

Filtro de APIs por displayName.

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--skip

Número de registos a ignorar.

--top

Número de registos a devolver.

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 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 Obrigatórios

--api-id

Identificador de API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--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 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 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 Obrigatórios

--api-id

Nome exclusivo da api a ser criada.

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

Propriedade	Valor
Grupo de parâmetros:	API Arguments

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

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
Default value:	[]

--api-type

O tipo da API.

Propriedade	Valor
Grupo de parâmetros:	API Arguments
Valores aceites:	graphql, http, soap, websocket

--description

Descrição da API. Pode incluir tags de formatação HTML.

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--display-name

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

Propriedade	Valor
Grupo de parâmetros:	API 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
Default value:	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 espere que a operação de longa duração termine.

Propriedade	Valor
Default value:	False

--path

Required. URL relativa que identifica exclusivamente essa API e todos os seus caminhos de recursos dentro da instância do serviço de Gerenciamento de API.

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--protocols

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

Propriedade	Valor
Grupo de parâmetros:	API Arguments
Valores aceites:	http, https, ws, wss

--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
Default value:	[]

--service-url

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

Propriedade	Valor
Grupo de parâmetros:	API 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
Default value:	[]

--subscription-key-header-name

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

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--subscription-key-query-param-name

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

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--subscription-required

Se verdadeiro, a API requer uma chave de assinatura em solicitações.

Propriedade	Valor
Grupo de parâmetros:	API Arguments
Valores aceites:	false, true

--tags

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

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

Editar

Coloque a CLI em um estado de espera até que uma condição de uma apim api 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 api apim seja atendida. (autogenerated)

az apim api wait --created --api-id MyApi --name MyApim --resource-group MyResourceGroup

Parâmetros Obrigatórios

--api-id

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão. Required.

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

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.

--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Default value:	False

--custom

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

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments

--deleted

Aguarde até ser excluído.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Default value:	False

--exists

Aguarde até que o recurso exista.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Default value:	False

--interval

Intervalo de sondagem em segundos.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Default value:	30

--timeout

Espera máxima em segundos.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Default value:	3600

--updated

Aguarde até ser atualizado com provisioningState em 'Succeeded'.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
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.

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

Feedback

Esta página foi útil?

Partilhar via

az apim api

Comandos

az apim api create

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az apim api delete

Parâmetros Obrigatórios

Parâmetros Opcionais

az apim api export

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az apim api import

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az apim api list

Parâmetros Obrigatórios

Parâmetros Opcionais

az apim api show

Parâmetros Obrigatórios

az apim api update

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az apim api wait

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

Feedback