Azure Quota Service API

[アーティクル]
02/07/2024

Azure Quota Service REST API は、Azure リソースプロバイダーのクォータを表示および管理するために設計されています。

重要

Azure Quota Service API はパブリックプレビューです

新しい Azure Quota API バージョンはパブリックプレビューです。この API は Microsoft.Quota リソースプロバイダーを使用し、Azure 仮想マシン (コア/vCPU)、Azure Machine Learning (専用/vCPU)、ネットワーク、Azure HPC Cache、ストレージ、Azure Purview サービスをサポートします。

クォータは、Azure サブスクリプション内のリソースに設定されたサービス制限または許容量です。各 Azure サービスは、そのクォータを定義し、その既定値を決定します。最も一般的な Microsoft Azure クォータの詳細については、「 Azure サブスクリプションとサービスの制限、クォータ、制約」を参照してください。

クォータ API の使用

クォータ API を使用すると、次のことができます。

リソースの現在のクォータと使用状況を取得します。
すべてのリソースの現在のクォータと使用状況の一覧を取得します。
リソースのクォータを作成または更新します。
リソースのクォータ要求の状態を取得します。
1 年間のリソースのすべてのクォータ要求の一覧を取得する

クォータ API PUT の呼び出しとスコープ

Quota 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 呼び出しの例については、こちらを参照してください。

前提条件

重要

Quota API を使用する前に、次の作業を行う必要があります。

PowerShell を使用して、すべてのサブスクリプションの Microsoft.Quota リソースプロバイダーを登録します。
クォータ要求オペレーターロールを、クォータ操作を実行するすべてのユーザーアカウントとアプリケーションに割り当てます。

Microsoft Quota リソースプロバイダーの登録

Microsoft Quota リソースプロバイダーを登録するには、次の 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 リソースプロバイダー」を参照してください。

Throttling

送信する API 要求が多すぎると、すべてのサブスクリプションレベルおよびテナントレベルの API 呼び出しを調整できます。 API 呼び出しが調整されると、サーバーが API 要求を拒否したことを示すエラーメッセージが表示されます。しばらくしてから API 呼び出しを再試行できます。

API 調整の詳細、調整の問題のトラブルシューティング方法、調整されないようにする方法については、「 Azure での調整エラーのトラブルシューティング」を参照してください。

クォータ要求オペレーターロール

クォータ要求オペレーターは、クォータ操作用にカスタマイズされた Azure 組み込みロールです。クォータ要求の読み取りと作成、クォータ要求の状態の取得、サポートチケットの作成に対するアクセス許可が付与されます。このロールを、クォータ操作を実行するユーザー、グループ、サービスプリンシパル、マネージド ID、アプリケーションに割り当てます。参考までに、クォータ要求オペレーターロール ID は 0e5f05e5-9ab9-446b-b98d-1e2157c94125 です。

クォータ要求オペレーターロールが拡張され、クォータリソースプロバイダーのアクセス許可が含まれます。

クォータ API のベストプラクティス

クォータの使用率の監視: Azure クォータ API を利用して、クォータの使用状況を効果的に追跡します。この API は、現在の使用状況と、サブスクリプション、VM ファミリ、リージョンの特定の組み合わせに対して使用可能なクォータに関するリアルタイム情報を提供します。クォータの増加を検討する前に、クォータ使用率を定期的にチェックすることが重要です。
クォータの引き上げを要求する: クォータ使用率が定義済みのターゲットを超えた場合は、Azure クォータ API を使用してクォータの引き上げ要求を開始して、目標に沿った使用率を戻します。プロセスは簡単です。必要なクォータの引き上げの概要を示す API 要求を送信するだけです。たとえば、ヨーロッパ北部の Dv2 VM ファミリクォータのターゲット使用率が "subscription1" に設定され、Azure クォータ API の監視で実際の使用率が 85% であることが示されている場合は、クォータの増加を 10% から 20% に送信します。

ヒント

リソース使用率の予期しない急増に対して反響的なバッファーが提供されるため、リソースの使用率の 10% から 20% のクォータの引き上げを要求することをお勧めします。これにより、の増加後に新しいクォータ制限にすぐに達しないようにすることをお勧めします。この方法により、追加のクォータを要求するために頻繁に API 呼び出しを行う必要が最小限に抑えられます。これにより、承認の可能性が向上します。

クォータの増加 respnose: クォータ引き上げ要求を送信すると、要求が承認されたか拒否されたかを示す応答を受け取ります。拒否された場合は、Azure サポート REST API を使用するか、Azure portalで新しいサポートリクエストを使用してサポートリクエストをログに記録することで、拒否されたクォータの増加要求の詳細と問い合わせの理由を含むフォローアップを開始できます。

クォータ API エラーのトラブルシューティング

クォータ API の使用中に発生する可能性があるエラーのトラブルシューティングを行うには、次の表を使用します。

エラーコード	それを解決する方法
ContactSupport	Azure portalで新しいサポートリクエストを開きます。 [ 問題の種類の選択] で、[ サービスとサブスクリプションの制限 (クォータ)] を選択します。 Azure サポート REST API を使用してプログラムで開くこともできます。
InternalServerError	内部サーバーエラー。後で API 呼び出しを再試行します。
MissingRegistration	サブスクリプションごとに Microsoft.Quota リソースプロバイダーを登録します。トラブルシューティングのガイダンスについては、「リソースプロバイダー登録のエラーを解決する」を参照してください。
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で新しいサポートリクエストを開きます。 [ 問題の種類の選択] で、[ サービスとサブスクリプションの制限 (クォータ)] を選択します。
MFA が必要	クォータ要求には多要素認証が必要です。「MFA を有効にする」の手順に従って、テナント/アカウントに対して Multi-Factor Authentication を有効にしてから、もう一度お試しください
RequestPartiallyFulfilled	クォータ要求が部分的に満たされています。質問がある場合は、Azure portalで新しいサポートリクエストを開きます。 [問題の種類の選択] で、[サービスとサブスクリプションの制限 (クォータ)] を選択します

他の言語やインターフェイスでのサポート

クォータ REST API は、次の言語固有の Microsoft Azure SDK で使用できます。

Microsoft Azure SDK for .NET: NuGet パッケージ
Microsoft Azure SDK for Java: Java パッケージ
Microsoft Azure SDK for Python: Py パッケージ
Microsoft Azure SDK for JavaScript (NodeJS & Browser): JavaScript パッケージ
Microsoft Azure SDK for Go: Go パッケージ
Microsoft Azure CLI 拡張機能: Cli パッケージ

Azure portalとサポート API を使用してクォータを管理する

Azure では、サポート要求 (サポートチケットとも呼ばれる) を作成して管理できます。次のようにすることができます。