BlobContainers interface
BlobContainers を表すインターフェイス。
メソッド
| begin |
この操作により、BLOB コンテナーがコンテナー レベル WORM からオブジェクト レベルの不変性が有効なコンテナーに移行されます。 前提条件には、ロック状態またはロック解除状態のコンテナー レベルの不変ポリシーが必要です。アカウント レベルのバージョン管理を有効にする必要があり、コンテナーに対する訴訟ホールドが存在しない必要があります。 |
| begin |
この操作により、BLOB コンテナーがコンテナー レベル WORM からオブジェクト レベルの不変性が有効なコンテナーに移行されます。 前提条件には、ロック状態またはロック解除状態のコンテナー レベルの不変ポリシーが必要です。アカウント レベルのバージョン管理を有効にする必要があり、コンテナーに対する訴訟ホールドが存在しない必要があります。 |
| clear |
訴訟ホールド タグをクリアします。 同じタグまたは存在しないタグをクリアすると、べき等操作が発生します。 ClearLegalHold は、要求内の指定されたタグのみをクリアします。 |
| create(string, string, string, Blob |
要求本文で説明されているように、指定したアカウントの下に新しいコンテナーを作成します。 コンテナー リソースには、そのコンテナーのメタデータとプロパティが含まれます。 コンテナーに含まれる BLOB の一覧は含まれません。 |
| create |
ロックされていない不変ポリシーを作成または更新します。 If-Matchの ETag は、指定されている場合は受け入れられますが、この操作には必要ありません。 |
| delete(string, string, string, Blob |
指定したコンテナーをそのアカウントで削除します。 |
| delete |
ロックされていない不変ポリシーを中止します。 削除の応答には、immutabilityPeriodSinceCreationInDays が 0 に設定されています。 この操作には、If-Matchの ETag が必要です。 ロックされた不変ポリシーの削除は許可されていません。唯一の方法は、ポリシーロックされたコンテナー内のすべての期限切れの BLOB を削除した後にコンテナーを削除することです。 |
| extend |
ロックされた immutabilityPolicy の immutabilityPeriodSinceCreationInDays を拡張します。 ロックされたポリシーで許可される唯一のアクションは、このアクションです。 この操作には、If-Matchの ETag が必要です。 |
| get(string, string, string, Blob |
指定したコンテナーのプロパティを取得します。 |
| get |
応答ヘッダーと本文の対応する ETag と共に、既存の不変ポリシーを取得します。 |
| lease(string, string, string, Blob |
リース コンテナー操作は、削除操作用のコンテナーのロックを確立して管理します。 ロック期間は、15 ～ 60 秒にすることも、無限にすることもできます。 |
| list(string, string, Blob |
すべてのコンテナーを一覧表示し、データ プレーンのようなプレフィックスをサポートしていません。 また、今日の SRP は継続トークンを返しません。 |
| lock |
ImmutabilityPolicy を Locked 状態に設定します。 ロックされたポリシーで許可される唯一のアクションは、ExtendImmutabilityPolicy アクションです。 この操作には、If-Matchの ETag が必要です。 |
| set |
訴訟ホールド タグを設定します。 同じタグを設定すると、べき等操作が発生します。 SetLegalHold は追加パターンに従い、要求で指定されていない既存のタグをクリアしません。 |
| update(string, string, string, Blob |
要求本文で指定されたコンテナー プロパティを更新します。 要求に記載されていないプロパティは変更されません。 指定したコンテナーがまだ存在しない場合、更新は失敗します。 |
メソッドの詳細
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 文字で、数字、小文字、ダッシュ (-) のみを使用する必要があります。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。
options パラメーター。
戻り値
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 文字で、数字、小文字、ダッシュ (-) のみを使用する必要があります。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。
options パラメーター。
戻り値
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 プロパティ。
options パラメーター。
戻り値
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 コンテナーのプロパティ。
options パラメーター。
戻り値
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 文字で、数字、小文字、ダッシュ (-) のみを使用する必要があります。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。
options パラメーター。
戻り値
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 文字で、数字、小文字、ダッシュ (-) のみを使用する必要があります。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。
options パラメーター。
戻り値
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) バージョン。 不変ポリシーが既に存在する場合にのみ、値 "*" を使用して操作を適用できます。 省略すると、この操作は常に適用されます。
options パラメーター。
戻り値
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) バージョン。 不変ポリシーが既に存在する場合にのみ、値 "*" を使用して操作を適用できます。 省略すると、この操作は常に適用されます。
options パラメーター。
戻り値
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
options パラメーター。
戻り値
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 文字で、数字、小文字、ダッシュ (-) のみを使用する必要があります。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。
options パラメーター。
戻り値
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 文字で、数字、小文字、ダッシュ (-) のみを使用する必要があります。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。
options パラメーター。
戻り値
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
options パラメーター。
戻り値
lockImmutabilityPolicy(string, string, string, string, BlobContainersLockImmutabilityPolicyOptionalParams)
ImmutabilityPolicy を Locked 状態に設定します。 ロックされたポリシーで許可される唯一のアクションは、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) バージョン。 不変ポリシーが既に存在する場合にのみ、値 "*" を使用して操作を適用できます。 省略すると、この操作は常に適用されます。
options パラメーター。
戻り値
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 プロパティ。
options パラメーター。
戻り値
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 コンテナーの更新するプロパティ。
options パラメーター。
戻り値
Promise<BlobContainer>