az apim

Gerir os serviços de Gestão da API da Azure.

Comandos

az apim api

Gerir a Azure API Management API's.

az apim api create

Criar uma API de Gestão de API.

az apim api delete

Excluir uma API de Gestão de API.

az apim api import

Importe uma API de Gestão de API.

az apim api list

Lista API Management API's.

az apim api operation

Gerir operações de API de Gestão AZURE.

az apim api operation create

Cria uma nova operação na API.

az apim api operation delete

Elimina a operação especificada na API.

az apim api operation list

Listar uma recolha das operações para a API especificada.

az apim api operation show

Obtém os detalhes da Operação API especificados pelo seu identificador.

az apim api operation update

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

az apim api release

Gerir o lançamento da API Management API da Azure Management.

az apim api release create

Cria um novo lançamento para a API.

az apim api release delete

Elimina a versão especificada na API.

az apim api release list

Lista todos os lançamentos de uma API.

az apim api release show

Devolve os detalhes de um comunicado da API.

az apim api release update

Atualiza os detalhes da libertação da API especificada pelo seu identificador.

az apim api revision

Gerir a Revisão da API de Gestão AZURE.

az apim api revision create

Criar revisão da API.

az apim api revision list

Lista todas as revisões de uma API.

az apim api show

Mostrar detalhes de uma API Management API.

az apim api update

Atualize uma API de Gestão de API.

az apim api versionset

Gerir o conjunto de versão API de gestão API da Azure Management.

az apim api versionset create

Cria um conjunto de versão Api.

az apim api versionset delete

Elimina o conjunto de versão Api específico.

az apim api versionset list

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

az apim api versionset show

Obtém os detalhes do Conjunto de Versão Api especificados pelo seu identificador.

az apim api versionset update

Atualiza os detalhes do Api VersionSet especificados pelo seu identificador.

az apim api wait

Coloque o CLI em estado de espera até que uma condição de apim api seja satisfeita.

az apim apply-network-updates

Apoie um serviço de Gestão API na conta de armazenamento configurada.

az apim backup

Cria uma cópia de segurança do serviço de Gestão da API para a Conta Armazenamento Azure. Esta é uma operação de longa duração e pode levar vários minutos para ser concluída.

az apim check-name

Verifique se um nome de serviço está disponível para usar.

az apim create

Criar uma instância de serviço de Gestão API.

az apim delete

Elimina um serviço de Gestão API.

az apim list

Listar instâncias de serviço de gestão da API.

az apim nv

Gerir a Azure API Management Nomeou Valores.

az apim nv create

Criar um valor nomeado para a gestão da API.

az apim nv delete

Excluir um valor nomeado para a gestão da API.

az apim nv list

Listar valores nomeados pela Gestão da API.

az apim nv show

Mostrar detalhes de uma gestão da API nomeado valor.

az apim nv show-secret

Obtém o segredo de uma gestão da API chamada Valor.

az apim nv update

Atualize um valor nomeado para a gestão da API.

az apim product

Gerir os produtos de gestão da API da Azure.

az apim product api

Gerir as APIs do Produto de Gestão da AZure.

az apim product api add

Adicione uma API ao produto especificado.

az apim product api check

Verificações de que a entidade API especificada pelo identificador está associada à entidade produto.

az apim product api delete

Elimina 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

Eliminar o produto.

az apim product list

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

az apim product show

Obtém os detalhes do produto especificados pelo seu identificador.

az apim product update

Atualizar os detalhes do produto existentes.

az apim product wait

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

az apim restore

Restaura uma cópia de segurança de um serviço de Gestão API criado utilizando 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 show

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

az apim update

Atualizar uma instância de serviço de Gestão API.

az apim wait

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

az apim apply-network-updates

Apoie um serviço de Gestão API na conta de armazenamento configurada.

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

Parâmetros Obrigatórios

--name -n

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

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name> .

Parâmetros Opcionais

--location -l

Localização. Valores de: az account list-locations . Pode configurar a localização padrão utilizando az configure --defaults location=<location> .

--no-wait

Não espere que a operação de longa duração termine.

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição padrão utilizando az account set -s NAME_OR_ID .

az apim backup

Cria uma cópia de segurança do serviço de Gestão da API para a Conta Armazenamento Azure. 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]
               [--subscription]

Exemplos

Criar uma cópia de segurança da instância de serviço de Gestão da 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

--backup-name

O nome do ficheiro de reserva para criar.

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

O nome do recipiente da conta de armazenamento usado para colocar a cópia de segurança.

--name -n

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

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name> .

--storage-account-key

A chave de acesso da conta de armazenamento usada para colocar a cópia de segurança.

--storage-account-name

O nome da conta de armazenamento usado para colocar a cópia de segurança.

Parâmetros Opcionais

--no-wait

Não espere que a operação de longa duração termine.

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição padrão utilizando az account set -s NAME_OR_ID .

az apim check-name

Verifique se um nome de serviço está disponível para usar.

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

Parâmetros Obrigatórios

--name -n

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

Parâmetros Opcionais

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição padrão utilizando az account set -s NAME_OR_ID .

az apim create

Criar uma instância de serviço de Gestão 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

Criar um serviço de Gestão API de nível de desenvolvedor.

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

Criar um serviço de Gestão API de nível 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

--name -n

Nome único da instância de serviço a criar.

--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 notificações de e-mail.

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name> .

Parâmetros Opcionais

--enable-client-certificate

Aplica um certificado de cliente a ser apresentado em cada pedido ao gateway e também permite a capacidade de autenticar o certificado na apólice no gateway.

valores aceites: false, true
--enable-managed-identity

Criar uma identidade gerida para o serviço de Gestão da API para aceder a outros recursos da Azure.

valores aceites: false, true
--location -l

Localização. Valores de: az account list-locations . Pode configurar a localização padrão utilizando az configure --defaults location=<location> .

--no-wait

Não espere que a operação de longa duração termine.

--sku-capacity

O número de unidades implantadas do SKU.

valor predefinido: 1
--sku-name

O sku da instância de gestão da API.

valores aceites: Basic, Consumption, Developer, Premium, Standard
valor predefinido: Developer
--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição padrão utilizando az account set -s NAME_OR_ID .

--tags

Etiquetas separadas pelo espaço: chave[=valor] [chave[=valor] ...]. Utilize "" para limpar as etiquetas existentes.

--virtual-network -v

O tipo de rede virtual.

valores aceites: External, Internal, None
valor predefinido: None

az apim delete

Elimina um serviço de Gestão API.

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

Exemplos

Excluir um serviço de Gestão API.

az apim delete -n MyApim -g MyResourceGroup

Parâmetros Obrigatórios

--name -n

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

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name> .

Parâmetros Opcionais

--no-wait

Não espere que a operação de longa duração termine.

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição padrão utilizando az account set -s NAME_OR_ID .

--yes -y

Não pedir confirmação.

az apim list

Listar instâncias de serviço de gestão da API.

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

Parâmetros Opcionais

--query-examples

Recomende a cadeia JMESPath para si. Pode copiar uma das consultas e colá-la depois de --parâmetro de consulta dentro de duas aspas para ver os resultados. Pode adicionar uma ou mais palavras-chave posicionais para que possamos dar sugestões com base nestas palavras-chave.

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name> .

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição padrão utilizando az account set -s NAME_OR_ID .

az apim restore

Restaura uma cópia de segurança de um serviço de Gestão API criado utilizando 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]
                [--subscription]

Exemplos

Restaura uma cópia de segurança da instância de serviço da API Management

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

--backup-name

O nome do ficheiro de reserva para restaurar.

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

O nome do contentor da conta de armazenamento usado para recuperar a cópia de segurança.

--name -n

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

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name> .

--storage-account-key

A chave de acesso da conta de armazenamento usada para recuperar a cópia de segurança.

--storage-account-name

O nome da conta de armazenamento usada para recuperar a cópia de segurança.

Parâmetros Opcionais

--no-wait

Não espere que a operação de longa duração termine.

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição padrão utilizando az account set -s NAME_OR_ID .

az apim show

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

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

Parâmetros Obrigatórios

--name -n

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

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name> .

Parâmetros Opcionais

--query-examples

Recomende a cadeia JMESPath para si. Pode copiar uma das consultas e colá-la depois de --parâmetro de consulta dentro de duas aspas para ver os resultados. Pode adicionar uma ou mais palavras-chave posicionais para que possamos dar sugestões com base nestas palavras-chave.

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição padrão utilizando az account set -s NAME_OR_ID .

az apim update

Atualizar uma instância de serviço de Gestão 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 Obrigatórios

--name -n

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

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name> .

Parâmetros Opcionais

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor chave. Exemplo: --adicionar propriedade.listProperty <chave=valor, string ou> de cadeia JSON.

--enable-client-certificate

Aplica um certificado de cliente a ser apresentado em cada pedido ao gateway e também permite a capacidade de autenticar o certificado na apólice no gateway.

valores aceites: false, true
--enable-managed-identity

Criar uma identidade gerida para o serviço de Gestão da API para aceder a outros recursos da Azure.

valores aceites: false, true
--force-string

Ao utilizar 'set' ou 'add', preserve as cordas literais em vez de tentar converter-se em JSON.

--no-wait

Não espere que a operação de longa duração termine.

--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 notificações de e-mail.

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remover propriedade.list OR --remover propriedadeToRemove.

--set

Atualize um objeto especificando um caminho de propriedade e valor a definir. Exemplo: --set property1.property2=.

--sku-capacity

O número de unidades implantadas do SKU.

--sku-name

O sku da instância de gestão da API.

valores aceites: Basic, Consumption, Developer, Premium, Standard
--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição padrão utilizando az account set -s NAME_OR_ID .

--tags

Etiquetas separadas pelo espaço: chave[=valor] [chave[=valor] ...]. Utilize "" para limpar as etiquetas existentes.

--virtual-network -v

O tipo de rede virtual.

valores aceites: External, Internal, None

az apim wait

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

az apim wait --name
             --resource-group
             [--created]
             [--custom]
             [--deleted]
             [--exists]
             [--interval]
             [--subscription]
             [--timeout]
             [--updated]

Exemplos

Coloque o CLI em estado de espera até que uma condição de apim seja satisfeita. (autogerado)

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

Parâmetros Obrigatórios

--name -n

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

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido utilizando az configure --defaults group=<name> .

Parâmetros Opcionais

--created

Aguarde até ser criado com o "Estado de provisionamento" em 'Succeeded'.

--custom

Aguarde até que a condição satisfaça uma consulta personalizada do JMESPath. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Espere até ser apagado.

--exists

Aguarde até que o recurso exista.

--interval

Intervalo de sondagens em segundos.

valor predefinido: 30
--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição padrão utilizando az account set -s NAME_OR_ID .

--timeout

Espera máxima em segundos.

valor predefinido: 3600
--updated

Aguarde até ser atualizado com o Estado de provisionamento em 'Bem sucedido'.