FileService クラス
Server Message Block (SMB) プロトコルは、現在の内部設置型環境で好まれているファイル共有プロトコルです。 Microsoft Azure File サービスを使用すると、SMB クライアント アプリケーションを書き換えることなく、Azure のサービスとしてのクラウド インフラストラクチャ (IaaS) SMB の可用性とスケーラビリティを活用できます。
従来の Direct Attached Storage (DAS) および Storage Area Network (SAN) ソリューションは、インストール、構成、操作が複雑で高価な場合もよくありますが、Azure ファイル サービスは、こうしたソリューションの代替としても利用できます。
- 継承
-
FileService
コンストラクター
FileService(account_name=None, account_key=None, sas_token=None, protocol='https', endpoint_suffix='core.windows.net', request_session=None, connection_string=None, socket_timeout=None)パラメーター
- account_name
- str
ストレージ アカウント名。 これは、アカウント キーで署名された要求を認証し、ストレージ エンドポイントを構築するために使用されます。 接続文字列が指定されていない限り、これは必須です。
- sas_token
- str
アカウント キーの代わりに要求を認証するために使用する共有アクセス署名トークン。 アカウント キーと sas トークンの両方が指定されている場合は、アカウント キーを使用して署名します。
- 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」を参照してください。
変数
- MAX_SINGLE_GET_SIZE
- int
max_connectionsが 1 より大きい場合は、get_file_to_* メソッドによって最初の範囲のサイズが実行されます。 ファイルがこれより小さい場合は、少ないデータが返されます。
- MAX_CHUNK_GET_SIZE
- int
max_connectionsが 1 より大きく、ファイルがMAX_SINGLE_GET_SIZEより大きい場合、後続の範囲のサイズは get_file_to_* メソッドによって実行されます。 ファイルの残りの部分がこれより小さい場合は、少ないデータが返されます。 これが 4 MB を超える値に設定されている場合、content_validationは有効になっている場合にエラーをスローします。 ただし、content_validationが望ましくない場合は、4 MB を超えるサイズが最適な場合があります。 これを 4 MB 以下に設定することはお勧めしません。
- MAX_RANGE_SIZE
- int
create_file_from_* メソッドによって設定される範囲のサイズ。 提供されるデータが少ない場合は、より小さな範囲を配置できます。 サービスでサポートされる最大範囲サイズは 4 MB です。
メソッド
| abort_copy_file |
保留中のcopy_file操作を中止し、コピー先ファイルの長さと完全なメタデータを残します。 |
| clear_range |
指定した範囲をクリアし、その範囲の記憶域で使用されている領域を解放します。 |
| close_handles |
指定した共有のディレクトリまたはファイルで開いているハンドルを閉じるジェネレーターを返します。 ジェネレーターは、サービスによって返された継続トークンに遅れて従い、すべてのハンドルが閉じられたときに停止します。 生成される値は、各トランザクションで閉じられたハンドルの数を表します。 |
| copy_file |
ファイルを非同期にコピーします。 この操作は、コピー操作をチェックまたは中止するために使用できるコピー ID を含む、コピー操作のプロパティ オブジェクトを返します。 ファイル サービスは、ベスト エフォートベースでファイルをコピーします。 コピー先ファイルが存在する場合は、上書きされます。 コピー操作の進行中は、コピー先ファイルを変更できません。 |
| create_directory |
指定した共有ディレクトリまたは親ディレクトリの下に新しいディレクトリを作成します。 同じ名前のディレクトリが既に存在する場合、サービスで操作は失敗します。 既定では、例外はクライアントによって飲み込まれます。 例外を公開するには、fail_on_existsに True を指定します。 |
| create_file |
新しいファイルを 1 つ作成します。 自動チャンク通知と進行状況通知を使用して大きなファイルの作成とアップロードを処理する高レベルの関数については、「create_file_from_*」を参照してください。 |
| create_file_from_bytes |
バイト配列から新しいファイルを作成するか、自動チャンクと進行状況通知を使用して既存のファイルの内容を更新します。 |
| create_file_from_path |
ローカル ファイル パスから新しい Azure ファイルを作成するか、自動チャンクと進行状況通知を使用して既存のファイルの内容を更新します。 |
| create_file_from_stream |
ファイル/ストリームから新しいファイルを作成するか、自動チャンクと進行状況通知を使用して既存のファイルの内容を更新します。 |
| create_file_from_text |
str/unicode から新しいファイルを作成するか、自動チャンクと進行状況通知を使用して既存のファイルの内容を更新します。 |
| create_permission_for_share |
共有レベルでアクセス許可 (セキュリティ記述子) を作成します。 この 'アクセス許可' は、共有内のファイル/ディレクトリに使用できます。 'permission' が既に存在する場合は、そのキーを返し、それ以外の場合は共有レベルで新しいアクセス許可を作成し、そのキーを返します。 :rtype str ファイルのアクセス許可キーを返します |
| create_share |
指定したアカウントの下に新しい共有を作成します。 同じ名前の共有が既に存在する場合、サービスで操作は失敗します。 既定では、例外はクライアントによって飲み込まれます。 例外を公開するには、fail_on_existsに True を指定します。 |
| delete_directory |
指定した空のディレクトリを削除します。 ディレクトリを空にしてから削除する必要があることに注意してください。 空ではないディレクトリを削除しようとすると失敗します。 ディレクトリが存在しない場合、サービスで操作は失敗します。 既定では、例外はクライアントによって飲み込まれます。 例外を公開するには、fail_not_existに True を指定します。 |
| delete_file |
指定したファイルに削除のマークを付けます。 ファイルは後でガベージ コレクション中に削除されます。 |
| delete_share |
指定した共有に削除のマークを付けます。 共有が存在しない場合、サービスで操作は失敗します。 既定では、例外はクライアントによって飲み込まれます。 例外を公開するには、fail_not_existに True を指定します。 |
| exists |
共有名のみを指定した場合に共有が存在するかどうかを示すブール値を返します。 directory_nameが指定されている場合は、ディレクトリが存在するかどうかを示すブール値が返されます。 file_nameも指定すると、ファイルが存在するかどうかを示すブール値が返されます。 |
| extract_date_and_request_id | |
| generate_account_shared_access_signature |
ファイル サービスの共有アクセス署名を生成します。 返されたシグネチャは、FileService の sas_token パラメーターと共に使用します。 |
| generate_file_shared_access_signature |
ファイルの共有アクセス署名を生成します。 返されたシグネチャは、FileService の sas_token パラメーターと共に使用します。 |
| generate_share_shared_access_signature |
共有の共有アクセス署名を生成します。 返されたシグネチャは、FileService の sas_token パラメーターと共に使用します。 |
| get_directory_metadata |
指定したディレクトリのすべてのユーザー定義メタデータを返します。 |
| get_directory_properties |
指定したディレクトリのすべてのユーザー定義メタデータとシステム プロパティを返します。 返されるデータには、ディレクトリのファイルの一覧は含まれません。 |
| get_file_metadata |
指定したファイルのすべてのユーザー定義メタデータを返します。 |
| get_file_properties |
ファイルのすべてのユーザー定義メタデータ、標準 HTTP プロパティ、およびシステム プロパティを返します。 と のインスタンスFileFilePropertiesとメタデータ ディクテーションを返します。 |
| get_file_service_properties |
Azure Storage Analyticsを含むストレージ アカウントの File サービスのプロパティを取得します。 |
| get_file_to_bytes |
ファイルをバイト配列としてダウンロードし、自動チャンクと進行状況通知を使用します。 プロパティ、メタデータ、およびコンテンツを含む の File インスタンスを返します。 |
| get_file_to_path |
自動チャンクと進行状況通知を使用して、ファイルをファイル パスにダウンロードします。 プロパティとメタデータを含む File のインスタンスを返します。 |
| get_file_to_stream |
自動チャンクと進行状況通知を使用して、ストリームにファイルをダウンロードします。 プロパティとメタデータを含む の File インスタンスを返します。 |
| get_file_to_text |
自動チャンクと進行状況通知を使用して、ファイルを Unicode テキストとしてダウンロードします。 プロパティ、メタデータ、およびコンテンツを含む の File インスタンスを返します。 |
| get_permission_for_share |
共有レベルでアクセス許可 (セキュリティ記述子) を作成します。 この 'アクセス許可' は、共有内のファイルまたはディレクトリに使用できます。 'permission' が既に存在する場合は、そのキーを返し、それ以外の場合は共有レベルで新しいアクセス許可を作成し、そのキーを返します。 :ファイルのアクセス許可 (ポータブル SDDL) を返します:rtype str |
| get_share_acl |
指定した共有のアクセス許可を取得します。 |
| get_share_metadata |
指定した共有のすべてのユーザー定義メタデータを返します。 |
| get_share_properties |
指定した共有のすべてのユーザー定義メタデータとシステム プロパティを返します。 返されるデータには、共有のファイルまたはディレクトリの一覧は含まれません。 |
| get_share_stats |
共有に格納されているデータのおおよそのサイズを取得します。最も近いギガバイトに切り上げられます。 この値には、最近作成または最近サイズ変更されたすべてのファイルが含まれていない場合があることに注意してください。 |
| get_share_stats_in_bytes |
共有に格納されているデータのおおよそのサイズをバイト単位で取得します。 この値には、最近作成または最近サイズ変更されたすべてのファイルが含まれていない場合があることに注意してください。 |
| list_directories_and_files |
指定した共有のディレクトリとファイルを一覧表示するジェネレーターを返します。 ジェネレーターは、サービスによって返された継続トークンに遅れて従い、すべてのディレクトリとファイルが返されるか、num_resultsに達したときに停止します。 num_resultsが指定され、共有に含まれるファイルとディレクトリの数がそれ以上の場合、ジェネレーターは完了するとnext_markerフィールドが設定されます。 より多くの結果が必要な場合は、このマーカーを使用して新しいジェネレーターを作成できます。 |
| list_handles |
指定した共有の下にあるディレクトリまたはファイルで開いているハンドルを一覧表示するジェネレーターを返します。 ジェネレーターは、サービスによって返された継続トークンに遅れて従い、すべてのハンドルが返されるか、num_resultsに達すると停止します。 num_resultsが指定され、共有に含まれるファイルとディレクトリの数がそれ以上の場合、ジェネレーターは完了するとnext_markerフィールドが設定されます。 より多くの結果が必要な場合は、このマーカーを使用して新しいジェネレーターを作成できます。 |
| list_ranges |
ファイルの有効な範囲を取得します。 |
| list_shares |
指定したアカウントの共有を一覧表示するジェネレーターを返します。 ジェネレーターは、サービスによって返された継続トークンに遅れて従い、すべての共有が返されるか、num_resultsに達したときに停止します。 num_resultsを指定し、アカウントに共有の数を超える場合、ジェネレーターは完了するとnext_markerフィールドが設定されます。 より多くの結果が必要な場合は、このマーカーを使用して新しいジェネレーターを作成できます。 |
| make_file_url |
ファイルにアクセスするための URL を作成します。 |
| resize_file |
ファイルを指定したサイズに変更します。 指定したバイト値が現在のファイル サイズ未満の場合、指定したバイト値を超える範囲はすべてクリアされます。 |
| set_directory_metadata |
指定したディレクトリに対して 1 つ以上のユーザー定義の名前と値のペアを設定します。 この操作を呼び出すと、その都度、ディレクトリに関連付けられている既存のメタデータがすべて置き換えられます。 ディレクトリからすべてのメタデータを削除するには、メタデータ ディクテーションなしでこの操作を呼び出します。 |
| set_directory_properties | |
| set_file_metadata |
指定したファイルのユーザー定義メタデータを 1 つ以上の名前と値のペアとして設定します。 |
| set_file_properties |
ファイルのシステム プロパティを設定します。 content_settingsに 1 つのプロパティが設定されている場合、すべてのプロパティがオーバーライドされます。 |
| set_file_service_properties |
Azure Storage Analyticsを含むストレージ アカウントのファイル サービスのプロパティを設定します。 要素 (例: HourMetrics) が None のままの場合、その機能に対するサービスの既存の設定は保持されます。 |
| set_proxy |
HTTP CONNECT トンネリングのプロキシ サーバー ホストとポートを設定します。 |
| set_share_acl |
Shared Access Signature で使用できる、指定した共有または保存されたアクセス ポリシーのアクセス許可を設定します。 |
| set_share_metadata |
指定した共有に対して 1 つ以上のユーザー定義の名前と値のペアを設定します。 この操作を呼び出すと、その都度、共有に関連付けられている既存のすべてのメタデータが置き換えられます。 共有からすべてのメタデータを削除するには、メタデータ ディクテーションなしでこの操作を呼び出します。 |
| set_share_properties |
指定した共有のサービス定義プロパティを設定します。 |
| snapshot_share |
指定したアカウントの下に既存の共有のスナップショットを作成します。 |
| update_range |
要求本文で指定されたバイトを指定した範囲に書き込みます。 |
| update_range_from_file_url |
1 つの Azure File エンドポイントから別の Azure File エンドポイントの指定された範囲にバイトを書き込みます。 |
abort_copy_file
保留中のcopy_file操作を中止し、コピー先ファイルの長さと完全なメタデータを残します。
abort_copy_file(share_name, directory_name, file_name, copy_id, timeout=None)パラメーター
clear_range
指定した範囲をクリアし、その範囲の記憶域で使用されている領域を解放します。
clear_range(share_name, directory_name, file_name, start_range, end_range, timeout=None)パラメーター
- start_range
- int
ファイルのセクションをクリアするために使用するバイト範囲の先頭。 範囲のサイズは最大 4 MB です。 start_rangeパラメーターと end_range パラメーターは包括的です。 例: start_range=0、end_range=511 は最初の 512 バイトのファイルをダウンロードします。
- end_range
- int
ファイルのセクションをクリアするために使用するバイト範囲の末尾。 範囲のサイズは最大 4 MB です。 start_rangeパラメーターと end_range パラメーターは包括的です。 例: start_range=0、end_range=511 は最初の 512 バイトのファイルをダウンロードします。
close_handles
指定した共有のディレクトリまたはファイルで開いているハンドルを閉じるジェネレーターを返します。 ジェネレーターは、サービスによって返された継続トークンに遅れて従い、すべてのハンドルが閉じられたときに停止します。 生成される値は、各トランザクションで閉じられたハンドルの数を表します。
close_handles(share_name, directory_name=None, file_name=None, recursive=None, handle_id=None, marker=None, snapshot=None, timeout=None)パラメーター
- handle_id
- str
必須。 閉じるファイルまたはディレクトリで開かれたハンドル ID を指定します。 Astrix ('*') は、すべてのハンドルを指定するワイルドカードです。
- marker
- str
不透明な継続トークン。 この値は、前のジェネレーター オブジェクトの next_marker フィールドから取得できます(ハンドルの終了が完了していない場合)。 指定した場合、このジェネレーターは、前のジェネレーターが停止したポイントからハンドルの閉じを開始します。
copy_file
ファイルを非同期にコピーします。 この操作は、コピー操作をチェックまたは中止するために使用できるコピー ID を含む、コピー操作のプロパティ オブジェクトを返します。 ファイル サービスは、ベスト エフォートベースでファイルをコピーします。
コピー先ファイルが存在する場合は、上書きされます。 コピー操作の進行中は、コピー先ファイルを変更できません。
copy_file(share_name, directory_name, file_name, copy_source, metadata=None, timeout=None)パラメーター
- copy_source
- str
Azure ファイルまたは BLOB を指定する最大 2 KB の長さの URL。 この値は要求 URI に含まれるため、URL でエンコードされる必要があります。 ソースが別のアカウントにある場合、ソースはパブリックであるか、共有アクセス署名を介して認証される必要があります。 ソースがパブリックの場合、認証は必要ありません。 例: https://myaccount.file.core.windows.net/myshare/mydir/myfilehttps://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken
ファイルにメタデータとして関連付ける名前と値のペア。 名前と値のペアが指定されていない場合、操作によって、ソース BLOB またはファイルからコピー先ファイルにメタデータがコピーされます。 1 つ以上の名前と値のペアを指定すると、指定したメタデータを使用してコピー先ファイルが作成され、メタデータはソース BLOB またはファイルからコピーされません。
戻り値
状態、ソース、ID などのコピー操作のプロパティ。
の戻り値の型 :
create_directory
指定した共有ディレクトリまたは親ディレクトリの下に新しいディレクトリを作成します。 同じ名前のディレクトリが既に存在する場合、サービスで操作は失敗します。 既定では、例外はクライアントによって飲み込まれます。 例外を公開するには、fail_on_existsに True を指定します。
create_directory(share_name, directory_name, metadata=None, fail_on_exist=False, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)パラメーター
共有とメタデータとして関連付けるname_valueペアを持つディクテーション。 例:{'Category':'test'}
- smb_properties
- SMBProperties
SMB 関連ファイルのプロパティを設定します
戻り値
ディレクトリが作成されている場合は True、ディレクトリが既に存在する場合は False。
の戻り値の型 :
create_file
新しいファイルを 1 つ作成します。
自動チャンク通知と進行状況通知を使用して大きなファイルの作成とアップロードを処理する高レベルの関数については、「create_file_from_*」を参照してください。
create_file(share_name, directory_name, file_name, content_length, content_settings=None, metadata=None, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)パラメーター
- smb_properties
- SMBProperties
SMB 関連のファイル プロパティを設定します
create_file_from_bytes
バイト配列から新しいファイルを作成するか、自動チャンクと進行状況通知を使用して既存のファイルの内容を更新します。
create_file_from_bytes(share_name, directory_name, file_name, file, index=0, count=None, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)パラメーター
- validate_content
- bool
true の場合、ファイルの範囲ごとに MD5 ハッシュが計算されます。 ストレージ サービスは、送信されたハッシュで到着したコンテンツのハッシュをチェックします。 これは主に、https として https (既定値) ではなく https を使用して既に検証する場合に、ネットワーク上のビットフラグを検出する場合に重要です。 この MD5 ハッシュは ファイルと共に格納されないことに注意してください。
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
シグネチャ関数 (current, total) を使用した進行状況のコールバック。current はこれまでに転送されたバイト数で、total はファイルのサイズ、合計サイズが不明な場合は None です。
- smb_properties
- SMBProperties
SMB 関連のファイル プロパティを設定します
- timeout
- int
timeout パラメーターは、秒単位で表されます。 このメソッドは、Azure サービスに対して複数の呼び出しを行う場合があり、タイムアウトは各呼び出しに個別に適用されます。
create_file_from_path
ローカル ファイル パスから新しい Azure ファイルを作成するか、自動チャンクと進行状況通知を使用して既存のファイルの内容を更新します。
create_file_from_path(share_name, directory_name, file_name, local_file_path, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>, timeout=None)パラメーター
- validate_content
- bool
true の場合、ファイルの範囲ごとに MD5 ハッシュが計算されます。 ストレージ サービスは、送信されたハッシュで到着したコンテンツのハッシュをチェックします。 これは主に、https として https (既定値) ではなく https を使用して既に検証する場合に、ネットワーク上のビットフラグを検出する場合に重要です。 この MD5 ハッシュは ファイルと共に格納されないことに注意してください。
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
シグネチャ関数 (current, total) を使用した進行状況のコールバック。current はこれまでに転送されたバイト数で、total はファイルのサイズ、合計サイズが不明な場合は None です。
- smb_properties
- SMBProperties
SMB 関連のファイル プロパティを設定します
- timeout
- int
timeout パラメーターは、秒単位で表されます。 このメソッドは、Azure サービスに対して複数の呼び出しを行う場合があり、タイムアウトは各呼び出しに個別に適用されます。
create_file_from_stream
ファイル/ストリームから新しいファイルを作成するか、自動チャンクと進行状況通知を使用して既存のファイルの内容を更新します。
create_file_from_stream(share_name, directory_name, file_name, stream, count, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)パラメーター
- validate_content
- bool
true の場合、ファイルの範囲ごとに MD5 ハッシュが計算されます。 ストレージ サービスは、送信されたハッシュで到着したコンテンツのハッシュをチェックします。 これは主に、https として https (既定値) ではなく https を使用して既に検証する場合に、ネットワーク上のビットフラグを検出する場合に重要です。 この MD5 ハッシュは ファイルと共に格納されないことに注意してください。
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
シグネチャ関数 (current, total) を使用した進行状況のコールバック。current はこれまでに転送されたバイト数で、total はファイルのサイズ、合計サイズが不明な場合は None です。
- smb_properties
- SMBProperties
SMB 関連のファイル プロパティを設定します
- timeout
- int
timeout パラメーターは、秒単位で表されます。 このメソッドは、Azure サービスに対して複数の呼び出しを行う場合があり、タイムアウトは各呼び出しに個別に適用されます。
create_file_from_text
str/unicode から新しいファイルを作成するか、自動チャンクと進行状況通知を使用して既存のファイルの内容を更新します。
create_file_from_text(share_name, directory_name, file_name, text, encoding='utf-8', content_settings=None, metadata=None, validate_content=False, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)パラメーター
- validate_content
- bool
true の場合、ファイルの範囲ごとに MD5 ハッシュが計算されます。 ストレージ サービスは、送信されたハッシュで到着したコンテンツのハッシュをチェックします。 これは主に、https として https (既定値) ではなく https を使用して既に検証する場合に、ネットワーク上のビットフラグを検出する場合に重要です。 この MD5 ハッシュは ファイルと共に格納されないことに注意してください。
- smb_properties
- SMBProperties
SMB 関連のファイル プロパティを設定します
- timeout
- int
timeout パラメーターは、秒単位で表されます。 このメソッドは、Azure サービスに対して複数の呼び出しを行う場合があり、タイムアウトは各呼び出しに個別に適用されます。
create_permission_for_share
共有レベルでアクセス許可 (セキュリティ記述子) を作成します。 この 'アクセス許可' は、共有内のファイル/ディレクトリに使用できます。 'permission' が既に存在する場合は、そのキーを返し、それ以外の場合は共有レベルで新しいアクセス許可を作成し、そのキーを返します。
:rtype str ファイルのアクセス許可キーを返します
create_permission_for_share(share_name, file_permission, timeout=None)パラメーター
- share_name
共有の名前。
- file_permission
ファイルのアクセス許可、ポータブル SDDL
- timeout
timeout パラメーターは、秒単位で表されます。
create_share
指定したアカウントの下に新しい共有を作成します。 同じ名前の共有が既に存在する場合、サービスで操作は失敗します。 既定では、例外はクライアントによって飲み込まれます。 例外を公開するには、fail_on_existsに True を指定します。
create_share(share_name, metadata=None, quota=None, fail_on_exist=False, timeout=None)パラメーター
戻り値
共有が作成されている場合は True、共有が既に存在する場合は False。
の戻り値の型 :
delete_directory
指定した空のディレクトリを削除します。 ディレクトリを空にしてから削除する必要があることに注意してください。 空ではないディレクトリを削除しようとすると失敗します。
ディレクトリが存在しない場合、サービスで操作は失敗します。 既定では、例外はクライアントによって飲み込まれます。 例外を公開するには、fail_not_existに True を指定します。
delete_directory(share_name, directory_name, fail_not_exist=False, timeout=None)パラメーター
戻り値
ディレクトリが削除された場合は True、それ以外の場合は False。
の戻り値の型 :
delete_file
指定したファイルに削除のマークを付けます。 ファイルは後でガベージ コレクション中に削除されます。
delete_file(share_name, directory_name, file_name, timeout=None)パラメーター
delete_share
指定した共有に削除のマークを付けます。 共有が存在しない場合、サービスで操作は失敗します。 既定では、例外はクライアントによって飲み込まれます。 例外を公開するには、fail_not_existに True を指定します。
delete_share(share_name, fail_not_exist=False, timeout=None, snapshot=None, delete_snapshots=None)パラメーター
- snapshot
- str
スナップショットバージョンを表す文字列 (該当する場合)。 特定のスナップショットのみを削除するには、この引数を指定します。 delete_snapshotsが指定されている場合は None にする必要があります。
- delete_snapshots
- DeleteSnapshot
スナップショットを含む共有を削除するには、DeleteSnapshot.Include として指定する必要があります。
戻り値
共有が削除された場合は True、False 共有は存在しません。
の戻り値の型 :
exists
共有名のみを指定した場合に共有が存在するかどうかを示すブール値を返します。 directory_nameが指定されている場合は、ディレクトリが存在するかどうかを示すブール値が返されます。 file_nameも指定すると、ファイルが存在するかどうかを示すブール値が返されます。
exists(share_name, directory_name=None, file_name=None, timeout=None, snapshot=None)パラメーター
戻り値
リソースが存在するかどうかを示すブール値。
の戻り値の型 :
extract_date_and_request_id
static extract_date_and_request_id(retry_context)パラメーター
- retry_context
generate_account_shared_access_signature
ファイル サービスの共有アクセス署名を生成します。 返されたシグネチャは、FileService の 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 アドレスに要求が制限されます。
- protocol
- str
要求に対して許可されるプロトコルを指定します。 使用できる値は、HTTPS と HTTP (https,http) または HTTPS のみ (https) の両方です。 既定値は https,http です。 HTTP のみの値は許可されていないことに注意してください。
戻り値
Shared Access Signature (sas) トークン。
の戻り値の型 :
generate_file_shared_access_signature
ファイルの共有アクセス署名を生成します。 返されたシグネチャは、FileService の sas_token パラメーターと共に使用します。
generate_file_shared_access_signature(share_name, directory_name=None, file_name=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)パラメーター
- directory_name
- str
ディレクトリの名前。 SAS トークンはディレクトリに対して作成できないため、このパラメーターは、file_nameが指定されている場合にのみ存在する必要があります。
- permission
- FilePermissions
共有アクセス署名と関連付けられているアクセス許可。 ユーザーが使用できる操作は、アクセス許可によって許可されるものに制限されます。 アクセス許可は、読み取り、作成、書き込み、削除、リストの順序付けである必要があります。 このフィールドを含む格納されているアクセス ポリシーを参照する ID が指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。
共有アクセス署名が無効になる時刻。 このフィールドを含む格納されているアクセス ポリシーを参照する ID が指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。 Azure では常に値が UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。
共有アクセス署名が有効になる時刻。 省略した場合、この呼び出しの開始時刻はストレージ サービスが要求を受け取った時刻と見なされます。 Azure では常に値が UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。
- id
- str
格納されているアクセス ポリシーに関連付けられる最大 64 文字の一意の値。 格納されているアクセス ポリシーを作成するには、set_file_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 アドレスに要求が制限されます。
- protocol
- str
要求に対して許可されるプロトコルを指定します。 使用できる値は、HTTPS と HTTP (https,http) または HTTPS のみ (https) の両方です。 既定値は https,http です。 HTTP のみの値は許可されていないことに注意してください。
戻り値
Shared Access Signature (sas) トークン。
の戻り値の型 :
generate_share_shared_access_signature
共有の共有アクセス署名を生成します。 返されたシグネチャは、FileService の sas_token パラメーターと共に使用します。
generate_share_shared_access_signature(share_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)パラメーター
- permission
- SharePermissions
共有アクセス署名と関連付けられているアクセス許可。 ユーザーが使用できる操作は、アクセス許可によって許可されるものに制限されます。 アクセス許可は、読み取り、作成、書き込み、削除、リストの順序付けである必要があります。 このフィールドを含む格納されているアクセス ポリシーを参照する ID が指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。
共有アクセス署名が無効になる時刻。 このフィールドを含む格納されているアクセス ポリシーを参照する ID が指定されていない限り、必須です。 このフィールドは、関連付けられた保存されているアクセス ポリシーで指定されている場合には省略する必要があります。 Azure では常に値が UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。
共有アクセス署名が有効になる時刻。 省略した場合、この呼び出しの開始時刻はストレージ サービスが要求を受け取った時刻と見なされます。 Azure では常に値が UTC に変換されます。 タイムゾーン情報なしで日付が渡された場合は、UTC と見なされます。
- id
- str
格納されているアクセス ポリシーに関連付けられる最大 64 文字の一意の値。 格納されているアクセス ポリシーを作成するには、 を使用 set_share_aclします。
- ip
- str
要求を受け入れる IP アドレスまたは IP アドレスの範囲を指定します。 要求の発信元の IP アドレスが SAS トークンで指定された IP アドレスまたはアドレス範囲と一致しない場合、要求は認証されません。 たとえば、SAS で sip=168.1.5.65 または sip=168.1.5.60-168.1.5.70 を指定すると、それらの IP アドレスに要求が制限されます。
- protocol
- str
要求に対して許可されるプロトコルを指定します。 使用できる値は、HTTPS と HTTP (https,http) または HTTPS のみ (https) の両方です。 既定値は https,http です。 HTTP のみの値は許可されていないことに注意してください。
戻り値
Shared Access Signature (sas) トークン。
の戻り値の型 :
get_directory_metadata
指定したディレクトリのすべてのユーザー定義メタデータを返します。
get_directory_metadata(share_name, directory_name, timeout=None, snapshot=None)パラメーター
戻り値
ディレクトリ メタデータ名、値ペアを表すディクショナリ。
の戻り値の型 :
get_directory_properties
指定したディレクトリのすべてのユーザー定義メタデータとシステム プロパティを返します。 返されるデータには、ディレクトリのファイルの一覧は含まれません。
get_directory_properties(share_name, directory_name, timeout=None, snapshot=None)パラメーター
戻り値
ディレクトリ オブジェクト内の指定したディレクトリのプロパティ。
の戻り値の型 :
get_file_metadata
指定したファイルのすべてのユーザー定義メタデータを返します。
get_file_metadata(share_name, directory_name, file_name, timeout=None, snapshot=None)パラメーター
戻り値
ファイル メタデータ名、値ペアを表すディクショナリ。
の戻り値の型 :
get_file_properties
ファイルのすべてのユーザー定義メタデータ、標準 HTTP プロパティ、およびシステム プロパティを返します。 と のインスタンスFileFilePropertiesとメタデータ ディクテーションを返します。
get_file_properties(share_name, directory_name, file_name, timeout=None, snapshot=None)パラメーター
戻り値
プロパティとメタデータを含むファイル オブジェクト。
の戻り値の型 :
get_file_service_properties
Azure Storage Analyticsを含むストレージ アカウントの File サービスのプロパティを取得します。
get_file_service_properties(timeout=None)パラメーター
戻り値
ファイル サービスのプロパティ。
の戻り値の型 :
get_file_to_bytes
ファイルをバイト配列としてダウンロードし、自動チャンクと進行状況通知を使用します。 プロパティ、メタデータ、およびコンテンツを含む の File インスタンスを返します。
get_file_to_bytes(share_name, directory_name, file_name, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)パラメーター
- start_range
- int
ファイルのセクションをダウンロードするために使用するバイト範囲の先頭。 end_rangeが指定されていない場合は、start_rangeの後のすべてのバイトがダウンロードされます。 start_rangeパラメーターと end_range パラメーターは包括的です。 例: start_range=0、end_range=511 は最初の 512 バイトのファイルをダウンロードします。
- end_range
- int
ファイルのセクションをダウンロードするために使用するバイト範囲の末尾。 end_rangeを指定する場合は、start_rangeを指定する必要があります。 start_rangeパラメーターと end_range パラメーターは包括的です。 例: start_range=0、end_range=511 は最初の 512 バイトのファイルをダウンロードします。
- validate_content
- bool
true に設定されている場合は、ファイルの取得された各部分の 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 はファイルのサイズ (既知の場合) です。
- max_connections
- int
2 以上に設定した場合、最初の取得は最初の自己に対して行われます。ファイルのMAX_SINGLE_GET_SIZEバイト数。 これがファイル全体の場合、 メソッドはこの時点で を返します。 そうでない場合は、max_connectionsと等しいスレッドの数を使用して、残りのデータを並列にダウンロードします。 各チャンクのサイズは self になります。MAX_CHUNK_GET_SIZE。 1 に設定すると、1 つの大きな get 要求が実行されます。 これは一般的には推奨されませんが、使用するスレッドが非常に少ない場合、ネットワーク要求が非常に高価な場合、またはシーク不可能なストリームが並列ダウンロードを妨げる場合に使用できます。 これは、アトミック性を強制するためにファイルが同時に変更されている場合や、max_connectionsが 1 より大きい場合に空のファイルに対して追加の要求が必要であるため、多くのファイルが空であると予想される場合にも役立ちます。
- timeout
- int
timeout パラメーターは、秒単位で表されます。 このメソッドは、Azure サービスに対して複数の呼び出しを行う場合があり、タイムアウトは各呼び出しに個別に適用されます。
戻り値
プロパティ、コンテンツ、およびメタデータを含むファイル。
の戻り値の型 :
get_file_to_path
自動チャンクと進行状況通知を使用して、ファイルをファイル パスにダウンロードします。 プロパティとメタデータを含む File のインスタンスを返します。
get_file_to_path(share_name, directory_name, file_name, file_path, open_mode='wb', start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)パラメーター
- open_mode
- str
ファイルを開くときに使用するモード。 append のみをopen_mode指定すると、並列ダウンロードは実行できなくなることに注意してください。 そのため、このopen_modeを使用する場合は、max_connectionsを 1 に設定する必要があります。
- start_range
- int
ファイルのセクションをダウンロードするために使用するバイト範囲の先頭。 end_rangeが指定されていない場合は、start_rangeの後のすべてのバイトがダウンロードされます。 start_rangeパラメーターと end_range パラメーターは包括的です。 例: start_range=0、end_range=511 は最初の 512 バイトのファイルをダウンロードします。
- end_range
- int
ファイルのセクションをダウンロードするために使用するバイト範囲の末尾。 end_rangeを指定する場合は、start_rangeを指定する必要があります。 start_rangeパラメーターと end_range パラメーターは包括的です。 例: start_range=0、end_range=511 は最初の 512 バイトのファイルをダウンロードします。
- validate_content
- bool
true に設定されている場合は、ファイルの取得された各部分の 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 はファイルのサイズ (既知の場合) です。
- max_connections
- int
2 以上に設定した場合、最初の取得は最初の自己に対して行われます。ファイルのMAX_SINGLE_GET_SIZEバイト数。 これがファイル全体の場合、 メソッドはこの時点で を返します。 そうでない場合は、max_connectionsと等しいスレッドの数を使用して、残りのデータを並列にダウンロードします。 各チャンクのサイズは self になります。MAX_CHUNK_GET_SIZE。 1 に設定すると、1 つの大きな get 要求が実行されます。 これは一般的には推奨されませんが、使用するスレッドが非常に少ない場合、ネットワーク要求が非常に高価な場合、またはシーク不可能なストリームが並列ダウンロードを妨げる場合に使用できます。 これは、アトミック性を強制するためにファイルが同時に変更されている場合や、max_connectionsが 1 より大きい場合に空のファイルに対して追加の要求が必要であるため、多くのファイルが空であると予想される場合にも役立ちます。
- timeout
- int
timeout パラメーターは、秒単位で表されます。 このメソッドは、Azure サービスに対して複数の呼び出しを行う場合があり、タイムアウトは各呼び出しに個別に適用されます。
戻り値
プロパティとメタデータを含むファイル。
の戻り値の型 :
get_file_to_stream
自動チャンクと進行状況通知を使用して、ストリームにファイルをダウンロードします。 プロパティとメタデータを含む の File インスタンスを返します。
get_file_to_stream(share_name, directory_name, file_name, stream, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)パラメーター
- start_range
- int
ファイルのセクションをダウンロードするために使用するバイト範囲の先頭。 end_rangeが指定されていない場合は、start_rangeの後のすべてのバイトがダウンロードされます。 start_rangeパラメーターと end_range パラメーターは包括的です。 例: start_range=0、end_range=511 は最初の 512 バイトのファイルをダウンロードします。
- end_range
- int
ファイルのセクションをダウンロードするために使用するバイト範囲の末尾。 end_rangeを指定する場合は、start_rangeを指定する必要があります。 start_rangeパラメーターと end_range パラメーターは包括的です。 例: start_range=0、end_range=511 は最初の 512 バイトのファイルをダウンロードします。
- validate_content
- bool
true に設定されている場合は、ファイルの取得された各部分の 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 はファイルのサイズ (既知の場合) です。
- max_connections
- int
2 以上に設定した場合、最初の取得は最初の自己に対して行われます。ファイルのMAX_SINGLE_GET_SIZEバイト数。 これがファイル全体の場合、 メソッドはこの時点で を返します。 そうでない場合は、max_connectionsと等しいスレッドの数を使用して、残りのデータを並列にダウンロードします。 各チャンクのサイズは self になります。MAX_CHUNK_GET_SIZE。 1 に設定すると、1 つの大きな get 要求が実行されます。 これは一般的には推奨されませんが、使用するスレッドが非常に少ない場合、ネットワーク要求が非常に高価な場合、またはシーク不可能なストリームが並列ダウンロードを妨げる場合に使用できます。 これは、アトミック性を強制するためにファイルが同時に変更されている場合や、max_connectionsが 1 より大きい場合に空のファイルに対して追加の要求が必要であるため、多くのファイルが空であると予想される場合にも役立ちます。
- timeout
- int
timeout パラメーターは、秒単位で表されます。 このメソッドは、Azure サービスに対して複数の呼び出しを行う場合があり、タイムアウトは各呼び出しに個別に適用されます。
戻り値
プロパティとメタデータを含むファイル。
の戻り値の型 :
get_file_to_text
自動チャンクと進行状況通知を使用して、ファイルを Unicode テキストとしてダウンロードします。 プロパティ、メタデータ、およびコンテンツを含む の File インスタンスを返します。
get_file_to_text(share_name, directory_name, file_name, encoding='utf-8', start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)パラメーター
- start_range
- int
ファイルのセクションをダウンロードするために使用するバイト範囲の先頭。 end_rangeが指定されていない場合は、start_rangeの後のすべてのバイトがダウンロードされます。 start_rangeパラメーターと end_range パラメーターは包括的です。 例: start_range=0、end_range=511 は最初の 512 バイトのファイルをダウンロードします。
- end_range
- int
ファイルのセクションをダウンロードするために使用するバイト範囲の末尾。 end_rangeを指定する場合は、start_rangeを指定する必要があります。 start_rangeパラメーターと end_range パラメーターは包括的です。 例: start_range=0、end_range=511 は最初の 512 バイトのファイルをダウンロードします。
- validate_content
- bool
true に設定されている場合は、ファイルの取得された各部分の 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 はファイルのサイズ (既知の場合) です。
- max_connections
- int
2 以上に設定した場合、最初の取得は最初の自己に対して行われます。ファイルのMAX_SINGLE_GET_SIZEバイト数。 これがファイル全体の場合、 メソッドはこの時点で を返します。 そうでない場合は、max_connectionsと等しいスレッドの数を使用して、残りのデータを並列にダウンロードします。 各チャンクのサイズは self になります。MAX_CHUNK_GET_SIZE。 1 に設定すると、1 つの大きな get 要求が実行されます。 これは一般的には推奨されませんが、使用するスレッドが非常に少ない場合、ネットワーク要求が非常に高価な場合、またはシーク不可能なストリームが並列ダウンロードを妨げる場合に使用できます。 これは、アトミック性を強制するためにファイルが同時に変更されている場合や、max_connectionsが 1 より大きい場合に空のファイルに対して追加の要求が必要であるため、多くのファイルが空であると予想される場合にも役立ちます。
- timeout
- int
timeout パラメーターは、秒単位で表されます。 このメソッドは、Azure サービスに対して複数の呼び出しを行う場合があり、タイムアウトは各呼び出しに個別に適用されます。
戻り値
プロパティ、コンテンツ、およびメタデータを含むファイル。
の戻り値の型 :
get_permission_for_share
共有レベルでアクセス許可 (セキュリティ記述子) を作成します。 この 'アクセス許可' は、共有内のファイルまたはディレクトリに使用できます。 'permission' が既に存在する場合は、そのキーを返し、それ以外の場合は共有レベルで新しいアクセス許可を作成し、そのキーを返します。
:ファイルのアクセス許可 (ポータブル SDDL) を返します:rtype str
get_permission_for_share(share_name, file_permission_key, timeout=None)パラメーター
- share_name
共有の名前。
- file_permission_key
取得するファイルアクセス許可のキー
- timeout
timeout パラメーターは、秒単位で表されます。
get_share_acl
指定した共有のアクセス許可を取得します。
get_share_acl(share_name, timeout=None)パラメーター
戻り値
共有に関連付けられているアクセス ポリシーのディクショナリ。
の戻り値の型 :
get_share_metadata
指定した共有のすべてのユーザー定義メタデータを返します。
get_share_metadata(share_name, timeout=None, snapshot=None)パラメーター
戻り値
共有メタデータ名と値のペアを表すディクショナリ。
の戻り値の型 :
get_share_properties
指定した共有のすべてのユーザー定義メタデータとシステム プロパティを返します。 返されるデータには、共有のファイルまたはディレクトリの一覧は含まれません。
get_share_properties(share_name, timeout=None, snapshot=None)パラメーター
戻り値
プロパティとメタデータを公開する共有。
の戻り値の型 :
get_share_stats
共有に格納されているデータのおおよそのサイズを取得します。最も近いギガバイトに切り上げられます。
この値には、最近作成または最近サイズ変更されたすべてのファイルが含まれていない場合があることに注意してください。
get_share_stats(share_name, timeout=None)パラメーター
戻り値
共有に格納されているデータのおおよそのサイズ。
の戻り値の型 :
get_share_stats_in_bytes
共有に格納されているデータのおおよそのサイズをバイト単位で取得します。
この値には、最近作成または最近サイズ変更されたすべてのファイルが含まれていない場合があることに注意してください。
get_share_stats_in_bytes(share_name, timeout=None)パラメーター
戻り値
共有に格納されているデータのおおよそのサイズ。
の戻り値の型 :
list_directories_and_files
指定した共有のディレクトリとファイルを一覧表示するジェネレーターを返します。 ジェネレーターは、サービスによって返された継続トークンに遅れて従い、すべてのディレクトリとファイルが返されるか、num_resultsに達したときに停止します。
num_resultsが指定され、共有に含まれるファイルとディレクトリの数がそれ以上の場合、ジェネレーターは完了するとnext_markerフィールドが設定されます。 より多くの結果が必要な場合は、このマーカーを使用して新しいジェネレーターを作成できます。
list_directories_and_files(share_name, directory_name=None, num_results=None, marker=None, timeout=None, prefix=None, snapshot=None)パラメーター
- num_results
- int
返されるファイルの最大数 (すべてのディレクトリ要素を含む) を指定します。 要求で num_resultsを指定しない場合、または 5,000 を超える値を指定した場合、サーバーは最大 5,000 個のアイテムを返します。 num_resultsを 0 以下の値に設定すると、エラー応答コード 400 (Bad Request) が発生します。
- marker
- str
不透明な継続トークン。 この値は、前のジェネレーター オブジェクトの next_marker フィールドから取得できますnum_resultsが指定され、そのジェネレーターが結果の列挙を完了した場合です。 指定した場合、このジェネレーターは、前のジェネレーターが停止したポイントから結果の返しを開始します。
list_handles
指定した共有の下にあるディレクトリまたはファイルで開いているハンドルを一覧表示するジェネレーターを返します。 ジェネレーターは、サービスによって返された継続トークンに遅れて従い、すべてのハンドルが返されるか、num_resultsに達すると停止します。
num_resultsが指定され、共有に含まれるファイルとディレクトリの数がそれ以上の場合、ジェネレーターは完了するとnext_markerフィールドが設定されます。 より多くの結果が必要な場合は、このマーカーを使用して新しいジェネレーターを作成できます。
list_handles(share_name, directory_name=None, file_name=None, recursive=None, max_results=None, marker=None, snapshot=None, timeout=None)パラメーター
- max_results
- int
返されるファイルやディレクトリに対して取得されるハンドルの最大数を指定します。 要求で max_resultsを指定しない場合、または 5,000 より大きい値を指定した場合、サーバーは最大 5,000 個のアイテムを返します。 max_resultsを 0 以下の値に設定すると、エラー応答コード 400 (Bad Request) が発生します。
- marker
- str
不透明な継続トークン。 この値は、前のジェネレーター オブジェクトのnext_marker フィールドから取得できますmax_results指定され、そのジェネレーターが結果の列挙を完了した場合です。 指定した場合、このジェネレーターは、前のジェネレーターが停止したポイントから結果の返しを開始します。
list_ranges
ファイルの有効な範囲を取得します。
list_ranges(share_name, directory_name, file_name, start_range=None, end_range=None, timeout=None, snapshot=None)パラメーター
- start_range
- int
範囲を一覧表示するバイトの開始オフセットを指定します。 start_rangeパラメーターと end_range パラメーターは包括的です。 例: start_range=0、end_range=511 は最初の 512 バイトのファイルをダウンロードします。
- end_range
- int
範囲を一覧表示するバイトの終了オフセットを指定します。 start_rangeパラメーターと end_range パラメーターは包括的です。 例: start_range=0、end_range=511 は最初の 512 バイトのファイルをダウンロードします。
戻り値
有効な範囲の一覧
の戻り値の型 :
list_shares
指定したアカウントの共有を一覧表示するジェネレーターを返します。 ジェネレーターは、サービスによって返された継続トークンに遅れて従い、すべての共有が返されるか、num_resultsに達したときに停止します。
num_resultsを指定し、アカウントに共有の数を超える場合、ジェネレーターは完了するとnext_markerフィールドが設定されます。 より多くの結果が必要な場合は、このマーカーを使用して新しいジェネレーターを作成できます。
list_shares(prefix=None, marker=None, num_results=None, include_metadata=False, timeout=None, include_snapshots=False)パラメーター
- marker
- str
不透明な継続トークン。 この値は、前のジェネレーター オブジェクトの next_marker フィールドから取得できますnum_resultsが指定され、そのジェネレーターが結果の列挙を完了した場合です。 指定した場合、このジェネレーターは、前のジェネレーターが停止したポイントから結果の返しを開始します。
make_file_url
ファイルにアクセスするための URL を作成します。
make_file_url(share_name, directory_name, file_name, protocol=None, sas_token=None)パラメーター
戻り値
ファイル アクセス URL。
の戻り値の型 :
resize_file
ファイルを指定したサイズに変更します。 指定したバイト値が現在のファイル サイズ未満の場合、指定したバイト値を超える範囲はすべてクリアされます。
resize_file(share_name, directory_name, file_name, content_length, timeout=None)パラメーター
set_directory_metadata
指定したディレクトリに対して 1 つ以上のユーザー定義の名前と値のペアを設定します。 この操作を呼び出すと、その都度、ディレクトリに関連付けられている既存のメタデータがすべて置き換えられます。 ディレクトリからすべてのメタデータを削除するには、メタデータ ディクテーションなしでこの操作を呼び出します。
set_directory_metadata(share_name, directory_name, metadata=None, timeout=None)パラメーター
メタデータとしてディレクトリに関連付ける名前と値のペアを含む dict。 例: {'category':'test'}
set_directory_properties
set_directory_properties(share_name, directory_name, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>, timeout=None)パラメーター
- share_name
共有の名前
- directory_name
ディレクトリの名前
- smb_properties
- SMBProperties
SMB 関連ファイルのプロパティを設定します
set_file_metadata
指定したファイルのユーザー定義メタデータを 1 つ以上の名前と値のペアとして設定します。
set_file_metadata(share_name, directory_name, file_name, metadata=None, timeout=None)パラメーター
名前と値のペアを含む Dict。 この操作を呼び出すと、その都度、ファイルに関連付けられている既存のメタデータがすべて置き換えられます。 すべてのメタデータをファイルから削除するには、この操作をメタデータ ヘッダーなしで呼び出します。
set_file_properties
ファイルのシステム プロパティを設定します。 content_settingsに 1 つのプロパティが設定されている場合、すべてのプロパティがオーバーライドされます。
set_file_properties(share_name, directory_name, file_name, content_settings, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)パラメーター
- smb_properties
- SMBProperties
SMB 関連ファイルのプロパティを設定します
set_file_service_properties
Azure Storage Analyticsを含むストレージ アカウントのファイル サービスのプロパティを設定します。 要素 (例: HourMetrics) が None のままの場合、その機能に対するサービスの既存の設定は保持されます。
set_file_service_properties(hour_metrics=None, minute_metrics=None, cors=None, timeout=None)パラメーター
- hour_metrics
- <xref:Metrics>
時間メトリック設定では、API 別にグループ化された要求統計の概要が、ファイルの時間単位の集計で示されます。
- minute_metrics
- <xref:Metrics>
分単位のメトリック設定では、ファイルの 1 分ごとの要求統計が提供されます。
- cors
- list(CorsRule)
リストには、最大 5 つの CorsRule 要素を含めることができます。 空のリストを指定すると、すべての CORS ルールが削除され、サービスに対して CORS が無効になります。
set_proxy
HTTP CONNECT トンネリングのプロキシ サーバー ホストとポートを設定します。
set_proxy(host, port, user=None, password=None)パラメーター
set_share_acl
Shared Access Signature で使用できる、指定した共有または保存されたアクセス ポリシーのアクセス許可を設定します。
set_share_acl(share_name, signed_identifiers=None, timeout=None)パラメーター
- signed_identifiers
- dict(str, AccessPolicy)
共有に関連付けるアクセス ポリシーのディクショナリ。 ディクショナリには、最大 5 つの要素を含めることができます。 空のディクショナリを使用すると、サービスに設定されているアクセス ポリシーがクリアされます。
set_share_metadata
指定した共有に対して 1 つ以上のユーザー定義の名前と値のペアを設定します。 この操作を呼び出すと、その都度、共有に関連付けられている既存のすべてのメタデータが置き換えられます。 共有からすべてのメタデータを削除するには、メタデータ ディクテーションなしでこの操作を呼び出します。
set_share_metadata(share_name, metadata=None, timeout=None)パラメーター
set_share_properties
指定した共有のサービス定義プロパティを設定します。
set_share_properties(share_name, quota, timeout=None)パラメーター
snapshot_share
指定したアカウントの下に既存の共有のスナップショットを作成します。
snapshot_share(share_name, metadata=None, quota=None, timeout=None)パラメーター
- metadata
- <xref:<xref:a dict> of <xref:str to str:>>
共有とメタデータとして関連付けるname_valueペアを持つディクテーション。 例:{'Category':'test'}
戻り値
スナップショットプロパティ
の戻り値の型 :
update_range
要求本文で指定されたバイトを指定した範囲に書き込みます。
update_range(share_name, directory_name, file_name, data, start_range, end_range, validate_content=False, timeout=None)パラメーター
- start_range
- int
ファイルのセクションを更新するために使用するバイト範囲の先頭。 範囲のサイズは最大 4 MB です。 start_rangeパラメーターと end_range パラメーターは包括的です。 例: start_range=0、end_range=511 は最初の 512 バイトのファイルをダウンロードします。
- end_range
- int
ファイルのセクションを更新するために使用するバイト範囲の末尾。 範囲のサイズは最大 4 MB です。 start_rangeパラメーターと end_range パラメーターは包括的です。 例: start_range=0、end_range=511 は最初の 512 バイトのファイルをダウンロードします。
- validate_content
- bool
true の場合、ページ コンテンツの MD5 ハッシュを計算します。 ストレージ サービスは、送信されたハッシュで到着したコンテンツのハッシュをチェックします。 これは主に、https (既定値) として https ではなく http を使用して既に検証される場合に、ネットワーク上のビットフラグを検出する場合に重要です。 この MD5 ハッシュは ファイルと共に格納されないことに注意してください。
update_range_from_file_url
1 つの Azure File エンドポイントから別の Azure File エンドポイントの指定された範囲にバイトを書き込みます。
update_range_from_file_url(share_name, directory_name, file_name, start_range, end_range, source, source_start_range, timeout=None)パラメーター
- start_range
- int
ファイルのセクションを更新するために使用するバイト範囲の先頭。 範囲のサイズは最大 4 MB です。 start_rangeパラメーターと end_range パラメーターは包括的です。 例: start_range=0、end_range=511 は最初の 512 バイトのファイルをダウンロードします。
- end_range
- int
ファイルのセクションを更新するために使用するバイト範囲の末尾。 範囲のサイズは最大 4 MB です。 start_rangeパラメーターと end_range パラメーターは包括的です。 例: start_range=0、end_range=511 は最初の 512 バイトのファイルをダウンロードします。
- source
- str
Azure ファイルまたは BLOB を指定する最大 2 KB の長さの URL。 この値は要求 URI に含まれるため、URL でエンコードされる必要があります。 ソースが別のアカウントにある場合、ソースはパブリックであるか、共有アクセス署名を介して認証される必要があります。 ソースがパブリックの場合、認証は必要ありません。 例: https://myaccount.file.core.windows.net/myshare/mydir/myfilehttps://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken
- source_start_range
- int
ファイルのセクションを更新するために使用するバイト範囲の先頭。 範囲のサイズは最大 4 MB です。 start_rangeパラメーターと end_range パラメーターは包括的です。 例: start_range=0、end_range=511 は最初の 512 バイトのファイルをダウンロードします。
属性
protocol
request_session
socket_timeout
MAX_CHUNK_GET_SIZE
MAX_CHUNK_GET_SIZE = 8388608MAX_RANGE_SIZE
MAX_RANGE_SIZE = 4194304MAX_SINGLE_GET_SIZE
MAX_SINGLE_GET_SIZE = 33554432
Azure SDK for Python
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示