Quota - Get

Служба:

Reserved VM Instances

Версия API:

2020-10-25

Получение текущей квоты (ограничения службы) и использования ресурса. Вы можете использовать ответ из операции GET для отправки запроса на обновление квоты.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
location	path	True	string	Регион Azure.
providerId	path	True	string	Идентификатор поставщика ресурсов Azure.
resourceName	path	True	string	Имя ресурса поставщика ресурсов, например имя SKU для Microsoft.Compute, Sku или TotalLowPriorityCores для Microsoft.MachineLearningServices
subscriptionId	path	True	string	Идентификатор подписки Azure.
api-version	query	True	string	Версия API.

Ответы

Имя	Тип	Описание
200 OK	CurrentQuotaLimitBase	ХОРОШО. Возвращает сведения о квоте с разбивкой на страницы. Заголовки ETag: string
Other Status Codes	ExceptionResponse	Описание ошибки в ответе.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Quotas_Request_ForCompute

Образец запроса

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 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/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 ReservationQuotaResource created on azure
// for more information of creating ReservationQuotaResource, please refer to the document of ReservationQuotaResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string providerId = "Microsoft.Compute";
AzureLocation location = new AzureLocation("eastus");
string resourceName = "standardNDSFamily";
ResourceIdentifier reservationQuotaResourceId = ReservationQuotaResource.CreateResourceIdentifier(subscriptionId, providerId, location, resourceName);
ReservationQuotaResource reservationQuota = client.GetReservationQuotaResource(reservationQuotaResourceId);

// invoke the operation
ReservationQuotaResource result = await reservationQuota.GetAsync();

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

Пример ответа

Код состояния:

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

Определения

Имя	Описание
CurrentQuotaLimitBase	Свойства квоты.
ExceptionResponse	Ошибка API.
QuotaProperties	Свойства квоты для ресурса.
ResourceName	Имя ресурса, предоставленное поставщиком ресурсов. Используйте это свойство для параметра quotaRequest.
ResourceType	Имя типа ресурса.
ServiceError	Сведения об ошибке API.
ServiceErrorDetail	Сведения об ошибке.

CurrentQuotaLimitBase

Object

Свойства квоты.

Имя	Тип	Описание
id	string	Идентификатор запроса квоты.
name	string	Имя запроса квоты.
properties	QuotaProperties	Свойства квоты для ресурса.
type	string	Тип ресурса. "Microsoft.Capacity/ServiceLimits"

ExceptionResponse

Object

Ошибка API.

Имя	Тип	Описание
error	ServiceError	Сведения об ошибке API.

QuotaProperties

Object

Свойства квоты для ресурса.

Имя	Тип	Описание
currentValue	integer (int32)	Текущее значение использования ресурса.
limit	integer (int32)	Свойства квоты.
name	ResourceName	Имя ресурса, предоставленного поставщиком ресурсов. Используйте это свойство для операций ресурсов quotaRequests.
properties	object	Дополнительные свойства для указанного поставщика ресурсов.
quotaPeriod	string	Период времени, в течение которого суммируются значения использования квоты. Например, P1D (в один день), PT1M (за одну минуту) и PT1S (в одну секунду). Этот параметр является необязательным, так как для некоторых ресурсов, таких как вычисления, период времени не имеет значения.
resourceType	ResourceType	Имя типа ресурса.
unit	string	Единицы ограничения, такие как количество и байтов. Используйте поле единицы, предоставленное в ответ на операцию GET квоты.

ResourceName

Object

Имя ресурса, предоставленное поставщиком ресурсов. Используйте это свойство для параметра quotaRequest.

Имя	Тип	Описание
localizedValue	string	Отображаемое локализованное имя ресурса.
value	string	Имя ресурса.

ResourceType

Перечисление

Имя типа ресурса.

Значение	Описание
dedicated
lowPriority
serviceSpecific
shared
standard

ServiceError

Object

Сведения об ошибке API.

Имя	Тип	Описание
code	string	Код ошибки.
details	ServiceErrorDetail[]	Список сведений об ошибке.
message	string	Текст сообщения об ошибке.

ServiceErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сообщение об ошибке.