Quota By Counter Keys - Update

Başvuru

Service:: API Management

API Version:: 2022-08-01

Mevcut kota sayacı anahtarıyla belirtilen tüm kota sayacı değerlerini belirtilen hizmet örneğindeki bir değere Güncelleştirmeler. Bu, kota sayacı değerlerini sıfırlamak için kullanılmalıdır.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
quotaCounterKey	path	True	string	Kota sayacı anahtar tanımlayıcısı. Bu, anahtara göre kota ilkesinin counter-key özniteliğinde tanımlanan ifadenin sonucudur. Örneğin, ilkede counter-key="boo" belirtirseniz buna "boo" sayaç anahtarıyla erişilebilir. Ancak counter-key="@("b"+"a")" olarak tanımlanırsa"ba" tuşuyla erişilebilir olur
resourceGroupName	path	True	string	Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.
serviceName	path	True	string	API Management hizmetinin adı. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	Hedef aboneliğin kimliği.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Tür	Description
properties.callsCount	integer	Counter'ın kaç kez çağrıldığı.
properties.kbTransferred	number	KiloBytes cinsinden Aktarılan Veriler.

Yanıtlar

Name	Tür	Description
200 OK	QuotaCounterCollection	Kota Sayacı Değerleri güncelleştirildi.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

ApiManagementUpdateQuotaCounterKey

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/quotas/ba?api-version=2022-08-01

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

import com.azure.resourcemanager.apimanagement.models.QuotaCounterValueUpdateContract;

/** Samples for QuotaByCounterKeys Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateQuotaCounterKey.json
     */
    /**
     * Sample code: ApiManagementUpdateQuotaCounterKey.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementUpdateQuotaCounterKey(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .quotaByCounterKeys()
            .updateWithResponse(
                "rg1",
                "apimService1",
                "ba",
                new QuotaCounterValueUpdateContract().withCallsCount(0).withKbTransferred(2.5630078125D),
                com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_update_quota_counter_key.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.quota_by_counter_keys.update(
        resource_group_name="rg1",
        service_name="apimService1",
        quota_counter_key="ba",
        parameters={"properties": {"callsCount": 0, "kbTransferred": 2.5630078125}},
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateQuotaCounterKey.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateQuotaCounterKey.json
func ExampleQuotaByCounterKeysClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewQuotaByCounterKeysClient().Update(ctx, "rg1", "apimService1", "ba", armapimanagement.QuotaCounterValueUpdateContract{
		Properties: &armapimanagement.QuotaCounterValueContractProperties{
			CallsCount:    to.Ptr[int32](0),
			KbTransferred: to.Ptr[float64](2.5630078125),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.QuotaCounterCollection = armapimanagement.QuotaCounterCollection{
	// 	Value: []*armapimanagement.QuotaCounterContract{
	// 		{
	// 			CounterKey: to.Ptr("ba"),
	// 			PeriodEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-02-08T16:54:40.000Z"); return t}()),
	// 			PeriodKey: to.Ptr("0_P3Y6M4DT12H30M5S"),
	// 			PeriodStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2014-08-04T04:24:35.000Z"); return t}()),
	// 			Value: &armapimanagement.QuotaCounterValueContractProperties{
	// 				CallsCount: to.Ptr[int32](5),
	// 				KbTransferred: to.Ptr[float64](2.5830078125),
	// 			},
	// 	}},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates all the quota counter values specified with the existing quota counter key to a value in the specified service instance. This should be used for reset of the quota counter values.
 *
 * @summary Updates all the quota counter values specified with the existing quota counter key to a value in the specified service instance. This should be used for reset of the quota counter values.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateQuotaCounterKey.json
 */
async function apiManagementUpdateQuotaCounterKey() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const quotaCounterKey = "ba";
  const parameters = {
    callsCount: 0,
    kbTransferred: 2.5630078125,
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.quotaByCounterKeys.update(
    resourceGroupName,
    serviceName,
    quotaCounterKey,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

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

Tanımlar

Name	Description
ErrorFieldContract	Hata Alanı sözleşmesi.
ErrorResponse	Hata Yanıtı.
QuotaCounterCollection	Disk Belleği Kota Sayacı liste gösterimi.
QuotaCounterContract	Kota sayacı ayrıntıları.
QuotaCounterValueContractProperties	Kota sayacı değer ayrıntıları.
QuotaCounterValueUpdateContract	Kota sayacı değer ayrıntıları.

ErrorFieldContract

Hata Alanı sözleşmesi.

Name	Tür	Description
code	string	Özellik düzeyi hata kodu.
message	string	Özellik düzeyi hatanın insan tarafından okunabilir gösterimi.
target	string	Özellik adı.

ErrorResponse

Hata Yanıtı.

Name	Tür	Description
error.code	string	Hizmet tanımlı hata kodu. Bu kod, yanıtta belirtilen HTTP hata kodu için bir alt durum görevi görür.
error.details	ErrorFieldContract[]	Doğrulama hatası durumunda istekte gönderilen geçersiz alanların listesi.
error.message	string	Hatanın insan tarafından okunabilir gösterimi.

QuotaCounterCollection

Disk Belleği Kota Sayacı liste gösterimi.

Name	Tür	Description
count	integer	Tüm sayfalardaki toplam kayıt sayısı.
nextLink	string	Varsa sonraki sayfa bağlantısı.
value	QuotaCounterContract[]	Kota sayacı değerleri.

QuotaCounterContract

Kota sayacı ayrıntıları.

Name	Tür	Description
counterKey	string	Sayacın Anahtar değeri. Boş olmamalıdır.
periodEndTime	string	Sayaç Döneminin bitiş tarihi. Tarih şu biçime uygundur: `yyyy-MM-ddTHH:mm:ssZ` ISO 8601 standardı tarafından belirtildiği gibi.
periodKey	string	Sayacın toplandığı Dönemin tanımlayıcısı. Boş olmamalıdır.
periodStartTime	string	Sayaç Döneminin başlangıç tarihi. Tarih şu biçime uygundur: `yyyy-MM-ddTHH:mm:ssZ` ISO 8601 standardı tarafından belirtildiği gibi.
value	QuotaCounterValueContractProperties	Kota Değeri Özellikleri

QuotaCounterValueContractProperties

Kota sayacı değer ayrıntıları.

Name	Tür	Description
callsCount	integer	Counter'ın kaç kez çağrıldığı.
kbTransferred	number	KiloBytes cinsinden Aktarılan Veriler.

QuotaCounterValueUpdateContract

Kota sayacı değer ayrıntıları.

Name	Tür	Description
properties.callsCount	integer	Counter'ın kaç kez çağrıldığı.
properties.kbTransferred	number	KiloBytes cinsinden Aktarılan Veriler.

Quota By Counter Keys - Update

URI Parametreleri

İstek Gövdesi

Yanıtlar

Güvenlik

azure_auth

Scopes

Örnekler

ApiManagementUpdateQuotaCounterKey

Sample Request

Sample Response

Tanımlar

ErrorFieldContract

ErrorResponse

QuotaCounterCollection

QuotaCounterContract

QuotaCounterValueContractProperties

QuotaCounterValueUpdateContract

Ek kaynaklar