Freigeben über

Quota By Counter Keys - Update

  • Referenz
Dienst:
API Management
API-Version:
2024-05-01

Aktualisiert alle mit dem vorhandenen Kontingentzählerschlüssel angegebenen Kontingentzählerwerte auf einen Wert in der angegebenen Dienstinstanz. Dies sollte zum Zurücksetzen der Kontingentzählerwerte verwendet werden.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}?api-version=2024-05-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
quotaCounterKey
 path True

string

Kontingentindikator-Schlüsselbezeichner. Dies ist das Ergebnis des Ausdrucks, der im Gegenschlüssel-Attribut der Kontingent-nach-Schlüssel-Richtlinie definiert ist. Wenn Sie in der Richtlinie z. B. "counter-key="boo" angeben, kann auf sie über den Booleschen Zählerschlüssel zugegriffen werden. Wenn es jedoch als Counter-key="@("b"+"a")" definiert ist, kann er über die "ba"-Taste zugegriffen werden.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Der Name des API-Verwaltungsdiensts.
subscriptionId
 path True

string (uuid)

Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version
 query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name Typ Beschreibung
properties.callsCount

integer (int32)

Anzahl der Aufrufe des Indikators.
properties.kbTransferred

number (double)

Übertragene Daten in KiloByte.

Antworten

Name Typ Beschreibung
200 OK

QuotaCounterCollection

Aktualisierte Kontingentzählerwerte.
Other Status Codes

ErrorResponse

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

ApiManagementUpdateQuotaCounterKey

Beispielanforderung

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/quotas/ba?api-version=2024-05-01

{
  "properties": {
    "callsCount": 0,
    "kbTransferred": 2.5630078125
  }
}

Beispiel für eine Antwort

Statuscode:
200 
{
  "value": [
    {
      "counterKey": "ba",
      "periodKey": "0_P3Y6M4DT12H30M5S",
      "periodStartTime": "2014-08-04T04:24:35Z",
      "periodEndTime": "2018-02-08T16:54:40Z",
      "value": {
        "callsCount": 5,
        "kbTransferred": 2.5830078125
      }
    }
  ],
  "nextLink": ""
}

Definitionen

Name Beschreibung
ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail

Das Fehlerdetails.
ErrorResponse

Fehlerantwort
QuotaCounterCollection

Darstellung der Seitenkontingentzählerliste.
QuotaCounterContract

Details des Kontingentzählers.
QuotaCounterValueContractProperties

Details des Kontingentzählerwerts.
QuotaCounterValueUpdateContract

Details des Kontingentzählerwerts.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.
type

string

Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.
code

string

Der Fehlercode.
details

ErrorDetail[]

Die Fehlerdetails.
message

string

Die Fehlermeldung.
target

string

Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

QuotaCounterCollection

Objekt

Darstellung der Seitenkontingentzählerliste.

Name Typ Beschreibung
count

integer (int64)

Gesamtzahl der Datensätze auf allen Seiten.
nextLink

string

Link zur nächsten Seite, falls vorhanden.
value

QuotaCounterContract[]

Kontingentzählerwerte.

QuotaCounterContract

Objekt

Details des Kontingentzählers.

Name Typ Beschreibung
counterKey

string

minLength: 1

Der Schlüsselwert des Zählers. Darf nicht leer sein.
periodEndTime

string (date-time)

Das Datum des Endes des Zählerzeitraums. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm.
periodKey

string

minLength: 1

Bezeichner des Zeitraums, für den der Zähler erfasst wurde. Darf nicht leer sein.
periodStartTime

string (date-time)

Das Datum des Anfangs des Gegenzeitraums. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm.
value

QuotaCounterValueContractProperties

Kontingentwerteigenschaften

QuotaCounterValueContractProperties

Objekt

Details des Kontingentzählerwerts.

Name Typ Beschreibung
callsCount

integer (int32)

Anzahl der Aufrufe des Indikators.
kbTransferred

number (double)

Übertragene Daten in KiloByte.

QuotaCounterValueUpdateContract

Objekt

Details des Kontingentzählerwerts.

Name Typ Beschreibung
properties.callsCount

integer (int32)

Anzahl der Aufrufe des Indikators.
properties.kbTransferred

number (double)

Übertragene Daten in KiloByte.