API службы квот Azure

  • Статья

REST API службы квот Azure предназначен для просмотра квот и управления ими для поставщиков ресурсов Azure.

Важно!

API службы квот Azure является общедоступной предварительной версией

Новая версия API квот Azure является общедоступной предварительной версией. Этот API использует поставщик ресурсов Microsoft.Quota, поддерживает виртуальные машины Azure (ядра и виртуальные ЦП), Машинное обучение Azure (выделенные и виртуальные ЦП), сеть, azure HPC Cache, службы хранилища и Azure Purview.

Квота — это ограничение службы или квота, установленное для ресурса в подписке Azure. Каждая служба Azure определяет свои квоты и значения по умолчанию. Дополнительные сведения о наиболее распространенных квотах Microsoft Azure см. в статье Подписка и ограничения службы Azure, квоты и ограничения.

Использование API квоты

С помощью API квоты вы можете:

  1. Получение текущих квот и использования ресурса.
  2. Получение списка текущих квот и использования всех ресурсов.
  3. Создание или обновление квот ресурса.
  4. Получение состояния запросов квоты для ресурса.
  5. Получение списка всех запросов на квоту ресурса за один год

Вызов и область API квоты PUT

Запрос PUT API квоты включает параметр "область", который можно настроить в соответствии с требованиями поставщиков ресурсов, стремящихся увеличить квоту, гарантируя, что вызов API остается однородным.

https://management.azure.com/<scope>/Microsoft.Quota/quotas/<resourceName>?api-version=2021-03-15-preview
Поставщик ресурсов Область
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}

Примечание. Пример вызова PUT для вычислений можно найти здесь.

Предварительные требования

Важно!

Перед использованием API квоты необходимо:

Регистрация поставщика ресурсов квоты Майкрософт

Чтобы зарегистрировать поставщик ресурсов квоты Майкрософт, используйте следующую команду PowerShell:

Register-AzResourceProvider -ProviderNamespace Microsoft.Quota

Он возвращает результаты, аналогичные приведенным ниже выходным данным:

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

После регистрации RegistrationState поставщика ресурсов Microsoft.Quota будет задано значение Registered. Дополнительные сведения об управлении поставщиками ресурсов Azure см. в статье Поставщики ресурсов Azure.

Регулирование

При отправке слишком большого количества запросов API можно регулировать все вызовы API уровня подписки и клиента. Если вызов API регулируется, вы получите сообщение об ошибке о том, что сервер отклонил запрос API. Вы можете повторить вызов API по истечении некоторого времени.

Дополнительные сведения о регулировании API, устранении неполадок с регулированием и о том, как избежать регулирования, см. в статье Устранение ошибок регулирования в Azure.

Роль оператора запроса квоты

Оператор запроса квоты — это встроенная роль Azure, настроенная для операций квоты. Он предоставляет разрешения на чтение и создание запросов квоты, получение состояния запроса на квоту и создание запросов в службу поддержки. Назначьте эту роль пользователям, группам, субъектам-службам, управляемым удостоверениям и приложениям, которые выполняют операции квоты. Для справки идентификатором роли оператора запроса квоты является 0e5f05e5-9ab9-446b-b98d-1e2157c94125.

Роль оператора запроса квоты расширена для включения разрешений поставщика ресурсов квоты.

Рекомендации по API квоты

  1. Мониторинг использования квоты: Используйте API квот Azure для эффективного отслеживания использования квоты. Этот API предоставляет в режиме реального времени сведения о текущем использовании и доступной квоте для определенного сочетания подписки, семейства виртуальных машин и региона. Перед увеличением квоты крайне важно регулярно проверка использования квоты.

  2. Запрос на увеличение квоты: Если использование квоты превышает предопределенный целевой объект, инициируйте запрос на увеличение квоты с помощью API квоты Azure, чтобы привести использование в соответствие с целями. Процесс прост: просто отправьте запрос API, в котором описано требуемое увеличение квоты. Например, если целевое использование квоты семейства виртуальных машин Dv2 в Северной Европе в разделе "подписка1" установлено на уровне 80 %, а мониторинг API квоты Azure указывает на фактическое использование 85 %, отправьте увеличение квоты на 10%-20%.

Совет

Рекомендуется запросить увеличение квоты на 10–20 % от уровня ресурса, так как он предоставляет резональный буфер для непредвиденных пиков использования ресурсов, гарантируя, что вы не достигнете нового предела квоты сразу после увеличения . Такой подход сводит к минимуму потребность в частых вызовах API для запроса дополнительной квоты, повышая вероятность утверждения.

  1. Увеличение квоты respnose: После отправки запроса на увеличение квоты вы получите ответ, указывающий, был ли ваш запрос утвержден или отклонен. В случае отклонения можно инициировать дальнейшие действия, записав в журнал запрос на поддержку с помощью REST API службы поддержки Azure или используя новый запрос на поддержку в портал Azure, включая особенности запроса на увеличение квоты и причину запроса.

Устранение ошибок API квоты

Используйте следующие таблицы для устранения ошибок, которые могут возникнуть при использовании API квоты.

Код ошибки Как решить эту проблему
ContactSupport Откройте новый запрос в службу поддержки в портал Azure. В разделе Выберите тип проблемы выберите Ограничения службы и подписки (квоты). Вы также можете открыть его программным способом с помощью REST API службы поддержки Azure.
InternalServerError Внутренняя ошибка сервера. Повторите вызов API позже.
Отсутствуетрегистрация Зарегистрируйте поставщик ресурсов Microsoft.Quota для каждой подписки. Инструкции по устранению неполадок см. в статье Устранение ошибок при регистрации поставщика ресурсов.
QuotaNotAvailableForResource Квота сейчас недоступна в расположении для запрошенного ресурса. Откройте новый запрос в службу поддержки в портал Azure. В разделе Выберите тип проблемы выберите Ограничения службы и подписки (квоты). Вы также можете открыть его программным способом с помощью REST API службы поддержки Azure.
QuotaReductionNotSupported Текущее ограничение квоты превышает запрошенную квоту или текущее использование превышает запрошенную квоту. Сокращение квот не поддерживается. Квота не может быть уменьшена.
RequestThrottled Для повышения общей производительности службы можно регулировать все запросы API уровня подписки и клиента. Количество запросов превысило максимально допустимую частоту запросов API. Повторите попытку позже.
ResourceNotAvailableForOffer Ресурс в настоящее время недоступен в расположении для типа предложения. Список текущих и устаревших предложений см. на странице Сведений о предложении Microsoft Azure . Сведения об изменении типа предложения см. на странице Изменение подписки Azure на другое предложение . Вы также можете открыть новый запрос в службу поддержки в портал Azure. В разделе Выберите тип проблемы выберите Ограничения службы и подписки (квоты). Вы также можете открыть его программным способом с помощью REST API службы поддержки Azure.
ResourceNotAvailableForSubscription Ресурс в настоящее время недоступен в расположении для запрошенной подписки. Откройте новый запрос на поддержку в портал Azure. В разделе Выберите тип проблемы выберите Ограничения службы и подписки (квоты). Вы также можете открыть его программным способом с помощью REST API службы поддержки Azure.
UnableToIncreaseQuota Не удается увеличить квоты для запрошенных подписок. Откройте новый запрос на поддержку в портал Azure. В разделе Выберите тип проблемы выберите Ограничения службы и подписки (квоты).
Требуется многофакторная идентификация Запросы квоты требуют многофакторной проверки подлинности. Включите Многофакторную идентификацию для клиента или учетной записи, следуя инструкциям в разделе Включение MFA , и повторите попытку.
RequestPartiallyFulfilled Запрос квоты выполняется частично. Для любых вопросов отправьте новый запрос в службу поддержки в портал Azure. В разделе Выберите тип проблемы выберите Ограничения службы и подписки (квоты).

Поддержка другими языками и интерфейсами

REST API квоты доступен в следующих языковых пакетах SDK Для Microsoft Azure:

Использование API портал Azure и поддержки для управления квотами

Azure позволяет создавать запросы на поддержку и управлять ими. Вы можете: