Subscription Usages - Get

サービス:

SQL Database

API バージョン:

2023-08-01

サブスクリプションの使用状況メトリックを取得します。

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

URI パラメーター

名前	/	必須	型	説明
locationName	path	True	string	リソースが配置されているリージョンの名前。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
usageName	path	True	string	返される使用状況メトリックの名前。
api-version	query	True	string	要求に使用する API バージョン。

応答

名前	型	説明
200 OK	SubscriptionUsage	特定のサブスクリプションの場所の使用状況が正常に取得されました。
Other Status Codes	ErrorResponse	エラー応答: *** 400 InvalidLocation - 無効な場所が指定されました。 404 SubscriptionNotFound - 要求されたサブスクリプションが見つかりませんでした。 404 ResourceNotFound - 要求されたリソースが見つかりませんでした。

例

Get specific subscription usage in the given location.

要求のサンプル

HTTP

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

dotnet

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

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// get the collection of this SubscriptionUsageResource
AzureLocation locationName = new AzureLocation("WestUS");
SubscriptionUsageCollection collection = subscriptionResource.GetSubscriptionUsages(locationName);

// invoke the operation
string usageName = "ServerQuota";
NullableResponse<SubscriptionUsageResource> response = await collection.GetIfExistsAsync(usageName);
SubscriptionUsageResource 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
    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

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

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
SubscriptionUsage	場所内のサブスクリプションの使用状況メトリック。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

SubscriptionUsage

Object

場所内のサブスクリプションの使用状況メトリック。

名前	型	説明
id	string	リソース ID。
name	string	リソース名。
properties.currentValue	number (double)	メトリックの現在の値。
properties.displayName	string	メトリックのユーザーが読み取り可能な名前。
properties.limit	number (double)	メトリックの境界値。
properties.unit	string	メトリックの単位。
type	string	リソースの種類。