你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
BlobContainers interface
表示 BlobContainer 的接口。
方法
方法详细信息
beginObjectLevelWorm(string, string, string, BlobContainersObjectLevelWormOptionalParams)
此操作会将 Blob 容器从容器级别 WORM 迁移到已启用对象级别不可变性的容器。 先决条件要求容器级别不可变性策略处于锁定或解锁状态，必须启用帐户级别版本控制，并且容器上不应有法定保留。
function beginObjectLevelWorm(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersObjectLevelWormOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- containerName
-
string
指定存储帐户中的 Blob 容器的名称。 Blob 容器名称的长度必须介于 3 到 63 个字符之间，并且仅使用数字、小写字母和短划线 () 。 每个短划线（-）字符的前后必须紧跟字母或数字。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginObjectLevelWormAndWait(string, string, string, BlobContainersObjectLevelWormOptionalParams)
此操作会将 Blob 容器从容器级别 WORM 迁移到已启用对象级别不可变性的容器。 先决条件要求容器级别不可变性策略处于锁定或解锁状态，必须启用帐户级别版本控制，并且容器上不应有法定保留。
function beginObjectLevelWormAndWait(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersObjectLevelWormOptionalParams): Promise<void>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- containerName
-
string
指定存储帐户中的 Blob 容器的名称。 Blob 容器名称的长度必须介于 3 到 63 个字符之间，并且仅使用数字、小写字母和短划线 () 。 每个短划线（-）字符的前后必须紧跟字母或数字。
选项参数。
返回
Promise<void>
clearLegalHold(string, string, string, LegalHold, BlobContainersClearLegalHoldOptionalParams)
清除法定保留标记。 清除相同或不存在的标记会导致幂等操作。 ClearLegalHold 仅清除请求中的指定标记。
function clearLegalHold(resourceGroupName: string, accountName: string, containerName: string, legalHold: LegalHold, options?: BlobContainersClearLegalHoldOptionalParams): Promise<LegalHold>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- containerName
-
string
指定存储帐户中的 Blob 容器的名称。 Blob 容器名称的长度必须介于 3 到 63 个字符之间，并且仅使用数字、小写字母和短划线 () 。 每个短划线（-）字符的前后必须紧跟字母或数字。
- legalHold
- LegalHold
将从 Blob 容器中清除的 LegalHold 属性。
选项参数。
返回
Promise<LegalHold>
create(string, string, string, BlobContainer, BlobContainersCreateOptionalParams)
按请求正文所述，在指定的帐户下创建一个新容器。 容器资源包括容器的元数据和属性。 不包括容器所包含的 Blob 的列表。
function create(resourceGroupName: string, accountName: string, containerName: string, blobContainer: BlobContainer, options?: BlobContainersCreateOptionalParams): Promise<BlobContainer>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- containerName
-
string
指定存储帐户中的 Blob 容器的名称。 Blob 容器名称的长度必须介于 3 到 63 个字符之间，并且仅使用数字、小写字母和短划线 () 。 每个短划线（-）字符的前后必须紧跟字母或数字。
- blobContainer
- BlobContainer
要创建的 Blob 容器的属性。
选项参数。
返回
Promise<BlobContainer>
createOrUpdateImmutabilityPolicy(string, string, string, BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams)
创建或更新未锁定的不可变性策略。 如果给定但不需要此操作，则遵循 If-Match 中的 ETag。
function createOrUpdateImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams): Promise<BlobContainersCreateOrUpdateImmutabilityPolicyResponse>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- containerName
-
string
指定存储帐户中的 Blob 容器的名称。 Blob 容器名称的长度必须介于 3 到 63 个字符之间，并且仅使用数字、小写字母和短划线 () 。 每个短划线（-）字符的前后必须紧跟字母或数字。
返回
delete(string, string, string, BlobContainersDeleteOptionalParams)
删除其帐户下的指定容器。
function delete(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersDeleteOptionalParams): Promise<void>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- containerName
-
string
指定存储帐户中的 Blob 容器的名称。 Blob 容器名称的长度必须介于 3 到 63 个字符之间，并且仅使用数字、小写字母和短划线 () 。 每个短划线（-）字符的前后必须紧跟字母或数字。
选项参数。
返回
Promise<void>
deleteImmutabilityPolicy(string, string, string, string, BlobContainersDeleteImmutabilityPolicyOptionalParams)
中止未锁定的不可变性策略。 删除的响应将不可变性PeriodSinceCreationInDays 设置为 0。 此操作需要 If-Match 中的 ETag。 不允许删除锁定的不可变性策略，唯一的方法是在删除策略锁定容器内的所有过期 Blob 后删除容器。
function deleteImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersDeleteImmutabilityPolicyOptionalParams): Promise<BlobContainersDeleteImmutabilityPolicyResponse>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- containerName
-
string
指定存储帐户中的 Blob 容器的名称。 Blob 容器名称的长度必须介于 3 到 63 个字符之间，并且仅使用数字、小写字母和短划线 () 。 每个短划线（-）字符的前后必须紧跟字母或数字。
- ifMatch
-
string
实体状态 (ETag) 要更新的不可变性策略版本。 仅当不可变性策略已存在时，值“*”才可用于应用操作。 如果省略，将始终应用此操作。
选项参数。
返回
extendImmutabilityPolicy(string, string, string, string, BlobContainersExtendImmutabilityPolicyOptionalParams)
扩展锁定的不可变性Policy 的不可变性PeriodSinceCreationInDays。 锁定策略上允许的唯一操作是此操作。 此操作需要 If-Match 中的 ETag。
function extendImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersExtendImmutabilityPolicyOptionalParams): Promise<BlobContainersExtendImmutabilityPolicyResponse>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- containerName
-
string
指定存储帐户中的 Blob 容器的名称。 Blob 容器名称的长度必须介于 3 到 63 个字符之间，并且仅使用数字、小写字母和短划线 () 。 每个短划线（-）字符的前后必须紧跟字母或数字。
- ifMatch
-
string
实体状态 (ETag) 要更新的不可变性策略版本。 仅当不可变性策略已存在时，值“*”才可用于应用操作。 如果省略，将始终应用此操作。
选项参数。
返回
get(string, string, string, BlobContainersGetOptionalParams)
获取指定容器的属性。
function get(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersGetOptionalParams): Promise<BlobContainer>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- containerName
-
string
指定存储帐户中的 Blob 容器的名称。 Blob 容器名称的长度必须介于 3 到 63 个字符之间，并且仅使用数字、小写字母和短划线 () 。 每个短划线（-）字符的前后必须紧跟字母或数字。
- options
- BlobContainersGetOptionalParams
选项参数。
返回
Promise<BlobContainer>
getImmutabilityPolicy(string, string, string, BlobContainersGetImmutabilityPolicyOptionalParams)
获取现有的不可变性策略以及响应标头和正文中的相应 ETag。
function getImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersGetImmutabilityPolicyOptionalParams): Promise<BlobContainersGetImmutabilityPolicyResponse>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- containerName
-
string
指定存储帐户中的 Blob 容器的名称。 Blob 容器名称的长度必须介于 3 到 63 个字符之间，并且仅使用数字、小写字母和短划线 () 。 每个短划线（-）字符的前后必须紧跟字母或数字。
选项参数。
返回
lease(string, string, string, BlobContainersLeaseOptionalParams)
租用容器操作在容器上建立和管理用于删除操作的锁。 锁的持续时间可以是 15 到 60 秒，也可以是无限期。
function lease(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersLeaseOptionalParams): Promise<LeaseContainerResponse>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- containerName
-
string
指定存储帐户中的 Blob 容器的名称。 Blob 容器名称的长度必须介于 3 到 63 个字符之间，并且仅使用数字、小写字母和短划线 () 。 每个短划线（-）字符的前后必须紧跟字母或数字。
选项参数。
返回
Promise<LeaseContainerResponse>
list(string, string, BlobContainersListOptionalParams)
列出所有容器，不支持前缀（如数据平面）。 此外，SRP 今天不返回延续标记。
function list(resourceGroupName: string, accountName: string, options?: BlobContainersListOptionalParams): PagedAsyncIterableIterator<ListContainerItem, ListContainerItem[], PageSettings>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- options
- BlobContainersListOptionalParams
选项参数。
返回
lockImmutabilityPolicy(string, string, string, string, BlobContainersLockImmutabilityPolicyOptionalParams)
将“不可变性策略”设置为“锁定”状态。 锁定策略上允许的唯一操作是 ExtendImmutabilityPolicy 操作。 此操作需要 If-Match 中的 ETag。
function lockImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersLockImmutabilityPolicyOptionalParams): Promise<BlobContainersLockImmutabilityPolicyResponse>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- containerName
-
string
指定存储帐户中的 Blob 容器的名称。 Blob 容器名称的长度必须介于 3 到 63 个字符之间，并且仅使用数字、小写字母和短划线 () 。 每个短划线（-）字符的前后必须紧跟字母或数字。
- ifMatch
-
string
实体状态 (ETag) 要更新的不可变性策略版本。 仅当不可变性策略已存在时，值“*”才可用于应用操作。 如果省略，将始终应用此操作。
选项参数。
返回
setLegalHold(string, string, string, LegalHold, BlobContainersSetLegalHoldOptionalParams)
设置法定保留标记。 设置相同的标记会导致幂等操作。 SetLegalHold 遵循追加模式，不会清除请求中未指定的现有标记。
function setLegalHold(resourceGroupName: string, accountName: string, containerName: string, legalHold: LegalHold, options?: BlobContainersSetLegalHoldOptionalParams): Promise<LegalHold>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- containerName
-
string
指定存储帐户中的 Blob 容器的名称。 Blob 容器名称的长度必须介于 3 到 63 个字符之间，并且仅使用数字、小写字母和短划线 () 。 每个短划线（-）字符的前后必须紧跟字母或数字。
- legalHold
- LegalHold
将设置为 Blob 容器的 LegalHold 属性。
选项参数。
返回
Promise<LegalHold>
update(string, string, string, BlobContainer, BlobContainersUpdateOptionalParams)
汇报请求正文中指定的容器属性。 请求中未提及的属性将保持不变。 如果指定的容器尚不存在，更新将失败。
function update(resourceGroupName: string, accountName: string, containerName: string, blobContainer: BlobContainer, options?: BlobContainersUpdateOptionalParams): Promise<BlobContainer>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- containerName
-
string
指定存储帐户中的 Blob 容器的名称。 Blob 容器名称的长度必须介于 3 到 63 个字符之间，并且仅使用数字、小写字母和短划线 () 。 每个短划线（-）字符的前后必须紧跟字母或数字。
- blobContainer
- BlobContainer
要更新 Blob 容器的属性。
选项参数。
返回
Promise<BlobContainer>