Usages - List By Location

Ссылка

Service:: Storage Resource Provider

API Version:: 2023-01-01

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
location	path	True	string	Расположение ресурса службы хранилища Azure.
subscriptionId	path	True	string	Идентификатор целевой подписки.
api-version	query	True	string	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	UsageListResult	ОК — текущее количество и ограничение использования успешно получены и возвращены.

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

azure_auth

Поток OAuth2 в Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Примеры

UsageList

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Storage/locations/eastus2(stage)/usages?api-version=2023-01-01


/** Samples for Usages ListByLocation. */
public final class Main {
    /*
     * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/
     * StorageAccountListLocationUsage.json
     */
    /**
     * Sample code: UsageList.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void usageList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getUsages().listByLocation("eastus2(stage)",
            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

from azure.identity import DefaultAzureCredential
from azure.mgmt.storage import StorageManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-storage
# USAGE
    python storage_account_list_location_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 = StorageManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.usages.list_by_location(
        location="eastus2(stage)",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountListLocationUsage.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

package armstorage_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storage/armstorage"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/0baf811c3c76c87b3c127d098519bd97141222dd/specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountListLocationUsage.json
func ExampleUsagesClient_NewListByLocationPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstorage.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewUsagesClient().NewListByLocationPager("eastus2(stage)", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.UsageListResult = armstorage.UsageListResult{
		// 	Value: []*armstorage.Usage{
		// 		{
		// 			Name: &armstorage.UsageName{
		// 				LocalizedValue: to.Ptr("Storage Accounts"),
		// 				Value: to.Ptr("StorageAccounts"),
		// 			},
		// 			CurrentValue: to.Ptr[int32](55),
		// 			Limit: to.Ptr[int32](250),
		// 			Unit: to.Ptr(armstorage.UsageUnitCount),
		// 	}},
		// }
	}
}

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

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

/**
 * This sample demonstrates how to Gets the current usage count and the limit for the resources of the location under the subscription.
 *
 * @summary Gets the current usage count and the limit for the resources of the location under the subscription.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountListLocationUsage.json
 */
async function usageList() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const location = "eastus2(stage)";
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.usages.listByLocation(location)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "unit": "Count",
      "currentValue": 55,
      "limit": 250,
      "name": {
        "value": "StorageAccounts",
        "localizedValue": "Storage Accounts"
      }
    }
  ]
}

Определения

Имя	Описание
Usage	Описывает использование ресурсов хранилища.
UsageListResult	Ответ операции Перечисление использования.
UsageName	Имена использования, которые можно использовать; В настоящее время ограничено StorageAccount.
UsageUnit	Возвращает единицу измерения.

Usage

Описывает использование ресурсов хранилища.

Имя	Тип	Описание
currentValue	integer	Возвращает текущее количество выделенных ресурсов в подписке.
limit	integer	Возвращает максимальное количество ресурсов, которые могут быть выделены в подписке.
name	UsageName	Возвращает имя типа использования.
unit	UsageUnit	Возвращает единицу измерения.

UsageListResult

Ответ операции Перечисление использования.

Имя	Тип	Описание
value	Usage[]	Возвращает или задает список использования ресурсов хранилища.

UsageName

Имена использования, которые можно использовать; В настоящее время ограничено StorageAccount.

Имя	Тип	Описание
localizedValue	string	Возвращает локализованную строку, описывающую имя ресурса.
value	string	Возвращает строку, описывающую имя ресурса.

UsageUnit

Возвращает единицу измерения.

Имя	Тип	Описание
Bytes	string
BytesPerSecond	string
Count	string
CountsPerSecond	string
Percent	string
Seconds	string

Usages - List By Location

Параметры URI

Ответы

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

azure_auth

Scopes

Примеры

UsageList

Sample Request

Sample Response

Определения

Usage

UsageListResult

UsageName

UsageUnit

Дополнительные ресурсы