Subscription Usages - Get

Servicio:

SQL Database

Versión de la API:

2023-08-01

Obtiene una métrica de uso de la suscripción.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
locationName	path	True	string	Nombre de la región donde se encuentra el recurso.
subscriptionId	path	True	string	Identificador de suscripción que identifica una suscripción de Azure.
usageName	path	True	string	Nombre de la métrica de uso que se va a devolver.
api-version	query	True	string	Versión de la API que se va a usar para la solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	SubscriptionUsage	Se recuperó correctamente un uso de ubicación de suscripción determinado.
Other Status Codes	ErrorResponse	Respuestas de error: *** 400 InvalidLocation: se especificó una ubicación no válida. 404 SubscriptionNotFound: no se encontró la suscripción solicitada. 404 ResourceNotFound: no se encontró el recurso solicitado.

Ejemplos

Get specific subscription usage in the given location.

Solicitud de ejemplo

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

Respuesta de muestra

status code:

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

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
SubscriptionUsage	Métrica de uso de una suscripción en una ubicación.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

SubscriptionUsage

Object

Métrica de uso de una suscripción en una ubicación.

Nombre	Tipo	Description
id	string	Identificador de recurso.
name	string	Nombre del recurso.
properties.currentValue	number (double)	Valor actual de la métrica.
properties.displayName	string	Nombre legible por el usuario de la métrica.
properties.limit	number (double)	Valor de límite de la métrica.
properties.unit	string	Unidad de la métrica.
type	string	Tipo de recurso.