ListHandlesResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/azure-file-storage/json-schema/azure-file-storage-list-handles-response-schema.json",
  "title": "ListHandlesResponse",
  "description": "An enumeration of handles.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/azure-file-storage-file-api-openapi.yml#/components/schemas/ListHandlesResponse",
  "type": "object",
  "required": [
    "NextMarker"
  ],
  "properties": {
    "HandleList": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/HandleItem"
      }
    },
    "NextMarker": {
      "type": "string"
    }
  },
  "$defs": {
    "AccessRight": {
      "description": "Access rights of the access policy.",
      "type": "string",
      "enum": [
        "Read",
        "Write",
        "Delete"
      ],
      "x-ms-enum": {
        "name": "AccessRight",
        "modelAsString": false
      }
    },
    "HandleItem": {
      "description": "A listed Azure Storage handle item.",
      "type": "object",
      "required": [
        "HandleId",
        "Path",
        "FileId",
        "SessionId",
        "ClientIp",
        "ClientName",
        "OpenTime"
      ],
      "properties": {
        "HandleId": {
          "type": "string",
          "description": "XSMB service handle ID"
        },
        "Path": {
          "$ref": "#/$defs/StringEncoded"
        },
        "FileId": {
          "type": "string",
          "description": "FileId uniquely identifies the file or directory."
        },
        "ParentId": {
          "type": "string",
          "description": "ParentId uniquely identifies the parent directory of the object."
        },
        "SessionId": {
          "type": "string",
          "description": "SMB session ID in context of which the file handle was opened"
        },
        "ClientIp": {
          "type": "string",
          "description": "Client IP that opened the handle"
        },
        "ClientName": {
          "type": "string",
          "description": "Name of the client machine where the share is being mounted"
        },
        "OpenTime": {
          "type": "string",
          "format": "date-time-rfc1123",
          "description": "Time when the session that previously opened the handle has last been reconnected. (UTC)"
        },
        "LastReconnectTime": {
          "type": "string",
          "format": "date-time-rfc1123",
          "description": "Time handle was last connected to (UTC)"
        },
        "AccessRightList": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/AccessRight"
          }
        }
      }
    },
    "StringEncoded": {
      "type": "object",
      "properties": {
        "Encoded": {
          "type": "boolean"
        },
        "content": {
          "type": "string"
        }
      }
    }
  }
}