Edit

Supported metrics for Microsoft.FileShares/fileShares

The following table lists the metrics available for the Microsoft.FileShares/fileShares 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.

Category: Capacity

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

The used storage in bytes used by the file share.
FileCapacity No Bytes Average FileShare, Tier PT1H, PT6H, PT12H, P1D No
File Count

The number of files in the file share.
FileCount No Count Average FileShare, Tier PT1H, PT6H, PT12H, P1D No
File Share Provisioned IOPS

The number of IOPS provisioned on the file share.
FileShareProvisionedIOPS No CountPerSecond Average FileShare PT1H, PT6H, PT12H, P1D No
File Share Provisioned Storage Bytes

The amount of storage provisioned on the file share.
FileShareProvisionedStorageBytes No Bytes Average FileShare PT1H, PT6H, PT12H, P1D No
File Share Provisioned Throughput MiB/s

The amount of throughput provisioned on the file share.
FileShareProvisionedThroughputMiBps No CountPerSecond Average FileShare PT1H, PT6H, PT12H, P1D No
File Share Snapshot Count

The number of file share snapshots of the file share.
FileShareSnapshotCount No Count Average FileShare PT1H, PT6H, PT12H, P1D No
File Share Snapshot Size

The amount of differential storage used by the file share snapshots of the file share.
FileShareSnapshotSize No Bytes Average FileShare PT1H, PT6H, PT12H, P1D No

Category: Transaction

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

The percentage of availability for the file share (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 file share (or the specified API operation).
Availability No Percent Average, Minimum, Maximum GeoType, ApiName, Authentication, FileShare PT1M Yes
Egress

The amount of data read from the file share in bytes, including from clients inside of Azure.
Egress No Bytes Total (Sum), Average, Minimum, Maximum GeoType, ApiName, Authentication, FileShare 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
Max Used IOPS

The maximum used IOPS at the lowest time granularity of 1-minute for the file share.
FileShareMaxUsedIOPS No CountPerSecond Maximum FileShare PT1M No
Max Used Throughput MiB/s

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

The amount of data written to the file share in bytes, including from clients inside of Azure.
Ingress No Bytes Total (Sum), Average, Minimum, Maximum GeoType, ApiName, Authentication, FileShare PT1M Yes
Success E2E Latency

The average end-to-end latency of successful requests made to the file share (or the specified API operation) in milliseconds. This value includes the required processing time by the file share.
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 the file share. 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 the file share, including both successful and failed requests. Can be filtered further by the ResponseType dimension.
Transactions No Count Total (Sum) ResponseType, GeoType, ApiName, Authentication, FileShare, TransactionType PT1M Yes

Next steps