BlobContainersOperations クラス
警告
このクラスを直接インスタンス化しないでください。
代わりに、次の操作にアクセスする必要があります。
<xref:blob_containers> 属性を使用する。
- 継承
-
builtins.objectBlobContainersOperations
コンストラクター
BlobContainersOperations(*args, **kwargs)
メソッド
begin_object_level_worm |
この操作により、BLOB コンテナーがコンテナー レベル WORM からオブジェクト レベルの不変性が有効なコンテナーに移行されます。 前提条件には、ロック状態またはロック解除状態のコンテナー レベルの不変ポリシーが必要です。アカウント レベルのバージョン管理を有効にする必要があり、コンテナーに対する訴訟ホールドが存在しない必要があります。 |
clear_legal_hold |
訴訟ホールド タグをクリアします。 同じタグまたは存在しないタグをクリアすると、べき等操作が発生します。 ClearLegalHold は、要求内の指定されたタグのみをクリアします。 |
create |
要求本文で説明されているように、指定したアカウントの下に新しいコンテナーを作成します。 コンテナー リソースには、そのコンテナーのメタデータとプロパティが含まれます。 コンテナーに含まれる BLOB の一覧は含まれません。 |
create_or_update_immutability_policy |
ロックされていない不変ポリシーを作成または更新します。 If-Match の ETag は、指定されている場合は受け入れられますが、この操作には必要ありません。 |
delete |
指定したコンテナーをそのアカウントで削除します。 |
delete_immutability_policy |
ロックされていない不変ポリシーを中止します。 削除の応答には、immutabilityPeriodSinceCreationInDays が 0 に設定されています。 この操作には、If-Match の ETag が必要です。 ロックされた不変ポリシーの削除は許可されていません。唯一の方法は、ポリシーロックされたコンテナー内のすべての期限切れの BLOB を削除した後にコンテナーを削除することです。 |
extend_immutability_policy |
ロックされた immutabilityPolicy の immutabilityPeriodSinceCreationInDays を拡張します。 ロックされたポリシーで許可される唯一のアクションは、このアクションです。 この操作には、If-Match の ETag が必要です。 |
get |
指定したコンテナーのプロパティを取得します。 |
get_immutability_policy |
応答ヘッダーと本文の対応する ETag と共に、既存の不変ポリシーを取得します。 |
lease |
リース コンテナー操作は、削除操作用のコンテナーのロックを確立して管理します。 ロック期間は、15 ~ 60 秒にすることも、無限にすることもできます。 |
list |
すべてのコンテナーを一覧表示し、データ プレーンのようなプレフィックスをサポートしていません。 また、今日の SRP は継続トークンを返しません。 |
lock_immutability_policy |
ImmutabilityPolicy を Locked 状態に設定します。 ロックされたポリシーで許可される唯一のアクションは、ExtendImmutabilityPolicy アクションです。 この操作には、If-Match の ETag が必要です。 |
set_legal_hold |
訴訟ホールド タグを設定します。 同じタグを設定すると、べき等操作が発生します。 SetLegalHold は追加パターンに従い、要求で指定されていない既存のタグをクリアしません。 |
update |
要求本文で指定されたコンテナー プロパティを更新します。 要求に記載されていないプロパティは変更されません。 指定したコンテナーがまだ存在しない場合、更新は失敗します。 |
begin_object_level_worm
この操作により、BLOB コンテナーがコンテナー レベル WORM からオブジェクト レベルの不変性が有効なコンテナーに移行されます。 前提条件には、ロック状態またはロック解除状態のコンテナー レベルの不変ポリシーが必要です。アカウント レベルのバージョン管理を有効にする必要があり、コンテナーに対する訴訟ホールドが存在しない必要があります。
begin_object_level_worm(resource_group_name: str, account_name: str, container_name: str, **kwargs: Any) -> LROPoller[None]
パラメーター
- account_name
- str
指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ~ 24 文字で、数字と小文字のみを使用する必要があります。 必須です。
- container_name
- str
指定したストレージ アカウント内の BLOB コンテナーの名前。 BLOB コンテナー名の長さは 3 から 63 文字で、数字、小文字、ダッシュ (-) のみを使用する必要があります。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。 必須です。
- cls
- callable
直接応答が渡されるカスタム型または関数
- continuation_token
- str
保存された状態からポーリングを再開するための継続トークン。
- polling
- bool または PollingMethod
既定では、ポーリング メソッドは ARMPolling になります。 この操作に対して False を渡してポーリングを行わないか、個人のポーリング戦略のために独自に初期化されたポーリング オブジェクトを渡します。
- polling_interval
- int
Retry-After ヘッダーがない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。
戻り値
None または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
clear_legal_hold
訴訟ホールド タグをクリアします。 同じタグまたは存在しないタグをクリアすると、べき等操作が発生します。 ClearLegalHold は、要求内の指定されたタグのみをクリアします。
clear_legal_hold(resource_group_name: str, account_name: str, container_name: str, legal_hold: _models.LegalHold, *, content_type: str = 'application/json', **kwargs: Any) -> _models.LegalHold
パラメーター
- account_name
- str
指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ~ 24 文字で、数字と小文字のみを使用する必要があります。 必須です。
- container_name
- str
指定したストレージ アカウント内の BLOB コンテナーの名前。 BLOB コンテナー名の長さは 3 から 63 文字で、数字、小文字、ダッシュ (-) のみを使用する必要があります。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。 必須です。
- content_type
- str
Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。
- cls
- callable
直接応答が渡されるカスタム型または関数
戻り値
LegalHold または cls(response) の結果
の戻り値の型 :
例外
create
要求本文で説明されているように、指定したアカウントの下に新しいコンテナーを作成します。 コンテナー リソースには、そのコンテナーのメタデータとプロパティが含まれます。 コンテナーに含まれる BLOB の一覧は含まれません。
create(resource_group_name: str, account_name: str, container_name: str, blob_container: _models.BlobContainer, *, content_type: str = 'application/json', **kwargs: Any) -> _models.BlobContainer
パラメーター
- account_name
- str
指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ~ 24 文字で、数字と小文字のみを使用する必要があります。 必須です。
- container_name
- str
指定したストレージ アカウント内の BLOB コンテナーの名前。 BLOB コンテナー名の長さは 3 から 63 文字で、数字、小文字、ダッシュ (-) のみを使用する必要があります。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。 必須です。
- content_type
- str
Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。
- cls
- callable
直接応答が渡されるカスタム型または関数
戻り値
BlobContainer または cls(response) の結果
の戻り値の型 :
例外
create_or_update_immutability_policy
ロックされていない不変ポリシーを作成または更新します。 If-Match の ETag は、指定されている場合は受け入れられますが、この操作には必要ありません。
create_or_update_immutability_policy(resource_group_name: str, account_name: str, container_name: str, if_match: str | None = None, parameters: _models.ImmutabilityPolicy | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ImmutabilityPolicy
パラメーター
- account_name
- str
指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ~ 24 文字で、数字と小文字のみを使用する必要があります。 必須です。
- container_name
- str
指定したストレージ アカウント内の BLOB コンテナーの名前。 BLOB コンテナー名の長さは 3 から 63 文字で、数字、小文字、ダッシュ (-) のみを使用する必要があります。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。 必須です。
- if_match
- str
更新する不変ポリシーのエンティティ状態 (ETag) バージョン。 不変ポリシーが既に存在する場合にのみ、値 "*" を使用して操作を適用できます。 省略すると、この操作は常に適用されます。 既定値は [なし] です。
- parameters
- ImmutabilityPolicy または IO
BLOB コンテナーに対して作成または更新される ImmutabilityPolicy プロパティ。 ImmutabilityPolicy 型または IO 型のいずれかです。 既定値は [なし] です。
- immutability_policy_name
- str
指定したストレージ アカウント内の BLOB コンテナー immutabilityPolicy の名前。 ImmutabilityPolicy Name は 'default' である必要があります。 既定値は "default" です。 この既定値をオーバーライドすると、サポートされていない動作が発生する可能性があることに注意してください。
- content_type
- str
Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。
- cls
- callable
直接応答が渡されるカスタム型または関数
戻り値
ImmutabilityPolicy または cls(response) の結果
の戻り値の型 :
例外
delete
指定したコンテナーをそのアカウントで削除します。
delete(resource_group_name: str, account_name: str, container_name: str, **kwargs: Any) -> None
パラメーター
- account_name
- str
指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ~ 24 文字で、数字と小文字のみを使用する必要があります。 必須です。
- container_name
- str
指定したストレージ アカウント内の BLOB コンテナーの名前。 BLOB コンテナー名の長さは 3 から 63 文字で、数字、小文字、ダッシュ (-) のみを使用する必要があります。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。 必須です。
- cls
- callable
直接応答が渡されるカスタム型または関数
戻り値
なしまたは cls(response) の結果
の戻り値の型 :
例外
delete_immutability_policy
ロックされていない不変ポリシーを中止します。 削除の応答には、immutabilityPeriodSinceCreationInDays が 0 に設定されています。 この操作には、If-Match の ETag が必要です。 ロックされた不変ポリシーの削除は許可されていません。唯一の方法は、ポリシーロックされたコンテナー内のすべての期限切れの BLOB を削除した後にコンテナーを削除することです。
delete_immutability_policy(resource_group_name: str, account_name: str, container_name: str, if_match: str, **kwargs: Any) -> ImmutabilityPolicy
パラメーター
- account_name
- str
指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ~ 24 文字で、数字と小文字のみを使用する必要があります。 必須です。
- container_name
- str
指定したストレージ アカウント内の BLOB コンテナーの名前。 BLOB コンテナー名の長さは 3 から 63 文字で、数字、小文字、ダッシュ (-) のみを使用する必要があります。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。 必須です。
- if_match
- str
更新する不変ポリシーのエンティティ状態 (ETag) バージョン。 不変ポリシーが既に存在する場合にのみ、値 "*" を使用して操作を適用できます。 省略すると、この操作は常に適用されます。 必須です。
- immutability_policy_name
- str
指定したストレージ アカウント内の BLOB コンテナー immutabilityPolicy の名前。 ImmutabilityPolicy Name は 'default' である必要があります。 既定値は "default" です。 この既定値をオーバーライドすると、サポートされていない動作が発生する可能性があることに注意してください。
- cls
- callable
直接応答が渡されるカスタム型または関数
戻り値
ImmutabilityPolicy または cls(response) の結果
の戻り値の型 :
例外
extend_immutability_policy
ロックされた immutabilityPolicy の immutabilityPeriodSinceCreationInDays を拡張します。 ロックされたポリシーで許可される唯一のアクションは、このアクションです。 この操作には、If-Match の ETag が必要です。
extend_immutability_policy(resource_group_name: str, account_name: str, container_name: str, if_match: str, parameters: _models.ImmutabilityPolicy | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ImmutabilityPolicy
パラメーター
- account_name
- str
指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ~ 24 文字で、数字と小文字のみを使用する必要があります。 必須です。
- container_name
- str
指定したストレージ アカウント内の BLOB コンテナーの名前。 BLOB コンテナー名の長さは 3 から 63 文字で、数字、小文字、ダッシュ (-) のみを使用する必要があります。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。 必須です。
- if_match
- str
更新する不変ポリシーのエンティティ状態 (ETag) バージョン。 不変ポリシーが既に存在する場合にのみ、値 "*" を使用して操作を適用できます。 省略すると、この操作は常に適用されます。 必須です。
- parameters
- ImmutabilityPolicy または IO
BLOB コンテナー用に拡張される ImmutabilityPolicy プロパティ。 ImmutabilityPolicy 型または IO 型のいずれかです。 既定値は [なし] です。
- content_type
- str
Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。
- cls
- callable
直接応答が渡されるカスタム型または関数
戻り値
ImmutabilityPolicy または cls(response) の結果
の戻り値の型 :
例外
get
指定したコンテナーのプロパティを取得します。
get(resource_group_name: str, account_name: str, container_name: str, **kwargs: Any) -> BlobContainer
パラメーター
- account_name
- str
指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ~ 24 文字で、数字と小文字のみを使用する必要があります。 必須です。
- container_name
- str
指定したストレージ アカウント内の BLOB コンテナーの名前。 BLOB コンテナー名の長さは 3 から 63 文字で、数字、小文字、ダッシュ (-) のみを使用する必要があります。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。 必須です。
- cls
- callable
直接応答が渡されるカスタム型または関数
戻り値
BlobContainer または cls(response) の結果
の戻り値の型 :
例外
get_immutability_policy
応答ヘッダーと本文の対応する ETag と共に、既存の不変ポリシーを取得します。
get_immutability_policy(resource_group_name: str, account_name: str, container_name: str, if_match: str | None = None, **kwargs: Any) -> ImmutabilityPolicy
パラメーター
- account_name
- str
指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ~ 24 文字で、数字と小文字のみを使用する必要があります。 必須です。
- container_name
- str
指定したストレージ アカウント内の BLOB コンテナーの名前。 BLOB コンテナー名の長さは 3 から 63 文字で、数字、小文字、ダッシュ (-) のみを使用する必要があります。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。 必須です。
- if_match
- str
更新する不変ポリシーのエンティティ状態 (ETag) バージョン。 不変ポリシーが既に存在する場合にのみ、値 "*" を使用して操作を適用できます。 省略すると、この操作は常に適用されます。 既定値は [なし] です。
- immutability_policy_name
- str
指定したストレージ アカウント内の BLOB コンテナー immutabilityPolicy の名前。 ImmutabilityPolicy Name は 'default' である必要があります。 既定値は "default" です。 この既定値をオーバーライドすると、サポートされていない動作が発生する可能性があることに注意してください。
- cls
- callable
直接応答が渡されるカスタム型または関数
戻り値
ImmutabilityPolicy または cls(response) の結果
の戻り値の型 :
例外
lease
リース コンテナー操作は、削除操作用のコンテナーのロックを確立して管理します。 ロック期間は、15 ~ 60 秒にすることも、無限にすることもできます。
lease(resource_group_name: str, account_name: str, container_name: str, parameters: _models.LeaseContainerRequest | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.LeaseContainerResponse
パラメーター
- account_name
- str
指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ~ 24 文字で、数字と小文字のみを使用する必要があります。 必須です。
- container_name
- str
指定したストレージ アカウント内の BLOB コンテナーの名前。 BLOB コンテナー名の長さは 3 から 63 文字で、数字、小文字、ダッシュ (-) のみを使用する必要があります。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。 必須です。
- parameters
- LeaseContainerRequest または IO
リース コンテナー要求本文。 LeaseContainerRequest 型または IO 型のいずれかです。 既定値は [なし] です。
- content_type
- str
Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。
- cls
- callable
直接応答が渡されるカスタム型または関数
戻り値
LeaseContainerResponse または cls(response) の結果
の戻り値の型 :
例外
list
すべてのコンテナーを一覧表示し、データ プレーンのようなプレフィックスをサポートしていません。 また、今日の SRP は継続トークンを返しません。
list(resource_group_name: str, account_name: str, maxpagesize: str | None = None, filter: str | None = None, include: str | ListContainersInclude | None = None, **kwargs: Any) -> Iterable[ListContainerItem]
パラメーター
- account_name
- str
指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ~ 24 文字で、数字と小文字のみを使用する必要があります。 必須です。
- include
- str または ListContainersInclude
オプション。論理的に削除された BLOB コンテナーのプロパティを含めるために使用されます。 "deleted" 既定値は None です。
- cls
- callable
直接応答が渡されるカスタム型または関数
戻り値
ListContainerItem のインスタンスや cls(response) の結果のような反復子
の戻り値の型 :
例外
lock_immutability_policy
ImmutabilityPolicy を Locked 状態に設定します。 ロックされたポリシーで許可される唯一のアクションは、ExtendImmutabilityPolicy アクションです。 この操作には、If-Match の ETag が必要です。
lock_immutability_policy(resource_group_name: str, account_name: str, container_name: str, if_match: str, **kwargs: Any) -> ImmutabilityPolicy
パラメーター
- account_name
- str
指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ~ 24 文字で、数字と小文字のみを使用する必要があります。 必須です。
- container_name
- str
指定したストレージ アカウント内の BLOB コンテナーの名前。 BLOB コンテナー名の長さは 3 から 63 文字で、数字、小文字、ダッシュ (-) のみを使用する必要があります。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。 必須です。
- if_match
- str
更新する不変ポリシーのエンティティ状態 (ETag) バージョン。 不変ポリシーが既に存在する場合にのみ、値 "*" を使用して操作を適用できます。 省略すると、この操作は常に適用されます。 必須です。
- cls
- callable
直接応答が渡されるカスタム型または関数
戻り値
ImmutabilityPolicy または cls(response) の結果
の戻り値の型 :
例外
set_legal_hold
訴訟ホールド タグを設定します。 同じタグを設定すると、べき等操作が発生します。 SetLegalHold は追加パターンに従い、要求で指定されていない既存のタグをクリアしません。
set_legal_hold(resource_group_name: str, account_name: str, container_name: str, legal_hold: _models.LegalHold, *, content_type: str = 'application/json', **kwargs: Any) -> _models.LegalHold
パラメーター
- account_name
- str
指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ~ 24 文字で、数字と小文字のみを使用する必要があります。 必須です。
- container_name
- str
指定したストレージ アカウント内の BLOB コンテナーの名前。 BLOB コンテナー名の長さは 3 から 63 文字で、数字、小文字、ダッシュ (-) のみを使用する必要があります。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。 必須です。
- content_type
- str
Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。
- cls
- callable
直接応答が渡されるカスタム型または関数
戻り値
LegalHold または cls(response) の結果
の戻り値の型 :
例外
update
要求本文で指定されたコンテナー プロパティを更新します。 要求に記載されていないプロパティは変更されません。 指定したコンテナーがまだ存在しない場合、更新は失敗します。
update(resource_group_name: str, account_name: str, container_name: str, blob_container: _models.BlobContainer, *, content_type: str = 'application/json', **kwargs: Any) -> _models.BlobContainer
パラメーター
- account_name
- str
指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ~ 24 文字で、数字と小文字のみを使用する必要があります。 必須です。
- container_name
- str
指定したストレージ アカウント内の BLOB コンテナーの名前。 BLOB コンテナー名の長さは 3 から 63 文字で、数字、小文字、ダッシュ (-) のみを使用する必要があります。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。 必須です。
- content_type
- str
Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。
- cls
- callable
直接応答が渡されるカスタム型または関数
戻り値
BlobContainer または cls(response) の結果
の戻り値の型 :
例外
属性
models
models = <module 'azure.mgmt.storage.v2021_09_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\storage\\v2021_09_01\\models\\__init__.py'>
Azure SDK for Python