Subscription Usages - Get

Layanan:

SQL Database

Versi API:

2025-01-01

Mendapatkan metrik penggunaan langganan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
locationName	path	True	string	Nama wilayah tempat sumber daya berada.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus sebuah UUID.
usageName	path	True	string	Nama metrik penggunaan yang akan dikembalikan.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	SubscriptionUsage	Operasi Azure berhasil diselesaikan.
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Get specific subscription usage in the given location.

Permintaan sampel

HTTP

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

Java

/**
 * Samples for SubscriptionUsages Get.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/SubscriptionUsageGet.json
     */
    /**
     * Sample code: Get specific subscription usage in the given location.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void
        getSpecificSubscriptionUsageInTheGivenLocation(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getSubscriptionUsages().getWithResponse("WestUS", "ServerQuota",
            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.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python subscription_usage_get.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 = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.subscription_usages.get(
        location_name="WestUS",
        usage_name="ServerQuota",
    )
    print(response)


# x-ms-original-file: 2025-01-01/SubscriptionUsageGet.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

JavaScript

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to gets a subscription usage metric.
 *
 * @summary gets a subscription usage metric.
 * x-ms-original-file: 2025-01-01/SubscriptionUsageGet.json
 */
async function getSpecificSubscriptionUsageInTheGivenLocation() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.subscriptionUsages.get("WestUS", "ServerQuota");
  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.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

Respon sampel

Kode status:

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

Definisi

Nama	Deskripsi
createdByType	Jenis identitas yang membuat sumber daya.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan
SubscriptionUsage	Metrik Penggunaan Langganan di Lokasi.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Rincian kesalahan.
message	string	Pesan kesalahan.
target	string	Sasaran kesalahan.

ErrorResponse

Objek

Tanggapan kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

SubscriptionUsage

Objek

Metrik Penggunaan Langganan di Lokasi.

Nama	Jenis	Deskripsi
id	string (arm-id)	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nama sumber daya
properties.currentValue	number (double)	Nilai metrik saat ini.
properties.displayName	string	Nama metrik yang dapat dibaca pengguna.
properties.limit	number (double)	Nilai batas metrik.
properties.unit	string	Satuan dari metrik.
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createdBy dan modifiedBy.
type	string	Jenis sumber daya. Misalnya "Microsoft. Komputasi/virtualMachines" atau "Microsoft. Akun penyimpanan/penyimpanan"

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Stempel waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.