Quota By Counter Keys - Update

Servicio:

API Management

Versión de la API:

2024-05-01

Actualiza todos los valores de contador de cuota especificados con la clave de contador de cuota existente a un valor de la instancia de servicio especificada. Se debe usar para restablecer los valores del contador de cuota.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
quotaCounterKey	path	True	string	Identificador de clave de contador de cuota. Este es el resultado de la expresión definida en el atributo counter-key de la directiva de cuota por clave. Por ejemplo, si especifica counter-key="boo" en la directiva, la clave de contador "boo" puede acceder a ella. Pero si se define como counter-key="@("b"+"a")", será accesible mediante la tecla "ba".
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nombre del servicio API Management.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.callsCount	integer (int32)	Número de veces que se llamó a Counter.
properties.kbTransferred	number (double)	Datos transferidos en KiloBytes.

Respuestas

Nombre	Tipo	Description
200 OK	QuotaCounterCollection	Valores de contador de cuota actualizados.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

ApiManagementUpdateQuotaCounterKey

Solicitud de ejemplo

HTTP

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
  }
}

Respuesta de muestra

status code:

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": ""
}

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
QuotaCounterCollection	Representación de la lista Contador de cuota paginada.
QuotaCounterContract	Detalles del contador de cuota.
QuotaCounterValueContractProperties	Detalles del valor del contador de cuota.
QuotaCounterValueUpdateContract	Detalles del valor del contador de cuota.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

QuotaCounterCollection

Object

Representación de la lista Contador de cuota paginada.

Nombre	Tipo	Description
count	integer (int64)	Número total de recuento de registros en todas las páginas.
nextLink	string	Vínculo de página siguiente si existe.
value	QuotaCounterContract[]	Valores de contador de cuota.

QuotaCounterContract

Object

Detalles del contador de cuota.

Nombre	Tipo	Description
counterKey	string minLength: 1	Valor clave del contador. No debe estar vacío.
periodEndTime	string (date-time)	Fecha del final del período de contador. La fecha se ajusta al siguiente formato: yyyy-MM-ddTHH:mm:ssZ según lo especificado por el estándar ISO 8601.
periodKey	string minLength: 1	Identificador del período para el que se recopiló el contador. No debe estar vacío.
periodStartTime	string (date-time)	Fecha del inicio del período de contador. La fecha se ajusta al siguiente formato: yyyy-MM-ddTHH:mm:ssZ según lo especificado por el estándar ISO 8601.
value	QuotaCounterValueContractProperties	Propiedades de valor de cuota

QuotaCounterValueContractProperties

Object

Detalles del valor del contador de cuota.

Nombre	Tipo	Description
callsCount	integer (int32)	Número de veces que se llamó a Counter.
kbTransferred	number (double)	Datos transferidos en KiloBytes.

QuotaCounterValueUpdateContract

Object

Detalles del valor del contador de cuota.

Nombre	Tipo	Description
properties.callsCount	integer (int32)	Número de veces que se llamó a Counter.
properties.kbTransferred	number (double)	Datos transferidos en KiloBytes.