Quota - Update

Servicio:

Reserved VM Instances

Versión de la API:

2020-10-25

Actualice la cuota (límites de servicio) de este recurso al valor solicitado.

• Para obtener la información de cuota para un recurso específico, envíe una solicitud GET.

• Para aumentar la cuota, actualice el campo de límite de la respuesta GET a un nuevo valor.

• Para actualizar el valor de cuota, envíe la respuesta JSON a la API de solicitud de cuota para actualizar la cuota.

• Para actualizar la cuota. use la operación 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 identificador URI

Nombre	En	Requerido	Tipo	Description
location	path	True	string	Región de Azure.
providerId	path	True	string	Identificador del proveedor de recursos de Azure.
resourceName	path	True	string	Nombre de recurso de un proveedor de recursos, como el nombre de SKU de Microsoft.Compute, Sku o TotalLowPriorityCores para Microsoft.MachineLearningServices
subscriptionId	path	True	string	Identificador de suscripción de Azure
api-version	query	True	string	Versión de la API.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties	QuotaProperties	Propiedades de cuota para el recurso.

Respuestas

Nombre	Tipo	Description
200 OK	CurrentQuotaLimitBase	Aceptar. Devuelve los detalles de la solicitud de cuota.
201 Created	QuotaRequestSubmitResponse201	La solicitud se acepta y se está procesando. Use el parámetro requestId para comprobar el estado.
Other Status Codes	ExceptionResponse	Descripción del error en la respuesta.

Seguridad

azure_auth

Flujo 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	suplantación de su cuenta de usuario

Ejemplos

Quotas_Request_PatchForCompute

Solicitud de ejemplo

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

Respuesta de muestra

status code:

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

status code:

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

Definiciones

Nombre	Description
CurrentQuotaLimitBase	Propiedades de cuota.
ExceptionResponse	Error de API.
QuotaProperties	Propiedades de cuota para el recurso.
QuotaRequestState	Estado de la solicitud de cuota.
QuotaRequestSubmitResponse201	Respuesta con el identificador de solicitud que se aceptó la solicitud de cuota.
ResourceName	Nombre del recurso proporcionado por el proveedor de recursos. Use esta propiedad para el parámetro quotaRequest.
ResourceType	Nombre del tipo de recurso.
ServiceError	Detalles del error de LA API.
ServiceErrorDetail	Los detalles del error.

CurrentQuotaLimitBase

Propiedades de cuota.

Nombre	Tipo	Description
id	string	Identificador de solicitud de cuota.
name	string	Nombre de la solicitud de cuota.
properties	QuotaProperties	Propiedades de cuota para el recurso.
type	string	Tipo de recurso. "Microsoft.Capacity/ServiceLimits"

ExceptionResponse

Error de API.

Nombre	Tipo	Description
error	ServiceError	Detalles del error de LA API.

QuotaProperties

Propiedades de cuota para el recurso.

Nombre	Tipo	Description
currentValue	integer	Valor de uso actual del recurso.
limit	integer	Propiedades de cuota.
name	ResourceName	Nombre del recurso proporcionado por el proveedor de recursos. Use esta propiedad para las operaciones de recursos quotaRequests.
properties	object	Propiedades adicionales para el proveedor de recursos especificado.
quotaPeriod	string	Período de tiempo durante el que se resumen los valores de uso de cuota. Por ejemplo, P1D (por un día), PT1M (por minuto) y PT1S (por segundo). Este parámetro es opcional porque, para algunos recursos como el proceso, el período de tiempo es irrelevante.
resourceType	ResourceType	Nombre del tipo de recurso.
unit	string	Unidades de límite, como count y bytes. Use el campo de unidad proporcionado en la respuesta de la operación de cuota GET.

QuotaRequestState

Estado de la solicitud de cuota.

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

QuotaRequestSubmitResponse201

Respuesta con el identificador de solicitud que se aceptó la solicitud de cuota.

Nombre	Tipo	Description
id	string	Identificador de solicitud de cuota. Use el parámetro requestId para comprobar el estado de la solicitud.
name	string	Id. de operación
properties.message	string	Un mensaje descriptivo.
properties.provisioningState	QuotaRequestState	Detalles del estado de la solicitud de cuota.
type	string	Tipo de recurso

ResourceName

Nombre del recurso proporcionado por el proveedor de recursos. Use esta propiedad para el parámetro quotaRequest.

Nombre	Tipo	Description
localizedValue	string	Nombre localizado para mostrar el recurso.
value	string	Nombre del recurso.

ResourceType

Nombre del tipo de recurso.

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

ServiceError

Detalles del error de LA API.

Nombre	Tipo	Description
code	string	Código de error.
details	ServiceErrorDetail[]	Lista de detalles del error.
message	string	El texto del mensaje de error.

ServiceErrorDetail

Los detalles del error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	El mensaje de error.