API do Serviço de Cota do Azure

  • Artigo

A API REST do Serviço de Cota do Azure foi projetada para exibir e gerenciar cotas para provedores de recursos do Azure.

Importante

A API do Serviço de Cota do Azure é visualização pública

Uma nova versão da API de Cota do Azure é a versão prévia pública. Essa API usa o Provedor de Recursos Microsoft.Quota, dá suporte a máquinas virtuais do Azure (núcleos/vCPU), Azure Machine Learning (dedicado/vCPUs), rede, HPC Cache do Azure, armazenamento e serviços do Azure Purview.

Uma cota é o limite de serviço ou a permissão definida em um recurso em sua assinatura do Azure. Cada serviço do Azure define suas cotas e determina seus valores padrão. Para obter mais informações sobre as cotas mais comuns do Microsoft Azure, consulte Limites, cotas e restrições de assinatura e serviço do Azure.

Usando APIs de cota

Com a API de Cota, você pode:

  1. Obtenha as cotas e os usos atuais de um recurso.
  2. Obtenha uma lista de cotas e usos atuais de todos os recursos.
  3. Criar ou atualizar cotas de um recurso.
  4. Obtenha o status de solicitações de cota para um recurso.
  5. Obter a lista de todas as solicitações de cota de um recurso por um ano

Chamada put da API de cota e escopo

A solicitação PUT da API de Cota inclui um parâmetro de "escopo" que pode ser personalizado para se alinhar aos requisitos dos provedores de recursos que buscam um aumento de cota, garantindo que a chamada à API permaneça uniforme.

https://management.azure.com/<scope>/Microsoft.Quota/quotas/<resourceName>?api-version=2021-03-15-preview
Provedor de recursos Escopo
Microsoft.Compute subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{azure location}
Microsoft.HDInsight subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{azure location}
Microsoft.MachineLearningService subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningService/locations/{azure location}
Microsoft.Network subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{azure location}
Microsoft.Purview subscriptions/{subscriptionId}/providers/Microsoft.Purview/locations/{azure location}

Observação: o exemplo de chamada PUT para computação pode ser encontrado aqui.

Pré-requisitos

Importante

Antes de usar a API de Cota, você deve:

Registrando o provedor de recursos de Cota da Microsoft

Para registrar o provedor de recursos de Cota da Microsoft, use o comando do PowerShell abaixo:

Register-AzResourceProvider -ProviderNamespace Microsoft.Quota

Ele retorna resultados semelhantes à saída abaixo:

ProviderNamespace : Microsoft.Quota
RegistrationState : Registering
ResourceTypes     : {usages, quotas, quotaRequests, operationsStatus...}
Locations         : {West Europe, East US, South Central US...}

Depois que o provedor de recursos Microsoft.Quota for registrado, o RegistrationState será definido Registeredcomo . Para obter mais informações sobre como gerenciar provedores de recursos do Azure, confira Provedores de recursos do Azure.

Limitação

Todas as chamadas à API no nível da assinatura e no nível do locatário poderão ser limitadas se você enviar muitas solicitações de API. Se a chamada à API for limitada, você receberá uma mensagem de erro informando que o servidor rejeitou a solicitação de API. Você pode repetir a chamada à API depois que algum tempo tiver decorrido.

Para obter detalhes sobre a limitação da API, como solucionar problemas de limitação e como evitar a limitação, confira Solução de problemas de erros de limitação no Azure.

Função de operador de solicitação de cota

O Operador de Solicitação de Cota é uma função interna do Azure personalizada para operações de cota. Ele concede permissões para ler e criar solicitações de cota, obter status de solicitação de cota e criar tíquetes de suporte. Atribua essa função a usuários, grupos, entidades de serviço, identidades gerenciadas e aplicativos que fazem operações de cota. Para referência, a ID da função operador de solicitação de cota é 0e5f05e5-9ab9-446b-b98d-1e2157c94125.

A função Operador de Solicitação de Cota é estendida para incluir permissões de provedor de recursos de cota.

Práticas recomendadas de APIs de cota

  1. Monitoramento da utilização da cota: Utilize a API de cota do Azure para acompanhar o uso de cota com eficiência. Essa API fornece informações em tempo real sobre seu uso atual e a cota disponível para uma combinação específica de assinatura, família de VMs e região. É crucial marcar regularmente sua utilização de cota antes de considerar qualquer aumento de cota.

  2. Solicitando aumento de cota: Se a utilização da cota exceder o destino predefinido, inicie uma solicitação de aumento de cota usando a API de cota do Azure para alinhar sua utilização com suas metas. O processo é simples – basta enviar uma solicitação de API que deslineie o aumento de cota desejado. Por exemplo, se a utilização de destino para a cota da família de VMs Dv2 no Norte da Europa, em "subscription1", for definida em 80%, e o monitoramento da API de cota do Azure indicar uma utilização real de 85%, envie um aumento de cota de 10% a 20%.

Dica

É aconselhável solicitar um aumento de cota de 10% a 20% da utlização de recursos, pois ele fornece um buffer ressonável para picos inesperados no uso de recursos, garantindo que você não atingirá imediatamente seu novo limite de cota após um aumento. Essa abordagem minimiza a necessidade de chamadas frequentes à API para solicitar cota adicional, melhorando suas chances de aprovação.

  1. Respnose de aumento de cota: Ao enviar uma solicitação de aumento de cota, você receberá uma resposta indicando se sua solicitação foi aprovada ou rejeitada. Em caso de rejeição, você pode iniciar um acompanhamento registrando uma solicitação de suporte usando a API REST de Suporte do Azure ou usando uma nova solicitação de suporte no portal do Azure, incluindo as especificidades da solicitação de aumento de cota negada e o motivo da consulta.

Solução de problemas de erros da API de Cota

Use as tabelas a seguir para solucionar erros que você pode obter ao usar a API de Cota.

Código do erro Como resolvê-lo
ContactSupport Abra uma nova solicitação de suporte no portal do Azure. Em Selecionar um tipo de problema, escolha Limites de serviço e assinatura (cotas). Você também pode abri-lo programaticamente usando a API REST de Suporte do Azure.
InternalServerError Erro interno do servidor. Repita a chamada à API mais tarde.
MissingRegistration Registre o provedor de recursos Microsoft.Quota para cada uma de suas assinaturas. Para obter diretrizes de solução de problemas, consulte Resolver erros para o registro do provedor de recursos.
QuotaNotAvailableForResource No momento, a cota não está disponível no local do recurso solicitado. Abra uma nova solicitação de suporte no portal do Azure. Em Selecionar um tipo de problema, escolha Limites de serviço e assinatura (cotas). Você também pode abri-lo programaticamente usando a API REST de Suporte do Azure.
QuotaReductionNotSupported O limite de cota atual é maior que a cota solicitada ou o uso atual é maior que a cota solicitada. Não há suporte para a redução de cotas. A cota não pode ser reduzida.
RequestThrottled Cada solicitação de API no nível da assinatura e no nível do locatário pode ser limitada para ajudar com o desempenho geral do serviço. O número de solicitações excedeu a taxa máxima de solicitação de API permitida. Tente novamente depois.
ResourceNotAvailableForOffer No momento, o recurso não está disponível no local do tipo de oferta. Para obter a lista de ofertas atuais e desativadas, consulte a página Detalhes da Oferta do Microsoft Azure . Para alterar o tipo de oferta, consulte a página Alterar sua assinatura do Azure para uma oferta diferente . Você também pode abrir uma nova solicitação de suporte no portal do Azure. Em Selecionar um tipo de problema, escolha Limites de serviço e assinatura (cotas). Você também pode abri-lo programaticamente usando a API REST de Suporte do Azure.
ResourceNotAvailableForSubscription No momento, o recurso não está disponível no local da assinatura solicitada. Abra uma nova solicitação de suporte no portal do Azure. Em Selecionar um tipo de problema, escolha Limites de serviço e assinatura (cotas). Você também pode abri-lo programaticamente usando a API REST de Suporte do Azure.
UnableToIncreaseQuota Não é possível aumentar as cotas para as assinaturas solicitadas. Abra uma nova solicitação de suporte no portal do Azure. Em Selecionar um tipo de problema, escolha Limites de serviço e assinatura (cotas).
MFA necessário As solicitações de cota precisam da Autenticação Multifator. Habilite a Autenticação Multifator para seu locatário/conta seguindo as instruções em habilitar a MFA e tente novamente
RequestPartiallyFulfilled A solicitação de cota é parcialmente atendida. Para perguntas, abra uma nova solicitação de suporte no portal do Azure. Em Selecionar um tipo de problema, escolha Limites de serviço e assinatura (cotas)

Suporte em outras linguagens e interfaces

A API REST de Cota está disponível nos seguintes SDKs do Microsoft Azure específicos do idioma:

Usando portal do Azure e a API de suporte para gerenciar cotas

O Azure permite que você crie e gerencie solicitações de suporte, também conhecidas como tíquetes de suporte. Você pode: