Quota - Update

Referência

Serviço:: Reserved VM Instances

Versão da API:: 2020-10-25

Atualize a cota (limites de serviço) desse recurso para o valor solicitado.

• Para obter as informações de cota para um recurso específico, envie uma solicitação GET.

• Para aumentar a cota, atualize o campo limite da resposta GET para um novo valor.

• Para atualizar o valor da cota, envie a resposta JSON à API de solicitação de cota para atualizar a cota.

• Para atualizar a cota. use a operação PATCH.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
location	path	True	string	Região do Azure.
providerId	path	True	string	ID do provedor de recursos do Azure.
resourceName	path	True	string	O nome do recurso para um provedor de recursos, como o nome da SKU para Microsoft.Compute, Sku ou TotalLowPriorityCores para Microsoft.MachineLearningServices
subscriptionId	path	True	string	Id de assinatura do Azure.
api-version	query	True	string	Versão da API.

Corpo da solicitação

Nome	Tipo	Description
properties	QuotaProperties	Propriedades de cota para o recurso.

Respostas

Nome	Tipo	Description
200 OK	CurrentQuotaLimitBase	OK. Retorna detalhes da solicitação de cota.
201 Created	QuotaRequestSubmitResponse201	A solicitação é aceita e está sendo processada. Use o parâmetro requestId para marcar o status.
Other Status Codes	ExceptionResponse	Descrição do erro na resposta.

Segurança

azure_auth

Fluxo do 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

Quotas_Request_PatchForCompute

Solicitação de exemplo

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


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

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

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

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

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

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

Resposta de exemplo

Código de status:: 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": ""
  }
}

Código de status:: 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": {}
  }
}

Definições

Nome	Description
CurrentQuotaLimitBase	Propriedades de cota.
ExceptionResponse	O erro da API.
QuotaProperties	Propriedades de cota para o recurso.
QuotaRequestState	A solicitação de cota status.
QuotaRequestSubmitResponse201	Resposta com a ID da solicitação de que a solicitação de cota foi aceita.
ResourceName	Nome do recurso fornecido pelo provedor de recursos. Use essa propriedade para o parâmetro quotaRequest.
ResourceType	O nome do tipo de recurso.
ServiceError	Os detalhes do erro da API.
ServiceErrorDetail	Os detalhes do erro.

CurrentQuotaLimitBase

Propriedades de cota.

Nome	Tipo	Description
id	string	A ID da solicitação de cota.
name	string	O nome da solicitação de cota.
properties	QuotaProperties	Propriedades de cota para o recurso.
type	string	Tipo de recurso. "Microsoft.Capacity/ServiceLimits"

ExceptionResponse

O erro da API.

Nome	Tipo	Description
error	ServiceError	Os detalhes do erro da API.

QuotaProperties

Propriedades de cota para o recurso.

Nome	Tipo	Description
currentValue	integer	Valor de uso atual para o recurso.
limit	integer	Propriedades de cota.
name	ResourceName	Nome do recurso fornecido pelo provedor de recursos. Use essa propriedade para operações de recurso quotaRequests.
properties	object	Propriedades adicionais para o provedor de recursos especificado.
quotaPeriod	string	O período durante o qual os valores de uso da cota são resumidos. Por exemplo, P1D (por um dia), PT1M (por um minuto) e PT1S (por um segundo). Esse parâmetro é opcional porque, para alguns recursos, como computação, o período de tempo é irrelevante.
resourceType	ResourceType	O nome do tipo de recurso.
unit	string	As unidades de limite, como contagem e bytes. Use o campo de unidade fornecido na resposta da operação de cota GET.

QuotaRequestState

A solicitação de cota status.

Nome	Tipo	Description
Accepted	string
Failed	string
InProgress	string
Invalid	string
Succeeded	string

QuotaRequestSubmitResponse201

Resposta com a ID da solicitação de que a solicitação de cota foi aceita.

Nome	Tipo	Description
id	string	A ID da solicitação de cota. Use o parâmetro requestId para marcar o status de solicitação.
name	string	ID da Operação
properties.message	string	Uma mensagem amigável.
properties.provisioningState	QuotaRequestState	Os detalhes da solicitação de cota status.
type	string	Tipo de recurso

ResourceName

Nome do recurso fornecido pelo provedor de recursos. Use essa propriedade para o parâmetro quotaRequest.

Nome	Tipo	Description
localizedValue	string	Nome localizado da exibição de recurso.
value	string	Nome do recurso.

ResourceType

O nome do tipo de recurso.

Nome	Tipo	Description
dedicated	string
lowPriority	string
serviceSpecific	string
shared	string
standard	string

ServiceError

Os detalhes do erro da API.

Nome	Tipo	Description
code	string	O código de erro.
details	ServiceErrorDetail[]	A lista de detalhes do erro.
message	string	O texto da mensagem de erro.

ServiceErrorDetail

Os detalhes do erro.

Nome	Tipo	Description
code	string	O código de erro.
message	string	A mensagem de erro.