LeaseContainerRequest

Lease Container request schema.

AzureBlob StorageCloud StorageFile StorageQueue StorageStorageTable Storage

Properties

Name Type Description
action string Specifies the lease action. Can be one of the available actions.
breakPeriod integer Optional. For a break action, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60.
leaseDuration integer Required for acquire. Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires.
leaseId string Identifies the lease. Can be specified in any valid GUID string format.
proposedLeaseId string Optional for acquire, required for change. Proposed lease ID, in a GUID string format.
View JSON Schema on GitHub

JSON Schema

azure-storage-accounts-lease-container-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/azure-storage-accounts/refs/heads/main/json-schema/azure-storage-accounts-lease-container-request-schema.json",
  "title": "LeaseContainerRequest",
  "description": "Lease Container request schema.",
  "properties": {
    "action": {
      "description": "Specifies the lease action. Can be one of the available actions.",
      "enum": [
        "Acquire",
        "Renew",
        "Change",
        "Release",
        "Break"
      ],
      "type": "string"
    },
    "breakPeriod": {
      "description": "Optional. For a break action, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60.",
      "type": "integer"
    },
    "leaseDuration": {
      "description": "Required for acquire. Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires.",
      "type": "integer"
    },
    "leaseId": {
      "description": "Identifies the lease. Can be specified in any valid GUID string format.",
      "type": "string"
    },
    "proposedLeaseId": {
      "description": "Optional for acquire, required for change. Proposed lease ID, in a GUID string format.",
      "type": "string"
    }
  },
  "type": "object",
  "required": [
    "action"
  ]
}