Quota By Period Keys - Update

Usługa:

API Management

Wersja interfejsu API:

2024-05-01

Aktualizuje istniejącą wartość licznika przydziału w określonym wystąpieniu usługi.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
quotaCounterKey	path	True	string	Identyfikator klucza licznika przydziału. Jest to wynik wyrażenia zdefiniowanego w atrybucie counter-key zasad limitu przydziału według klucza. Jeśli na przykład określisz wartość counter-key="boo" w zasadach, będzie ona dostępna za pomocą klucza licznika "boo". Jeśli jednak jest on zdefiniowany jako counter-key="@("b"+"a")," będzie dostępny za pomocą klucza "ba"
quotaPeriodKey	path	True	string	Identyfikator klucza okresu przydziału.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nazwa usługi API Management.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Typ	Opis
properties.callsCount	integer (int32)	Liczba wywołań licznika.
properties.kbTransferred	number (double)	Dane przesyłane w kilobajtach.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	QuotaCounterContract	Treść odpowiedzi zawiera szczegóły licznika przydziału dla określonego okresu.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ApiManagementUpdateQuotaCounterKeyByQuotaPeriod

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:

200

{
  "counterKey": "ba",
  "periodKey": "0_P3Y6M4DT12H30M5S",
  "periodStartTime": "2014-08-04T04:24:35Z",
  "periodEndTime": "2018-02-08T16:54:40Z",
  "value": {
    "callsCount": 0,
    "kbTransferred": 2.5625
  }
}

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
QuotaCounterContract	Szczegóły licznika przydziału.
QuotaCounterValueContractProperties	Szczegóły wartości licznika przydziału.
QuotaCounterValueUpdateContract	Szczegóły wartości licznika przydziału.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

QuotaCounterContract

Objekt

Szczegóły licznika przydziału.

Nazwa	Typ	Opis
counterKey	string minLength: 1	Wartość Klucz licznika. Nie może być pusty.
periodEndTime	string (date-time)	Data zakończenia okresu licznika. Data jest zgodna z następującym formatem: yyyy-MM-ddTHH:mm:ssZ określony przez standard ISO 8601.
periodKey	string minLength: 1	Identyfikator okresu, dla którego zebrano licznik. Nie może być pusty.
periodStartTime	string (date-time)	Data rozpoczęcia okresu licznika. Data jest zgodna z następującym formatem: yyyy-MM-ddTHH:mm:ssZ określony przez standard ISO 8601.
value	QuotaCounterValueContractProperties	Właściwości wartości przydziału

QuotaCounterValueContractProperties

Objekt

Szczegóły wartości licznika przydziału.

Nazwa	Typ	Opis
callsCount	integer (int32)	Liczba wywołań licznika.
kbTransferred	number (double)	Dane przesyłane w kilobajtach.

QuotaCounterValueUpdateContract

Objekt

Szczegóły wartości licznika przydziału.

Nazwa	Typ	Opis
properties.callsCount	integer (int32)	Liczba wywołań licznika.
properties.kbTransferred	number (double)	Dane przesyłane w kilobajtach.