Compartilhar via

az apim

Gerenciar serviços de Gerenciamento de API do Azure.

Comandos

Nome Description Tipo Status
az apim api

Gerenciar API de Gerenciamento de API do Azure.

 Core GA
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 apply-network-updates

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

 Core 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 execução prolongada e pode levar vários minutos para ser concluída.

 Core GA
az apim check-name

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

 Core GA
az apim create

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

 Core GA
az apim delete

Exclui um serviço de Gerenciamento de API.

 Core GA
az apim deletedservice

Gerenciar serviços de Gerenciamento de API do Azure com exclusão reversível.

 Core GA
az apim deletedservice list

Liste todas as instâncias de serviços de Gerenciamento de API excluídas de modo reversível disponíveis para desdelete para a assinatura fornecida.

 Core GA
az apim deletedservice purge

Limpe a instância do serviço de Gerenciamento de API com exclusão reversível (exclui-a sem nenhuma opção para desacomplicar).

 Core GA
az apim deletedservice show

Obtenha instâncias de serviço de Gerenciamento de API excluídas de modo reversível disponíveis para undelete por nome.

 Core GA
az apim graphql

Gerenciar a API do GraphQL do Gerenciamento de API do Azure.

 Core GA
az apim graphql resolver

Gerenciar resolvedores da API do GraphQL de Gerenciamento de API do Azure.

 Core GA
az apim graphql resolver create

Crie um novo resolvedor na API do GraphQL ou atualize um existente.

 Core GA
az apim graphql resolver delete

Exclua o resolvedor especificado na API do GraphQL.

 Core GA
az apim graphql resolver list

Liste uma coleção de resolvedores para a API do GraphQL especificada.

 Core GA
az apim graphql resolver policy

Gerenciar as políticas de resolvedores da API do GraphQL de Gerenciamento de API do Azure.

 Core GA
az apim graphql resolver policy create

Crie ou atualize a configuração de política para o nível de Resolvedor de API do GraphQL.

 Core GA
az apim graphql resolver policy delete

Exclua a configuração de política no Resolvedor de API do GraphQL.

 Core GA
az apim graphql resolver policy list

Obtenha a lista de configuração de política no nível do Resolvedor de API do GraphQL.

 Core GA
az apim graphql resolver policy show

Obtenha a configuração de política no nível do Resolvedor de API do GraphQL.

 Core GA
az apim graphql resolver show

Obtenha os detalhes do Resolvedor de API do GraphQL especificado por seu identificador.

 Core GA
az apim list

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

 Core GA
az apim nv

Gerenciar valores nomeados do Gerenciamento de API do Azure.

 Core GA
az apim nv create

Criar um valor nomeado de gerenciamento de API.

 Core GA
az apim nv delete

Excluir um valor nomeado do Gerenciamento de API.

 Core GA
az apim nv list

Listar valores nomeados do Gerenciamento de API.

 Core GA
az apim nv show

Mostrar detalhes de um Valor Nomeado do Gerenciamento de API.

 Core GA
az apim nv show-secret

Obtém o segredo de um Valor Nomeado do Gerenciamento de API.

 Core GA
az apim nv update

Atualize um valor nomeado de gerenciamento de API.

 Core GA
az apim nv wait

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

 Core GA
az apim product

Gerenciar produtos do Gerenciamento de API do Azure.

 Core GA
az apim product api

Gerenciar AS APIs do Produto de Gerenciamento de API do Azure.

 Core GA
az apim product api add

Adicione uma API ao produto especificado.

 Core GA
az apim product api check

Verifica se a entidade de API especificada pelo identificador está associada à entidade Product.

 Core GA
az apim product api delete

Exclui a API especificada do produto especificado.

 Core GA
az apim product api list

Lista uma coleção de APIs associadas a um produto.

 Core GA
az apim product create

Cria um produto.

 Core GA
az apim product delete

Excluir produto.

 Core GA
az apim product list

Lista uma coleção de produtos na instância de serviço especificada.

 Core GA
az apim product show

Obtém os detalhes do produto especificado por seu identificador.

 Core GA
az apim product update

Atualize os detalhes do produto existente.

 Core GA
az apim product wait

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

 Core 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 execução longa e pode levar vários minutos para ser concluída.

 Core GA
az apim show

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

 Core GA
az apim update

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

 Core GA
az apim wait

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

 Core GA

az apim apply-network-updates

Editar

Atualize o recurso de 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

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.

--location -l

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

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 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 execução prolongada e pode levar vários minutos para ser concluída.

az apim backup --backup-name
               --container-name --storage-account-container
               --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 colocar 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 colocar o backup.

Propriedade Valor
Grupo de parâmetros: Storage Arguments
--storage-account-name

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

Propriedade Valor
Grupo de parâmetros: Storage Arguments

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.

--no-wait

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

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

Editar

Crie uma instância de 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 ele será incluído como o nome do host do gateway como" https://my-api-servicename.azure-api.net". Veja exemplos.

--publisher-email

O endereço de email para receber todas as notificações do sistema.

--publisher-name

O nome da sua organização para uso no portal do desenvolvedor e 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

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.

--disable-gateway

Desabilite o gateway na região mestra. Válido apenas para um serviço de Gerenciamento de API implantado em vários locais.

Propriedade Valor
Valores aceitos: false, true
--enable-client-certificate

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

Propriedade Valor
Valores aceitos: false, true
--enable-managed-identity

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

Propriedade Valor
Valor padrão: False
Valores aceitos: false, true
--location -l

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

Propriedade Valor
Valor padrão: False
--public-network-access

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

Propriedade Valor
Valores aceitos: false, true
--sku-capacity

O número de unidades implantadas do SKU.

Propriedade Valor
Valor padrão: 1
--sku-name

O sku da instância de gerenciamento de API.

Propriedade Valor
Valor padrão: Developer
Valores aceitos: Basic, Consumption, Developer, Isolated, Premium, Standard
--tags

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

--virtual-network -v

O tipo de rede virtual.

Propriedade Valor
Valor padrão: None
Valores aceitos: External, Internal, None
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 delete

Editar

Exclui um serviço de Gerenciamento de API.

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

Exemplos

Excluir 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

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.

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

Editar

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

az apim list [--resource-group]

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.

--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 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 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 execução longa e pode levar vários minutos para ser concluída.

az apim restore --backup-name
                --container-name --storage-account-container
                --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.

Propriedade Valor
Grupo de parâmetros: Storage Arguments
--storage-account-name

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

Propriedade Valor
Grupo de parâmetros: Storage Arguments

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.

--no-wait

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

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

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

Desabilite o gateway na região mestra. Válido apenas para um serviço de Gerenciamento de API implantado em vários locais.

Propriedade Valor
Valores aceitos: false, true
--enable-client-certificate

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

Propriedade Valor
Valores aceitos: false, true
--enable-managed-identity

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

Propriedade Valor
Valores aceitos: false, true
--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
--no-wait

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

Propriedade Valor
Valor padrão: False
--public-network-access

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

Propriedade Valor
Valores aceitos: false, true
--publisher-email

O endereço de email para receber todas as notificações do sistema.

--publisher-name

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

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

O número de unidades implantadas do SKU.

--sku-name

O sku da instância de gerenciamento de API.

Propriedade Valor
Valores aceitos: Basic, Consumption, Developer, Isolated, Premium, Standard
--tags

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

--virtual-network -v

O tipo de rede virtual.

Propriedade Valor
Valores aceitos: External, Internal, None
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 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. (autogenerated)

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

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