Quota - Get

Servizio:

Reserved VM Instances

Versione API:

2020-10-25

Ottenere la quota corrente (limite di servizio) e l'utilizzo di una risorsa. È possibile usare la risposta dell'operazione GET per inviare la richiesta di aggiornamento della quota.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
location	path	True	string	Area di Azure.
providerId	path	True	string	ID provider di risorse di Azure.
resourceName	path	True	string	Nome della risorsa per un provider di risorse, ad esempio nome SKU per Microsoft.Compute, Sku o TotalLowPriorityCores per Microsoft.MachineLearningServices
subscriptionId	path	True	string	ID sottoscrizione di Azure.
api-version	query	True	string	Versione dell'API.

Risposte

Nome	Tipo	Descrizione
200 OK	CurrentQuotaLimitBase	OK. Restituisce le informazioni sulla quota impaginata. Intestazioni ETag: string
Other Status Codes	ExceptionResponse	Descrizione dell'errore nella risposta.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Quotas_Request_ForCompute

Esempio di richiesta

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimits/standardNDSFamily?api-version=2020-10-25

Java

/**
 * Samples for Quota Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/reservations/resource-manager/Microsoft.Capacity/stable/2020-10-25/examples/getComputeOneSkuUsages.
     * json
     */
    /**
     * Sample code: Quotas_Request_ForCompute.
     * 
     * @param manager Entry point to ReservationsManager.
     */
    public static void quotasRequestForCompute(com.azure.resourcemanager.reservations.ReservationsManager manager) {
        manager.quotas().getWithResponse("00000000-0000-0000-0000-000000000000", "Microsoft.Compute", "eastus",
            "standardNDSFamily", 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

Python

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-reservations
# USAGE
    python get_compute_one_sku_usages.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.get(
        subscription_id="00000000-0000-0000-0000-000000000000",
        provider_id="Microsoft.Compute",
        location="eastus",
        resource_name="standardNDSFamily",
    )
    print(response)


# x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2020-10-25/examples/getComputeOneSkuUsages.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/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/getComputeOneSkuUsages.json
func ExampleQuotaClient_Get() {
	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)
	}
	res, err := clientFactory.NewQuotaClient().Get(ctx, "00000000-0000-0000-0000-000000000000", "Microsoft.Compute", "eastus", "standardNDSFamily", 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.CurrentQuotaLimitBase = armreservations.CurrentQuotaLimitBase{
	// 	Properties: &armreservations.QuotaProperties{
	// 		Name: &armreservations.ResourceName{
	// 			LocalizedValue: to.Ptr("Standard NDS Family vCPUs"),
	// 			Value: to.Ptr("standardNDSFamily"),
	// 		},
	// 		CurrentValue: to.Ptr[int32](0),
	// 		Limit: to.Ptr[int32](10),
	// 		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 Get the current quota (service limit) and usage of a resource. You can use the response from the GET operation to submit quota update request.
 *
 * @summary Get the current quota (service limit) and usage of a resource. You can use the response from the GET operation to submit quota update request.
 * x-ms-original-file: specification/reservations/resource-manager/Microsoft.Capacity/stable/2020-10-25/examples/getComputeOneSkuUsages.json
 */
async function quotasRequestForCompute() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const providerId = "Microsoft.Compute";
  const location = "eastus";
  const resourceName = "standardNDSFamily";
  const credential = new DefaultAzureCredential();
  const client = new AzureReservationAPI(credential);
  const result = await client.quota.get(subscriptionId, providerId, location, resourceName);
  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;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/reservations/resource-manager/Microsoft.Capacity/stable/2020-10-25/examples/getComputeOneSkuUsages.json
// this example is just showing the usage of "Quota_Get" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// get the collection of this ReservationQuotaResource
string providerId = "Microsoft.Compute";
AzureLocation location = new AzureLocation("eastus");
ReservationQuotaCollection collection = subscriptionResource.GetAllReservationQuota(providerId, location);

// invoke the operation
string resourceName = "standardNDSFamily";
NullableResponse<ReservationQuotaResource> response = await collection.GetIfExistsAsync(resourceName);
ReservationQuotaResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // 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

Risposta di esempio

Codice di stato:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimits/standardNDSFamily",
  "name": "standardNDSFamily",
  "type": "Microsoft.Capacity/ServiceLimits",
  "properties": {
    "limit": 10,
    "unit": "Count",
    "currentValue": 0,
    "name": {
      "value": "standardNDSFamily",
      "localizedValue": "Standard NDS Family vCPUs"
    }
  }
}

Definizioni

Nome	Descrizione
CurrentQuotaLimitBase	Proprietà quota.
ExceptionResponse	Errore dell'API.
QuotaProperties	Proprietà quota per la risorsa.
ResourceName	Nome della risorsa fornito dal provider di risorse. Usare questa proprietà per il parametro quotaRequest.
ResourceType	Nome del tipo di risorsa.
ServiceError	Dettagli dell'errore dell'API.
ServiceErrorDetail	Dettagli dell'errore.

CurrentQuotaLimitBase

Proprietà quota.

Nome	Tipo	Descrizione
id	string	ID richiesta quota.
name	string	Nome della richiesta di quota.
properties	QuotaProperties	Proprietà quota per la risorsa.
type	string	Tipo di risorsa. "Microsoft.Capacity/ServiceLimits"

ExceptionResponse

Errore dell'API.

Nome	Tipo	Descrizione
error	ServiceError	Dettagli dell'errore dell'API.

QuotaProperties

Proprietà quota per la risorsa.

Nome	Tipo	Descrizione
currentValue	integer	Valore di utilizzo corrente per la risorsa.
limit	integer	Proprietà quota.
name	ResourceName	Nome della risorsa fornito dal provider di risorse. Usare questa proprietà per le operazioni delle risorse quotaRequests.
properties	object	Proprietà aggiuntive per il provider di risorse specificato.
quotaPeriod	string	Periodo di tempo in cui vengono riepilogati i valori di utilizzo della quota. Ad esempio, P1D (per un giorno), PT1M (al minuto) e PT1S (al secondo). Questo parametro è facoltativo perché, per alcune risorse, ad esempio il calcolo, il periodo di tempo è irrilevante.
resourceType	ResourceType	Nome del tipo di risorsa.
unit	string	Unità limite, ad esempio conteggio e byte. Usare il campo unità fornito nella risposta dell'operazione di quota GET.

ResourceName

Nome della risorsa fornito dal provider di risorse. Usare questa proprietà per il parametro quotaRequest.

Nome	Tipo	Descrizione
localizedValue	string	Il nome localizzato della risorsa viene visualizzato.
value	string	Nome risorsa.

ResourceType

Nome del tipo di risorsa.

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

ServiceError

Dettagli dell'errore dell'API.

Nome	Tipo	Descrizione
code	string	Codice di errore.
details	ServiceErrorDetail[]	Elenco dei dettagli dell'errore.
message	string	Testo del messaggio di errore.

ServiceErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Messaggio di errore.