Freigeben über

Azure-Kontingentdienst-API

  • Artikel

Die Azure Quota Service-REST-API ist für das Anzeigen und Verwalten von Kontingenten für Azure-Ressourcenanbieter konzipiert.

Wichtig

Azure Quota Service-API ist öffentliche Vorschau

Eine neue Azure-Kontingent-API-Version ist eine öffentliche Vorschauversion. Diese API verwendet den Microsoft.Quota-Ressourcenanbieter, unterstützt Virtuelle Azure-Computer (Cores/vCPU), Azure Machine Learning (dedicated/vCPUs), Netzwerk, Azure HPC Cache, Storage und Azure Purview-Dienste.

Ein Kontingent ist das Dienstlimit oder die Für eine Ressource in Ihrem Azure-Abonnement festgelegte Freibetrag. Jeder Azure-Dienst definiert seine Kontingente und bestimmt seine Standardwerte. Weitere Informationen zu den gängigsten Microsoft Azure-Kontingenten finden Sie unter Grenzwerte, Kontingente und Einschränkungen für Azure-Abonnements und -Dienste.

Verwenden von Kontingent-APIs

Mit der Kontingent-API können Sie:

  1. Rufen Sie die aktuellen Kontingente und Nutzungen einer Ressource ab.
  2. Rufen Sie eine Liste der aktuellen Kontingente und Nutzungen aller Ressourcen ab.
  3. Erstellen oder Aktualisieren von Kontingenten einer Ressource
  4. Rufen Sie die status von Kontingentanforderungen für eine Ressource ab.
  5. Abrufen der Liste aller Kontingentanforderungen einer Ressource für ein Jahr

API-Kontingent-PUT-Aufruf und -Bereich

Die Put-Anforderung der Kontingent-API enthält einen "Scope"-Parameter, der an die Anforderungen von Ressourcenanbietern angepasst werden kann, die eine Kontingenterhöhung anstreben, um sicherzustellen, dass der API-Aufruf einheitlich bleibt.

https://management.azure.com/<scope>/Microsoft.Quota/quotas/<resourceName>?api-version=2021-03-15-preview
Ressourcenanbieter `Scope`
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}

Hinweis: Ein Beispiel für einen PUT-Aufruf für Compute finden Sie hier.

Voraussetzungen

Wichtig

Bevor Sie die Kontingent-API verwenden können, müssen Sie Folgendes ausführen:

Registrieren des Microsoft Quota-Ressourcenanbieters

Verwenden Sie den folgenden PowerShell-Befehl, um den Microsoft Quota-Ressourcenanbieter zu registrieren:

Register-AzResourceProvider -ProviderNamespace Microsoft.Quota

Es werden Ergebnisse wie die folgende Ausgabe zurückgegeben:

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

Nachdem der Microsoft.Quota-Ressourcenanbieter registriert wurde, wird auf RegistrationState festgelegt Registered. Weitere Informationen zum Verwalten von Azure-Ressourcenanbietern finden Sie unter Azure-Ressourcenanbieter.

Drosselung

Alle API-Aufrufe auf Abonnement- und Mandantenebene können gedrosselt werden, wenn Sie zu viele API-Anforderungen senden. Wenn Ihr API-Aufruf gedrosselt wird, erhalten Sie eine Fehlermeldung, die besagt, dass der Server die API-Anforderung abgelehnt hat. Sie können den API-Aufruf nach einiger Zeit wiederholen.

Ausführliche Informationen zur API-Einschränkung, zur Problembehandlung bei Drosselungsproblemen und zur Vermeidung einer Drosselung finden Sie unter Problembehandlung bei Drosselungsfehlern in Azure.

Rolle „Kontingentanforderungsoperator“

Der Kontingentanforderungsoperator ist eine integrierte Azure-Rolle, die für Kontingentvorgänge angepasst wurde. Sie gewährt Berechtigungen zum Lesen und Erstellen von Kontingentanforderungen, zum Abrufen von Kontingentanforderungen status und zum Erstellen von Supporttickets. Weisen Sie diese Rolle Benutzern, Gruppen, Dienstprinzipalen, verwalteten Identitäten und Anwendungen zu, die Kontingentvorgänge ausführen. Als Referenz lautet die Rollen-ID des Kontingentanforderungsoperators 0e5f05e5-9ab9-446b-b98d-1e2157c94125.

Die Rolle Kontingentanforderungsoperator wird erweitert, um Kontingentressourcenanbieterberechtigungen einzuschließen.

Bewährte Methoden für Kontingent-APIs

  1. Überwachen der Kontingentnutzung: Verwenden Sie die Azure-Kontingent-API, um Ihre Kontingentnutzung effektiv nachzuverfolgen. Diese API stellt Echtzeitinformationen zu Ihrer aktuellen Nutzung und dem verfügbaren Kontingent für eine bestimmte Kombination aus Abonnement, VM-Familie und Region bereit. Es ist wichtig, ihre Kontingentauslastung regelmäßig zu überprüfen, bevor Sie eine Kontingenterhöhung in Betracht ziehen.

  2. Anfordern einer Kontingenterhöhung: Wenn Ihre Kontingentauslastung das vordefinierte Ziel überschreitet, initiieren Sie mithilfe der Azure-Kontingent-API eine Anforderung zur Erhöhung des Kontingents, um Ihre Nutzung wieder mit Ihren Zielen in Einklang zu bringen. Der Prozess ist einfach: Senden Sie einfach eine API-Anforderung, die die gewünschte Kontingenterhöhung darstellt. Wenn beispielsweise die Zielauslastung für das Dv2-VM-Familienkontingent in Europa Nord unter "abonnement1" auf 80 % festgelegt ist und Ihre Azure-Kontingent-API-Überwachung eine tatsächliche Auslastung von 85 % angibt, übermitteln Sie eine Kontingenterhöhung von 10 % bis 20 %.

Tipp

Es ist ratsam, eine Kontingenterhöhung von 10 % bis 20 % der Ressourcen-Utlisierung anzufordern, da sie einen resonalble Puffer für unerwartete Spitzen der Ressourcennutzung bietet, um sicherzustellen, dass Sie nach einer Erhöhung nicht sofort Ihr neues Kontingentlimit erreichen. Dieser Ansatz minimiert die Notwendigkeit häufiger API-Aufrufe, um zusätzliches Kontingent anzufordern, und verbessert Ihre Chancen auf eine Genehmigung.

  1. Kontingenterhöhung respnose: Wenn Sie eine Anforderung zur Kontingenterhöhung senden, erhalten Sie eine Antwort, die angibt, ob Ihre Anforderung genehmigt oder abgelehnt wurde. Im Falle einer Ablehnung können Sie eine Nachverfolgung initiieren, indem Sie eine Supportanfrage mithilfe der Azure-Support-REST-API oder mithilfe einer neuen Supportanfrage im Azure-Portal protokollieren, einschließlich der Besonderheiten der Anforderung zur verweigerten Kontingenterhöhung und dem Grund für Ihre Anfrage.

Problembehandlung bei Kontingent-API-Fehlern

Verwenden Sie die folgenden Tabellen, um Fehler zu beheben, die bei der Verwendung der Kontingent-API auftreten können.

Fehlercode Wie sie gelöst werden kann
ContactSupport Öffnen Sie eine neue Supportanfrage im Azure-Portal. Wählen Sie unter Problemtyp auswählendie Option Dienst- und Abonnementlimits (Kontingente) aus. Sie können es auch programmgesteuert mit der Azure-Support-REST-API öffnen.
InternalServerError Interner Serverfehler. Wiederholen Sie den API-Aufruf später.
MissingRegistration Registrieren Sie den Microsoft.Quota-Ressourcenanbieter für jedes Ihrer Abonnements. Anleitungen zur Problembehandlung finden Sie unter Beheben von Fehlern bei der Ressourcenanbieterregistrierung.
QuotaNotAvailableForResource Das Kontingent ist derzeit am Speicherort für die angeforderte Ressource nicht verfügbar. Öffnen Sie eine neue Supportanfrage im Azure-Portal. Wählen Sie unter Problemtyp auswählendie Option Dienst- und Abonnementlimits (Kontingente) aus. Sie können es auch programmgesteuert mit der Azure-Support-REST-API öffnen.
QuotaReductionNotSupported Das aktuelle Kontingentlimit ist höher als das angeforderte Kontingent, oder die aktuelle Nutzung ist höher als das angeforderte Kontingent. Das Reduzieren von Kontingenten wird nicht unterstützt. Das Kontingent kann nicht reduziert werden.
RequestThrottled Alle API-Anforderungen auf Abonnement- und Mandantenebene können gedrosselt werden, um die Gesamtleistung des Diensts zu verbessern. Die Anzahl der Anforderungen überstieg die maximal zulässige API-Anforderungsrate. Versuchen Sie es später noch einmal.
ResourceNotAvailableForOffer Die Ressource ist derzeit am Speicherort für den Angebotstyp nicht verfügbar. Die Liste der aktuellen und eingestellten Angebote finden Sie auf der Seite Mit den Details zum Microsoft Azure-Angebot . Informationen zum Ändern Ihres Angebotstyps finden Sie unter Ändern Ihres Azure-Abonnements in ein anderes Angebot . Sie können auch eine neue Supportanfrage im Azure-Portal öffnen. Wählen Sie unter Problemtyp auswählendie Option Dienst- und Abonnementlimits (Kontingente) aus. Sie können es auch programmgesteuert mit der Azure-Support-REST-API öffnen.
ResourceNotAvailableForSubscription Die Ressource ist derzeit am Speicherort für das angeforderte Abonnement nicht verfügbar. Öffnen Sie eine neue Supportanfrage im Azure-Portal. Wählen Sie unter Problemtyp auswählen die Option Dienst- und Abonnementlimits (Kontingente) aus. Sie können es auch programmgesteuert mit der Azure-Support-REST-API öffnen.
UnableToIncreaseQuota Die Kontingente für die angeforderten Abonnements können nicht erhöht werden. Öffnen Sie eine neue Supportanfrage im Azure-Portal. Wählen Sie unter Problemtyp auswählen die Option Dienst- und Abonnementlimits (Kontingente) aus.
MFA erforderlich Kontingentanforderungen benötigen multi-Factor Authentication. Aktivieren Sie die Mehrstufige Authentifizierung für Ihren Mandanten/Ihr Konto, indem Sie die Anweisungen unter Aktivieren der MFA befolgen, und versuchen Sie es erneut.
RequestPartiallyFulfilled Die Kontingentanforderung wird teilweise erfüllt. Wenn Sie Fragen haben, öffnen Sie eine neue Supportanfrage im Azure-Portal. Wählen Sie unter Problemtyp auswählen die Option Dienst- und Abonnementlimits (Kontingente) aus.

Support für andere Sprachen und Schnittstellen

Die Kontingent-REST-API ist in den folgenden sprachspezifischen Microsoft Azure SDKs verfügbar:

Verwenden der Azure-Portal- und Support-API zum Verwalten von Kontingenten

Azure ermöglicht das Erstellen und Verwalten von Supportanfragen (auch Supporttickets genannt). Ihre Möglichkeiten: