Edit

Share via

Get-AzStorageFileServiceUsage

Module:
Az.Storage Module

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

Syntax

Get (Default) 

Get-AzStorageFileServiceUsage
    -ResourceGroupName <String>
    -StorageAccountName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

List 

Get-AzStorageFileServiceUsage
    -ResourceGroupName <String>
    -StorageAccountName <String>
    [-SubscriptionId <String[]>]
    [-Maxpagesize <Int32>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity 

Get-AzStorageFileServiceUsage
    -InputObject <IStorageIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

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

Examples

Example 1: Get a Storage account file service usage data

Get-AzStorageFileServiceUsage -StorageAccountName myaccount -ResourceGroupName myresroucegroup

BurstingConstantBurstFloorIops                      : 10000
BurstingConstantBurstIoScalar                       : 3
BurstingConstantBurstTimeframeSecond                : 3600
FileShareLimitMaxProvisionedBandwidthMiBPerSec      : 10340
FileShareLimitMaxProvisionedIops                    : 102400
FileShareLimitMaxProvisionedStorageGiB              : 262144
FileShareLimitMinProvisionedBandwidthMiBPerSec      : 125
FileShareLimitMinProvisionedIops                    : 3000
FileShareLimitMinProvisionedStorageGiB              : 32
FileShareRecommendationBandwidthScalar              : 0.1
FileShareRecommendationBaseBandwidthMiBPerSec       : 125
FileShareRecommendationBaseIops                     : 3000
FileShareRecommendationIoScalar                     : 1
Id                                                  : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresroucegroup/providers/Microsoft.Storage/storageAccounts/myaccount/fileServices/default/usages/default
LiveShareFileShareCount                             : 1
LiveShareProvisionedBandwidthMiBPerSec              : 129
LiveShareProvisionedIops                            : 3032
LiveShareProvisionedStorageGiB                      : 32
Name                                                : default
ResourceGroupName                                   : myresroucegroup
SoftDeletedShareFileShareCount                      : 0
SoftDeletedShareProvisionedBandwidthMiBPerSec       : 0
SoftDeletedShareProvisionedIops                     : 0
SoftDeletedShareProvisionedStorageGiB               : 0
StorageAccountLimitMaxFileShare                     : 50
StorageAccountLimitMaxProvisionedBandwidthMiBPerSec : 10340
StorageAccountLimitMaxProvisionedIops               : 102400
StorageAccountLimitMaxProvisionedStorageGiB         : 262144
Type                                                : Microsoft.Storage/storageAccounts/fileServices/usages

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

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Identity Parameter

Parameter properties

Type:IStorageIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Maxpagesize

Optional, specifies the maximum number of file service usages to be included in the list response.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

The name of the resource group within the user's subscription. The name is case insensitive.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-StorageAccountName

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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SubscriptionId

The ID of the target subscription.

Parameter properties

Type:

String[]

Default value:(Get-AzContext).Subscription.Id
Supports wildcards:False
DontShow:False

Parameter sets

Get
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

IStorageIdentity

Outputs

IFileServiceUsage