ListSharesResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/azure-file-storage/json-schema/azure-file-storage-list-shares-response-schema.json",
  "title": "ListSharesResponse",
  "description": "An enumeration of shares.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/azure-file-storage-openapi.yml#/components/schemas/ListSharesResponse",
  "type": "object",
  "required": [
    "ServiceEndpoint",
    "NextMarker"
  ],
  "properties": {
    "ServiceEndpoint": {
      "type": "string"
    },
    "Prefix": {
      "type": "string"
    },
    "Marker": {
      "type": "string"
    },
    "MaxResults": {
      "type": "integer"
    },
    "ShareItems": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ShareItemInternal"
      }
    },
    "NextMarker": {
      "type": "string"
    }
  },
  "$defs": {
    "LeaseDuration": {
      "description": "When a share is leased, specifies whether the lease is of infinite or fixed duration.",
      "type": "string",
      "enum": [
        "infinite",
        "fixed"
      ],
      "x-ms-enum": {
        "name": "LeaseDurationType",
        "modelAsString": false
      }
    },
    "LeaseState": {
      "description": "Lease state of the share.",
      "type": "string",
      "enum": [
        "available",
        "leased",
        "expired",
        "breaking",
        "broken"
      ],
      "x-ms-enum": {
        "name": "LeaseStateType",
        "modelAsString": false
      }
    },
    "LeaseStatus": {
      "description": "The current lease status of the share.",
      "type": "string",
      "enum": [
        "locked",
        "unlocked"
      ],
      "x-ms-enum": {
        "name": "LeaseStatusType",
        "modelAsString": false
      }
    },
    "Metadata": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "ShareEnabledProtocols": {
      "type": "string"
    },
    "ShareItemInternal": {
      "description": "A listed Azure Storage share item.",
      "type": "object",
      "required": [
        "Name",
        "Properties"
      ],
      "properties": {
        "Name": {
          "type": "string"
        },
        "Snapshot": {
          "type": "string"
        },
        "Deleted": {
          "type": "boolean"
        },
        "Version": {
          "type": "string"
        },
        "Properties": {
          "$ref": "#/$defs/SharePropertiesInternal"
        },
        "Metadata": {
          "$ref": "#/$defs/Metadata"
        }
      }
    },
    "SharePropertiesInternal": {
      "description": "Properties of a share.",
      "type": "object",
      "required": [
        "Last-Modified",
        "Etag",
        "Quota"
      ],
      "properties": {
        "Last-Modified": {
          "type": "string",
          "format": "date-time-rfc1123"
        },
        "Etag": {
          "type": "string"
        },
        "Quota": {
          "type": "integer"
        },
        "ProvisionedIops": {
          "type": "integer"
        },
        "ProvisionedIngressMBps": {
          "type": "integer"
        },
        "ProvisionedEgressMBps": {
          "type": "integer"
        },
        "ProvisionedBandwidthMiBps": {
          "type": "integer"
        },
        "NextAllowedQuotaDowngradeTime": {
          "type": "string",
          "format": "date-time-rfc1123"
        },
        "DeletedTime": {
          "type": "string",
          "format": "date-time-rfc1123"
        },
        "RemainingRetentionDays": {
          "type": "integer"
        },
        "AccessTier": {
          "type": "string"
        },
        "AccessTierChangeTime": {
          "type": "string",
          "format": "date-time-rfc1123"
        },
        "AccessTierTransitionState": {
          "type": "string"
        },
        "LeaseStatus": {
          "$ref": "#/$defs/LeaseStatus"
        },
        "LeaseState": {
          "$ref": "#/$defs/LeaseState"
        },
        "LeaseDuration": {
          "$ref": "#/$defs/LeaseDuration"
        },
        "EnabledProtocols": {
          "$ref": "#/$defs/ShareEnabledProtocols"
        },
        "RootSquash": {
          "$ref": "#/$defs/ShareRootSquash"
        },
        "EnableSnapshotVirtualDirectoryAccess": {
          "type": "boolean"
        },
        "PaidBurstingEnabled": {
          "type": "boolean"
        },
        "PaidBurstingMaxIops": {
          "type": "integer",
          "format": "int64"
        },
        "PaidBurstingMaxBandwidthMibps": {
          "type": "integer",
          "format": "int64"
        },
        "IncludedBurstIops": {
          "type": "integer",
          "format": "int64"
        },
        "MaxBurstCreditsForIops": {
          "type": "integer",
          "format": "int64"
        },
        "NextAllowedProvisionedIopsDowngradeTime": {
          "type": "string",
          "format": "date-time-rfc1123"
        },
        "NextAllowedProvisionedBandwidthDowngradeTime": {
          "type": "string",
          "format": "date-time-rfc1123"
        },
        "EnableSmbDirectoryLease": {
          "type": "boolean"
        }
      }
    },
    "ShareRootSquash": {
      "type": "string",
      "enum": [
        "NoRootSquash",
        "RootSquash",
        "AllSquash"
      ],
      "x-ms-enum": {
        "name": "ShareRootSquash",
        "modelAsString": false
      }
    }
  }
}