Quota By Counter Keys - Update

Serviço:

API Management

Versão da API:

2024-05-01

Atualiza todos os valores do contador de cotas especificados com a chave de contador de cota existente para um valor na instância de serviço especificada. Isso deve ser usado para redefinir os valores do contador de cotas.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
quotaCounterKey	path	True	string	Identificador de chave do contador de cotas. Esse é o resultado da expressão definida no atributo de contra-chave da política de cota por chave. Por exemplo, se você especificar counter-key="boo" na política, ela será acessível por uma tecla de contador "boo". Mas se ele for definido como counter-key="@("b"+"a")", ele será acessível por "ba" key
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	O nome do serviço de Gerenciamento de API.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
properties.callsCount	integer (int32)	Número de vezes que o Contador foi chamado.
properties.kbTransferred	number (double)	Dados transferidos em KiloBytes.

Respostas

Nome	Tipo	Description
200 OK	QuotaCounterCollection	Valores atualizados do contador de cotas.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ApiManagementUpdateQuotaCounterKey

Solicitação de exemplo

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

Resposta de exemplo

Código de status:

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

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
QuotaCounterCollection	Representação da lista contador de cotas paginada.
QuotaCounterContract	Detalhes do contador de cotas.
QuotaCounterValueContractProperties	Detalhes do valor do contador de cotas.
QuotaCounterValueUpdateContract	Detalhes do valor do contador de cotas.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

QuotaCounterCollection

Objeto

Representação da lista contador de cotas paginada.

Nome	Tipo	Description
count	integer (int64)	Número total de contagem de registros em todas as páginas.
nextLink	string	Link da próxima página, se houver.
value	QuotaCounterContract[]	Valores do contador de cotas.

QuotaCounterContract

Objeto

Detalhes do contador de cotas.

Nome	Tipo	Description
counterKey	string minLength: 1	O valor da chave do Contador. Não deve estar vazio.
periodEndTime	string (date-time)	A data do final do Período do Contador. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601.
periodKey	string minLength: 1	Identificador do Período para o qual o contador foi coletado. Não deve estar vazio.
periodStartTime	string (date-time)	A data do início do Período do Contador. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601.
value	QuotaCounterValueContractProperties	Propriedades de valor de cota

QuotaCounterValueContractProperties

Objeto

Detalhes do valor do contador de cotas.

Nome	Tipo	Description
callsCount	integer (int32)	Número de vezes que o Contador foi chamado.
kbTransferred	number (double)	Dados transferidos em KiloBytes.

QuotaCounterValueUpdateContract

Objeto

Detalhes do valor do contador de cotas.

Nome	Tipo	Description
properties.callsCount	integer (int32)	Número de vezes que o Contador foi chamado.
properties.kbTransferred	number (double)	Dados transferidos em KiloBytes.