BaseBlobService クラス
これは、BLOB リソースを管理するメイン クラスです。
BLOB Service は、クラウドに BLOB としてテキストおよびバイナリ データを格納します。 BLOB サービスで提供されるリソースは、ストレージ アカウント、コンテナー、および BLOB の 3 種類です。 ストレージ アカウント内では、コンテナーは一連の BLOB を整理するための手段となります。 詳細については、以下を参照してください。 https://msdn.microsoft.com/en-us/library/azure/ee691964.aspx
:type ~azure.storage.common.TokenCredential
- 継承
-
BaseBlobService
コンストラクター
BaseBlobService(account_name=None, account_key=None, sas_token=None, is_emulated=False, protocol='https', endpoint_suffix='core.windows.net', custom_domain=None, request_session=None, connection_string=None, socket_timeout=None, token_credential=None)パラメーター
- account_name
- str
ストレージ アカウント名。 これは、アカウント キーで署名された要求を認証し、ストレージ エンドポイントを構築するために使用されます。 接続文字列を指定しない限り、または匿名認証でカスタム ドメインを使用する場合は必須です。
- account_key
- str
ストレージ アカウント キー。 これは、共有キー認証に使用されます。 アカウント キーまたは sas トークンが指定されていない場合は、匿名アクセスが使用されます。
- sas_token
- str
アカウント キーの代わりに要求を認証するために使用する共有アクセス署名トークン。 アカウント キーと sas トークンの両方が指定されている場合は、アカウント キーを使用して署名します。 どちらも指定しない場合は、匿名アクセスが使用されます。
- is_emulated
- bool
エミュレーターを使用するかどうか。 既定値は False です。 を指定すると、接続文字列と要求セッション以外の他のすべてのパラメーターがオーバーライドされます。
- endpoint_suffix
- str
URL のホスト ベース コンポーネントからアカウント名を引いた値。 既定値は Azure (core.windows.net)。 これをオーバーライドして、China クラウド (core.chinacloudapi.cn) を使用します。
- request_session
- <xref:requests.Session>
http 要求に使用するセッション オブジェクト。
- connection_string
- str
指定すると、要求セッション以外の他のすべてのパラメーターがオーバーライドされます。 接続文字列形式については、以下を参照してくださいhttp://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/。
- socket_timeout
- int
指定すると、既定のソケット タイムアウトがオーバーライドされます。 指定されたタイムアウトは秒単位です。 既定値については、「_constants.py のDEFAULT_SOCKET_TIMEOUT」を参照してください。
- token_credential
HTTPS 要求を認証するために使用されるトークン資格情報。 トークン値は、有効期限の前に更新する必要があります。
変数
- MAX_SINGLE_GET_SIZE
- int
max_connectionsが 1 より大きい場合、最初の範囲のサイズは get_blob_to_* メソッドによって実行されます。 BLOB がこれより小さい場合は、より少ないデータが返されます。
- MAX_CHUNK_GET_SIZE
- int
max_connectionsが 1 より大きく、BLOB がMAX_SINGLE_GET_SIZEより大きい場合、後続の範囲のサイズは get_blob_to_* メソッドによって実行されます。 BLOB の残りの部分がこれより小さい場合は、少ないデータが返されます。 これが 4 MB を超えるに設定されている場合、content_validationは有効になっている場合にエラーをスローします。 ただし、content_validationが望ましくない場合は、4MBを超えるサイズが最適である可能性があります。 これを 4 MB 未満に設定することはお勧めしません。
- key_encryption_key
- object
ユーザーが必要に応じて提供する key-encryption-key。 指定した場合は、 を使用して、サポートされているメソッドで暗号化/暗号化解除を行います。 復号化を必要とするメソッドの場合は、key_encryption_keyまたはリゾルバーを指定する必要があります。 両方を指定すると、競合回避モジュールが優先されます。 暗号化を必要とする API には、次のメソッドを実装する必要があります。wrap_key(key)、ユーザーが選択したアルゴリズムを使用して、指定したキー (バイト) をラップします。 暗号化されたキーをバイトとして返します。 get_key_wrap_algorithm()は、指定した対称キーをラップするために使用されるアルゴリズムを返します。 get_kid()は、このキー暗号化キーの文字列キー ID を返します。 復号化を必要とする API には、次のメソッドを実装する必要があります。unwrap_key(key, algorithm)、文字列指定アルゴリズムを使用して、指定された対称キーのラップされていない形式を返します。 get_kid()は、このキー暗号化キーの文字列キー ID を返します。
- key_resolver_function
- kid) (<xref:function>
ユーザーが必要に応じて提供するキーを解決する関数。 指定されている場合は、 を使用して、サポートされているメソッドで暗号化を解除します。 復号化を必要とするメソッドの場合は、key_encryption_keyまたはリゾルバーを指定する必要があります。 両方が指定されている場合は、競合回避モジュールが優先されます。 kid 文字列を使用して、上記で定義したインターフェイスを実装するキー暗号化キーを返します。
- require_encryption
- bool
すべてのメッセージがキューに正常にアップロードされ、キューからダウンロードおよび正常に読み取られたすべてのメッセージが、サーバー上で暗号化/暗号化されていることを確認するために設定できるフラグ。 このフラグが設定されている場合は、暗号化/復号化に必要なすべてのパラメーターを指定する必要があります。 key_encryption_keyと競合回避モジュールについては、上記のコメントを参照してください。
メソッド
| abort_copy_blob |
保留中のcopy_blob操作を中止し、転送先 BLOB の長さと完全なメタデータを残します。 |
| acquire_blob_lease |
新しいリースを要求します。 BLOB にアクティブなリースがない場合、BLOB サービスはその BLOB のリースを作成し、新しいリース ID を返します。 |
| acquire_container_lease |
新しいリースを要求します。 コンテナーにアクティブなリースがない場合、BLOB Service はそのコンテナーのリースを作成し、新しいリース ID を返します。 |
| batch_delete_blobs |
複数の BLOB 削除要求のバッチを送信します。 BLOB 削除メソッドは、指定された BLOB またはスナップショットを削除します。 BLOB を削除すると、そのすべてのスナップショットも削除されることに注意してください。 詳細については、https://docs.microsoft.com/rest/api/storageservices/delete-blob を参照してください。 |
| break_blob_lease |
BLOB にアクティブなリースがある場合は、リースを中断します。 いったん中断したリースは更新できません。 承認済みの要求によってリースを中断できます。要求で一致するリース ID を指定する必要はありません。 リースが切断されると、リースの中断期間が経過することが許可され、その間、BLOB に対して中断と解放を除くリース操作を実行できません。 リースが正常に中断されると、応答で新しいリースを取得できるようになるまでの時間 (秒単位) が示されます。 中断されたリースを解放することもできます。この場合、別のクライアントがその BLOB のリースをすぐに取得できます。 |
| break_container_lease |
コンテナーにアクティブなリースがある場合は、リースを中断します。 いったん中断したリースは更新できません。 承認済みの要求によってリースを中断できます。要求で一致するリース ID を指定する必要はありません。 リースが切断されると、リース中断期間が経過することが許可され、その間、コンテナーで中断と解放を除くリース操作を実行することはできません。 リースが正常に中断されると、応答で新しいリースを取得できるようになるまでの時間 (秒単位) が示されます。 |
| change_blob_lease |
アクティブなリースのリース ID を変更します。 変更には、現在のリース ID と新しいリース ID を含める必要があります。 |
| change_container_lease |
アクティブなリースのリース ID を変更します。 変更には、現在のリース ID と新しいリース ID を含める必要があります。 |
| copy_blob |
BLOB を非同期的にコピーします。 この操作は、コピー操作をチェックまたは中止するために使用できるコピー ID を含む、コピー操作のプロパティ オブジェクトを返します。 BLOB サービスは、ベストエフォート方式で BLOB をコピーします。 コピー操作のソース BLOB は、ブロック BLOB、追加 BLOB、またはページ BLOB のいずれかです。 コピー先 BLOB が既に存在する場合、コピー元 BLOB と同じ BLOB の種類である必要があります。 既存のコピー先 BLOB はすべて上書きされます。 コピー先 BLOB は、コピー操作の進行中は変更できません。 ページ BLOB からコピーする場合、BLOB サービスは、ソース BLOB の長さのコピー先ページ BLOB を作成し、最初はすべてのゼロを含みます。 その後、コピー元ページの範囲が列挙され、空以外の範囲がコピーされます。 ブロック BLOB または追加 BLOB の場合、BLOB サービスは、この操作から戻る前に長さが 0 のコミット済み BLOB を作成します。 ブロック BLOB からコピーすると、コミットされたすべてのブロックとそのブロック ID がコピーされます。 コミットされていないブロックはコピーされません。 コピー操作の最後に、コピー先 BLOB のコミット済みブロック数はソースと同じになります。 追加 BLOB からコピーすると、コミットされたすべてのブロックがコピーされます。 コピー操作の最後に、コピー先 BLOB のコミット済みブロック数はソースと同じになります。 すべての BLOB の種類について、コピー先 BLOB のget_blob_propertiesを呼び出して、コピー操作の状態をチェックできます。 コピーが完了すると、最終 BLOB がコミットされます。 |
| create_container |
指定したアカウントの下に新しいコンテナーを作成します。 同じ名前のコンテナーが既に存在する場合、fail_on_existが True の場合、操作は失敗します。 |
| delete_blob |
指定した BLOB またはスナップショットを削除対象としてマークします。 BLOB は、後でガベージ コレクション中に削除されます。 BLOB を削除するには、そのスナップショットをすべて削除する必要があります。 BLOB の削除操作を使用して、両方を同時に削除できます。 サービスに対して削除アイテム保持ポリシーが有効になっている場合、この操作は、BLOB またはスナップショットを論理的に削除し、指定した日数にわたって BLOB またはスナップショットを保持します。 指定した日数が経過すると、ガベージ コレクション中に BLOB のデータがサービスから削除されます。 論理的に削除された BLOB またはスナップショットには、include=Include.Deleted オプションを指定する List Blobs API を使用してアクセスできます。 論理的に削除された BLOB またはスナップショットは、Undelete API を使用して復元できます。 |
| delete_container |
指定したコンテナーに削除のマークを付けます。 コンテナーとその中に含まれている BLOB は、後でガベージ コレクション中に削除されます。 |
| exists |
コンテナーが存在するかどうかを示すブール値 (blob_name が None の場合) を返します。それ以外の場合は、BLOB が存在するかどうかを示すブール値を返します。 |
| extract_date_and_request_id | |
| generate_account_shared_access_signature |
BLOB サービスの共有アクセス署名を生成します。 返されたシグネチャは、BlobService の sas_token パラメーターと共に使用します。 |
| generate_blob_shared_access_signature |
BLOB またはそのスナップショットの 1 つに対する共有アクセス署名を生成します。 返されたシグネチャは、BlobService の sas_token パラメーターと共に使用します。 |
| generate_container_shared_access_signature |
コンテナーの共有アクセス署名を生成します。 返されたシグネチャは、任意の BlobService の sas_token パラメーターと共に使用します。 |
| get_blob_account_information |
ストレージ アカウントに関連する情報を取得します。 ユーザーがコンテナーまたは BLOB への SAS を持っている場合も、情報を取得できます。 |
| get_blob_metadata |
指定した BLOB またはスナップショットのすべてのユーザー定義メタデータを返します。 |
| get_blob_properties |
BLOB のすべてのユーザー定義メタデータ、標準 HTTP プロパティ、およびシステム プロパティを返します。 BLOB のコンテンツは返しません。 と メタデータ ディBlobBlobPropertiesクテーションを返します。 |
| get_blob_service_properties |
Azure Storage Analyticsを含むストレージ アカウントの BLOB サービスのプロパティを取得します。 |
| get_blob_service_stats |
BLOB Service のレプリケーションに関連する統計情報を取得します。 これは、ストレージ アカウントに対して読み取りアクセス geo 冗長レプリケーションが有効になっている場合にのみ使用できます。 地理冗長レプリケーションでは、Azure ストレージによって 2 か所でデータの持続性が維持されます。 両方の場所で、Azure ストレージは継続的にデータの複数の正常なレプリカを維持します。 データの読み取り、作成、更新、または削除を行う場所は、1 次ストレージ アカウント拠点です。 プライマリの場所は、Azure Management Azure クラシック ポータル (米国中北部など) を使用してアカウントを作成するときに選択したリージョンに存在します。 データのレプリケート先の場所が、2 次拠点です。 2 次拠点は 1 次拠点の場所に基づいて自動的に決められ、1 次拠点と同じ地域にある 2 つ目のデータ センター内に設定されます。 読み取りアクセスの地理冗長レプリケーションがストレージ アカウントで有効な場合は、2 次拠点から読み取り専用アクセスを使用できます。 |
| get_blob_to_bytes |
BLOB をバイト配列としてダウンロードし、自動チャンクと進行状況通知を使用します。 プロパティ、メタデータ、およびコンテンツを含む の Blob インスタンスを返します。 |
| get_blob_to_path |
BLOB をファイル パスにダウンロードし、自動チャンクと進行状況通知を使用します。 プロパティとメタデータを含む の Blob インスタンスを返します。 |
| get_blob_to_stream |
自動チャンクと進行状況通知を使用して、BLOB をストリームにダウンロードします。 プロパティとメタデータを含む の Blob インスタンスを返します。 |
| get_blob_to_text |
自動チャンクと進行状況通知を使用して、BLOB を Unicode テキストとしてダウンロードします。 プロパティ、メタデータ、およびコンテンツを含む の Blob インスタンスを返します。 |
| get_container_acl |
指定したコンテナーのアクセス許可を取得します。 アクセス許可は、コンテナー データがパブリックにアクセス可能かどうかを示します。 |
| get_container_metadata |
指定したコンテナーのすべてのユーザー定義メタデータを返します。 |
| get_container_properties |
指定したコンテナーのすべてのユーザー定義メタデータとシステム プロパティを返します。 返されるデータにコンテナーの BLOB 一覧は含まれません。 |
| get_user_delegation_key |
SAS トークンに署名するために、ユーザー委任キーを取得します。 この要求を成功させるには、サービス オブジェクトにトークン資格情報が存在する必要があります。 |
| list_blob_names |
指定したコンテナーの下の BLOB 名を一覧表示するジェネレーターを返します。 ジェネレーターは、サービスによって返された継続トークンに遅れて従い、すべての BLOB が返されるか、num_resultsに達したときに停止します。 num_resultsを指定し、アカウントに BLOB の数を超える値が含まれている場合、ジェネレーターは完了するとnext_markerフィールドが設定されます。 より多くの結果が必要な場合は、このマーカーを使用して新しいジェネレーターを作成できます。 |
| list_blobs |
指定したコンテナーの下にある BLOB を一覧表示するジェネレーターを返します。 ジェネレーターは、サービスによって返された継続トークンに遅れて従い、すべての BLOB が返されるか、num_resultsに達したときに停止します。 num_resultsを指定し、アカウントに BLOB の数を超える値が含まれている場合、ジェネレーターは完了するとnext_markerフィールドが設定されます。 より多くの結果が必要な場合は、このマーカーを使用して新しいジェネレーターを作成できます。 |
| list_containers |
指定したアカウントのコンテナーを一覧表示するジェネレーターを返します。 ジェネレーターは、サービスによって返された継続トークンに遅れて従い、すべてのコンテナーが返されるか、num_resultsに達したときに停止します。 num_resultsを指定し、アカウントにコンテナーの数を超える数が含まれている場合、ジェネレーターは完了するとnext_markerフィールドが設定されます。 より多くの結果が必要な場合は、このマーカーを使用して新しいジェネレーターを作成できます。 |
| make_blob_url |
BLOB にアクセスする URL を作成します。 |
| make_container_url |
コンテナーにアクセスするための URL を作成します。 |
| release_blob_lease |
リースを解放します。 要求で指定したリース ID が BLOB に関連付けられているリース ID と一致する場合、リースを解放できます。 リースを解放すると、解放が完了した直後から、別のクライアントがその BLOB のリースを取得できるようになります。 |
| release_container_lease |
リースを解放します。 指定したlease_idがコンテナーに関連付けられていると一致する場合、リースが解放される可能性があります。 リースを解放すると、解放が完了した直後から、別のクライアントがそのコンテナーのリースを取得できるようになります。 |
| renew_blob_lease |
リースを更新します。 要求で指定したリース ID が BLOB に関連付けられているリース ID と一致する場合、リースを更新できます。 リースの有効期限が切れていても、そのリースの期限切れ以降に BLOB が変更されたり、再度リースされたりしていなければ、リースを更新できます。 リースを更新すると、リース期間の時間がリセットされます。 |
| renew_container_lease |
リースを更新します。 指定されたリース ID がコンテナーに関連付けられているリース ID と一致する場合は、リースを更新できます。 リースの有効期限が切れていても、そのリースの期限切れ以降にコンテナーが再度リースされていなければ、リースを更新できます。 リースを更新すると、リース期間の時間がリセットされます。 |
| set_blob_metadata |
1 つまたは複数の名前と値のペアとして指定された BLOB のユーザー定義メタデータを設定します。 |
| set_blob_properties |
BLOB のシステム プロパティを設定します。 content_settingsに 1 つのプロパティが設定されている場合、すべてのプロパティがオーバーライドされます。 |
| set_blob_service_properties |
Azure Storage Analyticsを含むストレージ アカウントの BLOB サービスのプロパティを設定します。 要素 (ログ記録など) が None のままの場合、その機能に対するサービスの既存の設定は保持されます。 |
| set_container_acl |
Shared Access Signature で使用できる、指定したコンテナーまたは格納されているアクセス ポリシーのアクセス許可を設定します。 アクセス許可は、コンテナー内の BLOB がパブリックにアクセス可能かどうかを示します。 |
| set_container_metadata |
指定したコンテナーの 1 つ以上のユーザー定義の名前と値のペアを設定します。 この操作を呼び出すと、その都度、コンテナーに関連付けられている既存のメタデータがすべて置き換えられます。 コンテナーからすべてのメタデータを削除するには、メタデータ ディクテーションなしでこの操作を呼び出します。 |
| set_proxy |
HTTP CONNECT トンネリングのプロキシ サーバー ホストとポートを設定します。 |
| snapshot_blob |
BLOB の読み取り専用のスナップショットを作成します。 |
| undelete_blob |
削除を取り消す BLOB 操作は、論理的に削除された BLOB またはスナップショットの内容とメタデータを復元します。 論理的に削除されていない BLOB またはスナップショットの削除を取り消そうとしても、変更は行われません。 |
abort_copy_blob
保留中のcopy_blob操作を中止し、転送先 BLOB の長さと完全なメタデータを残します。
abort_copy_blob(container_name, blob_name, copy_id, lease_id=None, timeout=None)パラメーター
acquire_blob_lease
新しいリースを要求します。 BLOB にアクティブなリースがない場合、BLOB サービスはその BLOB のリースを作成し、新しいリース ID を返します。
acquire_blob_lease(container_name, blob_name, lease_duration=-1, proposed_lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)パラメーター
- lease_duration
- int
リース期間 (秒単位) を指定します。無期限のリースには -1 を指定します。 無限リースでない場合は、15 ～ 60 秒を指定できます。 更新または変更を使用してリース期間を変更することはできません。 既定値は -1 (無限リース) です。
- proposed_lease_id
- str
GUID 文字列形式の推奨リース ID。 提案されたリース ID が正しい形式でない場合、BLOB サービスは 400 (無効な要求) を返します。
- if_modified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した時刻以降にリソースが変更されている場合に限り操作が実行されます。
- if_unmodified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した日付/時刻以降にリソースが変更されていない場合に限り操作が実行されます。
- if_none_match
- str
ETag 値、またはワイルドカード文字 ()。リソースの ETag が指定された値と一致しない場合にのみ、このヘッダーを指定して操作を実行します。ワイルドカード文字 () を指定して、リソースが存在しない場合にのみ操作を実行し、存在する場合は操作を失敗させます。
戻り値
str
acquire_container_lease
新しいリースを要求します。 コンテナーにアクティブなリースがない場合、BLOB Service はそのコンテナーのリースを作成し、新しいリース ID を返します。
acquire_container_lease(container_name, lease_duration=-1, proposed_lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)パラメーター
- lease_duration
- int
リース期間 (秒単位) を指定します。無期限のリースには -1 を指定します。 無限リースでない場合は、15 ～ 60 秒を指定できます。 更新または変更を使用してリース期間を変更することはできません。 既定値は -1 (無限リース) です。
- proposed_lease_id
- str
GUID 文字列形式の推奨リース ID。 提案されたリース ID が正しい形式でない場合、BLOB サービスは 400 (無効な要求) を返します。
- if_modified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した時刻以降にリソースが変更されている場合に限り操作が実行されます。
- if_unmodified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した日付/時刻以降にリソースが変更されていない場合に限り操作が実行されます。
戻り値
str
batch_delete_blobs
複数の BLOB 削除要求のバッチを送信します。
BLOB 削除メソッドは、指定された BLOB またはスナップショットを削除します。 BLOB を削除すると、そのすべてのスナップショットも削除されることに注意してください。 詳細については、https://docs.microsoft.com/rest/api/storageservices/delete-blob を参照してください。
batch_delete_blobs(batch_delete_sub_requests, timeout=None)パラメーター
戻り値
解析されたバッチ削除 HTTP 応答
の戻り値の型 :
break_blob_lease
BLOB にアクティブなリースがある場合は、リースを中断します。 いったん中断したリースは更新できません。 承認済みの要求によってリースを中断できます。要求で一致するリース ID を指定する必要はありません。 リースが切断されると、リースの中断期間が経過することが許可され、その間、BLOB に対して中断と解放を除くリース操作を実行できません。 リースが正常に中断されると、応答で新しいリースを取得できるようになるまでの時間 (秒単位) が示されます。
中断されたリースを解放することもできます。この場合、別のクライアントがその BLOB のリースをすぐに取得できます。
break_blob_lease(container_name, blob_name, lease_break_period=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)パラメーター
- lease_break_period
- int
中断操作の場合、これは、リースが中断されるまでに継続する必要がある、0 から 60 秒の間で提案された秒数です。 この中断期間は、リースの残り時間よりも短い場合にのみ使用されます。 長い場合は、リースの残り時間が使用されます。 中断期間が終了するまで新しいリースは使用できなくなりますが、中断期間よりも長い期間リースが保持される場合があります。 このヘッダーが中断操作で表示されない場合は、残存リース期間が経過した後に固定期間のリースが中断され、無限リースが直ちに中断されます。
- if_modified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した時刻以降にリソースが変更されている場合に限り操作が実行されます。
- if_unmodified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した日付/時刻以降にリソースが変更されていない場合に限り操作が実行されます。
- if_none_match
- str
ETag 値、またはワイルドカード文字 ()。リソースの ETag が指定した値と一致しない場合にのみ、このヘッダーを指定して操作を実行します。ワイルドカード文字 () を指定して、リソースが存在しない場合にのみ操作を実行し、存在する場合は操作を失敗させます。
戻り値
INT
break_container_lease
コンテナーにアクティブなリースがある場合は、リースを中断します。 いったん中断したリースは更新できません。 承認済みの要求によってリースを中断できます。要求で一致するリース ID を指定する必要はありません。 リースが切断されると、リース中断期間が経過することが許可され、その間、コンテナーで中断と解放を除くリース操作を実行することはできません。 リースが正常に中断されると、応答で新しいリースを取得できるようになるまでの時間 (秒単位) が示されます。
break_container_lease(container_name, lease_break_period=None, if_modified_since=None, if_unmodified_since=None, timeout=None)パラメーター
- lease_break_period
- int
これは、0 ~ 60 秒の間にリースが中断されるまでにリースを続行する必要がある、提案された秒数です。 この中断期間は、リースの残り時間よりも短い場合にのみ使用されます。 長い場合は、リースの残り時間が使用されます。 中断期間が終了するまで新しいリースは使用できなくなりますが、中断期間よりも長い期間リースが保持される場合があります。 このヘッダーが中断操作で表示されない場合は、残存リース期間が経過した後に固定期間のリースが中断され、無限リースが直ちに中断されます。
- if_modified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した時刻以降にリソースが変更されている場合に限り操作が実行されます。
- if_unmodified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した日付/時刻以降にリソースが変更されていない場合に限り操作が実行されます。
戻り値
INT
change_blob_lease
アクティブなリースのリース ID を変更します。 変更には、現在のリース ID と新しいリース ID を含める必要があります。
change_blob_lease(container_name, blob_name, lease_id, proposed_lease_id, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)パラメーター
- if_modified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した時刻以降にリソースが変更されている場合に限り操作が実行されます。
- if_unmodified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した日付/時刻以降にリソースが変更されていない場合に限り操作が実行されます。
- if_none_match
- str
ETag 値、またはワイルドカード文字 ()。リソースの ETag が指定した値と一致しない場合にのみ、このヘッダーを指定して操作を実行します。ワイルドカード文字 () を指定して、リソースが存在しない場合にのみ操作を実行し、存在する場合は操作を失敗させます。
change_container_lease
アクティブなリースのリース ID を変更します。 変更には、現在のリース ID と新しいリース ID を含める必要があります。
change_container_lease(container_name, lease_id, proposed_lease_id, if_modified_since=None, if_unmodified_since=None, timeout=None)パラメーター
- if_modified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した時刻以降にリソースが変更されている場合に限り操作が実行されます。
- if_unmodified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した日付/時刻以降にリソースが変更されていない場合に限り操作が実行されます。
copy_blob
BLOB を非同期的にコピーします。 この操作は、コピー操作をチェックまたは中止するために使用できるコピー ID を含む、コピー操作のプロパティ オブジェクトを返します。 BLOB サービスは、ベストエフォート方式で BLOB をコピーします。
コピー操作のソース BLOB は、ブロック BLOB、追加 BLOB、またはページ BLOB のいずれかです。 コピー先 BLOB が既に存在する場合、コピー元 BLOB と同じ BLOB の種類である必要があります。 既存のコピー先 BLOB はすべて上書きされます。 コピー先 BLOB は、コピー操作の進行中は変更できません。
ページ BLOB からコピーする場合、BLOB サービスは、ソース BLOB の長さのコピー先ページ BLOB を作成し、最初はすべてのゼロを含みます。 その後、コピー元ページの範囲が列挙され、空以外の範囲がコピーされます。
ブロック BLOB または追加 BLOB の場合、BLOB サービスは、この操作から戻る前に長さが 0 のコミット済み BLOB を作成します。 ブロック BLOB からコピーすると、コミットされたすべてのブロックとそのブロック ID がコピーされます。 コミットされていないブロックはコピーされません。 コピー操作の最後に、コピー先 BLOB のコミット済みブロック数はソースと同じになります。
追加 BLOB からコピーすると、コミットされたすべてのブロックがコピーされます。 コピー操作の最後に、コピー先 BLOB のコミット済みブロック数はソースと同じになります。
すべての BLOB の種類について、コピー先 BLOB のget_blob_propertiesを呼び出して、コピー操作の状態をチェックできます。 コピーが完了すると、最終 BLOB がコミットされます。
copy_blob(container_name, blob_name, copy_source, metadata=None, source_if_modified_since=None, source_if_unmodified_since=None, source_if_match=None, source_if_none_match=None, destination_if_modified_since=None, destination_if_unmodified_since=None, destination_if_match=None, destination_if_none_match=None, destination_lease_id=None, source_lease_id=None, timeout=None)パラメーター
- copy_source
- str
Azure ファイルまたは BLOB を指定する最大 2 KB の長さの URL。 この値は要求 URI に含まれるため、URL でエンコードされる必要があります。 ソースが別のアカウントにある場合、ソースはパブリックであるか、共有アクセス署名を介して認証される必要があります。 ソースがパブリックの場合、認証は必要ありません。 例: https://myaccount.blob.core.windows.net/mycontainer/myblobhttps://myaccount.blob.core.windows.net/mycontainer/myblob?スナップショット=https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken
BLOB にメタデータとして関連付ける名前と値のペア。 名前と値のペアが指定されていない場合、操作によって、ソース BLOB またはファイルからコピー先 BLOB にメタデータがコピーされます。 1 つ以上の名前と値のペアが指定されている場合、ターゲット BLOB は指定されたメタデータで作成され、メタデータはソース BLOB またはファイルからコピーされません。
- source_if_modified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 この条件ヘッダーを指定すると、コピー元 BLOB が指定した日付/時刻以降に変更された場合にのみ BLOB がコピーされます。
- source_if_unmodified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 この条件ヘッダーを指定すると、コピー元 BLOB が指定した日付/時刻以降に変更されなかった場合にのみ BLOB がコピーされます。
- source_if_match
- <xref:ETag>
ETag 値またはワイルドカード文字 (*)。 この条件ヘッダーを指定すると、ETag が指定した値に一致する場合にのみコピー元 BLOB がコピーされます。 ETag 値が一致しない場合、BLOB サービスはステータス コード 412 (Precondition Failed) を返します。 ソースが Azure ファイルの場合、このヘッダーを指定できません。
- source_if_none_match
- <xref:ETag>
ETag 値またはワイルドカード文字 (*)。 この条件ヘッダーを指定すると、ETag が指定した値に一致しない場合にのみ BLOB がコピーされます。 値が一致する場合、BLOB Service はステータス コード 412 (Precondition Failed) を返します。 ソースが Azure ファイルの場合、このヘッダーを指定できません。
- destination_if_modified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 この条件ヘッダーを指定すると、コピー先 BLOB が指定した日付/時刻以降に変更された場合にのみ BLOB がコピーされます。 コピー先 BLOB が変更されていない場合、BLOB Service はステータス コード 412 (Precondition Failed) を返します。
- destination_if_unmodified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 この条件ヘッダーを指定すると、コピー先 BLOB が指定した日付/時刻以降に変更されなかった場合にのみ BLOB がコピーされます。 コピー先 BLOB が変更されている場合、BLOB サービスはステータス コード 412 (Precondition Failed) を返します。
- destination_if_match
- <xref:ETag>
ETag 値またはワイルドカード文字 (*)。 指定した ETag 値が既存のターゲット BLOB の ETag 値と一致する場合にのみ、この条件付きヘッダーに ETag 値を指定して BLOB をコピーします。 宛先 BLOB の ETag が If-Match に指定された ETag と一致しない場合、BLOB サービスは状態コード 412 (前提条件に失敗しました) を返します。
- destination_if_none_match
- <xref:ETag>
ETag 値、またはワイルドカード文字 ()。指定した ETag 値がターゲット BLOB の ETag 値と一致しない場合にのみ、この条件付きヘッダーに ETag 値を指定して BLOB をコピーします。対象の BLOB が存在しない場合にのみ操作を実行するには、ワイルドカード文字 () を指定します。 指定した条件を満たしていない場合、BLOB サービスはステータス コード 412 (Precondition Failed) を返します。
- destination_lease_id
- str
このヘッダーに指定するリース ID は、コピー先 BLOB のリース ID と一致している必要があります。 要求にリース ID が含まれていないか、リース ID が無効な場合、操作はステータス コード 412 (Precondition Failed) で失敗します。
- source_lease_id
- str
指定したリース ID がソース BLOB のアクティブなリース ID と一致する場合にのみ、BLOB のコピー操作を実行するには、これを指定します。
戻り値
状態、ソース、ID などのコピー操作のプロパティ。
の戻り値の型 :
create_container
指定したアカウントの下に新しいコンテナーを作成します。 同じ名前のコンテナーが既に存在する場合、fail_on_existが True の場合、操作は失敗します。
create_container(container_name, metadata=None, public_access=None, fail_on_exist=False, timeout=None)パラメーター
- container_name
- str
作成するコンテナーの名前。 コンテナー名には小文字、数字、ハイフンのみを含め、文字または数字で始まる必要があります。 各ハイフンの前後にはハイフン以外の文字を指定する必要があります。 また、名前は 3 から 63 文字で指定する必要があります。
戻り値
コンテナーが作成されている場合は True、コンテナーが既に存在する場合は False。
の戻り値の型 :
delete_blob
指定した BLOB またはスナップショットを削除対象としてマークします。 BLOB は、後でガベージ コレクション中に削除されます。
BLOB を削除するには、そのスナップショットをすべて削除する必要があります。 BLOB の削除操作を使用して、両方を同時に削除できます。
サービスに対して削除アイテム保持ポリシーが有効になっている場合、この操作は、BLOB またはスナップショットを論理的に削除し、指定した日数にわたって BLOB またはスナップショットを保持します。 指定した日数が経過すると、ガベージ コレクション中に BLOB のデータがサービスから削除されます。 論理的に削除された BLOB またはスナップショットには、include=Include.Deleted オプションを指定する List Blobs API を使用してアクセスできます。 論理的に削除された BLOB またはスナップショットは、Undelete API を使用して復元できます。
delete_blob(container_name, blob_name, snapshot=None, lease_id=None, delete_snapshots=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)パラメーター
- if_modified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した時刻以降にリソースが変更されている場合に限り操作が実行されます。
- if_unmodified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した日付/時刻以降にリソースが変更されていない場合に限り操作が実行されます。
- if_none_match
- str
ETag 値、またはワイルドカード文字 ()。リソースの ETag が指定された値と一致しない場合にのみ、このヘッダーを指定して操作を実行します。ワイルドカード文字 () を指定して、リソースが存在しない場合にのみ操作を実行し、存在する場合は操作を失敗させます。
delete_container
指定したコンテナーに削除のマークを付けます。 コンテナーとその中に含まれている BLOB は、後でガベージ コレクション中に削除されます。
delete_container(container_name, fail_not_exist=False, lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)パラメーター
- lease_id
- str
指定した場合、delete_containerはコンテナーのリースがアクティブで、この ID と一致する場合にのみ成功します。 コンテナーにアクティブなリースがある場合は必須です。
- if_modified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した時刻以降にリソースが変更されている場合に限り操作が実行されます。
- if_unmodified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した日付/時刻以降にリソースが変更されていない場合に限り操作が実行されます。
戻り値
コンテナーが削除された場合は True、False コンテナーは存在しません。
の戻り値の型 :
exists
コンテナーが存在するかどうかを示すブール値 (blob_name が None の場合) を返します。それ以外の場合は、BLOB が存在するかどうかを示すブール値を返します。
exists(container_name, blob_name=None, snapshot=None, timeout=None)パラメーター
戻り値
リソースが存在するかどうかを示すブール値。
の戻り値の型 :
extract_date_and_request_id
static extract_date_and_request_id(retry_context)パラメーター
- retry_context
generate_account_shared_access_signature
BLOB サービスの共有アクセス署名を生成します。 返されたシグネチャは、BlobService の sas_token パラメーターと共に使用します。
generate_account_shared_access_signature(resource_types, permission, expiry, start=None, ip=None, protocol=None)パラメーター
- resource_types
- <xref:ResourceTypes>
アカウント SAS でアクセスできるリソースの種類を指定します。
- permission
- <xref:AccountPermissions>
共有アクセス署名と関連付けられているアクセス許可。 ユーザーが使用できる操作は、アクセス許可によって許可されるものに制限されます。 このフィールドを含む格納されているアクセス ポリシーを参照する ID が指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。
共有アクセス署名が無効になる時刻。 このフィールドを含む格納されているアクセス ポリシーを参照する ID が指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。 Azure では常に値が UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。
共有アクセス署名が有効になる時刻。 省略した場合、この呼び出しの開始時刻はストレージ サービスが要求を受け取った時刻と見なされます。 Azure では常に値が UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。
- ip
- str
要求を受け入れる IP アドレスまたは IP アドレスの範囲を指定します。 要求の発信元の IP アドレスが SAS トークンで指定された IP アドレスまたはアドレス範囲と一致しない場合、要求は認証されません。 たとえば、SAS で sip=168.1.5.65 または sip=168.1.5.60-168.1.5.70 を指定すると、それらの IP アドレスに要求が制限されます。
戻り値
Shared Access Signature (sas) トークン。
の戻り値の型 :
generate_blob_shared_access_signature
BLOB またはそのスナップショットの 1 つに対する共有アクセス署名を生成します。 返されたシグネチャは、BlobService の sas_token パラメーターと共に使用します。
generate_blob_shared_access_signature(container_name, blob_name, snapshot=None, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None, user_delegation_key=None)パラメーター
- permission
- BlobPermissions
共有アクセス署名と関連付けられているアクセス許可。 ユーザーが使用できる操作は、アクセス許可によって許可されるものに制限されます。 アクセス許可は、読み取り、書き込み、削除、リストの順序付けである必要があります。 このフィールドを含む格納されているアクセス ポリシーを参照する ID が指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。
共有アクセス署名が無効になる時刻。 このフィールドを含む格納されているアクセス ポリシーを参照する ID が指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。 Azure では常に値が UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。
共有アクセス署名が有効になる時刻。 省略した場合、この呼び出しの開始時刻はストレージ サービスが要求を受け取った時刻と見なされます。 Azure では常に値が UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。
- id
- str
格納されているアクセス ポリシーに関連付けられる最大 64 文字の一意の値。 格納されているアクセス ポリシーを作成するには、 を使用 set_container_aclします。
- ip
- str
要求を受け入れる IP アドレスまたは IP アドレスの範囲を指定します。 要求の発信元の IP アドレスが SAS トークンで指定された IP アドレスまたはアドレス範囲と一致しない場合、要求は認証されません。 たとえば、SAS で sip=168.1.5.65 または sip=168.1.5.60-168.1.5.70 を指定すると、それらの IP アドレスに要求が制限されます。
- user_delegation_key
- UserDelegationKey
アカウント キーの代わりに、ユーザーはユーザー委任キーを渡すことができます。 AAD ID を使用して認証することで、サービスからユーザー委任キーを取得できます。これは、get_user_delegation_keyを呼び出すことによって実現できます。 存在する場合、SAS は代わりにユーザー委任キーで署名されます。
戻り値
Shared Access Signature (sas) トークン。
の戻り値の型 :
generate_container_shared_access_signature
コンテナーの共有アクセス署名を生成します。 返されたシグネチャは、任意の BlobService の sas_token パラメーターと共に使用します。
generate_container_shared_access_signature(container_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None, user_delegation_key=None)パラメーター
- permission
- ContainerPermissions
共有アクセス署名と関連付けられているアクセス許可。 ユーザーが使用できる操作は、アクセス許可によって許可されるものに制限されます。 アクセス許可は、読み取り、書き込み、削除、リストの順序付けである必要があります。 このフィールドを含む格納されているアクセス ポリシーを参照する ID が指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。
共有アクセス署名が無効になる時刻。 このフィールドを含む格納されているアクセス ポリシーを参照する ID が指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。 Azure では常に値が UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。
共有アクセス署名が有効になる時刻。 省略した場合、この呼び出しの開始時刻はストレージ サービスが要求を受け取った時刻と見なされます。 Azure では常に値が UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。
- id
- str
格納されているアクセス ポリシーに関連付けられる最大 64 文字の一意の値。 格納されているアクセス ポリシーを作成するには、set_blob_service_propertiesを使用します。
- ip
- str
要求を受け入れる IP アドレスまたは IP アドレスの範囲を指定します。 要求の発信元の IP アドレスが SAS トークンで指定された IP アドレスまたはアドレス範囲と一致しない場合、要求は認証されません。 たとえば、SAS で sip=168.1.5.65 または sip=168.1.5.60-168.1.5.70 を指定すると、要求はこれらの IP アドレスに制限されます。
- user_delegation_key
- UserDelegationKey
アカウント キーの代わりに、ユーザーはユーザー委任キーを渡すことができます。 ユーザー委任キーは、AAD ID を使用して認証することで、サービスから取得できます。これは、get_user_delegation_keyを呼び出すことによって実現できます。 存在する場合、SAS は代わりにユーザー委任キーで署名されます。
戻り値
Shared Access Signature (sas) トークン。
の戻り値の型 :
get_blob_account_information
ストレージ アカウントに関連する情報を取得します。 ユーザーがコンテナーまたは BLOB への SAS を持っている場合も、情報を取得できます。
get_blob_account_information(container_name=None, blob_name=None, timeout=None)パラメーター
戻り値
get_blob_metadata
指定した BLOB またはスナップショットのすべてのユーザー定義メタデータを返します。
get_blob_metadata(container_name, blob_name, snapshot=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)パラメーター
- if_modified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した時刻以降にリソースが変更されている場合に限り操作が実行されます。
- if_unmodified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した日付/時刻以降にリソースが変更されていない場合に限り操作が実行されます。
- if_none_match
- str
ETag 値、またはワイルドカード文字 ()。リソースの ETag が指定された値と一致しない場合にのみ、このヘッダーを指定して操作を実行します。ワイルドカード文字 () を指定して、リソースが存在しない場合にのみ操作を実行し、存在する場合は操作を失敗させます。
指定されたキーを使用して、サービス側のデータを復号化します。 お客様から提供されたキーの使用は、HTTPS 経由で行う必要があります。 暗号化キー自体が要求で提供されるため、キーを転送するにはセキュリティで保護された接続を確立する必要があります。
戻り値
BLOB メタデータ名と値のペアを表すディクショナリ。
の戻り値の型 :
get_blob_properties
BLOB のすべてのユーザー定義メタデータ、標準 HTTP プロパティ、およびシステム プロパティを返します。 BLOB のコンテンツは返しません。 と メタデータ ディBlobBlobPropertiesクテーションを返します。
get_blob_properties(container_name, blob_name, snapshot=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)パラメーター
- if_modified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した時刻以降にリソースが変更されている場合に限り操作が実行されます。
- if_unmodified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した日付/時刻以降にリソースが変更されていない場合に限り操作が実行されます。
- if_none_match
- str
ETag 値、またはワイルドカード文字 ()。リソースの ETag が指定された値と一致しない場合にのみ、このヘッダーを指定して操作を実行します。ワイルドカード文字 () を指定して、リソースが存在しない場合にのみ操作を実行し、存在する場合は操作を失敗させます。
指定されたキーを使用して、サービス側のデータを復号化します。 お客様から提供されたキーの使用は、HTTPS 経由で行う必要があります。 暗号化キー自体が要求で提供されるため、キーを転送するにはセキュリティで保護された接続を確立する必要があります。
戻り値
プロパティとメタデータを含む BLOB オブジェクト。
の戻り値の型 :
get_blob_service_properties
Azure Storage Analyticsを含むストレージ アカウントの BLOB サービスのプロパティを取得します。
get_blob_service_properties(timeout=None)パラメーター
戻り値
target_version プロパティがアタッチされた BLOB ServiceProperties 。
get_blob_service_stats
BLOB Service のレプリケーションに関連する統計情報を取得します。 これは、ストレージ アカウントに対して読み取りアクセス geo 冗長レプリケーションが有効になっている場合にのみ使用できます。
地理冗長レプリケーションでは、Azure ストレージによって 2 か所でデータの持続性が維持されます。 両方の場所で、Azure ストレージは継続的にデータの複数の正常なレプリカを維持します。 データの読み取り、作成、更新、または削除を行う場所は、1 次ストレージ アカウント拠点です。 プライマリの場所は、Azure Management Azure クラシック ポータル (米国中北部など) を使用してアカウントを作成するときに選択したリージョンに存在します。 データのレプリケート先の場所が、2 次拠点です。 2 次拠点は 1 次拠点の場所に基づいて自動的に決められ、1 次拠点と同じ地域にある 2 つ目のデータ センター内に設定されます。 読み取りアクセスの地理冗長レプリケーションがストレージ アカウントで有効な場合は、2 次拠点から読み取り専用アクセスを使用できます。
get_blob_service_stats(timeout=None)パラメーター
戻り値
BLOB サービスの統計情報です。
の戻り値の型 :
get_blob_to_bytes
BLOB をバイト配列としてダウンロードし、自動チャンクと進行状況通知を使用します。 プロパティ、メタデータ、およびコンテンツを含む の Blob インスタンスを返します。
get_blob_to_bytes(container_name, blob_name, snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)パラメーター
- start_range
- int
BLOB のセクションのダウンロードに使用するバイト範囲の先頭。 end_rangeが指定されていない場合は、start_rangeの後のすべてのバイトがダウンロードされます。 start_rangeパラメーターと end_range パラメーターは包括的です。 例: start_range=0、end_range=511 は最初の 512 バイトの BLOB をダウンロードします。
- end_range
- int
BLOB のセクションをダウンロードするために使用するバイト範囲の末尾。 end_rangeを指定する場合は、start_rangeを指定する必要があります。 start_rangeパラメーターと end_range パラメーターは包括的です。 例: start_range=0、end_range=511 は最初の 512 バイトの BLOB をダウンロードします。
- validate_content
- bool
true に設定されている場合は、BLOB の取得された各部分の MD5 ハッシュを検証します。 これは主に、https (既定値) として https ではなく http を使用して既に検証される場合に、ネットワーク上のビットフラグを検出する場合に重要です。 サービスは 4 MB 以下のチャンクに対してのみトランザクション MD5 を返すので、最初の get 要求のサイズは自己になります。自己ではなくMAX_CHUNK_GET_SIZE。MAX_SINGLE_GET_SIZE。 自己の場合。MAX_CHUNK_GET_SIZEが 4 MB を超えるに設定されている場合は、エラーがスローされます。 MD5 のコンピューティングには処理時間がかかり、チャンク サイズが小さくなるため、より多くの要求を行う必要があるため、待機時間が若干増加する可能性があります。
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
シグネチャ関数 (current, total) を使用した進行状況のコールバック。current はこれまでに転送されたバイト数で、total は既知の場合は BLOB のサイズです。
- max_connections
- int
2 以上に設定した場合、最初の取得は最初の自己に対して行われます。BLOB のMAX_SINGLE_GET_SIZEバイト数。 これが BLOB 全体の場合、メソッドはこの時点で を返します。 そうでない場合は、max_connectionsと等しいスレッドの数を使用して、残りのデータを並列にダウンロードします。 各チャンクのサイズは self になります。MAX_CHUNK_GET_SIZE。 1 に設定すると、1 つの大きな get 要求が実行されます。 これは一般的には推奨されませんが、使用するスレッドが非常に少ない場合、ネットワーク要求が非常に高価な場合、またはシーク不可能なストリームが並列ダウンロードを妨げる場合に使用できます。 これは、max_connectionsが 1 より大きい場合に空の BLOB に追加の要求が必要であるため、多くの BLOB が空であると予想される場合にも役立ちます。
- if_modified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した時刻以降にリソースが変更されている場合に限り操作が実行されます。
- if_unmodified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した日付/時刻以降にリソースが変更されていない場合に限り操作が実行されます。
- if_none_match
- str
ETag 値、またはワイルドカード文字 ()。リソースの ETag が指定した値と一致しない場合にのみ、このヘッダーを指定して操作を実行します。ワイルドカード文字 () を指定して、リソースが存在しない場合にのみ操作を実行し、存在する場合は操作を失敗させます。
指定したキーを使用して、サービス側のデータを復号化します。 顧客が指定したキーの使用は HTTPS 経由で行う必要があります。 暗号化キー自体が要求で提供されるため、キーを転送するにはセキュリティで保護された接続を確立する必要があります。
- timeout
- int
timeout パラメーターは、秒単位で表されます。 このメソッドは、Azure サービスに対して複数の呼び出しを行う場合があり、タイムアウトは各呼び出しに個別に適用されます。
戻り値
プロパティとメタデータを含む BLOB。 max_connectionsが 1 より大きい場合、content_md5 (BLOB に設定されている場合) は返されません。 この値が必要な場合は、get_blob_propertiesを使用するか、max_connectionsを 1 に設定します。
の戻り値の型 :
get_blob_to_path
BLOB をファイル パスにダウンロードし、自動チャンクと進行状況通知を使用します。 プロパティとメタデータを含む の Blob インスタンスを返します。
get_blob_to_path(container_name, blob_name, file_path, open_mode='wb', snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)パラメーター
- open_mode
- str
ファイルを開くときに使用するモード。 append のみをopen_mode指定すると、並列ダウンロードは実行できなくなることに注意してください。 そのため、このopen_modeを使用する場合は、max_connectionsを 1 に設定する必要があります。
- start_range
- int
BLOB のセクションのダウンロードに使用するバイト範囲の開始。 end_rangeが指定されていない場合は、start_rangeの後のすべてのバイトがダウンロードされます。 start_rangeパラメーターと end_range パラメーターは包括的です。 例: start_range=0、end_range=511 は最初の 512 バイトの BLOB をダウンロードします。
- end_range
- int
BLOB のセクションのダウンロードに使用するバイト範囲の末尾。 end_rangeを指定する場合は、start_rangeを指定する必要があります。 start_rangeパラメーターと end_range パラメーターは包括的です。 例: start_range=0、end_range=511 は最初の 512 バイトの BLOB をダウンロードします。
- validate_content
- bool
true に設定されている場合は、BLOB の取得された各部分の MD5 ハッシュを検証します。 これは主に、https (既定値) として https ではなく http を使用して既に検証される場合に、ネットワーク上のビットフラグを検出する場合に重要です。 サービスは 4 MB 以下のチャンクに対してのみトランザクション MD5 を返すので、最初の get 要求のサイズは自己になります。自己ではなくMAX_CHUNK_GET_SIZE。MAX_SINGLE_GET_SIZE。 自己の場合。MAX_CHUNK_GET_SIZEが 4 MB を超えるに設定されている場合は、エラーがスローされます。 MD5 のコンピューティングには処理時間がかかり、チャンク サイズが小さくなるため、より多くの要求を行う必要があるため、待機時間が若干増加する可能性があります。
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
シグネチャ関数 (current, total) を使用した進行状況のコールバック。current はこれまでに転送されたバイト数で、total は既知の場合は BLOB のサイズです。
- max_connections
- int
2 以上に設定した場合、最初の取得は最初の自己に対して行われます。BLOB のMAX_SINGLE_GET_SIZEバイト数。 これが BLOB 全体の場合、メソッドはこの時点で を返します。 そうでない場合は、max_connectionsと等しいスレッドの数を使用して、残りのデータを並列にダウンロードします。 各チャンクのサイズは self になります。MAX_CHUNK_GET_SIZE。 1 に設定すると、1 つの大きな get 要求が実行されます。 これは一般的には推奨されませんが、使用するスレッドが非常に少ない場合、ネットワーク要求が非常に高価な場合、またはシーク不可能なストリームが並列ダウンロードを妨げる場合に使用できます。 これは、max_connectionsが 1 より大きい場合に空の BLOB に追加の要求が必要であるため、多くの BLOB が空であると予想される場合にも役立ちます。
- if_modified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した時刻以降にリソースが変更されている場合に限り操作が実行されます。
- if_unmodified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した日付/時刻以降にリソースが変更されていない場合に限り操作が実行されます。
- if_none_match
- str
ETag 値、またはワイルドカード文字 ()。リソースの ETag が指定した値と一致しない場合にのみ、このヘッダーを指定して操作を実行します。ワイルドカード文字 () を指定して、リソースが存在しない場合にのみ操作を実行し、存在する場合は操作を失敗させます。
指定したキーを使用して、サービス側のデータを復号化します。 顧客が指定したキーの使用は HTTPS 経由で行う必要があります。 暗号化キー自体が要求で提供されるため、キーを転送するにはセキュリティで保護された接続を確立する必要があります。
- timeout
- int
timeout パラメーターは、秒単位で表されます。 このメソッドは、Azure サービスに対して複数の呼び出しを行う場合があり、タイムアウトは各呼び出しに個別に適用されます。
戻り値
プロパティとメタデータを含む BLOB。 max_connectionsが 1 より大きい場合、content_md5 (BLOB に設定されている場合) は返されません。 この値が必要な場合は、get_blob_propertiesを使用するか、max_connectionsを 1 に設定します。
の戻り値の型 :
get_blob_to_stream
自動チャンクと進行状況通知を使用して、BLOB をストリームにダウンロードします。 プロパティとメタデータを含む の Blob インスタンスを返します。
get_blob_to_stream(container_name, blob_name, stream, snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)パラメーター
- start_range
- int
BLOB のセクションのダウンロードに使用するバイト範囲の開始。 end_rangeが指定されていない場合は、start_rangeの後のすべてのバイトがダウンロードされます。 start_rangeパラメーターと end_range パラメーターは包括的です。 例: start_range=0、end_range=511 は最初の 512 バイトの BLOB をダウンロードします。
- end_range
- int
BLOB のセクションのダウンロードに使用するバイト範囲の末尾。 end_rangeを指定する場合は、start_rangeを指定する必要があります。 start_rangeパラメーターと end_range パラメーターは包括的です。 例: start_range=0、end_range=511 は最初の 512 バイトの BLOB をダウンロードします。
- validate_content
- bool
true に設定されている場合は、BLOB の取得された各部分の MD5 ハッシュを検証します。 これは主に、https (既定値) として https ではなく http を使用して既に検証される場合に、ネットワーク上のビットフラグを検出する場合に重要です。 サービスは 4 MB 以下のチャンクに対してのみトランザクション MD5 を返すので、最初の get 要求のサイズは自己になります。自己ではなくMAX_CHUNK_GET_SIZE。MAX_SINGLE_GET_SIZE。 自己の場合。MAX_CHUNK_GET_SIZEが 4 MB を超えるに設定されている場合は、エラーがスローされます。 MD5 のコンピューティングには処理時間がかかり、チャンク サイズが小さくなるため、より多くの要求を行う必要があるため、待機時間が若干増加する可能性があります。
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
シグネチャ関数 (current, total) を使用した進行状況のコールバック。current はこれまでに転送されたバイト数で、total は既知の場合は BLOB のサイズです。
- max_connections
- int
2 以上に設定した場合、最初の取得は最初の自己に対して行われます。BLOB のMAX_SINGLE_GET_SIZEバイト数。 これが BLOB 全体の場合、メソッドはこの時点で を返します。 そうでない場合は、max_connectionsと等しいスレッドの数を使用して、残りのデータを並列にダウンロードします。 各チャンクのサイズは self になります。MAX_CHUNK_GET_SIZE。 1 に設定すると、1 つの大きな get 要求が実行されます。 これは一般的には推奨されませんが、使用するスレッドが非常に少ない場合、ネットワーク要求が非常に高価な場合、またはシーク不可能なストリームが並列ダウンロードを妨げる場合に使用できます。 これは、max_connectionsが 1 より大きい場合に空の BLOB に追加の要求が必要であるため、多くの BLOB が空であると予想される場合にも役立ちます。
- if_modified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した時刻以降にリソースが変更されている場合に限り操作が実行されます。
- if_unmodified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した日付/時刻以降にリソースが変更されていない場合に限り操作が実行されます。
- if_none_match
- str
ETag 値、またはワイルドカード文字 ()。リソースの ETag が指定した値と一致しない場合にのみ、このヘッダーを指定して操作を実行します。ワイルドカード文字 () を指定して、リソースが存在しない場合にのみ操作を実行し、存在する場合は操作を失敗させます。
指定したキーを使用して、サービス側のデータを復号化します。 顧客が指定したキーの使用は HTTPS 経由で行う必要があります。 暗号化キー自体が要求で提供されるため、キーを転送するにはセキュリティで保護された接続を確立する必要があります。
- timeout
- int
timeout パラメーターは、秒単位で表されます。 このメソッドは、Azure サービスに対して複数の呼び出しを行う場合があり、タイムアウトは各呼び出しに個別に適用されます。
戻り値
プロパティとメタデータを含む BLOB。 max_connectionsが 1 より大きい場合、content_md5 (BLOB に設定されている場合) は返されません。 この値が必要な場合は、get_blob_propertiesを使用するか、max_connectionsを 1 に設定します。
の戻り値の型 :
get_blob_to_text
自動チャンクと進行状況通知を使用して、BLOB を Unicode テキストとしてダウンロードします。 プロパティ、メタデータ、およびコンテンツを含む の Blob インスタンスを返します。
get_blob_to_text(container_name, blob_name, encoding='utf-8', snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)パラメーター
- start_range
- int
BLOB のセクションのダウンロードに使用するバイト範囲の開始。 end_rangeが指定されていない場合は、start_rangeの後のすべてのバイトがダウンロードされます。 start_rangeパラメーターと end_range パラメーターは包括的です。 例: start_range=0、end_range=511 は最初の 512 バイトの BLOB をダウンロードします。
- end_range
- int
BLOB のセクションのダウンロードに使用するバイト範囲の末尾。 end_rangeを指定する場合は、start_rangeを指定する必要があります。 start_rangeパラメーターと end_range パラメーターは包括的です。 例: start_range=0、end_range=511 は最初の 512 バイトの BLOB をダウンロードします。
- validate_content
- bool
true に設定されている場合は、BLOB の取得された各部分の MD5 ハッシュを検証します。 これは主に、https (既定値) として https ではなく http を使用して既に検証される場合に、ネットワーク上のビットフラグを検出する場合に重要です。 サービスは 4 MB 以下のチャンクに対してのみトランザクション MD5 を返すので、最初の get 要求のサイズは自己になります。自己ではなくMAX_CHUNK_GET_SIZE。MAX_SINGLE_GET_SIZE。 自己の場合。MAX_CHUNK_GET_SIZEが 4 MB を超えるに設定されている場合は、エラーがスローされます。 MD5 のコンピューティングには処理時間がかかり、チャンク サイズが小さくなるため、より多くの要求を行う必要があるため、待機時間が若干増加する可能性があります。
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
シグネチャ関数 (current, total) を使用した進行状況のコールバック。current はこれまでに転送されたバイト数で、total は既知の場合は BLOB のサイズです。
- max_connections
- int
2 以上に設定した場合、最初の取得は最初の自己に対して行われます。BLOB のMAX_SINGLE_GET_SIZEバイト数。 これが BLOB 全体の場合、メソッドはこの時点で を返します。 そうでない場合は、max_connectionsと等しいスレッドの数を使用して、残りのデータを並列にダウンロードします。 各チャンクのサイズは self になります。MAX_CHUNK_GET_SIZE。 1 に設定すると、1 つの大きな get 要求が実行されます。 これは一般的には推奨されませんが、使用するスレッドが非常に少ない場合、ネットワーク要求が非常に高価な場合、またはシーク不可能なストリームが並列ダウンロードを妨げる場合に使用できます。 これは、max_connectionsが 1 より大きい場合に空の BLOB に追加の要求が必要であるため、多くの BLOB が空であると予想される場合にも役立ちます。
- if_modified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した時刻以降にリソースが変更されている場合に限り操作が実行されます。
- if_unmodified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した日付/時刻以降にリソースが変更されていない場合に限り操作が実行されます。
- if_none_match
- str
ETag 値、またはワイルドカード文字 ()。リソースの ETag が指定した値と一致しない場合にのみ、このヘッダーを指定して操作を実行します。ワイルドカード文字 () を指定して、リソースが存在しない場合にのみ操作を実行し、存在する場合は操作を失敗させます。
指定したキーを使用して、サービス側のデータを復号化します。 顧客が指定したキーの使用は HTTPS 経由で行う必要があります。 暗号化キー自体が要求で提供されるため、キーを転送するにはセキュリティで保護された接続を確立する必要があります。
- timeout
- int
timeout パラメーターは、秒単位で表されます。 このメソッドは、Azure サービスに対して複数の呼び出しを行う場合があり、タイムアウトは各呼び出しに個別に適用されます。
戻り値
プロパティとメタデータを含む BLOB。 max_connectionsが 1 より大きい場合、content_md5 (BLOB に設定されている場合) は返されません。 この値が必要な場合は、get_blob_propertiesを使用するか、max_connectionsを 1 に設定します。
の戻り値の型 :
get_container_acl
指定したコンテナーのアクセス許可を取得します。 アクセス許可は、コンテナー データがパブリックにアクセス可能かどうかを示します。
get_container_acl(container_name, lease_id=None, timeout=None)パラメーター
- lease_id
指定した場合、get_container_aclはコンテナーのリースがアクティブで、この ID と一致する場合にのみ成功します。
戻り値
コンテナーに関連付けられているアクセス ポリシーのディクショナリ。 パブリック アクセスが有効になっている場合は、 への AccessPolicy str と public_access プロパティの dict
get_container_metadata
指定したコンテナーのすべてのユーザー定義メタデータを返します。
get_container_metadata(container_name, lease_id=None, timeout=None)パラメーター
戻り値
コンテナー メタデータ名、値ペアを表すディクショナリ。
の戻り値の型 :
get_container_properties
指定したコンテナーのすべてのユーザー定義メタデータとシステム プロパティを返します。 返されるデータにコンテナーの BLOB 一覧は含まれません。
get_container_properties(container_name, lease_id=None, timeout=None)パラメーター
戻り値
コンテナー オブジェクト内の指定されたコンテナーのプロパティ。
の戻り値の型 :
get_user_delegation_key
SAS トークンに署名するために、ユーザー委任キーを取得します。 この要求を成功させるには、サービス オブジェクトにトークン資格情報が存在する必要があります。
get_user_delegation_key(key_start_time, key_expiry_time, timeout=None)パラメーター
戻り値
ユーザー委任キー。
の戻り値の型 :
list_blob_names
指定したコンテナーの下の BLOB 名を一覧表示するジェネレーターを返します。 ジェネレーターは、サービスによって返された継続トークンに遅れて従い、すべての BLOB が返されるか、num_resultsに達したときに停止します。
num_resultsを指定し、アカウントに BLOB の数を超える値が含まれている場合、ジェネレーターは完了するとnext_markerフィールドが設定されます。 より多くの結果が必要な場合は、このマーカーを使用して新しいジェネレーターを作成できます。
list_blob_names(container_name, prefix=None, num_results=None, include=None, delimiter=None, marker=None, timeout=None)パラメーター
- num_results
- int
すべての <xref:azure.storage.blob.baseblobservice.BlobPrefix> 要素も含め、返される BLOB の最大数を指定します。 要求で num_resultsを指定しない場合、または 5,000 を超える値を指定した場合、サーバーは最大 5,000 個のアイテムを返します。 num_resultsを 0 以下の値に設定すると、エラー応答コード 400 (Bad Request) が発生します。
- delimiter
- str
要求にこのパラメーターが含まれている場合、この操作は、区切り文字の外観まで同じ部分文字列で始まるすべての BLOB のプレースホルダーとして機能する要素を結果リストに返 BlobPrefix します。 区切り記号には単一文字または文字列を使用できます。
- marker
- str
不透明な継続トークン。 この値は、前のジェネレーター オブジェクトの next_marker フィールドから取得できますnum_resultsが指定され、そのジェネレーターが結果の列挙を完了した場合です。 指定した場合、このジェネレーターは、前のジェネレーターが停止したポイントから結果の返しを開始します。
list_blobs
指定したコンテナーの下にある BLOB を一覧表示するジェネレーターを返します。 ジェネレーターは、サービスによって返された継続トークンに遅れて従い、すべての BLOB が返されるか、num_resultsに達したときに停止します。
num_resultsを指定し、アカウントに BLOB の数を超える値が含まれている場合、ジェネレーターは完了するとnext_markerフィールドが設定されます。 より多くの結果が必要な場合は、このマーカーを使用して新しいジェネレーターを作成できます。
list_blobs(container_name, prefix=None, num_results=None, include=None, delimiter=None, marker=None, timeout=None)パラメーター
- num_results
- int
すべての <xref:azure.storage.blob.baseblobservice.BlobPrefix> 要素も含め、返される BLOB の最大数を指定します。 要求で num_resultsを指定しない場合、または 5,000 を超える値を指定した場合、サーバーは最大 5,000 個のアイテムを返します。 num_resultsを 0 以下の値に設定すると、エラー応答コード 400 (Bad Request) が発生します。
- delimiter
- str
要求にこのパラメーターが含まれている場合、この操作は、区切り文字の外観まで同じ部分文字列で始まるすべての BLOB のプレースホルダーとして機能する要素を結果リストに返 BlobPrefix します。 区切り記号には単一文字または文字列を使用できます。
- marker
- str
不透明な継続トークン。 この値は、前のジェネレーター オブジェクトの next_marker フィールドから取得できますnum_resultsが指定され、そのジェネレーターが結果の列挙を完了した場合です。 指定した場合、このジェネレーターは、前のジェネレーターが停止したポイントから結果の返しを開始します。
list_containers
指定したアカウントのコンテナーを一覧表示するジェネレーターを返します。 ジェネレーターは、サービスによって返された継続トークンに遅れて従い、すべてのコンテナーが返されるか、num_resultsに達したときに停止します。
num_resultsを指定し、アカウントにコンテナーの数を超える数が含まれている場合、ジェネレーターは完了するとnext_markerフィールドが設定されます。 より多くの結果が必要な場合は、このマーカーを使用して新しいジェネレーターを作成できます。
list_containers(prefix=None, num_results=None, include_metadata=False, marker=None, timeout=None)パラメーター
- num_results
- int
返されるコンテナーの最大数を指定します。 1 つのリスト要求で最大 1,000 個の連続体が返される場合があり、追加の resutls を取得するために従う必要がある継続トークンが返される可能性があります。
- marker
- str
不透明な継続トークン。 この値は、前のジェネレーター オブジェクトの next_marker フィールドから取得できますnum_resultsが指定され、そのジェネレーターが結果の列挙を完了した場合です。 指定した場合、このジェネレーターは、前のジェネレーターが停止したポイントから結果の返しを開始します。
make_blob_url
BLOB にアクセスする URL を作成します。
make_blob_url(container_name, blob_name, protocol=None, sas_token=None, snapshot=None)パラメーター
- protocol
- str
使用するプロトコル: 'http' または 'https'。 指定しない場合は、BaseBlobService の初期化時に指定されたプロトコルを使用します。
戻り値
BLOB アクセス URL。
の戻り値の型 :
make_container_url
コンテナーにアクセスするための URL を作成します。
make_container_url(container_name, protocol=None, sas_token=None)パラメーター
- protocol
- str
使用するプロトコル: 'http' または 'https'。 指定しない場合は、BaseBlobService の初期化時に指定されたプロトコルを使用します。
戻り値
コンテナー アクセス URL。
の戻り値の型 :
release_blob_lease
リースを解放します。 要求で指定したリース ID が BLOB に関連付けられているリース ID と一致する場合、リースを解放できます。 リースを解放すると、解放が完了した直後から、別のクライアントがその BLOB のリースを取得できるようになります。
release_blob_lease(container_name, blob_name, lease_id, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)パラメーター
- if_modified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した時刻以降にリソースが変更されている場合に限り操作が実行されます。
- if_unmodified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した日付/時刻以降にリソースが変更されていない場合に限り操作が実行されます。
- if_none_match
- str
ETag 値、またはワイルドカード文字 ()。リソースの ETag が指定した値と一致しない場合にのみ、このヘッダーを指定して操作を実行します。ワイルドカード文字 () を指定して、リソースが存在しない場合にのみ操作を実行し、存在する場合は操作を失敗させます。
release_container_lease
リースを解放します。 指定したlease_idがコンテナーに関連付けられていると一致する場合、リースが解放される可能性があります。 リースを解放すると、解放が完了した直後から、別のクライアントがそのコンテナーのリースを取得できるようになります。
release_container_lease(container_name, lease_id, if_modified_since=None, if_unmodified_since=None, timeout=None)パラメーター
- if_modified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した時刻以降にリソースが変更されている場合に限り操作が実行されます。
- if_unmodified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した日付/時刻以降にリソースが変更されていない場合に限り操作が実行されます。
renew_blob_lease
リースを更新します。 要求で指定したリース ID が BLOB に関連付けられているリース ID と一致する場合、リースを更新できます。 リースの有効期限が切れていても、そのリースの期限切れ以降に BLOB が変更されたり、再度リースされたりしていなければ、リースを更新できます。 リースを更新すると、リース期間の時間がリセットされます。
renew_blob_lease(container_name, blob_name, lease_id, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)パラメーター
- if_modified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した時刻以降にリソースが変更されている場合に限り操作が実行されます。
- if_unmodified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した日付/時刻以降にリソースが変更されていない場合に限り操作が実行されます。
- if_none_match
- str
ETag 値、またはワイルドカード文字 ()。リソースの ETag が指定された値と一致しない場合にのみ、このヘッダーを指定して操作を実行します。ワイルドカード文字 () を指定して、リソースが存在しない場合にのみ操作を実行し、存在する場合は操作を失敗させます。
戻り値
str
renew_container_lease
リースを更新します。 指定されたリース ID がコンテナーに関連付けられているリース ID と一致する場合は、リースを更新できます。 リースの有効期限が切れていても、そのリースの期限切れ以降にコンテナーが再度リースされていなければ、リースを更新できます。 リースを更新すると、リース期間の時間がリセットされます。
renew_container_lease(container_name, lease_id, if_modified_since=None, if_unmodified_since=None, timeout=None)パラメーター
- if_modified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した時刻以降にリソースが変更されている場合に限り操作が実行されます。
- if_unmodified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した日付/時刻以降にリソースが変更されていない場合に限り操作が実行されます。
戻り値
str
set_blob_metadata
1 つまたは複数の名前と値のペアとして指定された BLOB のユーザー定義メタデータを設定します。
set_blob_metadata(container_name, blob_name, metadata=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)パラメーター
名前と値のペアを含むディクテーション。 この操作を呼び出すと、その都度、BLOB に関連付けられている既存のメタデータがすべて置き換えられます。 すべてのメタデータを BLOB から削除するには、この操作をメタデータ ヘッダーなしで呼び出します。
- if_modified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した時刻以降にリソースが変更されている場合に限り操作が実行されます。
- if_unmodified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した日付/時刻以降にリソースが変更されていない場合に限り操作が実行されます。
- if_none_match
- str
ETag 値、またはワイルドカード文字 ()。リソースの ETag が指定された値と一致しない場合にのみ、このヘッダーを指定して操作を実行します。ワイルドカード文字 () を指定して、リソースが存在しない場合にのみ操作を実行し、存在する場合は操作を失敗させます。
指定されたキーを使用して、サービス側のデータを暗号化します。 お客様から提供されたキーの使用は、HTTPS 経由で行う必要があります。 暗号化キー自体が要求で提供されるため、キーを転送するにはセキュリティで保護された接続を確立する必要があります。
戻り値
更新された BLOB の ETag プロパティと最後に変更されたプロパティ
の戻り値の型 :
set_blob_properties
BLOB のシステム プロパティを設定します。 content_settingsに 1 つのプロパティが設定されている場合、すべてのプロパティがオーバーライドされます。
set_blob_properties(container_name, blob_name, content_settings=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)パラメーター
- if_modified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した時刻以降にリソースが変更されている場合に限り操作が実行されます。
- if_unmodified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した日付/時刻以降にリソースが変更されていない場合に限り操作が実行されます。
- if_none_match
- str
ETag 値、またはワイルドカード文字 ()。リソースの ETag が指定された値と一致しない場合にのみ、このヘッダーを指定して操作を実行します。ワイルドカード文字 () を指定して、リソースが存在しない場合にのみ操作を実行し、存在する場合は操作を失敗させます。
指定されたキーを使用して、サービス側のデータを暗号化します。 お客様から提供されたキーの使用は、HTTPS 経由で行う必要があります。 暗号化キー自体が要求で提供されるため、キーを転送するにはセキュリティで保護された接続を確立する必要があります。
戻り値
更新された BLOB の ETag プロパティと最後に変更されたプロパティ
の戻り値の型 :
set_blob_service_properties
Azure Storage Analyticsを含むストレージ アカウントの BLOB サービスのプロパティを設定します。 要素 (ログ記録など) が None のままの場合、その機能に対するサービスの既存の設定は保持されます。
set_blob_service_properties(logging=None, hour_metrics=None, minute_metrics=None, cors=None, target_version=None, timeout=None, delete_retention_policy=None, static_website=None)パラメーター
- cors
- list(CorsRule)
リストには、最大 5 つの CorsRule 要素を含めることができます。 空のリストを指定すると、すべての CORS ルールが削除され、サービスに対して CORS が無効になります。
- delete_retention_policy
- DeleteRetentionPolicy
削除アイテム保持ポリシーでは、削除された BLOB を保持するかどうかを指定します。 また、保持する BLOB の日数とバージョンも指定します。
- static_website
- StaticWebsite
静的 Web サイト機能を有効にするかどうかを指定し、はい場合は、使用するインデックス ドキュメントと 404 エラー ドキュメントを示します。
set_container_acl
Shared Access Signature で使用できる、指定したコンテナーまたは格納されているアクセス ポリシーのアクセス許可を設定します。 アクセス許可は、コンテナー内の BLOB がパブリックにアクセス可能かどうかを示します。
set_container_acl(container_name, signed_identifiers=None, public_access=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)パラメーター
- signed_identifiers
- dict(str, AccessPolicy)
コンテナーに関連付けるアクセス ポリシーのディクショナリ。 ディクショナリには、最大 5 つの要素を含めることができます。 空のディクショナリを使用すると、サービスに設定されているアクセス ポリシーがクリアされます。
- if_modified_since
- datetime
datetime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 指定した日時以降にリソースが変更された場合にのみ、このヘッダーを指定して操作を実行します。
- if_unmodified_since
- datetime
datetime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した日付/時刻以降にリソースが変更されていない場合に限り操作が実行されます。
戻り値
更新されたコンテナーの ETag プロパティと最後に変更されたプロパティ
の戻り値の型 :
set_container_metadata
指定したコンテナーの 1 つ以上のユーザー定義の名前と値のペアを設定します。 この操作を呼び出すと、その都度、コンテナーに関連付けられている既存のメタデータがすべて置き換えられます。 コンテナーからすべてのメタデータを削除するには、メタデータ ディクテーションなしでこの操作を呼び出します。
set_container_metadata(container_name, metadata=None, lease_id=None, if_modified_since=None, timeout=None)パラメーター
- if_modified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した時刻以降にリソースが変更されている場合に限り操作が実行されます。
戻り値
更新されたコンテナーの ETag プロパティと最後に変更されたプロパティ
の戻り値の型 :
set_proxy
HTTP CONNECT トンネリングのプロキシ サーバー ホストとポートを設定します。
set_proxy(host, port, user=None, password=None)パラメーター
snapshot_blob
BLOB の読み取り専用のスナップショットを作成します。
snapshot_blob(container_name, blob_name, metadata=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, lease_id=None, timeout=None, cpk=None)パラメーター
BLOB に関連付けられたユーザー定義の名前と値のペアを指定します。 名前と値のペアを指定しない場合、ベース BLOB メタデータがスナップショットにコピーされます。 1 つまたは複数の名前と値のペアを指定した場合、指定したメタデータでスナップショットが作成され、メタデータはベース BLOB からコピーされません。
- if_modified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した時刻以降にリソースが変更されている場合に限り操作が実行されます。
- if_unmodified_since
- datetime
DateTime 値。 Azure では、渡された日付値が UTC であると想定しています。 タイムゾーンが含まれている場合、UTC 以外の日時は UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。 このヘッダーを指定すると、指定した日付/時刻以降にリソースが変更されていない場合に限り操作が実行されます。
- if_none_match
- str
ETag 値、またはワイルドカード文字 ()。リソースの ETag が指定した値と一致しない場合にのみ、このヘッダーを指定して操作を実行します。ワイルドカード文字 () を指定して、リソースが存在しない場合にのみ操作を実行し、存在する場合は操作を失敗させます。
指定したキーを使用してサービス側のデータを暗号化します。 顧客が指定したキーの使用は HTTPS 経由で行う必要があります。 暗号化キー自体が要求で提供されるため、キーを転送するにはセキュリティで保護された接続を確立する必要があります。
戻り値
スナップショットプロパティ
の戻り値の型 :
undelete_blob
削除を取り消す BLOB 操作は、論理的に削除された BLOB またはスナップショットの内容とメタデータを復元します。 論理的に削除されていない BLOB またはスナップショットの削除を取り消そうとしても、変更は行われません。
undelete_blob(container_name, blob_name, timeout=None)パラメーター
属性
protocol
request_session
socket_timeout
MAX_CHUNK_GET_SIZE
MAX_CHUNK_GET_SIZE = 4194304MAX_SINGLE_GET_SIZE
MAX_SINGLE_GET_SIZE = 33554432
Azure SDK for Python