Gets the current usage count and the limit for the resources of the location under the subscription.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Storage/locations/{location}/usages?api-version=2023-05-01
URI Parameters
| Name |
In |
Required |
Type |
Description |
|
location
|
path |
True
|
string
|
The location of the Azure Storage resource.
|
|
subscriptionId
|
path |
True
|
string
|
The ID of the target subscription.
|
|
api-version
|
query |
True
|
string
|
The API version to use for this operation.
|
Responses
| Name |
Type |
Description |
|
200 OK
|
UsageListResult
|
OK -- current usage count and limit retrieved and returned successfully.
|
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name |
Description |
|
user_impersonation
|
impersonate your user account
|
Examples
UsageList
Sample request
GET https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Storage/locations/eastus2(stage)/usages?api-version=2023-05-01
/**
* Samples for Usages ListByLocation.
*/
public final class Main {
/*
* x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-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-05-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/220ad9c6554fc7d6d10a89bdb441c1e3b36e3285/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-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-05-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
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Storage.Models;
using Azure.ResourceManager.Storage;
// Generated from example definition: specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/StorageAccountListLocationUsage.json
// this example is just showing the usage of "Usages_ListByLocation" 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 = "{subscription-id}";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);
// invoke the operation and iterate over the result
AzureLocation location = new AzureLocation("eastus2(stage)");
await foreach (StorageUsage item in subscriptionResource.GetUsagesByLocationAsync(location))
{
Console.WriteLine($"Succeeded: {item}");
}
Console.WriteLine($"Succeeded");
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
{
"value": [
{
"unit": "Count",
"currentValue": 55,
"limit": 250,
"name": {
"value": "StorageAccounts",
"localizedValue": "Storage Accounts"
}
}
]
}
Definitions
| Name |
Description |
|
Usage
|
Describes Storage Resource Usage.
|
|
UsageListResult
|
The response from the List Usages operation.
|
|
UsageName
|
The usage names that can be used; currently limited to StorageAccount.
|
|
UsageUnit
|
Gets the unit of measurement.
|
Usage
Describes Storage Resource Usage.
| Name |
Type |
Description |
|
currentValue
|
integer
|
Gets the current count of the allocated resources in the subscription.
|
|
limit
|
integer
|
Gets the maximum count of the resources that can be allocated in the subscription.
|
|
name
|
UsageName
|
Gets the name of the type of usage.
|
|
unit
|
UsageUnit
|
Gets the unit of measurement.
|
UsageListResult
The response from the List Usages operation.
| Name |
Type |
Description |
|
value
|
Usage[]
|
Gets or sets the list of Storage Resource Usages.
|
UsageName
The usage names that can be used; currently limited to StorageAccount.
| Name |
Type |
Description |
|
localizedValue
|
string
|
Gets a localized string describing the resource name.
|
|
value
|
string
|
Gets a string describing the resource name.
|
UsageUnit
Gets the unit of measurement.
| Name |
Type |
Description |
|
Bytes
|
string
|
|
|
BytesPerSecond
|
string
|
|
|
Count
|
string
|
|
|
CountsPerSecond
|
string
|
|
|
Percent
|
string
|
|
|
Seconds
|
string
|
|