lease_id Property
The lease Id to include when making requests.
Syntax
def get_lease_id() -> str: ... def set_lease_id(value: str) -> None: ...
lease_id = property(get_lease_id, set_lease_id)
Default Value
""
Remarks
This property specifies the lease Id to include when making requests. If non-empty, this property's value must be a GUID string formatted in one of the styles described by Microsoft's .NET Guid(string) constructor documentation. For example: dddddddd-dddd-dddd-dddd-dddddddddddd, where each d is a single case-insensitive hex digit.
The following table indicates whether this property should be populated when calling a method on a container or blob that has an active lease.
MUST be populated | May OPTIONALLY be populated |
Containers | |
Blobs | |
For methods in one of the "MUST" categories: if this property is empty, requests will fail if the container or blob has an active lease. For create_blob and copy_blob, note that this property must be empty if the target blob does not yet exist.
For all methods listed above: if this property is populated, requests will fail if the container or blob doesn't have an active lease; or if it does, but the lease Id specified by this property does not match.
Finally, note that this property is used in a specific manner by the lease method; refer to its documentation for more information.