az apim api

Gerenciar API de Gerenciamento de API do Azure.

Comandos

Nome	Description	Tipo	Status
az apim api create	Crie uma API de Gerenciamento de API.	Core	GA
az apim api delete	Exclua uma API de Gerenciamento de API.	Core	GA
az apim api export	Exportar uma API de Gerenciamento de API.	Core	GA
az apim api import	Importar uma API de Gerenciamento de API.	Core	GA
az apim api list	Listar API de Gerenciamento de API.	Core	GA
az apim api operation	Gerenciar operações da API de Gerenciamento de API do Azure.	Core	GA
az apim api operation create	Cria uma nova operação na API.	Core	GA
az apim api operation delete	Exclui a operação especificada na API.	Core	GA
az apim api operation list	Liste uma coleção das operações para a API especificada.	Core	GA
az apim api operation show	Obtém os detalhes da Operação de API especificada por seu identificador.	Core	GA
az apim api operation update	Atualiza os detalhes da operação na API especificada por seu identificador.	Core	GA
az apim api release	Gerenciar a versão da API de Gerenciamento de API do Azure.	Core	GA
az apim api release create	Cria uma nova versão para a API.	Core	GA
az apim api release delete	Exclui a versão especificada na API.	Core	GA
az apim api release list	Lista todas as versões de uma API.	Core	GA
az apim api release show	Retorna os detalhes de uma versão da API.	Core	GA
az apim api release update	Atualiza os detalhes da versão da API especificada por seu identificador.	Core	GA
az apim api revision	Gerenciar a revisão da API de Gerenciamento de API do Azure.	Core	GA
az apim api revision create	Criar revisão de API.	Core	GA
az apim api revision list	Lista todas as revisões de uma API.	Core	GA
az apim api schema	Gerenciar esquemas de API de Gerenciamento de API do Azure.	Core	GA
az apim api schema create	Criar um esquema de API de Gerenciamento de API.	Core	GA
az apim api schema delete	Excluir um esquema de API de Gerenciamento de API.	Core	GA
az apim api schema get-etag	Obter a etag de um esquema de API de Gerenciamento de API.	Core	GA
az apim api schema list	Listar esquemas de API de Gerenciamento de API.	Core	GA
az apim api schema show	Mostrar detalhes de um esquema de API de Gerenciamento de API.	Core	GA
az apim api schema wait	Coloque a CLI em um estado de espera até que uma condição de um esquema de api apim seja atendida.	Core	GA
az apim api show	Mostrar detalhes de uma API de Gerenciamento de API.	Core	GA
az apim api update	Atualize uma API de Gerenciamento de API.	Core	GA
az apim api versionset	Gerenciar o conjunto de versões da API de Gerenciamento de API do Azure.	Core	GA
az apim api versionset create	Cria um conjunto de versões de API.	Core	GA
az apim api versionset delete	Exclui um conjunto de versão de API específico.	Core	GA
az apim api versionset list	Lista uma coleção de Conjuntos de Versões de API na instância de serviço especificada.	Core	GA
az apim api versionset show	Obtém os detalhes do Conjunto de Versões da API especificado por seu identificador.	Core	GA
az apim api versionset update	Atualiza os detalhes do Conjunto de Versões da API especificado por seu identificador.	Core	GA
az apim api wait	Coloque a CLI em um estado de espera até que uma condição de uma api apim seja atendida.	Core	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. A revisão não atual tem; rev=n como um sufixo em que 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 gerenciamento de API.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--api-type

O tipo da API.

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

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

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--no-wait

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

Propriedade	Valor
Valor padrão:	False

--open-id-provider-id

Especifica a 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 aceitos:	http, https, ws, wss

--service-url

URL absoluta do serviço de back-end que implementa essa API. Não pode ter mais de 2.000 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 de 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 essa API, true – a API é incluída apenas em produtos fechados, false – a API é incluída apenas em produtos abertos, nulo – há uma combinação de produtos.

--subscription-required

Se for true, a API exigirá uma chave de assinatura nas solicitações.

Propriedade	Valor
Grupo de parâmetros:	API Arguments
Valor padrão:	False
Valores aceitos:	false, true

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	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 Exigidos

--api-id

Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. A revisão não atual tem; rev=n como um sufixo em que 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 gerenciamento de API.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

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

Propriedade	Valor
Valor padrão:	False

--yes -y

Não solicite confirmação.

Propriedade	Valor
Valor padrão:	False

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	False

az apim api export

Editar

Exportar 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 que contenha 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. A revisão não atual tem; rev=n como um sufixo em que 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 aceitos:	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 se tornar obrigatórios para que o comando seja executado com sucesso.

--file-path -f

Caminho do arquivo especificado para exportar a API.

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	False

az apim api import

Editar

Importar 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 uma URL

az apim api import -g MyResourceGroup --service-name MyApim --path MyApi --specification-url https://MySpecificationURL --specification-format OpenApiJson

Parâmetros Exigidos

--path

Required. URL relativa identificando exclusivamente essa API e todos os seus caminhos de recurso 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 aceitos:	GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--api-id

Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. A revisão não atual tem; rev=n como um sufixo em que 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 aceitos:	graphql, http, soap, websocket

--api-version

Descreve a versão da API. Se você adicionar uma versão a uma API não com 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 marcas de formatação HTML.

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--display-name

Nome de exibição dessa API.

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--no-wait

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

Propriedade	Valor
Valor padrão:	False

--protocols

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

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

--service-url

URL absoluta do serviço de back-end que implementa essa API. Não pode ter mais de 2.000 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 de chave de assinatura.

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--subscription-required

Se for true, a API exigirá uma chave de assinatura nas solicitações.

Propriedade	Valor
Grupo de parâmetros:	API Arguments
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 a verbosidade de log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	False

az apim api list

Editar

Listar API de Gerenciamento de API.

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 gerenciamento de API.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--filter-display-name

Filtro de APIs por displayName.

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--skip

Número de registros a serem ignoradas.

--top

Número de registros a serem retornados.

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	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 Exigidos

--api-id

Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. A revisão não atual tem; rev=n como um sufixo em que 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 gerenciamento de API.

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	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 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. A revisão não atual tem; rev=n como um sufixo em que 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 gerenciamento de API.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--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
Valor padrão:	[]

--api-type

O tipo da API.

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

--description

Descrição da API. Pode incluir marcas 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 cadeia de caracteres em vez de tentar converter em JSON.

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

--no-wait

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

Propriedade	Valor
Valor padrão:	False

--path

Required. URL relativa identificando exclusivamente essa API e todos os seus caminhos de recurso 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 aceitos:	http, https, ws, wss

--remove

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

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments
Valor padrão:	[]

--service-url

URL absoluta do serviço de back-end que implementa essa API. Não pode ter mais de 2.000 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
Valor padrão:	[]

--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 de chave de assinatura.

Propriedade	Valor
Grupo de parâmetros:	API Arguments

--subscription-required

Se for true, a API exigirá uma chave de assinatura nas solicitações.

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

--tags

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

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	False

az apim api wait

Editar

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

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. A revisão não atual tem; rev=n como um sufixo em que 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--created

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

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	False

--custom

Aguarde até que a condição atenda 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
Valor padrão:	False

--exists

Aguarde até que o recurso exista.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	False

--interval

Intervalo de sondagem em segundos.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	30

--timeout

Espera máxima em segundos.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	3600

--updated

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

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	False

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	False

Comentários

Esta página foi útil?

Compartilhar via

az apim api

Comandos

az apim api create

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az apim api delete

Parâmetros Exigidos

Parâmetros Opcionais

az apim api export

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az apim api import

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az apim api list

Parâmetros Exigidos

Parâmetros Opcionais

az apim api show

Parâmetros Exigidos

az apim api update

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az apim api wait

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

Comentários