Azure Quota API
Quota API は、Azure サービスのクォータを表示および管理するために使用できる REST API です。
重要
クォータ API の一般提供
Azure Quota API が一般公開されました。 現在、Azure 仮想マシン (コア/vCPU) と Azure Machine Learning サービス (専用/vCPU) がサポートされています。
メモ: クォータ REST API の新しいバージョンは、 Azure Quota Service Rest API でパブリック プレビュー段階にあります。 Microsoft.Quota リソース プロバイダーを使用し、Azure 仮想マシン (コア/vCPU)、Azure Machine Learning、Azure ネットワーク、Azure HPC Cache、Azure Purview サービスをサポートしています。
クォータは、Azure サブスクリプション内のリソース、アクション、および項目の最大値です。 各 Azure サービスは、そのクォータを定義し、その既定値を決定します。 ビジネス ニーズによっては、クォータ値を増やす必要がある場合があります。
Microsoft Azure の最も一般的な制限の詳細については、「 Azure サブスクリプションとサービスの制限、クォータ、制約」を参照してください。
クォータ API の使用
クォータ API を使用すると、次のことができます。
- リソースの現在のクォータと使用状況を取得します。
- すべてのリソースの現在のクォータと使用状況の一覧を取得します。
- リソースのクォータを作成または更新します。
- リソースのクォータ要求の状態を取得します。
- 1 年間のリソースのすべてのクォータ要求の一覧を取得します。
REST 操作
Azure Quota API を使用すると、次の REST 操作を使用して、クォータと要求の増加を簡単に検索できます。
- クォータ管理 REST 操作の詳細については、「 クォータ API リファレンス」を参照してください。
- クォータ要求の状態 REST 操作の詳細については、「 クォータ要求の状態 API リファレンス」を参照してください。
前提条件
重要
Quota API を使用する前に、次の作業を行う必要があります。
- PowerShell を使用して、すべてのサブスクリプションの Microsoft Capacity (Microsoft.Capacity) リソース プロバイダーを登録します。
- クォータ要求オペレーター ロールを、クォータ 操作を実行するすべてのユーザー アカウントとアプリケーションに割り当てます。
Microsoft Capacity リソース プロバイダーの登録
Microsoft Capacity リソース プロバイダーを登録するには、次の PowerShell コマンドを使用します。
Register-AzResourceProvider -ProviderNamespace Microsoft.Capacity
次の出力のような結果が返されます。
ProviderNamespace : Microsoft.Capacity
RegistrationState : Registering
ResourceTypes : {resources, reservationOrders, reservationOrders/reservations, listbenefits...}
Locations : {West Europe, East US, South Central US...}
Microsoft.Capacity リソース プロバイダーが登録されると、 RegistrationState
が に Registered
設定されます。 Azure リソース プロバイダーの管理の詳細については、「 Azure リソース プロバイダー」を参照してください。
クォータ要求オペレーター ロール
クォータ要求オペレーター ロールは、クォータ操作用にカスタマイズされた Azure 組み込みロールです。 クォータ要求の読み取りと作成、クォータ要求の状態の取得、サポート チケットの作成に対するアクセス許可が付与されます。 このロールを、クォータ操作を実行するユーザー、グループ、サービス プリンシパル、マネージド ID、アプリケーションに割り当てます。 参考までに、クォータ要求オペレーターロール ID は 0e5f05e5-9ab9-446b-b98d-1e2157c94125 です。
vCPU のクォータ
Quota API を使用して、次の 2 種類の vCPU クォータのクォータを管理できます。
- 従量課金制 VM と予約 VM インスタンスの Standard vCPU クォータ。
- スポット VM のスポット vCPU クォータ。
Azure の制限とクォータの詳細については、「 Azure サブスクリプションとサービスの制限、クォータ、制約」を参照してください。
Azure Machine Learning のクォータ
Quota API を使用して、Azure Machine Learning ワークスペースとコンピューティングのクォータを管理できます。 次の詳細については、 Azure Machine Learning を使用したリソースのクォータの管理と引き上げ に関する記事を参照してください。
- Azure Machine Learning に関連する Azure リソースの既定の制限事項。
- ワークスペースレベルのクォータを作成する。
- クォータと制限を表示する。
- クォータの引き上げを依頼する。
- プライベート エンドポイントと DNS クォータ。
リージョン
ほとんどのクォータは、任意の 1 つのリージョンのワークロードに固有です。 サービスをデプロイするリージョンごとに個別のクォータを要求します。 サービスが存在するすべての Azure リージョンを一覧表示するには、 サービス リージョン別の一覧表示 操作を使用します。
Throttling
送信する API 要求が多すぎると、すべてのサブスクリプション レベルおよびテナント レベルの API 呼び出しを調整できます。 API 呼び出しが調整されると、サーバーが API 要求を拒否したことを示すエラー メッセージが表示されます。 しばらくしてから API 呼び出しを再試行できます。
API 調整の詳細、調整の問題のトラブルシューティング方法、調整されないようにする方法については、「 Azure での調整エラーのトラブルシューティング」を参照してください。
クォータ API エラーのトラブルシューティング
クォータ API の使用中に発生する可能性があるエラーのトラブルシューティングを行うには、次の表を使用します。
エラー コード | それを解決する方法 |
---|---|
ContactSupport | Azure portalで新しいサポート リクエストを開きます。 [ 問題の種類の選択] で、[ サービスとサブスクリプションの制限 (クォータ)] を選択します。 Azure サポート REST API を使用してプログラムで開くこともできます。 |
InternalServerError | 内部サーバー エラー。 後で API 呼び出しを再試行します。 |
MissingRegistration | サブスクリプションごとに Microsoft.Capacity リソース プロバイダーを登録します。 トラブルシューティングのガイダンスについては、「 リソース プロバイダー登録のエラーを解決する」を参照してください。 |
QuotaNotAvailableForResource | クォータは現在、要求されたリソースの場所では使用できません。 Azure portalで新しいサポート リクエストを開きます。 [ 問題の種類の選択] で、[ サービスとサブスクリプションの制限 (クォータ)] を選択します。 Azure サポート REST API を使用してプログラムで開くこともできます。 |
QuotaReductionNotSupported | 現在のクォータ制限が要求されたクォータより大きいか、現在の使用量が要求されたクォータより高くなっています。 クォータの削減はサポートされていません。 クォータを減らすことはできません。 |
RequestThrottled | サービスの全体的なパフォーマンスに役立つよう、すべてのサブスクリプション レベルおよびテナント レベルの API 要求が調整される場合があります。 要求の数が、許可される API 要求の最大レートを超えました。 後で再試行してください。 |
ResourceNotAvailableForOffer | リソースは現在、オファーの種類の場所では使用できません。 現在のオファーと廃止されたオファーの一覧については、「 Microsoft Azure プランの詳細 」ページを参照してください。 オファーの種類を変更するには、「 Azure サブスクリプションを別のオファーに変更する 」ページを参照してください。 Azure portalで新しいサポート リクエストを開くこともできます。 [ 問題の種類の選択] で、[ サービスとサブスクリプションの制限 (クォータ)] を選択します。 Azure サポート REST API を使用してプログラムで開くこともできます。 |
ResourceNotAvailableForSubscription | リソースは現在、要求されたサブスクリプションの場所では使用できません。 Azure portalで新しいサポート リクエストを開きます。 [ 問題の種類の選択] で、[ サービスとサブスクリプションの制限 (クォータ)] を選択します。 Azure サポート REST API を使用してプログラムで開くこともできます。 |
UnableToIncreaseQuota | 要求されたサブスクリプションのクォータを増やすことができません。 Azure portalで新しいサポート リクエストを開きます。 [ 問題の種類の選択] で、[ サービスとサブスクリプションの制限 (クォータ)] を選択します。 |
他の言語やインターフェイスでのサポート
クォータ REST API は、次の言語固有の Microsoft Azure SDK で使用できます。
- Microsoft Azure SDK for .NET: NuGet パッケージ
- Microsoft Azure SDK for Python: Py パッケージ
- Microsoft Azure SDK for JavaScript (NodeJS & Browser): js パッケージ
- Microsoft Azure SDK for Go: Go パッケージ
Azure portalとサポート API を使用してクォータを管理する
Azure では、サポート要求 (サポート チケットとも呼ばれる) を作成して管理できます。 次のようにすることができます。