次の方法で共有

ShareFileClient クラス

  • リファレンス

特定のファイルと対話するクライアント。ただし、そのファイルはまだ存在しない可能性があります。

その他のオプションの構成については、 ここをクリックしてください。

継承
azure.storage.fileshare._shared.base_client.StorageAccountHostsMixin
ShareFileClient

コンストラクター

ShareFileClient(account_url: str, share_name: str, file_path: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, *, token_intent: Literal['backup'] | None = None, **kwargs: Any)

パラメーター

account_url
str
必須

ストレージ アカウントへの URI。 ファイルに対する完全な URI を指定してクライアントを作成するには、 classmethod を使用します from_file_url 。

share_name
str
必須

ファイルの共有の名前。

file_path
str
必須

対話するファイルへのファイル パス。 指定した場合、この値はファイル URL で指定されたファイル値をオーバーライドします。

snapshot
str
既定値: None

操作するオプションのファイル スナップショット。 これには、スナップショット ID 文字列、または からcreate_snapshot返される応答を指定できます。

credential
既定値: None

認証に使用する資格情報。 アカウント URL に SAS トークンが既に含まれている場合、これは省略可能です。 値には、SAS トークン文字列、azure.core.credentials の AzureSasCredential または AzureNamedKeyCredential のインスタンス、アカウント共有アクセス キー、または azure.identity の TokenCredentials クラスのインスタンスを指定できます。 リソース URI に SAS トークンが既に含まれている場合、明示的な資格情報を優先して無視されます

  • 競合する SAS トークンによって ValueError が発生する AzureSasCredential の場合を除きます。 AzureNamedKeyCredential のインスタンスを使用する場合は、"name" をストレージ アカウント名に、"key" をストレージ アカウント キーにする必要があります。
token_intent
Literal['backup']

認証に TokenCredential を使用する場合は必須で、他の形式の認証では無視されます。 TokenCredential 認証を使用する場合のすべての要求の意図を指定します。 次のいずれかの値になります。

backup - 要求はバックアップ/管理者の種類の操作を目的としており、すべてのファイル/ディレクトリ ACL がバイパスされ、完全なアクセス許可が付与されることを意味します。 ユーザーには、必要な RBAC アクセス許可も必要です。

allow_trailing_dot
bool

true の場合、末尾のドットはターゲット URI からトリミングされません。

allow_source_trailing_dot
bool

true の場合、末尾のドットはソース URI からトリミングされません。

api_version
str

要求に使用するストレージ API バージョン。 既定値は、現在の SDK と互換性のある最新のサービス バージョンです。 古いバージョンに設定すると、機能の互換性が低下する可能性があります。

バージョン 12.1.0 の新機能。

secondary_hostname
str

セカンダリ エンドポイントのホスト名。

max_range_size
int

ファイルのアップロードに使用される最大範囲サイズ。 既定値は 4*1024*1024 です。

audience
str

Azure Active Directory 認証のトークンを要求するときに使用する対象ユーザー。 資格情報が TokenCredential 型の場合にのみ有効です。 値は (既定値) または https://.file.core.windows.net にすることができますhttps://storage.azure.com/。

メソッド

abort_copy

進行中のコピー操作を中止します。

これにより、コピー先ファイルの長さが 0 になり、完全なメタデータが残ります。 コピー操作が既に終了している場合は、エラーが発生します。
acquire_lease

新しいリースを要求します。

ファイルにアクティブなリースがない場合、ファイル サービスは BLOB にリースを作成し、新しいリースを返します。
clear_range

指定した範囲をクリアし、その範囲の記憶域で使用されている領域を解放します。
close

このメソッドは、クライアントによって開かれたソケットを閉じる方法です。 コンテキスト マネージャーで を使用する場合は使用する必要はありません。
close_all_handles

開いているファイル ハンドルをすべて閉じます。

この操作は、サービスが開いているすべてのハンドルを閉じるまでブロックされます。
close_handle

開いているファイル ハンドルを閉じます。
create_file

新しいファイルを 1 つ作成します。

ファイルはコンテンツなしでのみ初期化されることに注意してください。
delete_file

指定したファイルに削除のマークを付けます。 ファイルは後でガベージ コレクション中に削除されます。
download_file

StorageStreamDownloader にファイルをダウンロードします。 readall() メソッドを使用してすべてのコンテンツを読み取るか、readinto() を使用してファイルをストリームにダウンロードする必要があります。 chunks() を使用すると、ユーザーがコンテンツをチャンク単位で反復処理できる反復子が返されます。
from_connection_string

接続文字列から ShareFileClient を作成します。
from_file_url

特定のファイルと対話するクライアント。ただし、そのファイルはまだ存在しない可能性があります。
get_file_properties

ファイルのすべてのユーザー定義メタデータ、標準 HTTP プロパティ、およびシステム プロパティを返します。
get_ranges

ファイルまたはファイルのスナップショットの有効なページ範囲の一覧を返します。
get_ranges_diff

ファイルまたはファイルのスナップショットの有効なページ範囲の一覧を返します。

バージョン 12.6.0 の新機能。
list_handles

ファイルのハンドルを一覧表示します。
rename_file

ソース ファイルの名前を変更します。

:p aramtype file_attributes:~azure.storage.fileshare.NTFSAttributes または str :キーワード (keyword) file_creation_time:

ファイルの作成時刻。

:p aramtype file_creation_time:~datetime.datetime または str :キーワード (keyword) file_last_write_time:

ファイルの最終書き込み時刻。

:p aramtype file_last_write_time:~datetime.datetime または str :キーワード (keyword) file_change_time:

ファイルの時刻を変更します。 指定しない場合、変更時刻は現在の日付/時刻に設定されます。

バージョン 12.8.0 の新機能: このパラメーターは API バージョン '2021-06-08' で導入されました。
resize_file

ファイルを指定したサイズに変更します。
set_file_metadata

指定したファイルのユーザー定義メタデータを 1 つ以上の名前と値のペアとして設定します。

この操作を呼び出すと、その都度、ファイルに関連付けられている既存のメタデータがすべて置き換えられます。 ファイルからすべてのメタデータを削除するには、メタデータ ディクテーションなしでこの操作を呼び出します。
set_http_headers

ファイルに HTTP ヘッダーを設定します。
start_copy_from_url

ソース URL からクライアントが参照するファイルへのデータのコピーを開始します。

このコピー操作の状態は、 get_properties メソッドを使用して確認できます。
upload_file

新しいファイルをアップロードします。

param data: ファイルの内容。

param int length: ファイルの長さ (バイト単位)。 最大サイズ (最大 1 TiB) を指定します。

param file_attributes: ファイルとディレクトリのファイル システム属性。 設定しない場合、既定値は "None" になり、属性は "Archive" に設定されます。 var 型が str の場合の例を次に示します: 'Temporary|アーカイブ'。 file_attributes値では大文字と小文字は区別されません。

type file_attributes: str または ~azure.storage.fileshare.NTFSAttributes

param file_creation_time: ファイルの作成時刻 既定値: 今。

type file_creation_time: str または ~datetime.datetime

param file_last_write_time: ファイルの最終書き込み時刻 既定値: 今。

type file_last_write_time: str または ~datetime.datetime

param file_permission: 指定した場合、ディレクトリ/ファイルにアクセス許可 (セキュリティ記述子) を設定する必要があります。 このヘッダーは、アクセス許可のサイズが 8 KB の場合に使用できます。それ以外の場合は <、x-ms-file-permission-key ヘッダーを使用する必要があります。 既定値: 継承します。 SDDL を入力として指定する場合は、所有者、グループ、および dacl が必要です。 注: 指定する必要があるのは、x-ms-file-permission キーまたは x-ms-file-permission-key のいずれか 1 つだけです。

型 file_permission: str

param permission_key: ディレクトリ/ファイルに設定するアクセス許可のキー。 注: 指定する必要があるのは、x-ms-file-permission キーまたは x-ms-file-permission-key のいずれか 1 つだけです。

type permission_key: str
upload_range

バイト範囲をファイルにアップロードします。
upload_range_from_url

ある Azure File エンドポイントから別の Azure File エンドポイントの指定された範囲にバイトを書き込みます。

abort_copy

進行中のコピー操作を中止します。

これにより、コピー先ファイルの長さが 0 になり、完全なメタデータが残ります。 コピー操作が既に終了している場合は、エラーが発生します。

abort_copy(copy_id: str | FileProperties, **kwargs: Any) -> None

パラメーター

copy_id
str または FileProperties
必須

中止するコピー操作。 ID または FileProperties のインスタンスを指定できます。

lease
ShareLeaseClient または str

ファイルにアクティブなリースがある場合は必須。 値には、ShareLeaseClient オブジェクトまたは文字列としてのリース ID を指定できます。

バージョン 12.1.0 の新機能。

timeout
int

操作のサーバー側タイムアウトを秒単位で設定します。 詳細については、 https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations を参照してください。 この値は、クライアントで追跡または検証されません。 クライアント側のネットワーク タイムアウトを構成するには、 こちらを参照してください。

の戻り値の型 :

None

acquire_lease

新しいリースを要求します。

ファイルにアクティブなリースがない場合、ファイル サービスは BLOB にリースを作成し、新しいリースを返します。

acquire_lease(lease_id: str | None = None, **kwargs: Any) -> ShareLeaseClient

パラメーター

lease_id
str
必須

GUID 文字列形式の推奨リース ID。 提案されたリース ID が正しい形式でない場合、ファイル サービスは 400 (無効な要求) を返します。

timeout
int

操作のサーバー側タイムアウトを秒単位で設定します。 詳細については、 https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations を参照してください。 この値は、クライアントで追跡または検証されません。 クライアント側のネットワーク タイムアウトを構成するには、 こちらを参照してください。

戻り値

ShareLeaseClient オブジェクト。

の戻り値の型 :

ShareLeaseClient

例

ファイルのリースを取得する。


   source_file.create_file(1024)
   lease = source_file.acquire_lease()
   source_file.upload_file(b'hello world', lease=lease)

   lease.release()

clear_range

指定した範囲をクリアし、その範囲の記憶域で使用されている領域を解放します。

clear_range(offset: int, length: int, **kwargs) -> Dict[str, Any]

パラメーター

offset
int
必須

ファイルのセクションをクリアするために使用するバイト範囲の先頭。 範囲のサイズは最大 4 MB です。

length
int
必須

ファイルのセクションをクリアするために使用するバイト数。 範囲のサイズは最大 4 MB です。

lease
ShareLeaseClient または str

ファイルにアクティブなリースがある場合は必須。 値には、ShareLeaseClient オブジェクトまたは文字列としてのリース ID を指定できます。

バージョン 12.1.0 の新機能。

timeout
int

操作のサーバー側タイムアウトを秒単位で設定します。 詳細については、 https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations を参照してください。 この値は、クライアントで追跡または検証されません。 クライアント側のネットワーク タイムアウトを構成するには、 こちらを参照してください。

戻り値

ファイル更新プロパティの dict (Etag と最終変更)。

の戻り値の型 :

Dict[str, Any]

close

このメソッドは、クライアントによって開かれたソケットを閉じる方法です。 コンテキスト マネージャーで を使用する場合は使用する必要はありません。

close()

close_all_handles

開いているファイル ハンドルをすべて閉じます。

この操作は、サービスが開いているすべてのハンドルを閉じるまでブロックされます。

close_all_handles(**kwargs: Any) -> Dict[str, int]

パラメーター

timeout
int

操作のサーバー側タイムアウトを秒単位で設定します。 詳細については、 https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations を参照してください。 この値は、クライアントで追跡または検証されません。 クライアント側のネットワーク タイムアウトを構成するには、 こちらを参照してください。

戻り値

閉じたハンドルの数 (指定したハンドルが見つからなかった場合は 0 になる可能性があります) と、ディクテーションで閉じられなかったハンドルの数。

の戻り値の型 :

dict[str, int]

close_handle

開いているファイル ハンドルを閉じます。

close_handle(handle: str | Handle, **kwargs: Any) -> Dict[str, int]

パラメーター

handle
str または Handle
必須

閉じる特定のハンドル。

timeout
int

操作のサーバー側タイムアウトを秒単位で設定します。 詳細については、 https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations を参照してください。 この値は、クライアントで追跡または検証されません。 クライアント側のネットワーク タイムアウトを構成するには、 こちらを参照してください。

戻り値

閉じたハンドルの数 (指定したハンドルが見つからなかった場合は 0 になる可能性があります) と、ディクテーションで閉じられなかったハンドルの数。

の戻り値の型 :

dict[str, int]

create_file

新しいファイルを 1 つ作成します。

ファイルはコンテンツなしでのみ初期化されることに注意してください。

create_file(size: int, file_attributes: str | NTFSAttributes = 'none', file_creation_time: str | datetime | None = 'now', file_last_write_time: str | datetime | None = 'now', file_permission: str | None = None, permission_key: str | None = None, **kwargs: Any) -> Dict[str, Any]

パラメーター

size
int
必須

ファイルの最大サイズ (最大 1 TB) を指定します。

file_attributes
NTFSAttributes
必須

ファイルとディレクトリのファイル システム属性。 設定しない場合、既定値は "None" になり、属性は "Archive" に設定されます。 var 型が str の場合の例を次に示します: 'Temporary|アーカイブ'。 file_attributes値では大文字と小文字は区別されません。

file_creation_time
str または datetime
必須

ファイルの作成時間 既定値: 今すぐ。

file_last_write_time
str または datetime
必須

ファイルの最終書き込み時刻 既定値: 今すぐ。

file_permission
str
必須

指定した場合は、ディレクトリ/ファイルにアクセス許可 (セキュリティ記述子) を設定する必要があります。 このヘッダーは、アクセス許可サイズが 8 KB の場合に使用できます。それ以外の場合は <、x-ms-file-permission-key ヘッダーを使用します。 既定値: 継承。 SDDL を入力として指定する場合は、所有者、グループ、および dacl が必要です。 注: x-ms-file-permission または x-ms-file-permission-key のいずれかを指定する必要があります。

permission_key
str
必須

ディレクトリ/ファイルに設定するアクセス許可のキー。 注: x-ms-file-permission または x-ms-file-permission-key のいずれかを指定する必要があります。

file_change_time
str または datetime

ファイルの時刻を変更します。 指定しない場合、変更時刻は現在の日付/時刻に設定されます。

バージョン 12.8.0 の新機能: このパラメーターは API バージョン '2021-06-08' で導入されました。

content_settings
ContentSettings

ファイル プロパティの設定に使用される ContentSettings オブジェクト。 コンテンツ タイプ、エンコード、言語、処理、md5、キャッシュ制御を設定するために使用されます。

metadata
dict(str,str)

ファイルにメタデータとして関連付ける名前と値のペア。

lease
ShareLeaseClient または str

ファイルにアクティブなリースがある場合は必須。 値には、ShareLeaseClient オブジェクトまたは文字列としてのリース ID を指定できます。

バージョン 12.1.0 の新機能。

timeout
int

操作のサーバー側タイムアウトを秒単位で設定します。 詳細については、 https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations を参照してください。 この値は、クライアントで追跡または検証されません。 クライアント側のネットワーク タイムアウトを構成するには、 こちらを参照してください。

戻り値

ファイル更新プロパティの dict (Etag と最終変更)。

の戻り値の型 :

dict(str, Any)

例

ファイルを作成します。


   # Create and allocate bytes for the file (no content added yet)
   my_allocated_file.create_file(size=100)

delete_file

指定したファイルに削除のマークを付けます。 ファイルは後でガベージ コレクション中に削除されます。

delete_file(**kwargs: Any) -> None

パラメーター

lease
ShareLeaseClient または str

ファイルにアクティブなリースがある場合は必須。 値には、ShareLeaseClient オブジェクトまたは文字列としてのリース ID を指定できます。

バージョン 12.1.0 の新機能。

timeout
int

操作のサーバー側タイムアウトを秒単位で設定します。 詳細については、 https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations を参照してください。 この値は、クライアントで追跡または検証されません。 クライアント側のネットワーク タイムアウトを構成するには、 こちらを参照してください。

の戻り値の型 :

None

例

ファイルを削除します。


   my_file.delete_file()

download_file

StorageStreamDownloader にファイルをダウンロードします。 readall() メソッドを使用してすべてのコンテンツを読み取るか、readinto() を使用してファイルをストリームにダウンロードする必要があります。 chunks() を使用すると、ユーザーがコンテンツをチャンク単位で反復処理できる反復子が返されます。

download_file(offset: int | None = None, length: int | None = None, **kwargs: Any) -> StorageStreamDownloader

パラメーター

offset
int
必須

ファイルのセクションをダウンロードするために使用するバイト範囲の先頭。 length が指定されている場合は、 を設定する必要があります。

length
int
必須

ストリームから読み取るバイト数。 これは省略可能ですが、最適なパフォーマンスを得るための指定が必要です。

max_concurrency
int

使用する並列接続の最大数。

validate_content
bool

true の場合、ファイルの各チャンクの MD5 ハッシュを計算します。 ストレージ サービスは、送信されたハッシュで到着したコンテンツのハッシュをチェックします。 これは主に、https (既定値) として https ではなく http を使用して既に検証される場合に、ネットワーク上のビットフラグを検出する場合に重要です。 この MD5 ハッシュは ファイルと共に格納されないことに注意してください。 また、有効にすると、MD5 ハッシュを計算するにはブロック全体のバッファリングが必要であり、メモリ効率の高いアルゴリズムの目的が無効になるため、メモリ効率の高いアップロード アルゴリズムは使用されないことに注意してください。

lease
ShareLeaseClient または str

ファイルにアクティブなリースがある場合は必須。 値には、ShareLeaseClient オブジェクトまたは文字列としてのリース ID を指定できます。

バージョン 12.1.0 の新機能。

progress_hook
Callable[[int, int], None]

実行時間の長いダウンロードの進行状況を追跡するためのコールバック。 シグネチャは function(current: int, total: int) です。current はこれまでに転送されたバイト数で、total はダウンロードの合計サイズです。

timeout
int

操作のサーバー側タイムアウトを秒単位で設定します。 詳細については、 https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations を参照してください。 この値は、クライアントで追跡または検証されません。 クライアント側のネットワーク タイムアウトを構成するには、 こちらを参照してください。

戻り値

ストリーミング オブジェクト (StorageStreamDownloader)

の戻り値の型 :

<xref:azure.storage.fileshare.StorageStreamDownloader>

例

ファイルをダウンロードします。


   with open(DEST_FILE, "wb") as data:
       stream = my_file.download_file()
       data.write(stream.readall())

from_connection_string

接続文字列から ShareFileClient を作成します。

from_connection_string(conn_str: str, share_name: str, file_path: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

パラメーター

conn_str
str
必須

Azure Storage アカウントへの接続文字列。

share_name
str
必須

共有の名前。

file_path
str
必須

ファイル パス。

snapshot
str
既定値: None

操作するオプションのファイル スナップショット。 これには、スナップショット ID 文字列、または からcreate_snapshot返される応答を指定できます。

credential
既定値: None

認証に使用する資格情報。 アカウント URL に SAS トークンが既に含まれている場合、これは省略可能です。 値には、SAS トークン文字列、azure.core.credentials の AzureSasCredential または AzureNamedKeyCredential のインスタンス、アカウント共有アクセス キー、または azure.identity の TokenCredentials クラスのインスタンスを指定できます。 リソース URI に SAS トークンが既に含まれている場合、明示的な資格情報を優先して無視されます

  • 競合する SAS トークンによって ValueError が発生する AzureSasCredential の場合を除きます。 AzureNamedKeyCredential のインスタンスを使用する場合は、"name" をストレージ アカウント名に、"key" をストレージ アカウント キーにする必要があります。
audience
str

Azure Active Directory 認証のトークンを要求するときに使用する対象ユーザー。 資格情報が TokenCredential 型の場合にのみ有効です。 値は (既定値) または https://.file.core.windows.net にすることができますhttps://storage.azure.com/。

戻り値

ファイル クライアント。

の戻り値の型 :

ShareFileClient

例

接続文字列を使用してファイル クライアントを作成します。


   from azure.storage.fileshare import ShareFileClient
   file = ShareFileClient.from_connection_string(
       self.connection_string,
       share_name="helloworld2",
       file_path="myfile")

from_file_url

特定のファイルと対話するクライアント。ただし、そのファイルはまだ存在しない可能性があります。

from_file_url(file_url: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

パラメーター

file_url
str
必須

ファイルへの完全な URI。

snapshot
str
既定値: None

操作するオプションのファイル スナップショット。 これには、スナップショット ID 文字列、または からcreate_snapshot返される応答を指定できます。

credential
既定値: None

認証に使用する資格情報。 アカウント URL に SAS トークンが既に含まれている場合、これは省略可能です。 値には、SAS トークン文字列、azure.core.credentials の AzureSasCredential または AzureNamedKeyCredential のインスタンス、アカウント共有アクセス キー、または azure.identity の TokenCredentials クラスのインスタンスを指定できます。 リソース URI に SAS トークンが既に含まれている場合、明示的な資格情報を優先して無視されます

  • 競合する SAS トークンによって ValueError が発生する AzureSasCredential の場合を除きます。 AzureNamedKeyCredential のインスタンスを使用する場合は、"name" をストレージ アカウント名に、"key" をストレージ アカウント キーにする必要があります。
audience
str

Azure Active Directory 認証のトークンを要求するときに使用する対象ユーザー。 資格情報が TokenCredential 型の場合にのみ有効です。 値は (既定値) または https://.file.core.windows.net にすることができますhttps://storage.azure.com/。

戻り値

ファイル クライアント。

の戻り値の型 :

ShareFileClient

get_file_properties

ファイルのすべてのユーザー定義メタデータ、標準 HTTP プロパティ、およびシステム プロパティを返します。

get_file_properties(**kwargs: Any) -> FileProperties

パラメーター

lease
ShareLeaseClient または str

ファイルにアクティブなリースがある場合は必須。 値には、ShareLeaseClient オブジェクトまたは文字列としてのリース ID を指定できます。

バージョン 12.1.0 の新機能。

timeout
int

操作のサーバー側タイムアウトを秒単位で設定します。 詳細については、 https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations を参照してください。 この値は、クライアントで追跡または検証されません。 クライアント側のネットワーク タイムアウトを構成するには、 こちらを参照してください。

戻り値

FileProperties

の戻り値の型 :

FileProperties

get_ranges

ファイルまたはファイルのスナップショットの有効なページ範囲の一覧を返します。

get_ranges(offset: int | None = None, length: int | None = None, **kwargs: Any) -> List[Dict[str, int]]

パラメーター

offset
int
必須

範囲を取得するバイトの開始オフセットを指定します。

length
int
必須

範囲を取得するために使用するバイト数。

lease
ShareLeaseClient または str

ファイルにアクティブなリースがある場合は必須です。 値には、ShareLeaseClient オブジェクト、または文字列としてのリース ID を指定できます。

バージョン 12.1.0 の新機能。

timeout
int

操作のサーバー側タイムアウトを秒単位で設定します。 詳細については、 https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations を参照してください。 この値は、クライアントで追跡または検証されません。 クライアント側のネットワーク タイムアウトを構成するには、 こちらを参照してください。

戻り値

有効な範囲の一覧。

の戻り値の型 :

List[dict[str, int]]

get_ranges_diff

ファイルまたはファイルのスナップショットの有効なページ範囲の一覧を返します。

バージョン 12.6.0 の新機能。

get_ranges_diff(previous_sharesnapshot: str | Dict[str, Any], offset: int | None = None, length: int | None = None, **kwargs: Any) -> Tuple[List[Dict[str, int]], List[Dict[str, int]]]

パラメーター

offset
int
必須

範囲を取得するバイトの開始オフセットを指定します。

length
int
必須

範囲を取得するために使用するバイト数。

previous_sharesnapshot
str
必須

以前のファイルスナップショットをより新しいスナップショットまたは現在のファイルと比較することを指定する、不透明な DateTime 値を含む スナップショット diff パラメーター。

lease
ShareLeaseClient または str

ファイルにアクティブなリースがある場合は必須です。 値には、ShareLeaseClient オブジェクト、または文字列としてのリース ID を指定できます。

timeout
int

操作のサーバー側タイムアウトを秒単位で設定します。 詳細については、 https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations を参照してください。 この値は、クライアントで追跡または検証されません。 クライアント側のネットワーク タイムアウトを構成するには、 こちらを参照してください。

戻り値

'start' キーと 'end' キーを持つディクショナリとしてのファイル範囲の 2 つのリストのタプル。 最初の要素はファイル範囲に塗りつぶされ、2 番目の要素はファイル範囲をクリアします。

の戻り値の型 :

tuple(list(dict(str, str), list(dict(str, str))

list_handles

ファイルのハンドルを一覧表示します。

list_handles(**kwargs: Any) -> ItemPaged[Handle]

パラメーター

timeout
int

操作のサーバー側タイムアウトを秒単位で設定します。 詳細については、 https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations を参照してください。 この値は、クライアントで追跡または検証されません。 クライアント側のネットワーク タイムアウトを構成するには、 こちらを参照してください。

戻り値

ハンドルの自動ページング を実行できる

の戻り値の型 :

ItemPaged[Handle]

rename_file

ソース ファイルの名前を変更します。

:p aramtype file_attributes:~azure.storage.fileshare.NTFSAttributes または str :キーワード (keyword) file_creation_time:

ファイルの作成時刻。

:p aramtype file_creation_time:~datetime.datetime または str :キーワード (keyword) file_last_write_time:

ファイルの最終書き込み時刻。

:p aramtype file_last_write_time:~datetime.datetime または str :キーワード (keyword) file_change_time:

ファイルの時刻を変更します。 指定しない場合、変更時刻は現在の日付/時刻に設定されます。

バージョン 12.8.0 の新機能: このパラメーターは API バージョン '2021-06-08' で導入されました。

rename_file(new_name: str, **kwargs: Any) -> ShareFileClient

パラメーター

content_type
str

新しいファイルのコンテンツ タイプ。

バージョン 12.8.0 の新機能: このパラメーターは API バージョン '2021-06-08' で導入されました。

metadata
Dict[str,str]

ファイル ストレージ オブジェクトに関連付ける名前と値のペア。

source_lease
ShareLeaseClient または str

ソース ファイルにアクティブなリースがある場合は必須です。 値には、ShareLeaseClient オブジェクト、または文字列としてのリース ID を指定できます。

destination_lease
ShareLeaseClient または str

コピー先ファイルにアクティブなリースがある場合は必須です。 値には、ShareLeaseClient オブジェクト、または文字列としてのリース ID を指定できます。

戻り値

新しいファイル クライアント。

の戻り値の型 :

ShareFileClient

resize_file

ファイルを指定したサイズに変更します。

resize_file(size: int, **kwargs: Any) -> Dict[str, Any]

パラメーター

size
int
必須

ファイルのサイズを (バイト単位) に変更するサイズ

lease
ShareLeaseClient または str

ファイルにアクティブなリースがある場合は必須です。 値には、ShareLeaseClient オブジェクト、または文字列としてのリース ID を指定できます。

バージョン 12.1.0 の新機能。

timeout
int

操作のサーバー側タイムアウトを秒単位で設定します。 詳細については、 https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations を参照してください。 この値は、クライアントで追跡または検証されません。 クライアント側のネットワーク タイムアウトを構成するには、 こちらを参照してください。

戻り値

ファイル更新プロパティの dict (Etag と最終更新日)。

の戻り値の型 :

Dict[str, Any]

set_file_metadata

指定したファイルのユーザー定義メタデータを 1 つ以上の名前と値のペアとして設定します。

この操作を呼び出すと、その都度、ファイルに関連付けられている既存のメタデータがすべて置き換えられます。 ファイルからすべてのメタデータを削除するには、メタデータ ディクテーションなしでこの操作を呼び出します。

set_file_metadata(metadata: Dict[str, Any] | None = None, **kwargs: Any) -> Dict[str, Any]

パラメーター

metadata
dict(str, str)
必須

ファイルにメタデータとして関連付ける名前と値のペア。

lease
ShareLeaseClient または str

ファイルにアクティブなリースがある場合は必須です。 値には、ShareLeaseClient オブジェクト、または文字列としてのリース ID を指定できます。

バージョン 12.1.0 の新機能。

timeout
int

操作のサーバー側タイムアウトを秒単位で設定します。 詳細については、 https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations を参照してください。 この値は、クライアントで追跡または検証されません。 クライアント側のネットワーク タイムアウトを構成するには、 こちらを参照してください。

戻り値

ファイル更新プロパティの dict (Etag と最終更新日)。

の戻り値の型 :

dict(str, Any)

set_http_headers

ファイルに HTTP ヘッダーを設定します。

set_http_headers(content_settings: ContentSettings, file_attributes: str | NTFSAttributes = 'preserve', file_creation_time: str | datetime | None = 'preserve', file_last_write_time: str | datetime | None = 'preserve', file_permission: str | None = None, permission_key: str | None = None, **kwargs: Any) -> Dict[str, Any]

パラメーター

content_settings
ContentSettings
必須

ファイル プロパティの設定に使用される ContentSettings オブジェクト。 コンテンツ タイプ、エンコード、言語、処理、md5、およびキャッシュ制御を設定するために使用されます。

file_attributes
NTFSAttributes
必須

ファイルとディレクトリのファイル システム属性。 設定されていない場合は、既存の値の保持を示します。 var 型が str の場合の例を次に示します: 'Temporary|アーカイブ'

file_creation_time
str または datetime
必須

ファイルの作成時間 既定値: Preserve。

file_last_write_time
str または datetime
必須

ファイルの最終書き込み時刻 既定値: Preserve。

file_permission
str
必須

指定した場合、ディレクトリ/ファイルにアクセス許可 (セキュリティ記述子) を設定する必要があります。 このヘッダーは、アクセス許可のサイズが 8 KB の場合に使用できます。それ以外の場合は <、x-ms-file-permission-key ヘッダーを使用する必要があります。 既定値: 継承します。 SDDL を入力として指定する場合は、所有者、グループ、および dacl が必要です。 注: 指定する必要があるのは、x-ms-file-permission キーまたは x-ms-file-permission-key のいずれか 1 つだけです。

permission_key
str
必須

ディレクトリ/ファイルに設定するアクセス許可のキー。 注: 指定する必要があるのは、x-ms-file-permission キーまたは x-ms-file-permission-key のいずれか 1 つだけです。

file_change_time
str または datetime

ファイルの時刻を変更します。 指定しない場合、変更時刻は現在の日付/時刻に設定されます。

バージョン 12.8.0 の新機能: このパラメーターは API バージョン '2021-06-08' で導入されました。

lease
ShareLeaseClient または str

ファイルにアクティブなリースがある場合は必須です。 値には、ShareLeaseClient オブジェクト、または文字列としてのリース ID を指定できます。

バージョン 12.1.0 の新機能。

timeout
int

操作のサーバー側タイムアウトを秒単位で設定します。 詳細については、 https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations を参照してください。 この値は、クライアントで追跡または検証されません。 クライアント側のネットワーク タイムアウトを構成するには、 こちらを参照してください。

戻り値

ファイル更新プロパティの dict (Etag と最終更新日)。

の戻り値の型 :

dict(str, Any)

start_copy_from_url

ソース URL からクライアントが参照するファイルへのデータのコピーを開始します。

このコピー操作の状態は、 get_properties メソッドを使用して確認できます。

start_copy_from_url(source_url: str, **kwargs: Any) -> Any

パラメーター

source_url
str
必須

ソース ファイルの URL を指定します。

file_permission
str

指定した場合、ディレクトリ/ファイルにアクセス許可 (セキュリティ記述子) を設定する必要があります。 この値を "source" に設定して、ソース ファイルからセキュリティ記述子をコピーできます。 それ以外の場合は、この値を使用してソース値がオーバーライドされます。 設定されていない場合、アクセス許可の値はターゲット ファイルの親ディレクトリから継承されます。 この設定は、アクセス許可のサイズが 8 KB の場合に使用できます。それ以外の場合は <、permission_keyが使用されます。 SDDL を入力として指定する場合は、所有者、グループ、および dacl が必要です。 注: 指定する必要があるのは、file_permissionまたはpermission_keyのいずれか 1 つだけです。

バージョン 12.1.0 の新機能: このパラメーターは API バージョン '2019-07-07' で導入されました。

permission_key
str

ディレクトリ/ファイルに設定するアクセス許可のキー。 この値を "source" に設定して、ソース ファイルからセキュリティ記述子をコピーできます。 それ以外の場合は、この値を使用してソース値がオーバーライドされます。 設定されていない場合、アクセス許可の値はターゲット ファイルの親ディレクトリから継承されます。 注: 指定する必要があるのは、file_permissionまたはpermission_keyのいずれか 1 つだけです。

バージョン 12.1.0 の新機能: このパラメーターは API バージョン '2019-07-07' で導入されました。

file_attributes
NTFSAttributes

この値を "source" に設定すると、ソース ファイルからターゲット ファイルにファイル属性をコピーしたり、すべての属性をクリアしたりするために、"None" に設定できます。 それ以外の場合は、ターゲット ファイルで設定する属性の一覧に設定できます。 これが設定されていない場合、既定値は "Archive" です。

バージョン 12.1.0 の新機能: このパラメーターは API バージョン '2019-07-07' で導入されました。

file_creation_time
str または datetime

この値を "source" に設定して、ソース ファイルからターゲット ファイルに作成時刻をコピーするか、datetime をターゲット ファイルの作成時刻として設定できます。 ISO 8601 形式の文字列を指定することもできます。 これが設定されていない場合、作成時刻はコピー エンジンによってターゲット ファイルの作成 (または上書きされた日時) の日付時刻の値に設定されます。

バージョン 12.1.0 の新機能: このパラメーターは API バージョン '2019-07-07' で導入されました。

file_last_write_time
str または datetime

この値を "source" に設定して、ソース ファイルからターゲット ファイルに最後の書き込み時刻をコピーするか、datetime をターゲット ファイルの最後の書き込み時刻として設定できます。 ISO 8601 形式の文字列を指定することもできます。 これが設定されていない場合、値はコピー エンジンによるファイルへの最後の書き込み時刻になります。

バージョン 12.1.0 の新機能: このパラメーターは API バージョン '2019-07-07' で導入されました。

file_change_time
str または datetime

ファイルの時刻を変更します。 指定しない場合、変更時刻は現在の日付/時刻に設定されます。

バージョン 12.9.0 の新機能: このパラメーターは API バージョン '2021-06-08' で導入されました。

ignore_read_only
bool

ターゲット ファイルが既に存在し、読み取り専用属性が設定されている場合に、ターゲット ファイルを上書きするオプションを指定します。

バージョン 12.1.0 の新機能: このパラメーターは API バージョン '2019-07-07' で導入されました。

set_archive_attribute
bool

ターゲット ファイルにアーカイブ属性を設定するオプションを指定します。 True を指定すると、属性のオーバーライドやソース ファイルの状態にかかわらず、ターゲット ファイルにアーカイブ属性が設定されます。

バージョン 12.1.0 の新機能: このパラメーターは API バージョン '2019-07-07' で導入されました。

metadata

ファイルにメタデータとして関連付ける名前と値のペア。

lease
ShareLeaseClient または str

ファイルにアクティブなリースがある場合は必須です。 値には、ShareLeaseClient オブジェクト、または文字列としてのリース ID を指定できます。

バージョン 12.1.0 の新機能。

timeout
int

操作のサーバー側タイムアウトを秒単位で設定します。 詳細については、 https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations を参照してください。 この値は、クライアントで追跡または検証されません。 クライアント側のネットワーク タイムアウトを構成するには、 こちらを参照してください。

の戻り値の型 :

dict(str, Any)

例

URL からファイルをコピーする


   destination_file.start_copy_from_url(source_url=source_url)

upload_file

新しいファイルをアップロードします。

param data: ファイルの内容。

param int length: ファイルの長さ (バイト単位)。 最大サイズ (最大 1 TiB) を指定します。

param file_attributes: ファイルとディレクトリのファイル システム属性。 設定しない場合、既定値は "None" になり、属性は "Archive" に設定されます。 var 型が str の場合の例を次に示します: 'Temporary|アーカイブ'。 file_attributes値では大文字と小文字は区別されません。

type file_attributes: str または ~azure.storage.fileshare.NTFSAttributes

param file_creation_time: ファイルの作成時刻 既定値: 今。

type file_creation_time: str または ~datetime.datetime

param file_last_write_time: ファイルの最終書き込み時刻 既定値: 今。

type file_last_write_time: str または ~datetime.datetime

param file_permission: 指定した場合、ディレクトリ/ファイルにアクセス許可 (セキュリティ記述子) を設定する必要があります。 このヘッダーは、アクセス許可のサイズが 8 KB の場合に使用できます。それ以外の場合は <、x-ms-file-permission-key ヘッダーを使用する必要があります。 既定値: 継承します。 SDDL を入力として指定する場合は、所有者、グループ、および dacl が必要です。 注: 指定する必要があるのは、x-ms-file-permission キーまたは x-ms-file-permission-key のいずれか 1 つだけです。

型 file_permission: str

param permission_key: ディレクトリ/ファイルに設定するアクセス許可のキー。 注: 指定する必要があるのは、x-ms-file-permission キーまたは x-ms-file-permission-key のいずれか 1 つだけです。

type permission_key: str

upload_file(data: bytes | str | Iterable | IO, length: int | None = None, file_attributes: str | NTFSAttributes = 'none', file_creation_time: str | datetime | None = 'now', file_last_write_time: str | datetime | None = 'now', file_permission: str | None = None, permission_key: str | None = None, **kwargs) -> Dict[str, Any]

パラメーター

file_change_time

ファイルの時刻を変更します。 指定しない場合、変更時刻は現在の日付/時刻に設定されます。

バージョン 12.8.0 の新機能: このパラメーターは API バージョン '2021-06-08' で導入されました。

paramtype file_change_time: str または ~datetime.datetime

dict(str,str) メタデータキーワード (keyword): メタデータとしてファイルに関連付けられている名前と値のペア。

~azure.storage.fileshare.ContentSettings content_settings: ファイル プロパティの設定に使用される ContentSettings オブジェクトをキーワード (keyword)します。 コンテンツ タイプ、エンコード、言語、処理、md5、およびキャッシュ制御を設定するために使用されます。

キーワード (keyword) bool validate_content: true の場合、ファイルの各範囲の MD5 ハッシュが計算されます。 ストレージ サービスは、送信されたハッシュで到着したコンテンツのハッシュをチェックします。 これは主に、https として https (既定値) ではなく https を使用して既に検証する場合に、ネットワーク上のビットフラグを検出する場合に重要です。 この MD5 ハッシュは ファイルと共に格納されないことに注意してください。

キーワード (keyword) int max_concurrency: 使用する並列接続の最大数。

キーワード (keyword)リース: ファイルにアクティブなリースがある場合は必須です。 値には、ShareLeaseClient オブジェクト、または文字列としてのリース ID を指定できます。

バージョン 12.1.0 の新機能。

paramtype lease: ~azure.storage.fileshare.ShareLeaseClient または str

キーワード (keyword) progress_hook: 実行時間の長いアップロードの進行状況を追跡するためのコールバック。 シグネチャは function(current: int, total: Optional[int]) です。current はこれまでに転送されたバイト数で、total は BLOB のサイズ、サイズが不明な場合は None です。

paramtype progress_hook: Callable[[int, Optional[int]], None]

キーワード (keyword) int timeout: 操作のサーバー側タイムアウトを秒単位で設定します。 詳細については、 https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations を参照してください。 この値は、クライアントで追跡または検証されません。 クライアント側のネットワーク タイムアウトを構成するには、 こちらを参照してください。

キーワード (keyword) str エンコード: 既定値は UTF-8 です。

returns: ファイル更新プロパティの dict (Etag と最終更新日)。

rtype: dict(str, Any)

例: ファイルをアップロードします。


   with open(SOURCE_FILE, "rb") as source:
       my_file.upload_file(source)

upload_range

バイト範囲をファイルにアップロードします。

upload_range(data: bytes, offset: int, length: int, **kwargs) -> Dict[str, Any]

パラメーター

data
bytes
必須

アップロードするデータ。

offset
int
必須

ファイルのセクションをアップロードするために使用するバイト範囲の先頭。 範囲のサイズは最大 4 MB です。

length
int
必須

ファイルのセクションをアップロードするために使用するバイト数。 範囲のサイズは最大 4 MB です。

validate_content
bool

true の場合、ページ コンテンツの MD5 ハッシュを計算します。 ストレージ サービスは、送信されたハッシュで到着したコンテンツのハッシュをチェックします。 これは主に、https (既定値) として https ではなく http を使用して既に検証される場合に、ネットワーク上のビットフラグを検出する場合に重要です。 この MD5 ハッシュは ファイルと共に格納されないことに注意してください。

file_last_write_mode
Literal["preserve", "now"]

ファイルの最終書き込み時刻を保持または上書きする必要がある場合。 使用可能な値は、"preserve" または "now" です。 指定しない場合、ファイルの最終書き込み時刻は現在の日付/時刻に変更されます。

バージョン 12.8.0 の新機能: このパラメーターは API バージョン '2021-06-08' で導入されました。

lease
ShareLeaseClient または str

ファイルにアクティブなリースがある場合は必須。 値には、ShareLeaseClient オブジェクトまたは文字列としてのリース ID を指定できます。

バージョン 12.1.0 の新機能。

timeout
int

操作のサーバー側タイムアウトを秒単位で設定します。 詳細については、 https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations を参照してください。 この値は、クライアントで追跡または検証されません。 クライアント側のネットワーク タイムアウトを構成するには、 こちらを参照してください。

encoding
str

既定値は UTF-8 です。

戻り値

ファイル更新プロパティの dict (Etag と最終変更)。

の戻り値の型 :

Dict[str, Any]

upload_range_from_url

ある Azure File エンドポイントから別の Azure File エンドポイントの指定された範囲にバイトを書き込みます。

upload_range_from_url(source_url: str, offset: int, length: int, source_offset: int, **kwargs: Any) -> Dict[str, Any]

パラメーター

offset
int
必須

ファイルのセクションを更新するために使用するバイト範囲の先頭。 範囲のサイズは最大 4 MB です。

length
int
必須

ファイルのセクションを更新するために使用するバイト数。 範囲のサイズは最大 4 MB です。

source_url
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_offset
int
必須

これは、コピー ソースから取得する必要があるバイト範囲の開始を示します。 サービスは、宛先範囲 (長さオフセット) と同じバイト数を読み取ります。

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_etag
str

ソース ETag 値、またはワイルドカード文字 (*)。 リソースが変更されたかどうかをチェックし、match_condition パラメーターで指定された条件に従って動作するために使用されます。

source_match_condition
MatchConditions

etag で使用するソース一致条件。

file_last_write_mode
Literal["preserve", "now"]

ファイルの最終書き込み時刻を保持または上書きする必要がある場合。 使用可能な値は、"preserve" または "now" です。 指定しない場合、ファイルの最終書き込み時刻は現在の日付/時刻に変更されます。

バージョン 12.8.0 の新機能: このパラメーターは API バージョン '2021-06-08' で導入されました。

lease
ShareLeaseClient または str

ファイルにアクティブなリースがある場合は必須。 値には、ShareLeaseClient オブジェクトまたは文字列としてのリース ID を指定できます。

バージョン 12.1.0 の新機能。

timeout
int

操作のサーバー側タイムアウトを秒単位で設定します。 詳細については、 https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations を参照してください。 この値は、クライアントで追跡または検証されません。 クライアント側のネットワーク タイムアウトを構成するには、 こちらを参照してください。

source_authorization
str

クライアント シークレットを使用してサービス プリンシパルとして認証し、ソース BLOB にアクセスします。 "bearer" がsource_authorization文字列のプレフィックスであることを確認します。

属性

api_version

要求に使用される Storage API のバージョン。

location_mode

クライアントが現在使用している場所モード。

既定では、これは "プライマリ" になります。 オプションには、"primary" と "secondary" が含まれます。

primary_endpoint

完全なプライマリ エンドポイント URL。

primary_hostname

プライマリ エンドポイントのホスト名。

secondary_endpoint

完全なセカンダリ エンドポイント URL (構成されている場合)。

使用できない場合は、ValueError が発生します。 セカンダリ ホスト名を明示的に指定するには、インスタンス化時に省略可能な secondary_hostname キーワード (keyword) 引数を使用します。

例外

ValueError

secondary_hostname

セカンダリ エンドポイントのホスト名。

使用できない場合、これは None になります。 セカンダリ ホスト名を明示的に指定するには、インスタンス化時に省略可能な secondary_hostname キーワード (keyword) 引数を使用します。

url

SAS トークン (使用されている場合) を含む、このエンティティへの完全なエンドポイント URL。

これは、現在 location_modeの に応じて、プライマリ エンドポイントまたはセカンダリ エンドポイントのいずれかになります。 :returns: SAS トークン (使用されている場合) を含む、このエンティティへの完全なエンドポイント URL。 :rtype: str