{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/azure-storage-accounts/json-schema/azure-storage-accounts-file-service-usage-schema.json",
  "title": "FileServiceUsage",
  "description": "The usage of file service in storage account.",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/azure-storage-accounts-fileserviceusageoperationgroup-api-openapi.yml#/components/schemas/FileServiceUsage",
  "type": "object",
  "properties": {
    "properties": {
      "$ref": "#/$defs/FileServiceUsageProperties",
      "description": "File service usage in storage account including account limits, file share limits and constants used in recommendations and bursting formula."
    }
  },
  "allOf": [
    {
      "$ref": "#/$defs/ProxyResource"
    }
  ],
  "$defs": {
    "AccountLimits": {
      "type": "object",
      "description": "Maximum provisioned storage, IOPS, bandwidth and number of file shares limits for the storage account.",
      "properties": {
        "maxFileShares": {
          "type": "integer",
          "format": "int32",
          "description": "The maximum number of file shares limit for the storage account.",
          "readOnly": true
        },
        "maxProvisionedStorageGiB": {
          "type": "integer",
          "format": "int32",
          "description": "The maximum provisioned storage quota limit in gibibytes for the storage account.",
          "readOnly": true
        },
        "maxProvisionedIOPS": {
          "type": "integer",
          "format": "int32",
          "description": "The maximum provisioned IOPS limit for the storage account.",
          "readOnly": true
        },
        "maxProvisionedBandwidthMiBPerSec": {
          "type": "integer",
          "format": "int32",
          "description": "The maximum provisioned bandwidth limit in mebibytes per second for the storage account.",
          "readOnly": true
        }
      }
    },
    "AccountUsage": {
      "type": "object",
      "description": "Usage of provisioned storage, IOPS, bandwidth and number of file shares across all live shares and soft-deleted shares in the account.",
      "properties": {
        "liveShares": {
          "$ref": "#/$defs/AccountUsageElements",
          "description": "Usage of provisioned storage, IOPS, bandwidth and number of file shares across all live shares or soft-deleted shares in the account."
        },
        "softDeletedShares": {
          "$ref": "#/$defs/AccountUsageElements",
          "description": "Usage of provisioned storage, IOPS, bandwidth and number of file shares across all live shares or soft-deleted shares in the account."
        }
      }
    },
    "AccountUsageElements": {
      "type": "object",
      "description": "Usage of provisioned storage, IOPS, bandwidth and number of file shares across all live shares or soft-deleted shares in the account.",
      "properties": {
        "fileShareCount": {
          "type": "integer",
          "format": "int32",
          "description": "The total number of file shares.",
          "readOnly": true
        },
        "provisionedStorageGiB": {
          "type": "integer",
          "format": "int32",
          "description": "The total provisioned storage quota in gibibytes.",
          "readOnly": true
        },
        "provisionedIOPS": {
          "type": "integer",
          "format": "int32",
          "description": "The total provisioned IOPS.",
          "readOnly": true
        },
        "provisionedBandwidthMiBPerSec": {
          "type": "integer",
          "format": "int32",
          "description": "The total provisioned bandwidth in mebibytes per second.",
          "readOnly": true
        }
      }
    },
    "BurstingConstants": {
      "type": "object",
      "description": "Constants used for calculating included burst IOPS and maximum burst credits for IOPS for a file share in the storage account.",
      "properties": {
        "burstFloorIOPS": {
          "type": "integer",
          "format": "int32",
          "description": "The guaranteed floor of burst IOPS for small file shares.",
          "readOnly": true
        },
        "burstIOScalar": {
          "type": "number",
          "format": "double",
          "description": "The scalar against provisioned IOPS in the file share included burst IOPS formula.",
          "readOnly": true
        },
        "burstTimeframeSeconds": {
          "type": "integer",
          "format": "int32",
          "description": "The time frame for bursting in seconds in the file share maximum burst credits for IOPS formula.",
          "readOnly": true
        }
      }
    },
    "FileServiceUsageProperties": {
      "type": "object",
      "description": "File service usage in storage account including account limits, file share limits and constants used in recommendations and bursting formula.",
      "properties": {
        "storageAccountLimits": {
          "$ref": "#/$defs/AccountLimits",
          "description": "Maximum provisioned storage, IOPS, bandwidth and number of file shares limits for the storage account.",
          "readOnly": true
        },
        "fileShareLimits": {
          "$ref": "#/$defs/FileShareLimits",
          "description": "Minimum and maximum provisioned storage, IOPS and bandwidth limits for a file share in the storage account.",
          "readOnly": true
        },
        "fileShareRecommendations": {
          "$ref": "#/$defs/FileShareRecommendations",
          "description": "Constants used for calculating recommended provisioned IOPS and bandwidth for a file share in the storage account.",
          "readOnly": true
        },
        "burstingConstants": {
          "$ref": "#/$defs/BurstingConstants",
          "description": "Constants used for calculating included burst IOPS and maximum burst credits for IOPS for a file share in the storage account.",
          "readOnly": true
        },
        "storageAccountUsage": {
          "$ref": "#/$defs/AccountUsage",
          "description": "Usage of provisioned storage, IOPS, bandwidth and number of file shares across all live shares and soft-deleted shares in the account.",
          "readOnly": true
        }
      }
    },
    "FileShareLimits": {
      "type": "object",
      "description": "Minimum and maximum provisioned storage, IOPS and bandwidth limits for a file share in the storage account.",
      "properties": {
        "minProvisionedStorageGiB": {
          "type": "integer",
          "format": "int32",
          "description": "The minimum provisioned storage quota limit in gibibytes for a file share in the storage account.",
          "readOnly": true
        },
        "maxProvisionedStorageGiB": {
          "type": "integer",
          "format": "int32",
          "description": "The maximum provisioned storage quota limit in gibibytes for a file share in the storage account.",
          "readOnly": true
        },
        "minProvisionedIOPS": {
          "type": "integer",
          "format": "int32",
          "description": "The minimum provisioned IOPS limit for a file share in the storage account.",
          "readOnly": true
        },
        "maxProvisionedIOPS": {
          "type": "integer",
          "format": "int32",
          "description": "The maximum provisioned IOPS limit for a file share in the storage account.",
          "readOnly": true
        },
        "minProvisionedBandwidthMiBPerSec": {
          "type": "integer",
          "format": "int32",
          "description": "The minimum provisioned bandwidth limit in mebibytes per second for a file share in the storage account.",
          "readOnly": true
        },
        "maxProvisionedBandwidthMiBPerSec": {
          "type": "integer",
          "format": "int32",
          "description": "The maximum provisioned bandwidth limit in mebibytes per second for a file share in the storage account.",
          "readOnly": true
        },
        "guardrailIOScalar": {
          "type": "number",
          "format": "double",
          "description": "The IO scalar used for guardrail calculations for a file share in the storage account.",
          "readOnly": true
        },
        "guardrailBandwidthScalar": {
          "type": "number",
          "format": "double",
          "description": "The bandwidth scalar used for guardrail calculations for a file share in the storage account.",
          "readOnly": true
        }
      }
    },
    "FileShareRecommendations": {
      "type": "object",
      "description": "Constants used for calculating recommended provisioned IOPS and bandwidth for a file share in the storage account.",
      "properties": {
        "baseIOPS": {
          "type": "integer",
          "format": "int32",
          "description": "The base IOPS in the file share provisioned IOPS recommendation formula.",
          "readOnly": true
        },
        "ioScalar": {
          "type": "number",
          "format": "double",
          "description": "The scalar for IO in the file share provisioned IOPS recommendation formula.",
          "readOnly": true
        },
        "baseBandwidthMiBPerSec": {
          "type": "integer",
          "format": "int32",
          "description": "The base bandwidth in the file share provisioned bandwidth recommendation formula.",
          "readOnly": true
        },
        "bandwidthScalar": {
          "type": "number",
          "format": "double",
          "description": "The scalar for bandwidth in the file share provisioned bandwidth recommendation formula.",
          "readOnly": true
        }
      }
    },
    "ProxyResource": {
      "type": "object",
      "title": "Proxy Resource",
      "description": "The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location",
      "allOf": [
        {
          "$ref": "#/$defs/Resource"
        }
      ]
    },
    "Resource": {
      "type": "object",
      "title": "Resource",
      "description": "Common fields that are returned in the response for all Azure Resource Manager resources",
      "properties": {
        "id": {
          "type": "string",
          "format": "arm-id",
          "description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\"",
          "readOnly": true
        },
        "name": {
          "type": "string",
          "description": "The name of the resource",
          "readOnly": true
        },
        "type": {
          "type": "string",
          "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"",
          "readOnly": true
        },
        "systemData": {
          "$ref": "#/$defs/systemData",
          "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.",
          "readOnly": true
        }
      },
      "x-ms-azure-resource": true
    }
  }
}