|
| 1 | +--- |
| 2 | +external help file: |
| 3 | +Module Name: Az.Storage |
| 4 | +online version: https://learn.microsoft.com/powershell/module/az.storage/get-azstoragefileserviceusage |
| 5 | +schema: 2.0.0 |
| 6 | +--- |
| 7 | + |
| 8 | +# Get-AzStorageFileServiceUsage |
| 9 | + |
| 10 | +## SYNOPSIS |
| 11 | +Gets the usage of file service in storage account including account limits, file share limits and constants used in recommendations and bursting formula. |
| 12 | + |
| 13 | +## SYNTAX |
| 14 | + |
| 15 | +### Get (Default) |
| 16 | +``` |
| 17 | +Get-AzStorageFileServiceUsage -ResourceGroupName <String> -StorageAccountName <String> |
| 18 | + [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] |
| 19 | +``` |
| 20 | + |
| 21 | +### GetViaIdentity |
| 22 | +``` |
| 23 | +Get-AzStorageFileServiceUsage -InputObject <IStorageIdentity> [-DefaultProfile <PSObject>] |
| 24 | + [<CommonParameters>] |
| 25 | +``` |
| 26 | + |
| 27 | +### List |
| 28 | +``` |
| 29 | +Get-AzStorageFileServiceUsage -ResourceGroupName <String> -StorageAccountName <String> |
| 30 | + [-SubscriptionId <String[]>] [-Maxpagesize <Int32>] [-DefaultProfile <PSObject>] [<CommonParameters>] |
| 31 | +``` |
| 32 | + |
| 33 | +## DESCRIPTION |
| 34 | +Gets the usage of file service in storage account including account limits, file share limits and constants used in recommendations and bursting formula. |
| 35 | + |
| 36 | +## EXAMPLES |
| 37 | + |
| 38 | +### Example 1: Get a Storage account file service usage data |
| 39 | +```powershell |
| 40 | +Get-AzStorageFileServiceUsage -StorageAccountName myaccount -ResourceGroupName myresroucegroup |
| 41 | +``` |
| 42 | + |
| 43 | +```output |
| 44 | +BurstingConstantBurstFloorIops : 10000 |
| 45 | +BurstingConstantBurstIoScalar : 3 |
| 46 | +BurstingConstantBurstTimeframeSecond : 3600 |
| 47 | +FileShareLimitMaxProvisionedBandwidthMiBPerSec : 10340 |
| 48 | +FileShareLimitMaxProvisionedIops : 102400 |
| 49 | +FileShareLimitMaxProvisionedStorageGiB : 262144 |
| 50 | +FileShareLimitMinProvisionedBandwidthMiBPerSec : 125 |
| 51 | +FileShareLimitMinProvisionedIops : 3000 |
| 52 | +FileShareLimitMinProvisionedStorageGiB : 32 |
| 53 | +FileShareRecommendationBandwidthScalar : 0.1 |
| 54 | +FileShareRecommendationBaseBandwidthMiBPerSec : 125 |
| 55 | +FileShareRecommendationBaseIops : 3000 |
| 56 | +FileShareRecommendationIoScalar : 1 |
| 57 | +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresroucegroup/providers/Microsoft.Storage/storageAccounts/myaccount/fileServices/default/usages/default |
| 58 | +LiveShareFileShareCount : 1 |
| 59 | +LiveShareProvisionedBandwidthMiBPerSec : 129 |
| 60 | +LiveShareProvisionedIops : 3032 |
| 61 | +LiveShareProvisionedStorageGiB : 32 |
| 62 | +Name : default |
| 63 | +ResourceGroupName : myresroucegroup |
| 64 | +SoftDeletedShareFileShareCount : 0 |
| 65 | +SoftDeletedShareProvisionedBandwidthMiBPerSec : 0 |
| 66 | +SoftDeletedShareProvisionedIops : 0 |
| 67 | +SoftDeletedShareProvisionedStorageGiB : 0 |
| 68 | +StorageAccountLimitMaxFileShare : 50 |
| 69 | +StorageAccountLimitMaxProvisionedBandwidthMiBPerSec : 10340 |
| 70 | +StorageAccountLimitMaxProvisionedIops : 102400 |
| 71 | +StorageAccountLimitMaxProvisionedStorageGiB : 262144 |
| 72 | +Type : Microsoft.Storage/storageAccounts/fileServices/usages |
| 73 | +``` |
| 74 | + |
| 75 | +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. |
| 76 | + |
| 77 | +## PARAMETERS |
| 78 | + |
| 79 | +### -DefaultProfile |
| 80 | +The DefaultProfile parameter is not functional. |
| 81 | +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. |
| 82 | + |
| 83 | +```yaml |
| 84 | +Type: System.Management.Automation.PSObject |
| 85 | +Parameter Sets: (All) |
| 86 | +Aliases: AzureRMContext, AzureCredential |
| 87 | + |
| 88 | +Required: False |
| 89 | +Position: Named |
| 90 | +Default value: None |
| 91 | +Accept pipeline input: False |
| 92 | +Accept wildcard characters: False |
| 93 | +``` |
| 94 | +
|
| 95 | +### -InputObject |
| 96 | +Identity Parameter |
| 97 | +
|
| 98 | +```yaml |
| 99 | +Type: Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.IStorageIdentity |
| 100 | +Parameter Sets: GetViaIdentity |
| 101 | +Aliases: |
| 102 | + |
| 103 | +Required: True |
| 104 | +Position: Named |
| 105 | +Default value: None |
| 106 | +Accept pipeline input: True (ByValue) |
| 107 | +Accept wildcard characters: False |
| 108 | +``` |
| 109 | +
|
| 110 | +### -Maxpagesize |
| 111 | +Optional, specifies the maximum number of file service usages to be included in the list response. |
| 112 | +
|
| 113 | +```yaml |
| 114 | +Type: System.Int32 |
| 115 | +Parameter Sets: List |
| 116 | +Aliases: |
| 117 | + |
| 118 | +Required: False |
| 119 | +Position: Named |
| 120 | +Default value: None |
| 121 | +Accept pipeline input: False |
| 122 | +Accept wildcard characters: False |
| 123 | +``` |
| 124 | +
|
| 125 | +### -ResourceGroupName |
| 126 | +The name of the resource group within the user's subscription. |
| 127 | +The name is case insensitive. |
| 128 | +
|
| 129 | +```yaml |
| 130 | +Type: System.String |
| 131 | +Parameter Sets: Get, List |
| 132 | +Aliases: |
| 133 | + |
| 134 | +Required: True |
| 135 | +Position: Named |
| 136 | +Default value: None |
| 137 | +Accept pipeline input: False |
| 138 | +Accept wildcard characters: False |
| 139 | +``` |
| 140 | +
|
| 141 | +### -StorageAccountName |
| 142 | +The name of the storage account within the specified resource group. |
| 143 | +Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. |
| 144 | +
|
| 145 | +```yaml |
| 146 | +Type: System.String |
| 147 | +Parameter Sets: Get, List |
| 148 | +Aliases: |
| 149 | + |
| 150 | +Required: True |
| 151 | +Position: Named |
| 152 | +Default value: None |
| 153 | +Accept pipeline input: False |
| 154 | +Accept wildcard characters: False |
| 155 | +``` |
| 156 | +
|
| 157 | +### -SubscriptionId |
| 158 | +The ID of the target subscription. |
| 159 | +
|
| 160 | +```yaml |
| 161 | +Type: System.String[] |
| 162 | +Parameter Sets: Get, List |
| 163 | +Aliases: |
| 164 | + |
| 165 | +Required: False |
| 166 | +Position: Named |
| 167 | +Default value: (Get-AzContext).Subscription.Id |
| 168 | +Accept pipeline input: False |
| 169 | +Accept wildcard characters: False |
| 170 | +``` |
| 171 | +
|
| 172 | +### CommonParameters |
| 173 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). |
| 174 | +
|
| 175 | +## INPUTS |
| 176 | +
|
| 177 | +### Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.IStorageIdentity |
| 178 | +
|
| 179 | +## OUTPUTS |
| 180 | +
|
| 181 | +### Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.IFileServiceUsage |
| 182 | +
|
| 183 | +## NOTES |
| 184 | +
|
| 185 | +## RELATED LINKS |
| 186 | +
|
0 commit comments