Azure 配額服務 API

發行項
02/07/2024

Azure 配額服務 REST API 是專為檢視和管理 Azure 資源提供者的配額而設計。

重要

Azure 配額服務 API 為公開預覽

新的 Azure 配額 API 版本是公開預覽版。此 API 使用 Microsoft.Quota Resource Provider，支援 Azure 虛擬機 (核心/vCPU) 、Azure Machine Learning (專用/vCPU) 、網路、Azure HPC Cache、儲存體和 Azure Purview 服務。

配額是在 Azure 訂用帳戶中的資源上設定的服務限制或額度。每個 Azure 服務都會定義其配額，並判斷其預設值。如需最常見 Microsoft Azure 配額的詳細資訊，請參閱 Azure 訂用帳戶和服務限制、配額和條件約束。

使用配額 API

使用配額 API，您可以：

取得資源的目前配額和使用量。
取得所有資源的目前配額和使用量清單。
建立或更新資源的配額。
取得資源的配額要求狀態。
取得資源的所有配額要求清單一年

配額 API PUT 呼叫和範圍

配額 API PUT 要求包含「範圍」參數，可自定義以符合資源提供者搜尋配額增加的需求，以確保 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 為所有訂用帳戶註冊 Microsoft.Quota 資源提供者。
將配額要求操作員角色指派給將執行配額作業的所有用戶帳戶和應用程式。

註冊 Microsoft 配額資源提供者

若要註冊 Microsoft 配額資源提供者，請使用下列 PowerShell 命令：

Register-AzResourceProvider -ProviderNamespace Microsoft.Quota

它會傳回類似下列輸出的結果：

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

註冊 Microsoft.Quota 資源提供者之後， RegistrationState 將會設定為 Registered。如需管理 Azure 資源提供者的詳細資訊，請參閱 Azure 資源提供者。

節流

如果您傳送太多 API 要求，則可以節流每個訂用帳戶層級和租用戶層級 API 呼叫。如果您的 API 呼叫已節流，您會收到錯誤訊息，指出伺服器拒絕 API 要求。經過一段時間后，您可以重試 API 呼叫。

如需 API 節流、如何針對節流問題進行疑難解答，以及如何避免節流的詳細資訊，請參閱針對 Azure 中的節流錯誤進行疑難解答。

配額要求操作員角色

配額要求操作員是針對配額作業自定義的 Azure 內建角色。它會授與讀取和建立配額要求的許可權、取得配額要求狀態，以及建立支援票證。將此角色指派給執行配額作業的使用者、群組、服務主體、受控識別和應用程式。如需參考，配額要求操作員角色標識符為 0e5f05e5-9ab9-446b-b98d-1e2157c94125。

配額要求操作員角色會擴充為包含配額資源提供者許可權。

配額 API 最佳做法

監視配額使用率： 利用 Azure 配額 API 有效地追蹤您的配額使用量。此 API 會提供您目前使用量的實時資訊，以及訂用帳戶、VM 系列和區域特定組合的可用配額。在考慮任何配額增加之前，請務必定期檢查配額使用率。
要求增加配額： 如果您的配額使用率超過預先定義的目標，請使用 Azure 配額 API 起始配額增加要求，讓您的使用率符合您的目標。此程序很簡單 -只要提交概述所需配額增加的 API 要求即可。例如，如果歐洲北部的 Dv2 VM 系列配額目標使用率設定為 80%，且您的 Azure 配額 API 監視指出實際使用率為 85%，則提交配額增加 10% 至 20%。

提示

建議您要求增加 10% 至 20% 的資源配額，因為它提供資源使用量非預期尖峰的重新回應緩衝區，以確保在增加之後不會立即達到新的配額限制。這種方法可將頻繁的 API 呼叫需求降到最低，以要求額外的配額，以改善核准的機會。

增加配額： 提交配額增加要求時，您會收到回應，指出您的要求是否已獲得核准或拒絕。在拒絕的情況下，您可以使用 Azure 支援 REST API 記錄支援要求，或在 Azure 入口網站中使用新的支援要求來起始後續操作，包括拒絕配額增加要求的詳細數據，以及您查詢的原因。

針對配額 API 錯誤進行疑難解答

使用下表來針對使用配額 API 時可能會得到的錯誤進行疑難解答。

錯誤碼	如何加以解決
ContactSupport	在 Azure 入口網站中開啟新的支援要求。在 [選取問題類型] 下，選擇 [服務和訂用帳戶限制] (配額) 。您也可以使用 Azure 支援 REST API 以程式設計方式開啟它。
InternalServerError	內部伺服器錯誤。稍後再重試 API 呼叫。
MissingRegistration	註冊每個訂用帳戶的 Microsoft.Quota 資源提供者。如需疑難解答指引，請參閱解決資源提供者註冊的錯誤。
QuotaNotAvailableForResource	要求資源的位置目前無法使用配額。在 Azure 入口網站中開啟新的支援要求。在 [選取問題類型] 下，選擇 [服務和訂用帳戶限制] (配額) 。您也可以使用 Azure 支援 REST API 以程式設計方式開啟它。
QuotaReductionNotSupported	目前的配額限制高於要求的配額，或目前的使用量高於要求的配額。不支援減少配額。無法減少配額。
RequestThrottled	每個訂用帳戶層級和租用戶層級 API 要求可能會受到節流，以協助服務的整體效能。要求數目超過允許的 API 要求速率上限。請稍後再試一次。
ResourceNotAvailableForOffer	供應項目類型的位置目前無法使用資源。如需目前和已淘汰的供應專案清單，請參閱 Microsoft Azure 供應專案詳細數據頁面。若要變更您的供應項目類型，請參閱將 Azure 訂用帳戶變更為不同的供應項目頁面。您也可以在 Azure 入口網站中開啟新的支援要求。在 [選取問題類型] 下，選擇 [服務和訂用帳戶限制] (配額) 。您也可以使用 Azure 支援 REST API 以程式設計方式開啟它。
ResourceNotAvailableForSubscription	資源目前無法在要求之訂用帳戶的位置中使用。在 Azure 入口網站中開啟新的支援要求。在 [選取問題類型] 下，選擇 [服務與訂用帳戶限制] (配額) 。您也可以使用 Azure 支援 REST API 以程式設計方式開啟它。
UnableToIncreaseQuota	無法增加所要求訂用帳戶的配額。在 Azure 入口網站中開啟新的支援要求。在 [選取問題類型] 下，選擇 [服務與訂用帳戶限制] (配額) 。
需要 MFA	配額要求需要 Multi-Factor Authentication。請遵循啟用 MFA 的指示，為您的租使用者/帳戶啟用 Multi-Factor Authentication，然後再試一次
RequestPartiallyFulfilled	配額要求已部分完成。如有任何問題，請在 Azure 入口網站中開啟新的支援要求。在 [選取問題類型] 下，選擇 [服務與訂用帳戶限制] (配額)

其他語言和介面中的支援

配額 REST API 適用於下列語言特定的 Microsoft Azure SDK：

Microsoft Azure SDK for .NET：NuGet 套件
Microsoft Azure SDK for Java： Java 套件
適用於 Python 的 Microsoft Azure SDK： Py 套件
Microsoft Azure SDK for JavaScript (NodeJS & Browser) ： JavaScript 套件
Microsoft Azure SDK for Go： Go 套件
Microsoft Azure CLI 延伸模組： Cli 套件

使用 Azure 入口網站和支援 API 來管理配額

Azure 可讓您建立及管理支援要求，也稱為支援票證。您可以：

共用方式為