Azure Storage Account · JSON Structure

Azure Storage Account Account Sas Parameters Structure

The parameters to list SAS credentials of a storage account.

Type: object Properties: 8 Required: 4
AzureBlob StorageCloud StorageFile StorageMicrosoftStorage

AccountSasParameters is a JSON Structure definition published by Azure Storage Account, describing 8 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

keyToSign signedExpiry signedIp signedPermission signedProtocol signedResourceTypes signedServices signedStart

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/azure-storage-account/refs/heads/main/json-structure/azure-storage-account-account-sas-parameters-structure.json",
  "description": "The parameters to list SAS credentials of a storage account.",
  "properties": {
    "keyToSign": {
      "description": "The key to sign the account SAS token with.",
      "type": "string"
    },
    "signedExpiry": {
      "description": "The time at which the shared access signature becomes invalid.",
      "format": "date-time",
      "type": "string",
      "x-ms-client-name": "SharedAccessExpiryTime"
    },
    "signedIp": {
      "description": "An IP address or a range of IP addresses from which to accept requests.",
      "type": "string",
      "x-ms-client-name": "IPAddressOrRange"
    },
    "signedPermission": {
      "description": "The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p).",
      "enum": [
        "r",
        "d",
        "w",
        "l",
        "a",
        "c",
        "u",
        "p"
      ],
      "type": "string",
      "x-ms-client-name": "Permissions",
      "x-ms-enum": {
        "modelAsString": true,
        "name": "Permissions"
      }
    },
    "signedProtocol": {
      "description": "The protocol permitted for a request made with the account SAS.",
      "enum": [
        "https,http",
        "https"
      ],
      "type": "string",
      "x-ms-client-name": "Protocols",
      "x-ms-enum": {
        "modelAsString": false,
        "name": "HttpProtocol"
      }
    },
    "signedResourceTypes": {
      "description": "The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files.",
      "enum": [
        "s",
        "c",
        "o"
      ],
      "type": "string",
      "x-ms-client-name": "ResourceTypes",
      "x-ms-enum": {
        "modelAsString": true,
        "name": "SignedResourceTypes"
      }
    },
    "signedServices": {
      "description": "The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f).",
      "enum": [
        "b",
        "q",
        "t",
        "f"
      ],
      "type": "string",
      "x-ms-client-name": "Services",
      "x-ms-enum": {
        "modelAsString": true,
        "name": "Services"
      }
    },
    "signedStart": {
      "description": "The time at which the SAS becomes valid.",
      "format": "date-time",
      "type": "string",
      "x-ms-client-name": "SharedAccessStartTime"
    }
  },
  "type": "object",
  "required": [
    "signedServices",
    "signedResourceTypes",
    "signedPermission",
    "signedExpiry"
  ],
  "name": "AccountSasParameters"
}