BlobContainersOperations interface

パッケージ:

@azure/arm-storage

BlobContainers操作を表すインターフェース。

プロパティ

beginObjectLevelWorm
beginObjectLevelWormAndWait
clearLegalHold	訴訟ホールドタグをクリアします。 同じタグまたは存在しないタグをクリアすると、べき等演算が発生します。 ClearLegalHold は、要求で指定されたタグのみをクリアします。
create	要求本文で説明されているように、指定されたアカウントの下に新しいコンテナを作成します。 コンテナー・リソースには、そのコンテナーのメタデータとプロパティーが含まれます。 コンテナに含まれる BLOB の一覧は含まれません。
createOrUpdateImmutabilityPolicy	ロック解除された不変性ポリシーを作成または更新します。 If-Match の ETag は、指定された場合は受け入れられますが、この操作には必要ありません。
delete	アカウントで指定されたコンテナを削除します。
deleteImmutabilityPolicy	ロック解除された不変ポリシーを中止します。 削除の応答に immutabilityPeriodSinceCreationInDays が 0 に設定されています。 この操作には、If-Match の ETag が必要です。 ロックされた不変ポリシーの削除は許可されていません。唯一の方法は、ポリシーロックされたコンテナー内のすべての期限切れの BLOB を削除した後にコンテナーを削除することです。
extendImmutabilityPolicy	ロックされた immutabilityPolicy の immutabilityPeriodSinceCreationInDays を拡張します。 ロックされたポリシーで許可されるアクションは、このアクションのみです。 この操作には、If-Match の ETag が必要です。
get	指定したコンテナーのプロパティを取得します。
getImmutabilityPolicy	応答ヘッダーと本文の対応する ETag と共に、既存の不変ポリシーを取得します。
lease	リースコンテナ操作は、削除操作のためにコンテナのロックを確立および管理します。 ロック期間は、15 から 60 秒にすることも、無限にすることもできます。
list	すべてのコンテナーを一覧表示し、データ プレーンなどのプレフィックスはサポートしません。 また、今日の SRP は継続トークンを返しません。
lockImmutabilityPolicy	ImmutabilityPolicy を Locked 状態に設定します。 ロックされたポリシーで許可されるアクションは ExtendImmutabilityPolicy アクションだけです。 この操作には、If-Match の ETag が必要です。
objectLevelWorm	この操作により、BLOB コンテナーがコンテナー レベルの WORM からオブジェクト レベルの不変性が有効なコンテナーに移行されます。 前提条件には、ロック状態またはロック解除状態のコンテナー レベルの不変性ポリシーが必要であり、アカウント レベルのバージョン管理を有効にする必要があり、コンテナーに訴訟ホールドがあってはなりません。
setLegalHold	訴訟ホールドタグを設定します。 同じタグを設定すると、べき等演算になります。 SetLegalHold は追加パターンに従い、要求で指定されていない既存のタグはクリアされません。
update	要求本文で指定されたコンテナーのプロパティを更新します。 要求に記載されていないプロパティは変更されません。 指定したコンテナーがまだ存在しない場合、更新は失敗します。

プロパティの詳細

beginObjectLevelWorm

警告

この API は非推奨になりました。

use objectLevelWorm instead

beginObjectLevelWorm: (resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersObjectLevelWormOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

プロパティ値

(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersObjectLevelWormOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginObjectLevelWormAndWait

警告

この API は非推奨になりました。

use objectLevelWorm instead

beginObjectLevelWormAndWait: (resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersObjectLevelWormOptionalParams) => Promise<void>

プロパティ値

(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersObjectLevelWormOptionalParams) => Promise<void>

clearLegalHold

訴訟ホールドタグをクリアします。 同じタグまたは存在しないタグをクリアすると、べき等演算が発生します。 ClearLegalHold は、要求で指定されたタグのみをクリアします。

clearLegalHold: (resourceGroupName: string, accountName: string, containerName: string, legalHold: LegalHold, options?: BlobContainersClearLegalHoldOptionalParams) => Promise<LegalHold>

プロパティ値

(resourceGroupName: string, accountName: string, containerName: string, legalHold: LegalHold, options?: BlobContainersClearLegalHoldOptionalParams) => Promise<LegalHold>

create

要求本文で説明されているように、指定されたアカウントの下に新しいコンテナを作成します。 コンテナー・リソースには、そのコンテナーのメタデータとプロパティーが含まれます。 コンテナに含まれる BLOB の一覧は含まれません。

create: (resourceGroupName: string, accountName: string, containerName: string, blobContainer: BlobContainer, options?: BlobContainersCreateOptionalParams) => Promise<BlobContainer>

プロパティ値

(resourceGroupName: string, accountName: string, containerName: string, blobContainer: BlobContainer, options?: BlobContainersCreateOptionalParams) => Promise<BlobContainer>

createOrUpdateImmutabilityPolicy

ロック解除された不変性ポリシーを作成または更新します。 If-Match の ETag は、指定された場合は受け入れられますが、この操作には必要ありません。

createOrUpdateImmutabilityPolicy: (resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams) => Promise<ImmutabilityPolicy>

プロパティ値

(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams) => Promise<ImmutabilityPolicy>

delete

アカウントで指定されたコンテナを削除します。

delete: (resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersDeleteOptionalParams) => Promise<void>

プロパティ値

(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersDeleteOptionalParams) => Promise<void>

deleteImmutabilityPolicy

ロック解除された不変ポリシーを中止します。 削除の応答に immutabilityPeriodSinceCreationInDays が 0 に設定されています。 この操作には、If-Match の ETag が必要です。 ロックされた不変ポリシーの削除は許可されていません。唯一の方法は、ポリシーロックされたコンテナー内のすべての期限切れの BLOB を削除した後にコンテナーを削除することです。

deleteImmutabilityPolicy: (resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersDeleteImmutabilityPolicyOptionalParams) => Promise<ImmutabilityPolicy>

プロパティ値

(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersDeleteImmutabilityPolicyOptionalParams) => Promise<ImmutabilityPolicy>

extendImmutabilityPolicy

ロックされた immutabilityPolicy の immutabilityPeriodSinceCreationInDays を拡張します。 ロックされたポリシーで許可されるアクションは、このアクションのみです。 この操作には、If-Match の ETag が必要です。

extendImmutabilityPolicy: (resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersExtendImmutabilityPolicyOptionalParams) => Promise<ImmutabilityPolicy>

プロパティ値

(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersExtendImmutabilityPolicyOptionalParams) => Promise<ImmutabilityPolicy>

get

指定したコンテナーのプロパティを取得します。

get: (resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersGetOptionalParams) => Promise<BlobContainer>

プロパティ値

(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersGetOptionalParams) => Promise<BlobContainer>

getImmutabilityPolicy

応答ヘッダーと本文の対応する ETag と共に、既存の不変ポリシーを取得します。

getImmutabilityPolicy: (resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersGetImmutabilityPolicyOptionalParams) => Promise<ImmutabilityPolicy>

プロパティ値

(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersGetImmutabilityPolicyOptionalParams) => Promise<ImmutabilityPolicy>

lease

リースコンテナ操作は、削除操作のためにコンテナのロックを確立および管理します。 ロック期間は、15 から 60 秒にすることも、無限にすることもできます。

lease: (resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersLeaseOptionalParams) => Promise<LeaseContainerResponse>

プロパティ値

(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersLeaseOptionalParams) => Promise<LeaseContainerResponse>

list

すべてのコンテナーを一覧表示し、データ プレーンなどのプレフィックスはサポートしません。 また、今日の SRP は継続トークンを返しません。

list: (resourceGroupName: string, accountName: string, options?: BlobContainersListOptionalParams) => PagedAsyncIterableIterator<ListContainerItem, ListContainerItem[], PageSettings>

プロパティ値

(resourceGroupName: string, accountName: string, options?: BlobContainersListOptionalParams) => PagedAsyncIterableIterator<ListContainerItem, ListContainerItem[], PageSettings>

lockImmutabilityPolicy

ImmutabilityPolicy を Locked 状態に設定します。 ロックされたポリシーで許可されるアクションは ExtendImmutabilityPolicy アクションだけです。 この操作には、If-Match の ETag が必要です。

lockImmutabilityPolicy: (resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersLockImmutabilityPolicyOptionalParams) => Promise<ImmutabilityPolicy>

プロパティ値

(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersLockImmutabilityPolicyOptionalParams) => Promise<ImmutabilityPolicy>

objectLevelWorm

この操作により、BLOB コンテナーがコンテナー レベルの WORM からオブジェクト レベルの不変性が有効なコンテナーに移行されます。 前提条件には、ロック状態またはロック解除状態のコンテナー レベルの不変性ポリシーが必要であり、アカウント レベルのバージョン管理を有効にする必要があり、コンテナーに訴訟ホールドがあってはなりません。

objectLevelWorm: (resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersObjectLevelWormOptionalParams) => PollerLike<OperationState<void>, void>

プロパティ値

(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersObjectLevelWormOptionalParams) => PollerLike<OperationState<void>, void>

setLegalHold

訴訟ホールドタグを設定します。 同じタグを設定すると、べき等演算になります。 SetLegalHold は追加パターンに従い、要求で指定されていない既存のタグはクリアされません。

setLegalHold: (resourceGroupName: string, accountName: string, containerName: string, legalHold: LegalHold, options?: BlobContainersSetLegalHoldOptionalParams) => Promise<LegalHold>

プロパティ値

(resourceGroupName: string, accountName: string, containerName: string, legalHold: LegalHold, options?: BlobContainersSetLegalHoldOptionalParams) => Promise<LegalHold>

update

要求本文で指定されたコンテナーのプロパティを更新します。 要求に記載されていないプロパティは変更されません。 指定したコンテナーがまだ存在しない場合、更新は失敗します。

update: (resourceGroupName: string, accountName: string, containerName: string, blobContainer: BlobContainer, options?: BlobContainersUpdateOptionalParams) => Promise<BlobContainer>

プロパティ値

(resourceGroupName: string, accountName: string, containerName: string, blobContainer: BlobContainer, options?: BlobContainersUpdateOptionalParams) => Promise<BlobContainer>