az storage container lease

Manage blob storage container leases.

Commands

az storage container lease acquire Requests a new lease.
az storage container lease break Break the lease, if the container has an active lease.
az storage container lease change Change the lease ID of an active lease.
az storage container lease release Release the lease.
az storage container lease renew Renews the lease.

az storage container lease acquire

Requests a new lease.

az storage container lease acquire --container-name
[--account-key]
[--account-name]
[--connection-string]
[--if-modified-since]
[--if-unmodified-since]
[--lease-duration]
[--proposed-lease-id]
[--sas-token]
[--timeout]

Required Parameters

--container-name -c
The container name.

Optional Parameters

--account-key
Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.
--account-name
Storage account name. Must be used in conjunction with either storage account key or a SAS token. Environment variable: AZURE_STORAGE_ACCOUNT.
--connection-string
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
--if-modified-since
Alter only if modified since supplied UTC datetime (Y-m-d'T'H:M'Z').
--if-unmodified-since
Alter only if unmodified since supplied UTC datetime (Y-m-d'T'H:M'Z').
--lease-duration
Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change. Default is -1 (infinite lease).
default value: -1
--proposed-lease-id
Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format.
--sas-token
A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.
--timeout
Request timeout in seconds. Applies to each call to the service.

az storage container lease break

Break the lease, if the container has an active lease.

az storage container lease break --container-name
[--account-key]
[--account-name]
[--connection-string]
[--if-modified-since]
[--if-unmodified-since]
[--lease-break-period]
[--sas-token]
[--timeout]

Required Parameters

--container-name -c
The container name.

Optional Parameters

--account-key
Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.
--account-name
Storage account name. Must be used in conjunction with either storage account key or a SAS token. Environment variable: AZURE_STORAGE_ACCOUNT.
--connection-string
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
--if-modified-since
Alter only if modified since supplied UTC datetime (Y-m-d'T'H:M'Z').
--if-unmodified-since
Alter only if unmodified since supplied UTC datetime (Y-m-d'T'H:M'Z').
--lease-break-period
This is the proposed duration of seconds that the lease should continue before it is broken, between 0 and 60 seconds. This break period is only used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period. If this header does not appear with a break operation, a fixed-duration lease breaks after the remaining lease period elapses, and an infinite lease breaks immediately.
--sas-token
A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.
--timeout
Request timeout in seconds. Applies to each call to the service.

az storage container lease change

Change the lease ID of an active lease.

az storage container lease change --container-name
--lease-id
--proposed-lease-id
[--account-key]
[--account-name]
[--connection-string]
[--if-modified-since]
[--if-unmodified-since]
[--sas-token]
[--timeout]

Required Parameters

--container-name -c
The container name.
--lease-id
Lease ID for active lease.
--proposed-lease-id
Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format.

Optional Parameters

--account-key
Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.
--account-name
Storage account name. Must be used in conjunction with either storage account key or a SAS token. Environment variable: AZURE_STORAGE_ACCOUNT.
--connection-string
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
--if-modified-since
Alter only if modified since supplied UTC datetime (Y-m-d'T'H:M'Z').
--if-unmodified-since
Alter only if unmodified since supplied UTC datetime (Y-m-d'T'H:M'Z').
--sas-token
A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.
--timeout
Request timeout in seconds. Applies to each call to the service.

az storage container lease release

Release the lease.

az storage container lease release --container-name
--lease-id
[--account-key]
[--account-name]
[--connection-string]
[--if-modified-since]
[--if-unmodified-since]
[--sas-token]
[--timeout]

Required Parameters

--container-name -c
The container name.
--lease-id
Lease ID for active lease.

Optional Parameters

--account-key
Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.
--account-name
Storage account name. Must be used in conjunction with either storage account key or a SAS token. Environment variable: AZURE_STORAGE_ACCOUNT.
--connection-string
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
--if-modified-since
Alter only if modified since supplied UTC datetime (Y-m-d'T'H:M'Z').
--if-unmodified-since
Alter only if unmodified since supplied UTC datetime (Y-m-d'T'H:M'Z').
--sas-token
A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.
--timeout
Request timeout in seconds. Applies to each call to the service.

az storage container lease renew

Renews the lease.

az storage container lease renew --container-name
--lease-id
[--account-key]
[--account-name]
[--connection-string]
[--if-modified-since]
[--if-unmodified-since]
[--sas-token]
[--timeout]

Required Parameters

--container-name -c
The container name.
--lease-id
Lease ID for active lease.

Optional Parameters

--account-key
Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.
--account-name
Storage account name. Must be used in conjunction with either storage account key or a SAS token. Environment variable: AZURE_STORAGE_ACCOUNT.
--connection-string
Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.
--if-modified-since
Alter only if modified since supplied UTC datetime (Y-m-d'T'H:M'Z').
--if-unmodified-since
Alter only if unmodified since supplied UTC datetime (Y-m-d'T'H:M'Z').
--sas-token
A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.
--timeout
Request timeout in seconds. Applies to each call to the service.