Partilhar via

az apim

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

Comandos

Name Description Tipo Status
az apim api

Gerencie APIs de Gerenciamento de API do Azure.

 Core disponibilidade geral
az apim api create

Crie uma API de gerenciamento de API.

 Core disponibilidade geral
az apim api delete

Exclua uma API de gerenciamento de API.

 Core disponibilidade geral
az apim api export

Exporte uma API de gerenciamento de API.

 Core disponibilidade geral
az apim api import

Importe uma API de gerenciamento de API.

 Core disponibilidade geral
az apim api list

Listar APIs de gerenciamento de APIs.

 Core disponibilidade geral
az apim api operation

Gerencie as operações da API de Gerenciamento de API do Azure.

 Core disponibilidade geral
az apim api operation create

Cria uma nova operação na API.

 Core disponibilidade geral
az apim api operation delete

Exclui a operação especificada na API.

 Core disponibilidade geral
az apim api operation list

Liste uma coleção das operações para a API especificada.

 Core disponibilidade geral
az apim api operation show

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

 Core disponibilidade geral
az apim api operation update

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

 Core disponibilidade geral
az apim api release

Gerencie a versão da API de Gerenciamento de API do Azure.

 Core disponibilidade geral
az apim api release create

Cria uma nova versão para a API.

 Core disponibilidade geral
az apim api release delete

Exclui a versão especificada na API.

 Core disponibilidade geral
az apim api release list

Lista todas as versões de uma API.

 Core disponibilidade geral
az apim api release show

Retorna os detalhes de uma versão da API.

 Core disponibilidade geral
az apim api release update

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

 Core disponibilidade geral
az apim api revision

Gerencie a revisão da API de Gerenciamento de API do Azure.

 Core disponibilidade geral
az apim api revision create

Crie uma revisão de API.

 Core disponibilidade geral
az apim api revision list

Lista todas as revisões de uma API.

 Core disponibilidade geral
az apim api schema

Gerencie o esquema da API de Gerenciamento de API do Azure.

 Core disponibilidade geral
az apim api schema create

Crie um esquema de API de gerenciamento de API.

 Core disponibilidade geral
az apim api schema delete

Exclua um esquema de API de gerenciamento de API.

 Core disponibilidade geral
az apim api schema get-etag

Obtenha etag de um esquema de API de Gerenciamento de API.

 Core disponibilidade geral
az apim api schema list

Listar esquemas de API de Gerenciamento de API.

 Core disponibilidade geral
az apim api schema show

Mostrar detalhes de um esquema de API de gerenciamento de API.

 Core disponibilidade geral
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.

 Core disponibilidade geral
az apim api show

Mostrar detalhes de uma API de gerenciamento de API.

 Core disponibilidade geral
az apim api update

Atualize uma API de gerenciamento de API.

 Core disponibilidade geral
az apim api versionset

Gerencie o conjunto de versões da API de Gerenciamento de API do Azure.

 Core disponibilidade geral
az apim api versionset create

Cria um conjunto de versões da api.

 Core disponibilidade geral
az apim api versionset delete

Exclui o conjunto de versões da API específico.

 Core disponibilidade geral
az apim api versionset list

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

 Core disponibilidade geral
az apim api versionset show

Obtém os detalhes do Api Version set especificado por seu identificador.

 Core disponibilidade geral
az apim api versionset update

Atualiza os detalhes do Api VersionSet especificado por seu identificador.

 Core disponibilidade geral
az apim api wait

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

 Core disponibilidade geral
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 disponibilidade geral
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.

 Core disponibilidade geral
az apim check-name

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

 Core disponibilidade geral
az apim create

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

 Core disponibilidade geral
az apim delete

Exclui um serviço de Gerenciamento de API.

 Core disponibilidade geral
az apim deletedservice

Gerencie serviços de Gerenciamento de API do Azure excluídos suavemente.

 Core disponibilidade geral
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.

 Core disponibilidade geral
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).

 Core disponibilidade geral
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.

 Core disponibilidade geral
az apim graphql

Gerencie as APIs do Azure API Management GraphQL.

 Core disponibilidade geral
az apim graphql resolver

Gerencie os resolvedores da API do Azure API GraphQL.

 Core disponibilidade geral
az apim graphql resolver create

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

 Core disponibilidade geral
az apim graphql resolver delete

Exclua o resolvedor especificado na API do GraphQL.

 Core disponibilidade geral
az apim graphql resolver list

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

 Core disponibilidade geral
az apim graphql resolver policy

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

 Core disponibilidade geral
az apim graphql resolver policy create

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

 Core disponibilidade geral
az apim graphql resolver policy delete

Exclua a configuração da política no GraphQL Api Resolver.

 Core disponibilidade geral
az apim graphql resolver policy list

Obtenha a lista de configurações de política no nível do GraphQL API Resolver.

 Core disponibilidade geral
az apim graphql resolver policy show

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

 Core disponibilidade geral
az apim graphql resolver show

Obtenha os detalhes do GraphQL API Resolver especificado pelo seu identificador.

 Core disponibilidade geral
az apim list

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

 Core disponibilidade geral
az apim nv

Gerencie os valores nomeados do Gerenciamento de API do Azure.

 Core disponibilidade geral
az apim nv create

Crie um valor chamado de gerenciamento de API.

 Core disponibilidade geral
az apim nv delete

Exclua um valor nomeado de gerenciamento de API.

 Core disponibilidade geral
az apim nv list

Listar valores nomeados de gerenciamento de API.

 Core disponibilidade geral
az apim nv show

Mostrar detalhes de um valor nomeado de gerenciamento de API.

 Core disponibilidade geral
az apim nv show-secret

Obtém o segredo de um valor nomeado de gerenciamento de API.

 Core disponibilidade geral
az apim nv update

Atualize um valor nomeado de gerenciamento de API.

 Core disponibilidade geral
az apim nv wait

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

 Core disponibilidade geral
az apim product

Gerencie o Produto de Gerenciamento de API do Azure.

 Core disponibilidade geral
az apim product api

Gerencie as APIs do Produto de Gerenciamento de API do Azure.

 Core disponibilidade geral
az apim product api add

Adicione uma API ao produto especificado.

 Core disponibilidade geral
az apim product api check

Verifica se a entidade da API especificada pelo identificador está associada à entidade do Produto.

 Core disponibilidade geral
az apim product api delete

Exclui a API especificada do produto especificado.

 Core disponibilidade geral
az apim product api list

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

 Core disponibilidade geral
az apim product create

Cria um produto.

 Core disponibilidade geral
az apim product delete

Excluir produto.

 Core disponibilidade geral
az apim product list

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

 Core disponibilidade geral
az apim product show

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

 Core disponibilidade geral
az apim product update

Atualize os detalhes do produto existente.

 Core disponibilidade geral
az apim product wait

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

 Core disponibilidade geral
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.

 Core disponibilidade geral
az apim show

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

 Core disponibilidade geral
az apim update

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

 Core disponibilidade geral
az apim wait

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

 Core disponibilidade geral

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 Obrigatórios

--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 tornar-se necessários para que o comando seja executado com êxito.

--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 espere que a operação de longa duração termine.

Propriedade Valor
Default value: False
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: 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 longa duração 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 Obrigatórios

--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 tornar-se necessários para que o comando seja executado com êxito.

--no-wait

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

Propriedade Valor
Default value: False
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: 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 Obrigatórios

--name -n

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

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: 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 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

--name -n

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

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

--publisher-email

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

--publisher-name

O nome da sua organização para uso no portal do desenvolvedor e 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 tornar-se necessários para que o comando seja executado com êxito.

--disable-gateway

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

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

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

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

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.

Propriedade Valor
Default value: False
Valores aceites: 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 espere que a operação de longa duração termine.

Propriedade Valor
Default value: False
--public-network-access

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.

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

O número de unidades implantadas do SKU.

Propriedade Valor
Default value: 1
--sku-name

O sku da instância de gerenciamento de api.

Propriedade Valor
Default value: Developer
Valores aceites: Basic, Consumption, Developer, Isolated, Premium, Standard
--tags

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

--virtual-network -v

O tipo de rede virtual.

Propriedade Valor
Default value: None
Valores aceites: External, Internal, None
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az apim delete

Editar

Exclui um serviço de Gerenciamento de API.

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

Exemplos

Exclua um serviço de Gerenciamento de API.

az apim delete -n MyApim -g MyResourceGroup

Parâmetros Obrigatórios

--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 tornar-se necessários para que o comando seja executado com êxito.

--no-wait

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

Propriedade Valor
Default value: False
--yes -y

Não solicite confirmação.

Propriedade Valor
Default value: False
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az apim list

Editar

Listar instâncias de 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 tornar-se necessários para que o comando seja executado com êxito.

--resource-group -g

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

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: 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 longa duração 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 Obrigatórios

--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 tornar-se necessários para que o comando seja executado com êxito.

--no-wait

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

Propriedade Valor
Default value: False
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: 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 Obrigatórios

--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 de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az apim update

Editar

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

--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 tornar-se necessários para que o comando seja executado com êxito.

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

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

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

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

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

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.

Propriedade Valor
Valores aceites: false, true
--force-string

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Default value: False
--no-wait

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

Propriedade Valor
Default value: False
--public-network-access

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.

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

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

--publisher-name

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

--remove

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Default value: []
--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
Default value: []
--sku-capacity

O número de unidades implantadas do SKU.

--sku-name

O sku da instância de gerenciamento de api.

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

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

--virtual-network -v

O tipo de rede virtual.

Propriedade Valor
Valores aceites: External, Internal, None
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: 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 apim seja atendida. (autogenerated)

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

Parâmetros Obrigatórios

--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 tornar-se necessários para que o comando seja executado com êxito.

--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: False
--custom

Aguarde até que a condição satisfaç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
Default value: False
--exists

Aguarde até que o recurso exista.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: False
--interval

Intervalo de sondagem em segundos.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: 30
--timeout

Espera máxima em segundos.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: 3600
--updated

Aguarde até ser atualizado com provisioningState em 'Succeeded'.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: False
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False