Edit

Supported metrics for Microsoft.Storage/storageAccounts/fileServices

The following table lists the metrics available for the Microsoft.Storage/storageAccounts/fileServices resource type.

Table headings

  • Metric - The metric display name as it appears in the Azure portal.
  • Name in Rest API - Metric name as referred to in the REST API.
  • Advanced platform metrics - A premium, paid tier of platform metrics in Azure Monitor that provide more granular observability for Azure resources.
  • Unit - Unit of measure.
  • Aggregation - The default aggregation type. Valid values: Average, Minimum, Maximum, Total, Count.
  • Dimensions - Dimensions available for the metric.
  • Time Grains - Intervals at which the metric is sampled. For example, PT1M indicates that the metric is sampled every minute, PT30M every 30 minutes, PT1H every hour, and so on.
  • DS Export - Shows whether the metric is exportable to Azure Monitor Logs via Diagnostic Settings.

For information on exporting metrics, see - Metrics export using data collection rules and Create diagnostic settings in Azure Monitor.

For information on metric retention, see Azure Monitor Metrics overview.

For a list of supported logs, see Supported log categories - Microsoft.Storage/storageAccounts/fileServices

Category: Capacity

Metric Name in REST API Advanced platform metrics Unit Aggregation Dimensions Time Grains DS Export
File Capacity

The amount of File storage used by the storage account.
FileCapacity No Bytes Average FileShare, Tier PT1H, PT6H, PT12H, P1D No
File Count

The number of files in the storage account.
FileCount No Count Average FileShare, Tier PT1H, PT6H, PT12H, P1D No
File Share Capacity Quota

The upper limit on the amount of storage that can be used by Azure Files Service in bytes.
FileShareCapacityQuota No Bytes Average FileShare PT1H, PT6H, PT12H, P1D No
File Share Count

The number of file shares in the storage account.
FileShareCount No Count Average <none> PT1H, PT6H, PT12H, P1D No
File Share Provisioned Bandwidth MiB/s

The baseline provisioned bandwidth (throughput) in MiB/s for the file share.
FileShareProvisionedBandwidthMiBps No CountPerSecond Average FileShare PT1H, PT6H, PT12H, P1D No
File Share Provisioned IOPS

The baseline provisioned IOPS (not including burst) for the file share.
FileShareProvisionedIOPS No CountPerSecond Average FileShare PT1H, PT6H, PT12H, P1D No
File Share Snapshot Count

The number of snapshots present on the share in storage account's Files Service.
FileShareSnapshotCount No Count Average FileShare PT1H, PT6H, PT12H, P1D No
File Share Snapshot Size

The amount of storage used by the snapshots in storage account's File service in bytes.
FileShareSnapshotSize No Bytes Average FileShare PT1H, PT6H, PT12H, P1D No

Category: SLI

Metric Name in REST API Advanced platform metrics Unit Aggregation Dimensions Time Grains DS Export
Percentage File Share Bandwidth Utilization

The percentage of the file share bandwidth that is currently used. This value is calculated as the used bandwidth divided by the provisioned bandwidth of the file share, expressed as a percentage.
PercentFileShareBandwidthUtilization No Percent Average, Minimum, Maximum FileShare PT1H, PT6H, PT12H, P1D Yes
Percentage File Share IOPS Utilization

The percentage of the file share IOPS that is currently used. This value is calculated as the used IOPS divided by the provisioned IOPS of the file share, expressed as a percentage.
PercentFileShareIOPSUtilization No Percent Average, Minimum, Maximum FileShare PT1H, PT6H, PT12H, P1D Yes
Percentage File Share Utilization

The percentage of the file share capacity that is currently used. This value is calculated as the used storage divided by the provisioned capacity of the file share, expressed as a percentage.
PercentFileShareUtilization No Percent Average FileShare PT1H, PT6H, PT12H, P1D Yes

Category: Transaction

Metric Name in REST API Advanced platform metrics Unit Aggregation Dimensions Time Grains DS Export
Availability

The percentage of availability for the storage service or the specified API operation. Availability is calculated by taking the TotalBillableRequests value and dividing it by the number of applicable requests, including those that produced unexpected errors. All unexpected errors result in reduced availability for the storage service or the specified API operation.
Availability No Percent Average, Minimum, Maximum GeoType, ApiName, Authentication, FileShare PT1M Yes
Egress

The amount of egress data. This number includes egress to external client from Azure Storage as well as egress within Azure. As a result, this number does not reflect billable egress.
Egress No Bytes Total (Sum), Average, Minimum, Maximum GeoType, ApiName, Authentication, FileShare, SizeBucket PT1M Yes
Burst Credits For IOPS

The number of burst credits for IOPS available for the file share.
FileShareAvailableBurstCredits No Count Average FileShare PT1M No
Bandwidth by Max MiB/s

The maximum used bandwidth (throughput) in MiB/s at the lowest time granularity of 1-minute for the file share.
FileShareMaxUsedBandwidthMiBps No CountPerSecond Maximum FileShare PT1M No
Transactions by Max IOPS

The maximum used IOPS at the lowest time granularity of 1-minute for the file share.
FileShareMaxUsedIOPS No CountPerSecond Maximum FileShare PT1M No
Paid Bursting Bandwidth

The total billed paid bursting bandwidth for the file share.
FileSharePaidBurstingBandwidth No Bytes Total (Sum) FileShare PT1M No
Paid Bursting IOS

The total billed paid bursting IOs for the file share.
FileSharePaidBurstingIOS No Count Total (Sum) FileShare PT1M No
Ingress

The amount of ingress data, in bytes. This number includes ingress from an external client into Azure Storage as well as ingress within Azure.
Ingress No Bytes Total (Sum), Average, Minimum, Maximum GeoType, ApiName, Authentication, FileShare, SizeBucket PT1M Yes
Success E2E Latency

The average end-to-end latency of successful requests made to a storage service or the specified API operation, in milliseconds. This value includes the required processing time within Azure Storage to read the request, send the response, and receive acknowledgment of the response.
SuccessE2ELatency No MilliSeconds Average, Minimum, Maximum GeoType, ApiName, Authentication, FileShare PT1M Yes
Success Server Latency

The average time used to process a successful request by Azure Storage. This value does not include the network latency specified in SuccessE2ELatency.
SuccessServerLatency No MilliSeconds Average, Minimum, Maximum GeoType, ApiName, Authentication, FileShare PT1M Yes
Transactions

The number of requests made to a storage service or the specified API operation. This number includes successful and failed requests, as well as requests which produced errors. Use ResponseType dimension for the number of different types of response.
Transactions No Count Total (Sum) ResponseType, GeoType, ApiName, Authentication, FileShare, TransactionType PT1M Yes

Next steps