File Services - Get Service Usage

Reference

Service:: Storage Resource Provider

API Version:: 2024-01-01

Gets the usage of file service in storage account including account limits, file share limits and constants used in recommendations and bursting formula.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/usages/default?api-version=2024-01-01

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string	The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. Regex pattern: `^[a-z0-9]+$`
FileServicesName	path	True	FileServicesName	The name of the file Service within the specified storage account. File Service Name must be "default"
fileServiceUsagesName	path	True	fileServiceUsagesName	The name of the file service usage. File Service Usage Name must be "default" Regex pattern: `^[a-z][a-z0-9]*$`
resourceGroupName	path	True	string	The name of the resource group within the user's subscription. The name is case insensitive. Regex pattern: `^[-\w\._\(\)]+$`
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	FileServiceUsage	OK -- returned the usage of a storage account’s File service.
Other Status Codes	CloudError	Error response describing why the operation failed.

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

GetFileServiceUsage

Sample request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/fileServices/default/usages/default?api-version=2024-01-01


/**
 * Samples for FileServices GetServiceUsage.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/FileServicesGetUsage.json
     */
    /**
     * Sample code: GetFileServiceUsage.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getFileServiceUsage(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getFileServices().getServiceUsageWithResponse("res4410",
            "sto8607", 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 file_services_get_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="00000000-1111-2222-3333-444444444444",
    )

    response = client.file_services.get_service_usage(
        resource_group_name="res4410",
        account_name="sto8607",
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/FileServicesGetUsage.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/9d3547622288137fd36f086afcdaea5408dbe48c/specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/FileServicesGetUsage.json
func ExampleFileServicesClient_GetServiceUsage() {
	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)
	}
	res, err := clientFactory.NewFileServicesClient().GetServiceUsage(ctx, "res4410", "sto8607", 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.FileServiceUsage = armstorage.FileServiceUsage{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Storage/storageAccounts/fileServices/usages"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/fileServices/default/usages/default"),
	// 	Properties: &armstorage.FileServiceUsageProperties{
	// 		BurstingConstants: &armstorage.BurstingConstants{
	// 			BurstFloorIOPS: to.Ptr[int32](10000),
	// 			BurstIOScalar: to.Ptr[float64](3),
	// 			BurstTimeframeSeconds: to.Ptr[int32](3600),
	// 		},
	// 		FileShareLimits: &armstorage.FileShareLimits{
	// 			MaxProvisionedBandwidthMiBPerSec: to.Ptr[int32](10340),
	// 			MaxProvisionedIOPS: to.Ptr[int32](102400),
	// 			MaxProvisionedStorageGiB: to.Ptr[int32](262144),
	// 			MinProvisionedBandwidthMiBPerSec: to.Ptr[int32](125),
	// 			MinProvisionedIOPS: to.Ptr[int32](3000),
	// 			MinProvisionedStorageGiB: to.Ptr[int32](32),
	// 		},
	// 		FileShareRecommendations: &armstorage.FileShareRecommendations{
	// 			BandwidthScalar: to.Ptr[float64](0.1),
	// 			BaseBandwidthMiBPerSec: to.Ptr[int32](125),
	// 			BaseIOPS: to.Ptr[int32](3000),
	// 			IoScalar: to.Ptr[float64](1),
	// 		},
	// 		StorageAccountLimits: &armstorage.AccountLimits{
	// 			MaxFileShares: to.Ptr[int32](50),
	// 			MaxProvisionedBandwidthMiBPerSec: to.Ptr[int32](10340),
	// 			MaxProvisionedIOPS: to.Ptr[int32](102400),
	// 			MaxProvisionedStorageGiB: to.Ptr[int32](262144),
	// 		},
	// 		StorageAccountUsage: &armstorage.AccountUsage{
	// 			LiveShares: &armstorage.AccountUsageElements{
	// 				FileShareCount: to.Ptr[int32](2),
	// 				ProvisionedBandwidthMiBPerSec: to.Ptr[int32](258),
	// 				ProvisionedIOPS: to.Ptr[int32](6064),
	// 				ProvisionedStorageGiB: to.Ptr[int32](64),
	// 			},
	// 			SoftDeletedShares: &armstorage.AccountUsageElements{
	// 				FileShareCount: to.Ptr[int32](1),
	// 				ProvisionedBandwidthMiBPerSec: to.Ptr[int32](125),
	// 				ProvisionedIOPS: to.Ptr[int32](3000),
	// 				ProvisionedStorageGiB: to.Ptr[int32](100),
	// 			},
	// 		},
	// 	},
	// }
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets the usage of file service in storage account including account limits, file share limits and constants used in recommendations and bursting formula.
 *
 * @summary Gets the usage of file service in storage account including account limits, file share limits and constants used in recommendations and bursting formula.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/FileServicesGetUsage.json
 */
async function getFileServiceUsage() {
  const subscriptionId =
    process.env["STORAGE_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res4410";
  const accountName = "sto8607";
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.fileServices.getServiceUsage(resourceGroupName, accountName);
  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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Storage;

// Generated from example definition: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/FileServicesGetUsage.json
// this example is just showing the usage of "FileServices_GetServiceUsage" 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 FileServiceUsageResource created on azure
// for more information of creating FileServiceUsageResource, please refer to the document of FileServiceUsageResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "res4410";
string accountName = "sto8607";
ResourceIdentifier fileServiceUsageResourceId = FileServiceUsageResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
FileServiceUsageResource fileServiceUsage = client.GetFileServiceUsageResource(fileServiceUsageResourceId);

// invoke the operation
FileServiceUsageResource result = await fileServiceUsage.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
FileServiceUsageData 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

Sample response

Status code:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/fileServices/default/usages/default",
  "name": "default",
  "type": "Microsoft.Storage/storageAccounts/fileServices/usages",
  "properties": {
    "storageAccountLimits": {
      "maxFileShares": 50,
      "maxProvisionedStorageGiB": 262144,
      "maxProvisionedIOPS": 102400,
      "maxProvisionedBandwidthMiBPerSec": 10340
    },
    "fileShareLimits": {
      "minProvisionedStorageGiB": 32,
      "maxProvisionedStorageGiB": 262144,
      "minProvisionedIOPS": 3000,
      "maxProvisionedIOPS": 102400,
      "minProvisionedBandwidthMiBPerSec": 125,
      "maxProvisionedBandwidthMiBPerSec": 10340
    },
    "fileShareRecommendations": {
      "baseIOPS": 3000,
      "ioScalar": 1,
      "baseBandwidthMiBPerSec": 125,
      "bandwidthScalar": 0.1
    },
    "burstingConstants": {
      "burstFloorIOPS": 10000,
      "burstIOScalar": 3,
      "burstTimeframeSeconds": 3600
    },
    "storageAccountUsage": {
      "liveShares": {
        "fileShareCount": 2,
        "provisionedStorageGiB": 64,
        "provisionedIOPS": 6064,
        "provisionedBandwidthMiBPerSec": 258
      },
      "softDeletedShares": {
        "fileShareCount": 1,
        "provisionedStorageGiB": 100,
        "provisionedIOPS": 3000,
        "provisionedBandwidthMiBPerSec": 125
      }
    }
  }
}

Definitions

Name	Description
AccountLimits	Maximum provisioned storage, IOPS, bandwidth and number of file shares limits for the storage account.
AccountUsage	Usage of provisioned storage, IOPS, bandwidth and number of file shares across all live shares and soft-deleted shares in the account.
AccountUsageElements	Usage of provisioned storage, IOPS, bandwidth and number of file shares across all live shares or soft-deleted shares in the account.
BurstingConstants	Constants used for calculating included burst IOPS and maximum burst credits for IOPS for a file share in the storage account.
CloudError	An error response from the Storage service.
CloudErrorBody	An error response from the Storage service.
FileServicesName	The name of the file Service within the specified storage account. File Service Name must be "default"
FileServiceUsage	The usage of file service in storage account.
FileServiceUsageProperties	File service usage in storage account including account limits, file share limits and constants used in recommendations and bursting formula.
fileServiceUsagesName	The name of the file service usage. File Service Usage Name must be "default"
FileShareLimits	Minimum and maximum provisioned storage, IOPS and bandwidth limits for a file share in the storage account.
FileShareRecommendations	Constants used for calculating recommended provisioned IOPS and bandwidth for a file share in the storage account.

AccountLimits

Object

Maximum provisioned storage, IOPS, bandwidth and number of file shares limits for the storage account.

Name	Type	Description
maxFileShares	integer	The maximum number of file shares limit for the storage account.
maxProvisionedBandwidthMiBPerSec	integer	The maximum provisioned bandwidth limit in mebibytes per second for the storage account.
maxProvisionedIOPS	integer	The maximum provisioned IOPS limit for the storage account.
maxProvisionedStorageGiB	integer	The maximum provisioned storage quota limit in gibibytes for the storage account.

AccountUsage

Object

Usage of provisioned storage, IOPS, bandwidth and number of file shares across all live shares and soft-deleted shares in the account.

Name	Type	Description
liveShares	AccountUsageElements	Usage of provisioned storage, IOPS, bandwidth and number of file shares across all live shares or soft-deleted shares in the account.
softDeletedShares	AccountUsageElements	Usage of provisioned storage, IOPS, bandwidth and number of file shares across all live shares or soft-deleted shares in the account.

AccountUsageElements

Object

Usage of provisioned storage, IOPS, bandwidth and number of file shares across all live shares or soft-deleted shares in the account.

Name	Type	Description
fileShareCount	integer	The total number of file shares.
provisionedBandwidthMiBPerSec	integer	The total provisioned bandwidth in mebibytes per second.
provisionedIOPS	integer	The total provisioned IOPS.
provisionedStorageGiB	integer	The total provisioned storage quota in gibibytes.

BurstingConstants

Object

Constants used for calculating included burst IOPS and maximum burst credits for IOPS for a file share in the storage account.

Name	Type	Description
burstFloorIOPS	integer	The guaranteed floor of burst IOPS for small file shares.
burstIOScalar	number	The scalar against provisioned IOPS in the file share included burst IOPS formula.
burstTimeframeSeconds	integer	The time frame for bursting in seconds in the file share maximum burst credits for IOPS formula.

CloudError

Object

An error response from the Storage service.

Name	Type	Description
error	CloudErrorBody	An error response from the Storage service.

CloudErrorBody

Object

An error response from the Storage service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

FileServicesName

Enumeration

The name of the file Service within the specified storage account. File Service Name must be "default"

Value	Description
default

FileServiceUsage

Object

The usage of file service in storage account.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	FileServiceUsageProperties	File service usage in storage account including account limits, file share limits and constants used in recommendations and bursting formula.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

FileServiceUsageProperties

Object

File service usage in storage account including account limits, file share limits and constants used in recommendations and bursting formula.

Name	Type	Description
burstingConstants	BurstingConstants	Constants used for calculating included burst IOPS and maximum burst credits for IOPS for a file share in the storage account.
fileShareLimits	FileShareLimits	Minimum and maximum provisioned storage, IOPS and bandwidth limits for a file share in the storage account.
fileShareRecommendations	FileShareRecommendations	Constants used for calculating recommended provisioned IOPS and bandwidth for a file share in the storage account.
storageAccountLimits	AccountLimits	Maximum provisioned storage, IOPS, bandwidth and number of file shares limits for the storage account.
storageAccountUsage	AccountUsage	Usage of provisioned storage, IOPS, bandwidth and number of file shares across all live shares and soft-deleted shares in the account.

fileServiceUsagesName

Enumeration

The name of the file service usage. File Service Usage Name must be "default"

Value	Description
default

FileShareLimits

Object

Minimum and maximum provisioned storage, IOPS and bandwidth limits for a file share in the storage account.

Name	Type	Description
maxProvisionedBandwidthMiBPerSec	integer	The maximum provisioned bandwidth limit in mebibytes per second for a file share in the storage account.
maxProvisionedIOPS	integer	The maximum provisioned IOPS limit for a file share in the storage account.
maxProvisionedStorageGiB	integer	The maximum provisioned storage quota limit in gibibytes for a file share in the storage account.
minProvisionedBandwidthMiBPerSec	integer	The minimum provisioned bandwidth limit in mebibytes per second for a file share in the storage account.
minProvisionedIOPS	integer	The minimum provisioned IOPS limit for a file share in the storage account.
minProvisionedStorageGiB	integer	The minimum provisioned storage quota limit in gibibytes for a file share in the storage account.

FileShareRecommendations

Object

Constants used for calculating recommended provisioned IOPS and bandwidth for a file share in the storage account.

Name	Type	Description
bandwidthScalar	number	The scalar for bandwidth in the file share provisioned bandwidth recommendation formula.
baseBandwidthMiBPerSec	integer	The base bandwidth in the file share provisioned bandwidth recommendation formula.
baseIOPS	integer	The base IOPS in the file share provisioned IOPS recommendation formula.
ioScalar	number	The scalar for IO in the file share provisioned IOPS recommendation formula.