Usage By Subscription Sku - Usage By Subscription Sku

Dienst:

Search Management

API-Version:

2023-11-01

Ruft die Kontingentnutzung für eine Such-SKU im angegebenen Abonnement ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Search/locations/{location}/usages/{skuName}?api-version=2023-11-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
location	path	True	string	Der eindeutige Standortname für eine geografische Microsoft Azure-Region.
skuName	path	True	string	Der eindeutige SKU-Name, der eine abrechnende Ebene identifiziert.
subscriptionId	path	True	string	Der eindeutige Bezeichner für ein Microsoft Azure-Abonnement. Sie können diesen Wert aus der Azure Resource Manager-API, den Befehlszeilentools oder dem Portal abrufen.
api-version	query	True	string	Die API-Version, die für jede Anforderung verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string (uuid)	Ein vom Client generierter GUID-Wert, der diese Anforderung identifiziert. Wenn angegeben, wird dies in Antwortinformationen eingeschlossen, um die Anforderung nachzuverfolgen.

Antworten

Name	Typ	Beschreibung
200 OK	QuotaUsageResult	Der Vorgang war erfolgreich. Die Antwort enthält die Kontingentnutzung einer Suchdienst-SKU für das angegebene Abonnement.
Other Status Codes	CloudError	Unerwarteter Fehler während des Vorgangs.

Sicherheit

azure_auth

Microsoft Entra ID OAuth2-Autorisierungsfluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

GetQuotaUsage

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Search/locations/westus/usages/free?api-version=2023-11-01

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-search
# USAGE
    python get_quota_usage.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 = SearchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.usage_by_subscription_sku(
        location="westus",
        sku_name="free",
    )
    print(response)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/GetQuotaUsage.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 armsearch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7e29dd59eef13ef347d09e41a63f2585be77b3ca/specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/GetQuotaUsage.json
func ExampleManagementClient_UsageBySubscriptionSKU() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsearch.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewManagementClient().UsageBySubscriptionSKU(ctx, "westus", "free", &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, 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.QuotaUsageResult = armsearch.QuotaUsageResult{
	// 	Name: &armsearch.QuotaUsageResultName{
	// 		LocalizedValue: to.Ptr("F - Free"),
	// 		Value: to.Ptr("free"),
	// 	},
	// 	CurrentValue: to.Ptr[int32](8),
	// 	ID: to.Ptr("/subscriptions/{subscriptionId}/providers/Microsoft.Search/locations/{location}/usages/{skuName}"),
	// 	Limit: to.Ptr[int32](16),
	// 	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 { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the quota usage for a search sku in the given subscription.
 *
 * @summary Gets the quota usage for a search sku in the given subscription.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/GetQuotaUsage.json
 */
async function getQuotaUsage() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const location = "westus";
  const skuName = "free";
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const result = await client.usageBySubscriptionSku(location, skuName);
  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 System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search;
using Azure.ResourceManager.Search.Models;

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/GetQuotaUsage.json
// this example is just showing the usage of "UsageBySubscriptionSku" 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 = "subid";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
AzureLocation location = new AzureLocation("westus");
string skuName = "free";
QuotaUsageResult result = await subscriptionResource.UsageBySubscriptionSkuAsync(location, skuName);

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:

200

{
  "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Search/locations/{location}/usages/{skuName}",
  "unit": "Count",
  "currentValue": 8,
  "limit": 16,
  "name": {
    "value": "free",
    "localizedValue": "F - Free"
  }
}

Definitionen

Name	Beschreibung
CloudError	Enthält Informationen zu einem API-Fehler.
CloudErrorBody	Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.
Name	Der Name der SKU, die von Azure AI Search unterstützt wird.
QuotaUsageResult	Beschreibt die Kontingentverwendung für eine bestimmte SKU.

CloudError

Objekt

Enthält Informationen zu einem API-Fehler.

Name	Typ	Beschreibung
error	CloudErrorBody	Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

CloudErrorBody

Objekt

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

Name	Typ	Beschreibung
code	string	Ein Fehlercode, der die Fehlerbedingung genauer beschreibt als ein HTTP-Statuscode. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.
details	CloudErrorBody[]	Enthält geschachtelte Fehler, die mit diesem Fehler zusammenhängen.
message	string	Eine Meldung, die den Fehler detailliert beschreibt und Debuginformationen bereitstellt.
target	string	Das Ziel des bestimmten Fehlers (z. B. der Name der Eigenschaft im Fehler).

Name

Objekt

Der Name der SKU, die von Azure AI Search unterstützt wird.

Name	Typ	Beschreibung
localizedValue	string	Der lokalisierte Zeichenfolgenwert für den SKU-Namen.
value	string	Der von Azure AI Search unterstützte SKU-Name.

QuotaUsageResult

Objekt

Beschreibt die Kontingentverwendung für eine bestimmte SKU.

Name	Typ	Beschreibung
currentValue	integer (int32)	Der aktuell verwendete Wert für die bestimmte Such-SKU.
id	string	Die Ressourcen-ID des SKU-Endpunkts für die Kontingentverwendung für den Microsoft.Search-Anbieter.
limit	integer (int32)	Das Kontingentlimit für die bestimmte Such-SKU.
name	Name	Der Name der SKU, die von Azure AI Search unterstützt wird.
unit	string	Die Maßeinheit für die Such-SKU.