Quota - Get

Dienst:

Reserved VM Instances

API-Version:

2020-10-25

Rufen Sie das aktuelle Kontingent (Dienstlimit) und die Nutzung einer Ressource ab. Sie können die Antwort des GET-Vorgangs verwenden, um eine Kontingentaktualisierungsanforderung zu übermitteln.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
location	path	True	string	Azure-Region.
providerId	path	True	string	Azure-Ressourcenanbieter-ID.
resourceName	path	True	string	Der Ressourcenname für einen Ressourcenanbieter, z. B. SKU-Name für Microsoft.Compute, Sku oder TotalLowPriorityCores für Microsoft.MachineLearningServices
subscriptionId	path	True	string	Die Azure-Abonnement-ID.
api-version	query	True	string	API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	CurrentQuotaLimitBase	OK. Gibt die paginierten Kontingentinformationen zurück. Header ETag: string
Other Status Codes	ExceptionResponse	Fehlerbeschreibung in der Antwort.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Quotas_Request_ForCompute

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
CurrentQuotaLimitBase	Kontingenteigenschaften.
ExceptionResponse	Der API-Fehler.
QuotaProperties	Kontingenteigenschaften für die Ressource.
ResourceName	Vom Ressourcenanbieter bereitgestellter Ressourcenname. Verwenden Sie diese Eigenschaft für den parameter quotaRequest.
ResourceType	Der Name des Ressourcentyps.
ServiceError	Die API-Fehlerdetails.
ServiceErrorDetail	Die Fehlerdetails.

CurrentQuotaLimitBase

Kontingenteigenschaften.

Name	Typ	Beschreibung
id	string	Die Kontingentanforderungs-ID.
name	string	Der Name der Kontingentanforderung.
properties	QuotaProperties	Kontingenteigenschaften für die Ressource.
type	string	Ressourcentyp. "Microsoft.Capacity/ServiceLimits"

ExceptionResponse

Der API-Fehler.

Name	Typ	Beschreibung
error	ServiceError	Die API-Fehlerdetails.

QuotaProperties

Kontingenteigenschaften für die Ressource.

Name	Typ	Beschreibung
currentValue	integer	Aktueller Nutzungswert für die Ressource.
limit	integer	Kontingenteigenschaften.
name	ResourceName	Name der Ressource, die vom Ressourcenanbieter bereitgestellt wird. Verwenden Sie diese Eigenschaft für quotaRequests-Ressourcenvorgänge.
properties	object	Zusätzliche Eigenschaften für den angegebenen Ressourcenanbieter.
quotaPeriod	string	Der Zeitraum, über den die Kontingentnutzungswerte zusammengefasst werden. Beispiel: P1D (pro Tag), PT1M (pro Minute) und PT1S (pro Sekunde). Dieser Parameter ist optional, da für einige Ressourcen wie Compute der Zeitraum irrelevant ist.
resourceType	ResourceType	Der Name des Ressourcentyps.
unit	string	Die Grenzwerteinheiten, z. B. Anzahl und Bytes. Verwenden Sie das In der Antwort des GET-Kontingentvorgangs angegebene Einheitenfeld.

ResourceName

Vom Ressourcenanbieter bereitgestellter Ressourcenname. Verwenden Sie diese Eigenschaft für den parameter quotaRequest.

Name	Typ	Beschreibung
localizedValue	string	Lokalisierter Name der Ressourcenanzeige.
value	string	Name der Ressource.

ResourceType

Der Name des Ressourcentyps.

Name	Typ	Beschreibung
dedicated	string
lowPriority	string
serviceSpecific	string
shared	string
standard	string

ServiceError

Die API-Fehlerdetails.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	ServiceErrorDetail[]	Die Liste der Fehlerdetails.
message	string	Der Text der Fehlermeldung.

ServiceErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
message	string	Die Fehlermeldung.