az apim
Gerencie os serviços de Gerenciamento de API do Azure.
Comandos
Name | Description | Tipo | Estado |
---|---|---|---|
az apim api |
Gerencie APIs de Gerenciamento de API do Azure. |
Principal | GA |
az apim api create |
Crie uma API de gerenciamento de API. |
Principal | GA |
az apim api delete |
Exclua uma API de gerenciamento de API. |
Principal | GA |
az apim api export |
Exporte uma API de gerenciamento de API. |
Principal | GA |
az apim api import |
Importe uma API de gerenciamento de API. |
Principal | GA |
az apim api list |
Listar APIs de gerenciamento de APIs. |
Principal | GA |
az apim api operation |
Gerencie as operações da API de Gerenciamento de API do Azure. |
Principal | GA |
az apim api operation create |
Cria uma nova operação na API. |
Principal | GA |
az apim api operation delete |
Exclui a operação especificada na API. |
Principal | GA |
az apim api operation list |
Liste uma coleção das operações para a API especificada. |
Principal | GA |
az apim api operation show |
Obtém os detalhes da operação da API especificada por seu identificador. |
Principal | GA |
az apim api operation update |
Atualiza os detalhes da operação na API especificada por seu identificador. |
Principal | GA |
az apim api release |
Gerencie a versão da API de Gerenciamento de API do Azure. |
Principal | GA |
az apim api release create |
Cria uma nova versão para a API. |
Principal | GA |
az apim api release delete |
Exclui a versão especificada na API. |
Principal | GA |
az apim api release list |
Lista todas as versões de uma API. |
Principal | GA |
az apim api release show |
Retorna os detalhes de uma versão da API. |
Principal | GA |
az apim api release update |
Atualiza os detalhes da versão da API especificada por seu identificador. |
Principal | GA |
az apim api revision |
Gerencie a revisão da API de Gerenciamento de API do Azure. |
Principal | GA |
az apim api revision create |
Crie uma revisão de API. |
Principal | GA |
az apim api revision list |
Lista todas as revisões de uma API. |
Principal | GA |
az apim api schema |
Gerencie o esquema da API de Gerenciamento de API do Azure. |
Principal | GA |
az apim api schema create |
Crie um esquema de API de gerenciamento de API. |
Principal | GA |
az apim api schema delete |
Exclua um esquema de API de gerenciamento de API. |
Principal | GA |
az apim api schema get-etag |
Obtenha etag de um esquema de API de Gerenciamento de API. |
Principal | GA |
az apim api schema list |
Listar esquemas de API de Gerenciamento de API. |
Principal | GA |
az apim api schema show |
Mostrar detalhes de um esquema de API de gerenciamento de API. |
Principal | 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. |
Principal | GA |
az apim api show |
Mostrar detalhes de uma API de gerenciamento de API. |
Principal | GA |
az apim api update |
Atualize uma API de gerenciamento de API. |
Principal | GA |
az apim api versionset |
Gerencie o conjunto de versões da API de Gerenciamento de API do Azure. |
Principal | GA |
az apim api versionset create |
Cria um conjunto de versões da api. |
Principal | GA |
az apim api versionset delete |
Exclui o conjunto de versões da API específico. |
Principal | GA |
az apim api versionset list |
Lista uma coleção de conjuntos de versões de API na instância de serviço especificada. |
Principal | GA |
az apim api versionset show |
Obtém os detalhes do Api Version set especificado por seu identificador. |
Principal | GA |
az apim api versionset update |
Atualiza os detalhes do Api VersionSet especificado por seu identificador. |
Principal | GA |
az apim api wait |
Coloque a CLI em um estado de espera até que uma condição de uma apim api seja atendida. |
Principal | 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. |
Principal | 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. |
Principal | GA |
az apim check-name |
Verifica se um nome de serviço está disponível para uso. |
Principal | GA |
az apim create |
Crie uma instância de serviço de Gerenciamento de API. |
Principal | GA |
az apim delete |
Exclui um serviço de Gerenciamento de API. |
Principal | GA |
az apim deletedservice |
Gerencie serviços de Gerenciamento de API do Azure excluídos suavemente. |
Principal | GA |
az apim deletedservice list |
Liste todas as instâncias de serviços de Gerenciamento de API excluídas por software disponíveis para cancelamento de exclusão para a assinatura fornecida. |
Principal | GA |
az apim deletedservice purge |
Limpe a instância do serviço de Gerenciamento de Api excluída por software (exclui-a sem opção de cancelar a exclusão). |
Principal | GA |
az apim deletedservice show |
Obtenha instâncias de serviço de Gerenciamento de Api excluídas por software disponíveis para cancelamento de exclusão por nome. |
Principal | GA |
az apim graphql |
Gerencie as APIs do Azure API Management GraphQL. |
Principal | GA |
az apim graphql resolver |
Gerencie os resolvedores da API do Azure API GraphQL. |
Principal | GA |
az apim graphql resolver create |
Crie um novo resolvedor na API do GraphQL ou atualize um existente. |
Principal | GA |
az apim graphql resolver delete |
Exclua o resolvedor especificado na API do GraphQL. |
Principal | GA |
az apim graphql resolver list |
Liste uma coleção de resolvedores para a API GraphQL especificada. |
Principal | GA |
az apim graphql resolver policy |
Gerencie as políticas de resolvedores da API do Azure API GraphQL. |
Principal | GA |
az apim graphql resolver policy create |
Crie ou atualize a configuração da política para o nível do Resolvedor da API GraphQL. |
Principal | GA |
az apim graphql resolver policy delete |
Exclua a configuração da política no GraphQL Api Resolver. |
Principal | GA |
az apim graphql resolver policy list |
Obtenha a lista de configurações de política no nível do GraphQL API Resolver. |
Principal | GA |
az apim graphql resolver policy show |
Obtenha a configuração da política no nível do GraphQL API Resolver. |
Principal | GA |
az apim graphql resolver show |
Obtenha os detalhes do GraphQL API Resolver especificado pelo seu identificador. |
Principal | GA |
az apim list |
Listar instâncias de serviço de Gerenciamento de API. |
Principal | GA |
az apim nv |
Gerencie os valores nomeados do Gerenciamento de API do Azure. |
Principal | GA |
az apim nv create |
Crie um valor chamado de gerenciamento de API. |
Principal | GA |
az apim nv delete |
Exclua um valor nomeado de gerenciamento de API. |
Principal | GA |
az apim nv list |
Listar valores nomeados de gerenciamento de API. |
Principal | GA |
az apim nv show |
Mostrar detalhes de um valor nomeado de gerenciamento de API. |
Principal | GA |
az apim nv show-secret |
Obtém o segredo de um valor nomeado de gerenciamento de API. |
Principal | GA |
az apim nv update |
Atualize um valor nomeado de gerenciamento de API. |
Principal | 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. |
Principal | GA |
az apim product |
Gerencie o Produto de Gerenciamento de API do Azure. |
Principal | GA |
az apim product api |
Gerencie as APIs do Produto de Gerenciamento de API do Azure. |
Principal | GA |
az apim product api add |
Adicione uma API ao produto especificado. |
Principal | GA |
az apim product api check |
Verifica se a entidade da API especificada pelo identificador está associada à entidade do Produto. |
Principal | GA |
az apim product api delete |
Exclui a API especificada do produto especificado. |
Principal | GA |
az apim product api list |
Lista uma coleção de APIs associadas a um produto. |
Principal | GA |
az apim product create |
Cria um produto. |
Principal | GA |
az apim product delete |
Excluir produto. |
Principal | GA |
az apim product list |
Lista uma coleção de produtos na instância de serviço especificada. |
Principal | GA |
az apim product show |
Obtém os detalhes do produto especificado por seu identificador. |
Principal | GA |
az apim product update |
Atualize os detalhes do produto existente. |
Principal | GA |
az apim product wait |
Coloque a CLI em um estado de espera até que uma condição de um produto apim seja atendida. |
Principal | 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. |
Principal | GA |
az apim show |
Mostrar detalhes de uma instância de serviço de Gerenciamento de API. |
Principal | GA |
az apim update |
Atualize uma instância de serviço de Gerenciamento de API. |
Principal | GA |
az apim wait |
Coloque a CLI em um estado de espera até que uma condição de um apim seja atendida. |
Principal | 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.
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 Obrigatórios
O nome da instância do serviço de gerenciamento de api.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Parâmetros Opcionais
Localização. Valores de: az account list-locations
. Você pode configurar o local padrão usando az configure --defaults location=<location>
.
Não espere que a operação de longa duração termine.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
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.
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 Obrigatórios
O nome do arquivo de backup a ser criado.
O nome do contêiner da conta de armazenamento usado para colocar o backup.
O nome da instância do serviço de gerenciamento de api.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
A chave de acesso da conta de armazenamento usada para colocar o backup.
O nome da conta de armazenamento usada para colocar o backup.
Parâmetros Opcionais
Não espere que a operação de longa duração termine.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az apim check-name
Verifica se um nome de serviço está disponível para uso.
az apim check-name --name
Parâmetros Obrigatórios
O nome da instância do serviço de gerenciamento de api.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az apim create
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 de 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 Obrigatórios
Nome exclusivo da instância de serviço a ser criada.
O nome deve ser globalmente exclusivo, pois será incluído como o nome do host do gateway como' https://my-api-servicename.azure-api.net'. Ver exemplos.
O endereço de e-mail para receber todas as notificações do sistema.
O nome da sua organização para uso no portal do desenvolvedor e notificações por email.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Parâmetros Opcionais
Desative o gateway na região principal. Válido apenas para um serviço de Gerenciamento de Api implantado em vários locais.
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.
Crie uma identidade gerenciada para o serviço de Gerenciamento de API para acessar outros recursos do Azure. Apenas destinado a ser usado para o Serviço de SKU de Consumo.
Localização. Valores de: az account list-locations
. Você pode configurar o local padrão usando az configure --defaults location=<location>
.
Não espere que a operação de longa duração termine.
Se o acesso ao ponto de extremidade público é permitido ou não para este serviço de Gerenciamento de API. Se definido como true, os pontos de extremidade privados são o método de acesso exclusivo.
O número de unidades implantadas do SKU.
O sku da instância de gerenciamento de api.
Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar tags existentes.
O tipo de rede virtual.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az apim delete
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 Obrigatórios
O nome da instância do serviço de gerenciamento de api.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Parâmetros Opcionais
Não espere que a operação de longa duração termine.
Não solicite confirmação.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az apim list
Listar instâncias de serviço de Gerenciamento de API.
az apim list [--resource-group]
Parâmetros Opcionais
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
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.
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 Obrigatórios
O nome do arquivo de backup a ser restaurado.
O nome do contêiner da conta de armazenamento usado para recuperar o backup.
O nome da instância do serviço de gerenciamento de api.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
A chave de acesso da conta de armazenamento usada para recuperar o backup.
O nome da conta de armazenamento usada para recuperar o backup.
Parâmetros Opcionais
Não espere que a operação de longa duração termine.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az apim show
Mostrar detalhes de uma instância de serviço de Gerenciamento de API.
az apim show --name
--resource-group
Parâmetros Obrigatórios
O nome da instância do serviço de gerenciamento de api.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az apim update
Atualize uma instância de 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 Obrigatórios
O nome da instância do serviço de gerenciamento de api.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Parâmetros Opcionais
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>
.
Desative o gateway na região principal. Válido apenas para um serviço de Gerenciamento de Api implantado em vários locais.
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.
Crie uma identidade gerenciada para o serviço de Gerenciamento de API para acessar outros recursos do Azure. Apenas destinado a ser usado para o Serviço de SKU de Consumo.
Ao usar 'set' ou 'add', preserve literais de string em vez de tentar converter para JSON.
Não espere que a operação de longa duração termine.
Se o acesso ao ponto de extremidade público é permitido ou não para este serviço de Gerenciamento de API. Se definido como true, os pontos de extremidade privados são o método de acesso exclusivo.
O endereço de e-mail para receber todas as notificações do sistema.
O nome da sua organização para uso no portal do desenvolvedor e notificações por email.
Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>
.
O número de unidades implantadas do SKU.
O sku da instância de gerenciamento de api.
Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar tags existentes.
O tipo de rede virtual.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az apim wait
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 apim seja atendida. (gerado automaticamente)
az apim wait --created --name MyApim --resource-group MyResourceGroup
Parâmetros Obrigatórios
O nome da instância do serviço de gerenciamento de api.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Parâmetros Opcionais
Aguarde até ser criado com 'provisioningState' em 'Succeeded'.
Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Aguarde até ser excluído.
Aguarde até que o recurso exista.
Intervalo de sondagem em segundos.
Espera máxima em segundos.
Aguarde até ser atualizado com provisioningState em 'Succeeded'.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.