你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az storage blob lease

管理存储 blob 租约。

命令

名称	说明	类型	Status
az storage blob lease acquire	请求新的租约。	核心	GA
az storage blob lease break	如果容器或 Blob 具有活动租约，则中断租约。	核心	GA
az storage blob lease change	更改活动租约的租约 ID。	核心	GA
az storage blob lease release	释放租约。	核心	GA
az storage blob lease renew	续订租约。	核心	GA

az storage blob lease acquire

请求新的租约。

az storage blob lease acquire --blob-name
                              --container-name
                              [--account-key]
                              [--account-name]
                              [--auth-mode {key, login}]
                              [--blob-endpoint]
                              [--connection-string]
                              [--if-match]
                              [--if-modified-since]
                              [--if-none-match]
                              [--if-unmodified-since]
                              [--lease-duration]
                              [--proposed-lease-id]
                              [--sas-token]
                              [--tags-condition]
                              [--timeout]

示例

请求新的租约。

az storage blob lease acquire -b myblob -c mycontainer --account-name mystorageaccount --account-key 0000-0000

必需参数

--blob-name -b

Blob 名称。

--container-name -c

容器名称。

可选参数

--account-key

存储帐户密钥。 必须与存储帐户名称或服务终结点结合使用。 环境变量：AZURE_STORAGE_KEY。

--account-name

存储帐户名称。 相关环境变量：AZURE_STORAGE_ACCOUNT。 必须与存储帐户密钥或 SAS 令牌结合使用。 如果两者都不存在，该命令将尝试使用经过身份验证的 Azure 帐户查询存储帐户密钥。 如果执行了大量存储命令，可能会命中 API 配额。

--auth-mode

运行命令的模式。 “登录”模式将直接使用登录凭据进行身份验证。 如果未提供帐户的身份验证参数，则旧版“密钥”模式将尝试查询帐户密钥。 环境变量：AZURE_STORAGE_AUTH_MODE。

接受的值: key, login

--blob-endpoint

存储数据服务终结点。 必须与存储帐户密钥或 SAS 令牌结合使用。 可以使用 .. 查找每个服务主终结点 az storage account show。 环境变量：AZURE_STORAGE_标准版RVICE_ENDPOINT。

--connection-string

存储帐户连接字符串。 环境变量：AZURE_STORAGE_CONNECTION_STRING。

--if-match

ETag 值或 wild卡 字符 \. 仅当资源的 ETag 与指定的值匹配时，才指定此标头来执行该操作。

--if-modified-since

仅当自提供的 UTC 日期时间（Y-m-d'T'H：M'Z'）修改后才开始。

--if-none-match

ETag 值或 wild卡 字符 （）。仅当资源的 ETag 与指定的值不匹配时，才指定此标头来执行该操作。指定 wild卡 字符 （） 以仅在资源不存在时执行该操作，如果资源不存在，则操作失败。

--if-unmodified-since

仅当自提供的 UTC 日期时间（Y-m-d'T'H：M'Z'）以来未修改时才开始。

--lease-duration

为永不过期的租约指定租约的持续时间（以秒为单位或负 1）。 非无限租约可以介于 15 到 60 秒之间。 无法使用续订或更改租约持续时间。 默认值为 -1（无限租约）。

默认值: -1

--proposed-lease-id

建议的租约 ID，采用 GUID 字符串格式。 如果建议的租约 ID 格式不正确，Blob 服务将返回 400 （无效请求）。

--sas-token

共享访问签名（SAS）。 必须与存储帐户名称或服务终结点结合使用。 环境变量：AZURE_STORAGE_SAS_TOKEN。

--tags-condition

指定 Blob 标记上的 SQL where 子句，以仅对具有匹配值的 Blob 进行操作。

--timeout

请求超时（以秒为单位）。 适用于对服务的每个调用。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az storage blob lease break

如果容器或 Blob 具有活动租约，则中断租约。

租约中断后，无法续订。 任何授权请求都可能会中断租约;不需要请求来指定匹配的租约 ID。 当租约中断时，允许租约中断期过，在此期间，除了中断和释放之外，任何租约操作都可以在容器或 Blob 上执行。 成功断开租约后，响应将指示在获取新租约之前间隔（以秒为单位）。

az storage blob lease break --blob-name
                            --container-name
                            [--account-key]
                            [--account-name]
                            [--auth-mode {key, login}]
                            [--blob-endpoint]
                            [--connection-string]
                            [--if-match]
                            [--if-modified-since]
                            [--if-none-match]
                            [--if-unmodified-since]
                            [--lease-break-period]
                            [--sas-token]
                            [--tags-condition]
                            [--timeout]

必需参数

--blob-name -b

Blob 名称。

--container-name -c

容器名称。

可选参数

--account-key

存储帐户密钥。 必须与存储帐户名称或服务终结点结合使用。 环境变量：AZURE_STORAGE_KEY。

--account-name

存储帐户名称。 相关环境变量：AZURE_STORAGE_ACCOUNT。 必须与存储帐户密钥或 SAS 令牌结合使用。 如果两者都不存在，该命令将尝试使用经过身份验证的 Azure 帐户查询存储帐户密钥。 如果执行了大量存储命令，可能会命中 API 配额。

--auth-mode

运行命令的模式。 “登录”模式将直接使用登录凭据进行身份验证。 如果未提供帐户的身份验证参数，则旧版“密钥”模式将尝试查询帐户密钥。 环境变量：AZURE_STORAGE_AUTH_MODE。

接受的值: key, login

--blob-endpoint

存储数据服务终结点。 必须与存储帐户密钥或 SAS 令牌结合使用。 可以使用 .. 查找每个服务主终结点 az storage account show。 环境变量：AZURE_STORAGE_标准版RVICE_ENDPOINT。

--connection-string

存储帐户连接字符串。 环境变量：AZURE_STORAGE_CONNECTION_STRING。

--if-match

ETag 值或 wild卡 字符 \. 仅当资源的 ETag 与指定的值匹配时，才指定此标头来执行该操作。

--if-modified-since

仅当自提供的 UTC 日期时间（Y-m-d'T'H：M'Z'）修改后才开始。

--if-none-match

ETag 值或 wild卡 字符 （）。仅当资源的 ETag 与指定的值不匹配时，才指定此标头来执行该操作。指定 wild卡 字符 （） 以仅在资源不存在时执行该操作，如果资源不存在，则操作失败。

--if-unmodified-since

仅当自提供的 UTC 日期时间（Y-m-d'T'H：M'Z'）以来未修改时才开始。

--lease-break-period

这是租约在中断前应持续的建议持续时间（介于 0 到 60 秒之间）。 仅当此中断期小于租约剩余时间时，才使用此中断期。 如果时间更长，则使用租约剩余的时间。 在中断期到期之前，新的租约将不可用，但租约的保留时间可能超过中断期。 如果此标头未显示中断操作，则剩余租约期过后的固定持续时间租约中断，并立即中断无限租约。

--sas-token

共享访问签名（SAS）。 必须与存储帐户名称或服务终结点结合使用。 环境变量：AZURE_STORAGE_SAS_TOKEN。

--tags-condition

指定 Blob 标记上的 SQL where 子句，以仅对具有匹配值的 Blob 进行操作。

--timeout

请求超时（以秒为单位）。 适用于对服务的每个调用。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az storage blob lease change

更改活动租约的租约 ID。

az storage blob lease change --blob-name
                             --container-name
                             --lease-id
                             --proposed-lease-id
                             [--account-key]
                             [--account-name]
                             [--auth-mode {key, login}]
                             [--blob-endpoint]
                             [--connection-string]
                             [--if-match]
                             [--if-modified-since]
                             [--if-none-match]
                             [--if-unmodified-since]
                             [--sas-token]
                             [--tags-condition]
                             [--timeout]

必需参数

--blob-name -b

Blob 名称。

--container-name -c

容器名称。

--lease-id

如果 Blob 具有活动租约，则为必需。

--proposed-lease-id

建议的租约 ID，采用 GUID 字符串格式。 如果建议的租约 ID 格式不正确，Blob 服务将返回 400 （无效请求）。

可选参数

--account-key

存储帐户密钥。 必须与存储帐户名称或服务终结点结合使用。 环境变量：AZURE_STORAGE_KEY。

--account-name

存储帐户名称。 相关环境变量：AZURE_STORAGE_ACCOUNT。 必须与存储帐户密钥或 SAS 令牌结合使用。 如果两者都不存在，该命令将尝试使用经过身份验证的 Azure 帐户查询存储帐户密钥。 如果执行了大量存储命令，可能会命中 API 配额。

--auth-mode

运行命令的模式。 “登录”模式将直接使用登录凭据进行身份验证。 如果未提供帐户的身份验证参数，则旧版“密钥”模式将尝试查询帐户密钥。 环境变量：AZURE_STORAGE_AUTH_MODE。

接受的值: key, login

--blob-endpoint

存储数据服务终结点。 必须与存储帐户密钥或 SAS 令牌结合使用。 可以使用 .. 查找每个服务主终结点 az storage account show。 环境变量：AZURE_STORAGE_标准版RVICE_ENDPOINT。

--connection-string

存储帐户连接字符串。 环境变量：AZURE_STORAGE_CONNECTION_STRING。

--if-match

ETag 值或 wild卡 字符 \. 仅当资源的 ETag 与指定的值匹配时，才指定此标头来执行该操作。

--if-modified-since

仅当自提供的 UTC 日期时间（Y-m-d'T'H：M'Z'）修改后才开始。

--if-none-match

ETag 值或 wild卡 字符 （）。仅当资源的 ETag 与指定的值不匹配时，才指定此标头来执行该操作。指定 wild卡 字符 （） 以仅在资源不存在时执行该操作，如果资源不存在，则操作失败。

--if-unmodified-since

仅当自提供的 UTC 日期时间（Y-m-d'T'H：M'Z'）以来未修改时才开始。

--sas-token

共享访问签名（SAS）。 必须与存储帐户名称或服务终结点结合使用。 环境变量：AZURE_STORAGE_SAS_TOKEN。

--tags-condition

指定 Blob 标记上的 SQL where 子句，以仅对具有匹配值的 Blob 进行操作。

--timeout

请求超时（以秒为单位）。 适用于对服务的每个调用。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az storage blob lease release

释放租约。

如果指定的客户端租约 ID 与与容器或 blob 关联的 ID 匹配，则可能会释放租约。 释放租约允许另一个客户端在发布完成后立即获取容器或 Blob 的租约。 ：关键字 (keyword) ~datetime.datetime if_modified_since：DateTime 值。 Azure 预期传入的日期值为 UTC。 如果包含时区，则任何非 UTC 日期/时间都将转换为 UTC。 如果在没有时区信息的情况下传入日期，则假定日期为 UTC。 仅当资源自指定时间以来已修改时，才指定此标头以执行该操作。 ：关键字 (keyword) ~datetime.datetime if_unmodified_since：DateTime 值。 Azure 预期传入的日期值为 UTC。 如果包含时区，则任何非 UTC 日期/时间都将转换为 UTC。 如果在没有时区信息的情况下传入日期，则假定日期为 UTC。 仅当资源自指定日期/时间以来尚未修改时，才指定此标头来执行该操作。 ：关键字 (keyword) str etag：ETag 值或 wild卡 字符 \. 用于检查资源已更改，并根据参数指定的match_condition条件进行操作。 ：关键字 (keyword) ~azure.core.MatchConditions match_condition：在 etag 上使用的匹配条件。 ：关键字 (keyword) str if_tags_match_condition：指定 blob 标记上的 SQL where 子句，以仅对具有匹配值的 Blob 进行操作。 例如 "\"tagname\"='my tag'" .. versionadded：： 12.4.0 ：关键字 (keyword) int timeout： 设置操作的服务器端超时（以秒为单位）。 有关详细信息，请参阅 https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations 。 不会在客户端上跟踪或验证此值。 若要配置客户端网络超时，请参阅 here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob #other-client--per-operation-configuration>_。 ：return： None。

az storage blob lease release --blob-name
                              --container-name
                              --lease-id
                              [--account-key]
                              [--account-name]
                              [--auth-mode {key, login}]
                              [--blob-endpoint]
                              [--connection-string]
                              [--if-match]
                              [--if-modified-since]
                              [--if-none-match]
                              [--if-unmodified-since]
                              [--sas-token]
                              [--tags-condition]
                              [--timeout]

必需参数

--blob-name -b

Blob 名称。

--container-name -c

容器名称。

--lease-id

如果 Blob 具有活动租约，则为必需。

可选参数

--account-key

存储帐户密钥。 必须与存储帐户名称或服务终结点结合使用。 环境变量：AZURE_STORAGE_KEY。

--account-name

存储帐户名称。 相关环境变量：AZURE_STORAGE_ACCOUNT。 必须与存储帐户密钥或 SAS 令牌结合使用。 如果两者都不存在，该命令将尝试使用经过身份验证的 Azure 帐户查询存储帐户密钥。 如果执行了大量存储命令，可能会命中 API 配额。

--auth-mode

运行命令的模式。 “登录”模式将直接使用登录凭据进行身份验证。 如果未提供帐户的身份验证参数，则旧版“密钥”模式将尝试查询帐户密钥。 环境变量：AZURE_STORAGE_AUTH_MODE。

接受的值: key, login

--blob-endpoint

存储数据服务终结点。 必须与存储帐户密钥或 SAS 令牌结合使用。 可以使用 .. 查找每个服务主终结点 az storage account show。 环境变量：AZURE_STORAGE_标准版RVICE_ENDPOINT。

--connection-string

存储帐户连接字符串。 环境变量：AZURE_STORAGE_CONNECTION_STRING。

--if-match

ETag 值或 wild卡 字符 \. 仅当资源的 ETag 与指定的值匹配时，才指定此标头来执行该操作。

--if-modified-since

仅当自提供的 UTC 日期时间（Y-m-d'T'H：M'Z'）修改后才开始。

--if-none-match

ETag 值或 wild卡 字符 （）。仅当资源的 ETag 与指定的值不匹配时，才指定此标头来执行该操作。指定 wild卡 字符 （） 以仅在资源不存在时执行该操作，如果资源不存在，则操作失败。

--if-unmodified-since

仅当自提供的 UTC 日期时间（Y-m-d'T'H：M'Z'）以来未修改时才开始。

--sas-token

共享访问签名（SAS）。 必须与存储帐户名称或服务终结点结合使用。 环境变量：AZURE_STORAGE_SAS_TOKEN。

--tags-condition

指定 Blob 标记上的 SQL where 子句，以仅对具有匹配值的 Blob 进行操作。

--timeout

请求超时（以秒为单位）。 适用于对服务的每个调用。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az storage blob lease renew

续订租约。

az storage blob lease renew --blob-name
                            --container-name
                            --lease-id
                            [--account-key]
                            [--account-name]
                            [--auth-mode {key, login}]
                            [--blob-endpoint]
                            [--connection-string]
                            [--if-match]
                            [--if-modified-since]
                            [--if-none-match]
                            [--if-unmodified-since]
                            [--sas-token]
                            [--tags-condition]
                            [--timeout]

示例

续订租约。

az storage blob lease renew -b myblob -c mycontainer --lease-id "32fe23cd-4779-4919-adb3-357e76c9b1bb" --account-name mystorageaccount --account-key 0000-0000

必需参数

--blob-name -b

Blob 名称。

--container-name -c

容器名称。

--lease-id

如果 Blob 具有活动租约，则为必需。

可选参数

--account-key

存储帐户密钥。 必须与存储帐户名称或服务终结点结合使用。 环境变量：AZURE_STORAGE_KEY。

--account-name

存储帐户名称。 相关环境变量：AZURE_STORAGE_ACCOUNT。 必须与存储帐户密钥或 SAS 令牌结合使用。 如果两者都不存在，该命令将尝试使用经过身份验证的 Azure 帐户查询存储帐户密钥。 如果执行了大量存储命令，可能会命中 API 配额。

--auth-mode

运行命令的模式。 “登录”模式将直接使用登录凭据进行身份验证。 如果未提供帐户的身份验证参数，则旧版“密钥”模式将尝试查询帐户密钥。 环境变量：AZURE_STORAGE_AUTH_MODE。

接受的值: key, login

--blob-endpoint

存储数据服务终结点。 必须与存储帐户密钥或 SAS 令牌结合使用。 可以使用 .. 查找每个服务主终结点 az storage account show。 环境变量：AZURE_STORAGE_标准版RVICE_ENDPOINT。

--connection-string

存储帐户连接字符串。 环境变量：AZURE_STORAGE_CONNECTION_STRING。

--if-match

ETag 值或 wild卡 字符 \. 仅当资源的 ETag 与指定的值匹配时，才指定此标头来执行该操作。

--if-modified-since

仅当自提供的 UTC 日期时间（Y-m-d'T'H：M'Z'）修改后才开始。

--if-none-match

ETag 值或 wild卡 字符 （）。仅当资源的 ETag 与指定的值不匹配时，才指定此标头来执行该操作。指定 wild卡 字符 （） 以仅在资源不存在时执行该操作，如果资源不存在，则操作失败。

--if-unmodified-since

仅当自提供的 UTC 日期时间（Y-m-d'T'H：M'Z'）以来未修改时才开始。

--sas-token

共享访问签名（SAS）。 必须与存储帐户名称或服务终结点结合使用。 环境变量：AZURE_STORAGE_SAS_TOKEN。

--tags-condition

指定 Blob 标记上的 SQL where 子句，以仅对具有匹配值的 Blob 进行操作。

--timeout

请求超时（以秒为单位）。 适用于对服务的每个调用。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。