Subscription Usages - Get

Служба:: SQL Database

Версия API:: 2025-01-01

Возвращает метрику использования подписки.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/usages/{usageName}?api-version=2025-01-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
locationName	path	True	string	Имя региона, в котором находится ресурс.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
usageName	path	True	string	Имя возвращаемой метрики использования.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	SubscriptionUsage	Операция Azure успешно завершена.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

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

azure_auth

Azure Active Directory OAuth2 Flow.

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

Области

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

Примеры

Get specific subscription usage in the given location.

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/WestUS/usages/ServerQuota?api-version=2025-01-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/SubscriptionUsageGet.json
// this example is just showing the usage of "SubscriptionUsages_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 SubscriptionUsageResource created on azure
// for more information of creating SubscriptionUsageResource, please refer to the document of SubscriptionUsageResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
AzureLocation locationName = new AzureLocation("WestUS");
string usageName = "ServerQuota";
ResourceIdentifier subscriptionUsageResourceId = SubscriptionUsageResource.CreateResourceIdentifier(subscriptionId, locationName, usageName);
SubscriptionUsageResource subscriptionUsage = client.GetSubscriptionUsageResource(subscriptionUsageResourceId);

// invoke the operation
SubscriptionUsageResource result = await subscriptionUsage.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
SubscriptionUsageData 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

{
  "name": "ServerQuota",
  "type": "Microsoft.Sql/locations/usages",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/Onebox/usages/ServerQuota",
  "properties": {
    "currentValue": 1,
    "displayName": "Regional Server Quota for West US",
    "limit": 20,
    "unit": "Count"
  }
}

Определения

Имя	Описание
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Ошибка управления ресурсами дополнительная информация.
ErrorDetail	Детали ошибки.
ErrorResponse	Ответ на ошибку
SubscriptionUsage	Метрика использования подписки в расположении.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

createdByType

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

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Объект

Ошибка управления ресурсами дополнительная информация.

Имя	Тип	Описание
info	object	Дополнительная информация.
type	string	Тип дополнительной информации.

ErrorDetail

Объект

Детали ошибки.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Ошибка дополнительная информация.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

SubscriptionUsage

Объект

Метрика использования подписки в расположении.

Имя	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Имя ресурса
properties.currentValue	number (double)	Текущее значение метрики.
properties.displayName	string	Читаемое пользователем имя метрики.
properties.limit	number (double)	Значение границы метрики.
properties.unit	string	Единица метрики.
systemData	systemData	Azure Resource Manager метаданные, содержащие информацию createdBy и modifiedBy.
type	string	Тип ресурса. Например, «Майкрософт. Compute/virtualMachines» или «Майкрософт. Аккаунты хранения/хранения»

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Временная метка последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.