BlobContainers interface
代表 BlobContainers 的介面。
方法
方法詳細資料
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)
中止已解除鎖定的不變性原則。 刪除的回應將 immutabilityPeriodSinceCreationInDays 設定為 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)
擴充鎖定 immutabilityPolicy 的 immutabilityPeriodSinceCreationInDays。 鎖定原則上允許的唯一動作是此動作。 此作業需要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)
將 ImmutabilityPolicy 設定為 [鎖定] 狀態。 鎖定原則上允許的唯一動作是 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>