Quota - Update

서비스:

Reserved VM Instances

API 버전:

2020-10-25

이 리소스의 할당량(서비스 제한)을 요청된 값으로 업데이트합니다.

• 특정 리소스에 대한 할당량 정보를 얻으려면 GET 요청을 보냅니다.

• 할당량을 늘리려면 GET 응답의 제한 필드를 새 값으로 업데이트합니다.

• 할당량 값을 업데이트하려면 할당량 요청 API에 JSON 응답을 제출하여 할당량을 업데이트합니다.

• 할당량을 업데이트합니다. PATCH 작업을 사용합니다.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Capacity/resourceProviders/{providerId}/locations/{location}/serviceLimits/{resourceName}?api-version=2020-10-25

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
location	path	True	string	Azure 지역.
providerId	path	True	string	Azure 리소스 공급자 ID입니다.
resourceName	path	True	string	리소스 공급자의 리소스 이름(예: Microsoft.Compute의 SKU 이름, Microsoft.MachineLearningServices용 Sku 또는 TotalLowPriorityCores)
subscriptionId	path	True	string	Azure 구독 ID입니다.
api-version	query	True	string	API 버전입니다.

요청 본문

Name	형식	Description
properties	QuotaProperties	리소스의 할당량 속성입니다.

응답

Name	형식	Description
200 OK	CurrentQuotaLimitBase	그래. 할당량 요청의 세부 정보를 반환합니다.
201 Created	QuotaRequestSubmitResponse201	요청이 수락되고 처리되고 있습니다. requestId 매개 변수를 사용하여 상태를 확인합니다.
Other Status Codes	ExceptionResponse	응답의 오류 설명입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Quotas_Request_PatchForCompute

샘플 요청

HTTP

PATCH https://management.azure.com/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimits/standardFSv2Family?api-version=2020-10-25

{
  "properties": {
    "limit": 200,
    "unit": "Count",
    "name": {
      "value": "standardFSv2Family"
    }
  }
}

Java

import com.azure.resourcemanager.reservations.models.CurrentQuotaLimitBase;
import com.azure.resourcemanager.reservations.models.QuotaProperties;
import com.azure.resourcemanager.reservations.models.ResourceName;

/**
 * Samples for Quota Update.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2020-10-25/examples/
     * patchComputeQuotaRequest.json
     */
    /**
     * Sample code: Quotas_Request_PatchForCompute.
     * 
     * @param manager Entry point to ReservationsManager.
     */
    public static void
        quotasRequestPatchForCompute(com.azure.resourcemanager.reservations.ReservationsManager manager) {
        CurrentQuotaLimitBase resource = manager.quotas().getWithResponse("D7EC67B3-7657-4966-BFFC-41EFD36BAAB3",
            "Microsoft.Compute", "eastus", "standardFSv2Family", com.azure.core.util.Context.NONE).getValue();
        resource.update().withProperties(new QuotaProperties().withLimit(200).withUnit("Count")
            .withName(new ResourceName().withValue("standardFSv2Family"))).apply();
    }
}

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.reservations import AzureReservationAPI

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-reservations
# USAGE
    python patch_compute_quota_request.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 = AzureReservationAPI(
        credential=DefaultAzureCredential(),
    )

    response = client.quota.begin_update(
        subscription_id="D7EC67B3-7657-4966-BFFC-41EFD36BAAB3",
        provider_id="Microsoft.Compute",
        location="eastus",
        resource_name="standardFSv2Family",
        create_quota_request={"properties": {"limit": 200, "name": {"value": "standardFSv2Family"}, "unit": "Count"}},
    ).result()
    print(response)


# x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2020-10-25/examples/patchComputeQuotaRequest.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

Go

package armreservations_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/reservations/armreservations/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/reservations/resource-manager/Microsoft.Capacity/stable/2020-10-25/examples/patchComputeQuotaRequest.json
func ExampleQuotaClient_BeginUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armreservations.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewQuotaClient().BeginUpdate(ctx, "D7EC67B3-7657-4966-BFFC-41EFD36BAAB3", "Microsoft.Compute", "eastus", "standardFSv2Family", armreservations.CurrentQuotaLimitBase{
		Properties: &armreservations.QuotaProperties{
			Name: &armreservations.ResourceName{
				Value: to.Ptr("standardFSv2Family"),
			},
			Limit: to.Ptr[int32](200),
			Unit:  to.Ptr("Count"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.CurrentQuotaLimitBase = armreservations.CurrentQuotaLimitBase{
	// 	Name: to.Ptr("2B5C8515-37D8-4B6A-879B-CD641A2CF605"),
	// 	Type: to.Ptr("Microsoft.Capacity/serviceLimits"),
	// 	ID: to.Ptr("/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimitsRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605"),
	// 	Properties: &armreservations.QuotaProperties{
	// 		Name: &armreservations.ResourceName{
	// 			LocalizedValue: to.Ptr("Standard FSv2 Family vCPUs"),
	// 			Value: to.Ptr("standardFSv2Family"),
	// 		},
	// 		CurrentValue: to.Ptr[int32](160),
	// 		Limit: to.Ptr[int32](200),
	// 		Properties: map[string]any{
	// 		},
	// 		QuotaPeriod: to.Ptr(""),
	// 		Unit: to.Ptr("Count"),
	// 	},
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Update the quota (service limits) of this resource to the requested value.
  • To get the quota information for specific resource, send a GET request.
  • To increase the quota, update the limit field from the GET response to a new value.
  • To update the quota value, submit the JSON response to the quota request API to update the quota.
  • To update the quota. use the PATCH operation.
 *
 * @summary Update the quota (service limits) of this resource to the requested value.
  • To get the quota information for specific resource, send a GET request.
  • To increase the quota, update the limit field from the GET response to a new value.
  • To update the quota value, submit the JSON response to the quota request API to update the quota.
  • To update the quota. use the PATCH operation.
 * x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2020-10-25/examples/patchComputeQuotaRequest.json
 */
async function quotasRequestPatchForCompute() {
  const subscriptionId = "D7EC67B3-7657-4966-BFFC-41EFD36BAAB3";
  const providerId = "Microsoft.Compute";
  const location = "eastus";
  const resourceName = "standardFSv2Family";
  const createQuotaRequest = {
    properties: {
      name: { value: "standardFSv2Family" },
      limit: 200,
      unit: "Count",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new AzureReservationAPI(credential);
  const result = await client.quota.beginUpdateAndWait(
    subscriptionId,
    providerId,
    location,
    resourceName,
    createQuotaRequest
  );
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Reservations.Models;
using Azure.ResourceManager.Reservations;

// Generated from example definition: specification/reservations/resource-manager/Microsoft.Capacity/stable/2020-10-25/examples/patchComputeQuotaRequest.json
// this example is just showing the usage of "Quota_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ReservationQuotaResource created on azure
// for more information of creating ReservationQuotaResource, please refer to the document of ReservationQuotaResource
string subscriptionId = "D7EC67B3-7657-4966-BFFC-41EFD36BAAB3";
string providerId = "Microsoft.Compute";
AzureLocation location = new AzureLocation("eastus");
string resourceName = "standardFSv2Family";
ResourceIdentifier reservationQuotaResourceId = ReservationQuotaResource.CreateResourceIdentifier(subscriptionId, providerId, location, resourceName);
ReservationQuotaResource reservationQuota = client.GetReservationQuotaResource(reservationQuotaResourceId);

// invoke the operation
ReservationQuotaData data = new ReservationQuotaData
{
    Properties = new QuotaProperties
    {
        Limit = 200,
        Unit = "Count",
        ResourceName = new ReservationResourceName
        {
            Value = "standardFSv2Family",
        },
    },
};
ArmOperation<ReservationQuotaResource> lro = await reservationQuota.UpdateAsync(WaitUntil.Completed, data);
ReservationQuotaResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ReservationQuotaData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

샘플 응답

상태 코드:

201

{
  "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimitsRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605",
  "name": "2B5C8515-37D8-4B6A-879B-CD641A2CF605",
  "type": "Microsoft.Capacity/ServiceLimits",
  "properties": {
    "provisioningState": "InProgress",
    "message": ""
  }
}

상태 코드:

200

{
  "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimitsRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605",
  "name": "2B5C8515-37D8-4B6A-879B-CD641A2CF605",
  "type": "Microsoft.Capacity/serviceLimits",
  "properties": {
    "limit": 200,
    "unit": "Count",
    "currentValue": 160,
    "name": {
      "value": "standardFSv2Family",
      "localizedValue": "Standard FSv2 Family vCPUs"
    },
    "quotaPeriod": "",
    "properties": {}
  }
}

정의

Name	Description
CurrentQuotaLimitBase	할당량 속성입니다.
ExceptionResponse	API 오류입니다.
QuotaProperties	리소스의 할당량 속성입니다.
QuotaRequestState	할당량 요청 상태입니다.
QuotaRequestSubmitResponse201	할당량 요청이 수락된 요청 ID가 있는 응답입니다.
ResourceName	리소스 공급자가 제공하는 리소스 이름입니다. quotaRequest 매개 변수에 이 속성을 사용합니다.
ResourceType	리소스 유형의 이름입니다.
ServiceError	API 오류 세부 정보입니다.
ServiceErrorDetail	오류 세부 정보입니다.

CurrentQuotaLimitBase

Object

할당량 속성입니다.

Name	형식	Description
id	string	할당량 요청 ID입니다.
name	string	할당량 요청의 이름입니다.
properties	QuotaProperties	리소스의 할당량 속성입니다.
type	string	리소스의 유형입니다. "Microsoft.Capacity/ServiceLimits"

ExceptionResponse

Object

API 오류입니다.

Name	형식	Description
error	ServiceError	API 오류 세부 정보입니다.

QuotaProperties

Object

리소스의 할당량 속성입니다.

Name	형식	Description
currentValue	integer (int32)	리소스의 현재 사용량 값입니다.
limit	integer (int32)	할당량 속성입니다.
name	ResourceName	리소스 공급자가 제공하는 리소스의 이름입니다. quotaRequests 리소스 작업에 이 속성을 사용합니다.
properties	object	지정된 리소스 공급자에 대한 추가 속성입니다.
quotaPeriod	string	할당량 사용량 값이 요약되는 기간입니다. 예를 들어 P1D(1일당), PT1M(1분당) 및 PT1S(1초당)입니다. 컴퓨팅과 같은 일부 리소스의 경우 기간이 관련이 없으므로 이 매개 변수는 선택 사항입니다.
resourceType	ResourceType	리소스 유형의 이름입니다.
unit	string	개수 및 바이트같은 제한 단위입니다. GET 할당량 작업의 응답에 제공된 단위 필드를 사용합니다.

QuotaRequestState

열거형

할당량 요청 상태입니다.

값	Description
Accepted
Failed
InProgress
Invalid
Succeeded

QuotaRequestSubmitResponse201

Object

할당량 요청이 수락된 요청 ID가 있는 응답입니다.

Name	형식	Description
id	string	할당량 요청 ID입니다. requestId 매개 변수를 사용하여 요청 상태를 확인합니다.
name	string	작업 ID
properties.message	string	사용자에게 친숙한 메시지입니다.
properties.provisioningState	QuotaRequestState	할당량 요청 상태의 세부 정보입니다.
type	string	리소스 종류

ResourceName

Object

리소스 공급자가 제공하는 리소스 이름입니다. quotaRequest 매개 변수에 이 속성을 사용합니다.

Name	형식	Description
localizedValue	string	리소스는 지역화된 이름을 표시합니다.
value	string	리소스 이름입니다.

ResourceType

열거형

리소스 유형의 이름입니다.

값	Description
dedicated
lowPriority
serviceSpecific
shared
standard

ServiceError

Object

API 오류 세부 정보입니다.

Name	형식	Description
code	string	오류 코드입니다.
details	ServiceErrorDetail[]	오류 세부 정보 목록입니다.
message	string	오류 메시지 텍스트입니다.

ServiceErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
code	string	오류 코드입니다.
message	string	오류 메시지입니다.