az apim

Referência

Gerenciar serviços de Gerenciamento de API do Azure.

Comandos

Nome	Description	Tipo	Status
az apim api	Gerenciar APIs de Gerenciamento de API do Azure.	Núcleo	GA
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 apply-network-updates	Atualize o recurso Gerenciamento de API em execução na rede virtual para escolher as configurações de rede atualizadas.	Núcleo	GA
az apim backup	Cria um backup do serviço de Gerenciamento de API para a Conta de Armazenamento do Azure fornecida. Esta é uma operação de longa duração e pode levar vários minutos para ser concluída.	Núcleo	GA
az apim check-name	Verifica se um nome de serviço está disponível para uso.	Núcleo	GA
az apim create	Crie uma instância do serviço de Gerenciamento de API.	Núcleo	GA
az apim delete	Exclui um serviço de Gerenciamento de API.	Núcleo	GA
az apim deletedservice	Gerenciar serviços de Gerenciamento de API do Azure excluídos por software.	Núcleo	GA
az apim deletedservice list	Liste todas as instâncias de serviços de Gerenciamento de Api excluídas por software disponíveis para exclusão para a assinatura especificada.	Núcleo	GA
az apim deletedservice purge	Limpar instância do serviço de Gerenciamento de Api excluída por software (exclui-a sem opção de cancelar exclusão).	Núcleo	GA
az apim deletedservice show	Obtenha instâncias de serviço de Gerenciamento de Api excluídas por software disponíveis para exclusão por nome.	Núcleo	GA
az apim graphql	Gerenciar APIs do Azure API Management GraphQL.	Núcleo	GA
az apim graphql resolver	Gerenciar resolvedores da API GraphQL do Azure API Management.	Núcleo	GA
az apim graphql resolver create	Crie um novo resolvedor na API do GraphQL ou atualize um existente.	Núcleo	GA
az apim graphql resolver delete	Exclua o resolvedor especificado na API GraphQL.	Núcleo	GA
az apim graphql resolver list	Liste uma coleção dos resolvedores para a API GraphQL especificada.	Núcleo	GA
az apim graphql resolver policy	Gerenciar políticas de resolvedores da API GraphQL de gerenciamento de API do Azure.	Núcleo	GA
az apim graphql resolver policy create	Crie ou atualize a configuração de política para o nível do Resolvedor de API do GraphQL.	Núcleo	GA
az apim graphql resolver policy delete	Exclua a configuração da política no GraphQL Api Resolver.	Núcleo	GA
az apim graphql resolver policy list	Obtenha a lista de configurações de políticas no nível do Resolvedor de API do GraphQL.	Núcleo	GA
az apim graphql resolver policy show	Obtenha a configuração da política no nível do Resolvedor de API do GraphQL.	Núcleo	GA
az apim graphql resolver show	Obtenha os detalhes do GraphQL API Resolver especificado por seu identificador.	Núcleo	GA
az apim list	Listar instâncias do serviço de Gerenciamento de API.	Núcleo	GA
az apim nv	Gerenciar valores nomeados de gerenciamento de API do Azure.	Núcleo	GA
az apim nv create	Crie um valor nomeado de gerenciamento de API.	Núcleo	GA
az apim nv delete	Exclua um valor nomeado de gerenciamento de API.	Núcleo	GA
az apim nv list	Listar valores nomeados de gerenciamento de API.	Núcleo	GA
az apim nv show	Mostrar detalhes de um Valor Nomeado de Gerenciamento de API.	Núcleo	GA
az apim nv show-secret	Obtém o segredo de um Valor Nomeado de Gerenciamento de API.	Núcleo	GA
az apim nv update	Atualize um valor nomeado de gerenciamento de API.	Núcleo	GA
az apim nv wait	Coloque a CLI em um estado de espera até que uma condição de um valor nomeado apim seja atendida.	Núcleo	GA
az apim product	Gerenciar Produtos de Gerenciamento de API do Azure.	Núcleo	GA
az apim product api	Gerenciar as APIs do Produto de Gerenciamento de API do Azure.	Núcleo	GA
az apim product api add	Adicione uma API ao produto especificado.	Núcleo	GA
az apim product api check	Verifica se a entidade de API especificada pelo identificador está associada à entidade Produto.	Núcleo	GA
az apim product api delete	Exclui a API especificada do produto especificado.	Núcleo	GA
az apim product api list	Lista uma coleção das APIs associadas a um produto.	Núcleo	GA
az apim product create	Cria um produto.	Núcleo	GA
az apim product delete	Excluir produto.	Núcleo	GA
az apim product list	Lista uma coleção de produtos na instância de serviço especificada.	Núcleo	GA
az apim product show	Obtém os detalhes do produto especificado por seu identificador.	Núcleo	GA
az apim product update	Atualize os detalhes do produto existente.	Núcleo	GA
az apim product wait	Coloque a CLI em um estado de espera até que uma condição de um produto apim seja atendida.	Núcleo	GA
az apim restore	Restaura um backup de um serviço de Gerenciamento de API criado usando a operação ApiManagementService_Backup no serviço atual. Esta é uma operação de longa duração e pode levar vários minutos para ser concluída.	Núcleo	GA
az apim show	Mostrar detalhes de uma instância de serviço de Gerenciamento de API.	Núcleo	GA
az apim update	Atualize uma instância do serviço de Gerenciamento de API.	Núcleo	GA
az apim wait	Coloque a CLI em um estado de espera até que uma condição de um apim seja atendida.	Núcleo	GA

az apim apply-network-updates

Editar

Atualize o recurso Gerenciamento de API em execução na rede virtual para escolher as configurações de rede atualizadas.

az apim apply-network-updates --name
                              --resource-group
                              [--location]
                              [--no-wait]

Exemplos

Atualizar as configurações de rede virtual da instância do serviço de Gerenciamento de API

az apim apply-network-updates --name MyApim -g MyResourceGroup

Parâmetros Exigidos

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

--location -l

Local. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

--no-wait

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

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 backup

Editar

Cria um backup do serviço de Gerenciamento de API para a Conta de Armazenamento do Azure fornecida. Esta é uma operação de longa duração e pode levar vários minutos para ser concluída.

az apim backup --backup-name
               --container-name
               --name
               --resource-group
               --storage-account-key
               --storage-account-name
               [--no-wait]

Exemplos

Criar um backup da instância do serviço de Gerenciamento de API

az apim backup --name MyApim -g MyResourceGroup --backup-name myBackup              --storage-account-name mystorageaccount --storage-account-container backups              --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==

Parâmetros Exigidos

--backup-name

O nome do arquivo de backup a ser criado.

--container-name --storage-account-container

O nome do contêiner da conta de armazenamento usado para fazer o backup.

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

--storage-account-key

A chave de acesso da conta de armazenamento usada para fazer o backup.

--storage-account-name

O nome da conta de armazenamento usada para fazer o backup.

Parâmetros Opcionais

--no-wait

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

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

Editar

Verifica se um nome de serviço está disponível para uso.

az apim check-name --name

Parâmetros Exigidos

--name -n

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 create

Editar

Crie uma instância do serviço de Gerenciamento de API.

az apim create --name
               --publisher-email
               --publisher-name
               --resource-group
               [--disable-gateway {false, true}]
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--location]
               [--no-wait]
               [--public-network-access {false, true}]
               [--sku-capacity]
               [--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
               [--tags]
               [--virtual-network {External, Internal, None}]

Exemplos

Crie um serviço de Gerenciamento de API da camada de desenvolvedor.

az apim create --name MyApim -g MyResourceGroup -l eastus --publisher-email email@mydomain.com --publisher-name Microsoft

Crie um serviço de Gerenciamento de API da camada de consumo.

az apim create --name MyApim -g MyResourceGroup -l eastus --sku-name Consumption --enable-client-certificate \
    --publisher-email email@mydomain.com --publisher-name Microsoft

Parâmetros Exigidos

--name -n

Nome exclusivo da instância de serviço a ser criada.

O nome deve ser globalmente exclusivo, pois será incluído como o nome de host do gateway como ' https://my-api-servicename.azure-api.net'. Consulte os exemplos.

--publisher-email

O endereço de e-mail para receber todas as notificações do sistema.

--publisher-name

O nome da sua organização para uso no portal do desenvolvedor e nas notificações por email.

--resource-group -g

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

Parâmetros Opcionais

--disable-gateway

Desative o gateway na região mestre. Válido apenas para um serviço de Gerenciamento de Api implantado em vários locais.

valores aceitos: false, true

--enable-client-certificate

Impõe um certificado de cliente a ser apresentado em cada solicitação ao gateway e também permite a capacidade de autenticar o certificado na política no gateway.

valores aceitos: false, true

--enable-managed-identity

Crie uma identidade gerenciada para o serviço de Gerenciamento de API para acessar outros recursos do Azure. Destina-se apenas a ser usado para o Serviço de SKU de Consumo.

valores aceitos: false, true

valor padrão: False

--location -l

Local. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

--no-wait

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

valor padrão: False

--public-network-access

Se o acesso público ao ponto de extremidade é permitido ou não para esse serviço de Gerenciamento de API. Se definido como true, os pontos de extremidade privados serão o método de acesso exclusivo.

valores aceitos: false, true

--sku-capacity

O número de unidades implantadas da SKU.

valor padrão: 1

--sku-name

A sku da instância de gerenciamento de api.

valores aceitos: Basic, Consumption, Developer, Isolated, Premium, Standard

valor padrão: Developer

--tags

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

--virtual-network -v

O tipo de rede virtual.

valores aceitos: External, Internal, None

valor padrão: None

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 delete

Editar

Exclui um serviço de Gerenciamento de API.

az apim delete --name
               --resource-group
               [--no-wait]
               [--yes]

Exemplos

Exclua um serviço de Gerenciamento de API.

az apim delete -n MyApim -g MyResourceGroup

Parâmetros Exigidos

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

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

Editar

Listar instâncias do serviço de Gerenciamento de API.

az apim list [--resource-group]

Parâmetros Opcionais

--resource-group -g

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

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 restore

Editar

Restaura um backup de um serviço de Gerenciamento de API criado usando a operação ApiManagementService_Backup no serviço atual. Esta é uma operação de longa duração e pode levar vários minutos para ser concluída.

az apim restore --backup-name
                --container-name
                --name
                --resource-group
                --storage-account-key
                --storage-account-name
                [--no-wait]

Exemplos

Restaura um backup da instância do serviço de Gerenciamento de API

az apim restore --name MyApim -g MyResourceGroup --backup-name myBackup              --storage-account-name mystorageaccount --storage-account-container backups              --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==

Parâmetros Exigidos

--backup-name

O nome do arquivo de backup a ser restaurado.

--container-name --storage-account-container

O nome do contêiner da conta de armazenamento usado para recuperar o backup.

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

--storage-account-key

A chave de acesso da conta de armazenamento usada para recuperar o backup.

--storage-account-name

O nome da conta de armazenamento usada para recuperar o backup.

Parâmetros Opcionais

--no-wait

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

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 show

Editar

Mostrar detalhes de uma instância de serviço de Gerenciamento de API.

az apim show --name
             --resource-group

Parâmetros Exigidos

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

Editar

Atualize uma instância do serviço de Gerenciamento de API.

az apim update --name
               --resource-group
               [--add]
               [--disable-gateway {false, true}]
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--force-string]
               [--no-wait]
               [--public-network-access {false, true}]
               [--publisher-email]
               [--publisher-name]
               [--remove]
               [--set]
               [--sku-capacity]
               [--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
               [--tags]
               [--virtual-network {External, Internal, None}]

Parâmetros Exigidos

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

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

--disable-gateway

Desative o gateway na região mestre. Válido apenas para um serviço de Gerenciamento de Api implantado em vários locais.

valores aceitos: false, true

--enable-client-certificate

Impõe um certificado de cliente a ser apresentado em cada solicitação ao gateway e também permite a capacidade de autenticar o certificado na política no gateway.

valores aceitos: false, true

--enable-managed-identity

Crie uma identidade gerenciada para o serviço de Gerenciamento de API para acessar outros recursos do Azure. Destina-se apenas a ser usado para o Serviço de SKU de Consumo.

valores aceitos: false, true

--force-string

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

valor padrão: False

--no-wait

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

valor padrão: False

--public-network-access

valores aceitos: false, true

--publisher-email

O endereço de e-mail para receber todas as notificações do sistema.

--publisher-name

O nome da sua organização para uso no portal do desenvolvedor e nas notificações por email.

--remove

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

valor padrão: []

--set

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

valor padrão: []

--sku-capacity

O número de unidades implantadas da SKU.

--sku-name

A sku da instância de gerenciamento de api.

valores aceitos: Basic, Consumption, Developer, Isolated, Premium, Standard

--tags

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

--virtual-network -v

O tipo de rede virtual.

valores aceitos: External, Internal, None

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 wait

Editar

Coloque a CLI em um estado de espera até que uma condição de um apim seja atendida.

az apim wait --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 um apim seja atendida. (gerado automaticamente)

az apim wait --created --name MyApim --resource-group MyResourceGroup

Parâmetros Exigidos

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

Compartilhar via

az apim

Comandos

az apim apply-network-updates

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az apim backup

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az apim check-name

Parâmetros Exigidos

az apim create

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az apim delete

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az apim list

Parâmetros Opcionais

az apim restore

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az apim show

Parâmetros Exigidos

az apim update

Parâmetros Exigidos

Parâmetros Opcionais

az apim wait

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

Recursos adicionais