az apim

Gerencie os serviços de gerenciamento de API do Azure.

Comandos

az_apim_nv_show_secret
az apim api

Gerenciar APIs de gerenciamento de API do Azure.

az apim api create

Criar uma API de gerenciamento de API.

az apim api delete

Excluir uma API de gerenciamento de API.

az apim api import

Importar uma API de gerenciamento de API.

az apim api list

Listar API de gerenciamento de API.

az apim api operation

Gerenciar operações da API de gerenciamento de API do Azure.

az apim api operation create

Cria uma nova operação na API.

az apim api operation delete

Exclui a operação especificada na API.

az apim api operation list

Lista uma coleção de operações para a API especificada.

az apim api operation show

Obtém os detalhes da operação de API especificada por seu identificador.

az apim api operation update

Atualiza os detalhes da operação na API especificada por seu identificador.

az apim api release

Gerenciar a versão da API de gerenciamento de API do Azure.

az apim api release create

Cria uma nova versão para a API.

az apim api release delete

Exclui a versão especificada na API.

az apim api release list

Lista todas as versões de uma API.

az apim api release show

Retorna os detalhes de uma versão de API.

az apim api release update

Atualiza os detalhes da versão da API especificada por seu identificador.

az apim api revision

Gerenciar a revisão da API de gerenciamento de API do Azure.

az apim api revision create

Criar revisão de API.

az apim api revision list

Lista todas as revisões de uma API.

az apim api show

Mostrar detalhes de uma API de gerenciamento de API.

az apim api update

Atualizar uma API de gerenciamento de API.

az apim api versionset

Gerenciar o conjunto de versão da API de gerenciamento de API do Azure.

az apim api versionset create

Cria uma versão de API definida.

az apim api versionset delete

Exclui o conjunto de versão de API específico.

az apim api versionset list

Lista uma coleção de conjuntos de versão de API na instância de serviço especificada.

az apim api versionset show

Obtém os detalhes do conjunto de versão de API especificado por seu identificador.

az apim api versionset update

Atualiza os detalhes do Versionset especificado por seu identificador.

az apim api wait

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

az apim apply-network-updates

Fazer backup de um serviço de gerenciamento de API para a conta de armazenamento configurada.

az apim backup

Cria um backup do serviço de gerenciamento de API para a conta de armazenamento do Azure fornecida. Essa operação é de execução longa e pode levar vários minutos para ser concluída.

az apim check-name

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

az apim create

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

az apim delete

Exclui um serviço de gerenciamento de API.

az apim list

Listar instâncias de serviço de gerenciamento de API.

az apim nv

Gerencie valores nomeados do gerenciamento de API do Azure.

az apim nv create

Crie um valor nomeado de gerenciamento de API.

az apim nv delete

Excluir um valor nomeado de gerenciamento de API.

az apim nv list

Listar valores nomeados de gerenciamento de API.

az apim nv show

Mostrar detalhes de um valor nomeado do gerenciamento de API.

az apim nv update

Atualize um valor nomeado de gerenciamento de API.

az apim product

Gerenciar o produto de gerenciamento de API do Azure.

az apim product api

Gerencie as APIs do produto de gerenciamento de API do Azure.

az apim product api add

Adicione uma API ao produto especificado.

az apim product api check

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

az apim product api delete

Exclui a API especificada do produto especificado.

az apim product api list

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

az apim product create

Cria um produto.

az apim product delete

Excluir produto.

az apim product list

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

az apim product show

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

az apim product update

Atualizar os detalhes do produto existente.

az apim product wait

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

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. Essa é uma operação de execução demorada e pode levar vários minutos para ser concluída.

az apim show

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

az apim update

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

az apim wait

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

az apim apply-network-updates

Fazer backup de um serviço de gerenciamento de API para a conta de armazenamento configurada.

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

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.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID .

az apim backup

Cria um backup do serviço de gerenciamento de API para a conta de armazenamento do Azure fornecida. Essa operação é de execução longa 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]
               [--subscription]

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID .

az apim check-name

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

az apim check-name --name
                   [--subscription]

Parâmetros Exigidos

--name -n

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

Parâmetros Opcionais

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID .

az apim create

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

az apim create --name
               --publisher-email
               --publisher-name
               --resource-group
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--location]
               [--no-wait]
               [--sku-capacity]
               [--sku-name {Basic, Consumption, Developer, Premium, Standard}]
               [--subscription]
               [--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 de 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.

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

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

valores aceitos: false, true
--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.

--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, Premium, Standard
valor padrão: Developer
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID .

--tags

Marcas separadas por espaço: chave [= valor] [chave [= valor]...]. Use "" para limpar as marcas existentes.

--virtual-network -v

O tipo de rede virtual.

valores aceitos: External, Internal, None
valor padrão: None

az apim delete

Exclui um serviço de gerenciamento de API.

az apim delete --name
               --resource-group
               [--no-wait]
               [--subscription]
               [--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

--no-wait

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID .

--yes -y

Não solicite confirmação.

az apim list

Listar instâncias de serviço de gerenciamento de API.

az apim list [--query-examples]
             [--resource-group]
             [--subscription]

Parâmetros Opcionais

--query-examples

Recomende uma cadeia de caracteres JMESPath para você. Você pode copiar uma da consulta e colá-la após o parâmetro--Query entre aspas duplas para ver os resultados. Você pode adicionar uma ou mais palavras-chave posicionais para que possamos dar sugestões com base nessas palavras-chaves.

--resource-group -g

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID .

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. Essa é uma operação de execução demorada 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]
                [--subscription]

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

--storage-account-name

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

Parâmetros Opcionais

--no-wait

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID .

az apim show

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

az apim show --name
             --resource-group
             [--query-examples]
             [--subscription]

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

--query-examples

Recomende uma cadeia de caracteres JMESPath para você. Você pode copiar uma da consulta e colá-la após o parâmetro--Query entre aspas duplas para ver os resultados. Você pode adicionar uma ou mais palavras-chave posicionais para que possamos dar sugestões com base nessas palavras-chaves.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID .

az apim update

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

az apim update --name
               --resource-group
               [--add]
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--force-string]
               [--no-wait]
               [--publisher-email]
               [--publisher-name]
               [--remove]
               [--set]
               [--sku-capacity]
               [--sku-name {Basic, Consumption, Developer, Premium, Standard}]
               [--subscription]
               [--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 chave-valor. Exemplo:--Adicionar Property. ListProperty <chave = valor, Cadeia de caracteres ou cadeia de caracteres JSON>.

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

valores aceitos: false, true
--force-string

Ao usar "set" ou "Add", preserve cadeias de caracteres literais em vez de tentar converter em JSON.

--no-wait

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

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

Remove uma propriedade ou um elemento de uma lista. Exemplo:--Remove Property. List ou--remove propertyToRemove.

--set

Atualize um objeto especificando um caminho de propriedade e um valor a serem definidos. Exemplo:--Set Property1. Property2 =.

--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, Premium, Standard
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID .

--tags

Marcas separadas por espaço: chave [= valor] [chave [= valor]...]. Use "" para limpar as marcas existentes.

--virtual-network -v

O tipo de rede virtual.

valores aceitos: External, Internal, None

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]
             [--subscription]
             [--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é que seja criado com ' provisioningState ' em ' êxito '.

--custom

Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por ex.: provisioningState! = ' em andamento ', instanceView. status [? código = = ' PowerState/em execução '].

--deleted

Aguarde até que seja excluído.

--exists

Aguarde até que o recurso exista.

--interval

Intervalo de sondagem em segundos.

valor padrão: 30
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID .

--timeout

Espera máxima em segundos.

valor padrão: 3600
--updated

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