ShareDirectoryClient クラス

リファレンス

特定のディレクトリと対話するクライアント。まだ存在しない可能性があります。

この共有内の特定のサブディレクトリまたはファイルに関連する操作の場合は、および get_file_client 関数を使用してget_subdirectory_client、それらのエンティティのクライアントを取得することもできます。

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

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

ShareDirectoryClient

コンストラクター

ShareDirectoryClient(account_url: str, share_name: str, directory_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_directory_url 。

share_name: str

必須

ディレクトリの共有の名前。

directory_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/。

メソッド

close	このメソッドは、クライアントによって開かれたソケットを閉じる方法です。コンテキストマネージャーでを使用する場合は使用する必要はありません。
close_all_handles	開いているファイルハンドルをすべて閉じます。この操作は、サービスが開いているすべてのハンドルを閉じるまでブロックされます。
close_handle	開いているファイルハンドルを閉じます。
create_directory	クライアントによって参照されるディレクトリの下に新しいディレクトリを作成します。
create_subdirectory	新しいサブディレクトリを作成し、サブディレクトリと対話するクライアントを返します。
delete_directory	ディレクトリに削除のマークを付けます。ディレクトリは後でガベージコレクション中に削除されます。
delete_file	指定したファイルに削除のマークを付けます。ファイルは後でガベージコレクション中に削除されます。
delete_subdirectory	サブディレクトリを削除します。
exists	ディレクトリが存在する場合は True を返し、それ以外の場合は False を返します。
from_connection_string	接続文字列から ShareDirectoryClient を作成します。
from_directory_url	ディレクトリ URL から ShareDirectoryClient を作成します。
get_directory_properties	指定したディレクトリのすべてのユーザー定義メタデータとシステムプロパティを返します。返されるデータには、ディレクトリのファイルの一覧は含まれません。
get_file_client	特定のファイルと対話するクライアントを取得します。ファイルがまだ存在している必要はありません。
get_subdirectory_client	特定のサブディレクトリと対話するクライアントを取得します。サブディレクトリがまだ存在している必要はありません。
list_directories_and_files	ディレクトリのすべてのディレクトリとファイルを一覧表示します。
list_handles	ディレクトリまたはディレクトリの下のファイルで開かれたハンドルを一覧表示します。
rename_directory	ソースディレクトリの名前を変更します。 :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' で導入されました。
set_directory_metadata	ディレクトリのメタデータを設定します。この操作を呼び出すと、その都度、ディレクトリに関連付けられている既存のメタデータがすべて置き換えられます。ディレクトリからすべてのメタデータを削除するには、空のメタデータ dict でこの操作を呼び出します。
set_http_headers	ディレクトリに HTTP ヘッダーを設定します。
upload_file	ディレクトリに新しいファイルを作成し、ShareFileClient を返してファイルを操作します。

close

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

close()

close_all_handles

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

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

close_all_handles(recursive: bool = False, **kwargs: Any) -> Dict[str, int]

パラメーター

recursive: bool

必須

クライアント、そのファイル、そのサブディレクトリ、およびそのファイルで指定されたディレクトリに操作を適用するかどうかを指定するブール値。既定値は False です。

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

戻り値

の戻り値の型 :

dict[str, int]

create_directory

クライアントによって参照されるディレクトリの下に新しいディレクトリを作成します。

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

パラメーター

file_attributes: NTFSAttributes

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

file_creation_time: str または datetime

ディレクトリの作成時間。既定値は "now" です。

file_last_write_time: str または datetime

ディレクトリの最終書き込み時刻。既定値は "now" です。

file_permission: str

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

file_permission_key: str

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

file_change_time: str または datetime

ディレクトリの時刻を変更します。指定しない場合、変更時刻は現在の日付/時刻に設定されます。

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

metadata: dict(str,str)

メタデータとしてディレクトリに関連付けられている名前と値のペア。

timeout: int

戻り値

ディレクトリ更新プロパティの dict (Etag と最終変更)。

の戻り値の型 :

dict(str, Any)

例

ディレクトリを作成します。


   my_directory.create_directory()

create_subdirectory

新しいサブディレクトリを作成し、サブディレクトリと対話するクライアントを返します。

create_subdirectory(directory_name: str, **kwargs) -> ShareDirectoryClient

パラメーター

directory_name: str

必須

サブディレクトリの名前。

metadata: dict(str,str)

メタデータとしてサブディレクトリに関連付けられている名前と値のペア。

timeout: int

戻り値

ShareDirectoryClient

の戻り値の型 :

ShareDirectoryClient

例

サブディレクトリを作成します。


   # Create the directory
   parent_dir.create_directory()

   # Create a subdirectory
   subdir = parent_dir.create_subdirectory("subdir")

delete_directory

ディレクトリに削除のマークを付けます。ディレクトリは後でガベージコレクション中に削除されます。

delete_directory(**kwargs: Any) -> None

パラメーター

timeout: int

の戻り値の型 :

None

例

ディレクトリを削除します。


   my_directory.delete_directory()

delete_file

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

delete_file(file_name: str, **kwargs: Any | None) -> None

パラメーター

file_name: str

必須

削除するファイルの名前。

timeout: int

の戻り値の型 :

None

例

ディレクトリ内のファイルを削除します。


   # Delete the file in the directory
   my_directory.delete_file(file_name="sample")

delete_subdirectory

サブディレクトリを削除します。

delete_subdirectory(directory_name: str, **kwargs) -> None

パラメーター

directory_name: str

必須

サブディレクトリの名前。

timeout: int

の戻り値の型 :

None

例

サブディレクトリを削除します。


   parent_dir.delete_subdirectory("subdir")

exists

ディレクトリが存在する場合は True を返し、それ以外の場合は False を返します。

exists(**kwargs: Any) -> bool

パラメーター

timeout: int

戻り値

ディレクトリが存在する場合は True、それ以外の場合は False。

の戻り値の型 :

bool

from_connection_string

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

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

パラメーター

conn_str: str

必須

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

share_name: str

必須

共有の名前。

directory_path: str

必須

ディレクトリのパスです。

credential

既定値: None

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

audience: str

戻り値

ディレクトリクライアント。

の戻り値の型 :

ShareDirectoryClient

from_directory_url

ディレクトリ URL から ShareDirectoryClient を作成します。

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

パラメーター

directory_url: str

必須

ディレクトリへの完全な URI。

snapshot: str

既定値: None

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

credential

既定値: None

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

audience: str

戻り値

ディレクトリクライアント。

の戻り値の型 :

ShareDirectoryClient

get_directory_properties

指定したディレクトリのすべてのユーザー定義メタデータとシステムプロパティを返します。返されるデータには、ディレクトリのファイルの一覧は含まれません。

get_directory_properties(**kwargs: Any) -> DirectoryProperties

パラメーター

timeout: int

戻り値

DirectoryProperties

の戻り値の型 :

DirectoryProperties

get_file_client

特定のファイルと対話するクライアントを取得します。

ファイルがまだ存在している必要はありません。

get_file_client(file_name: str, **kwargs: Any) -> ShareFileClient

パラメーター

file_name: str

必須

ファイルの名前です。

戻り値

ファイルクライアント。

の戻り値の型 :

ShareFileClient

get_subdirectory_client

特定のサブディレクトリと対話するクライアントを取得します。

サブディレクトリがまだ存在している必要はありません。

get_subdirectory_client(directory_name: str, **kwargs: Any) -> ShareDirectoryClient

パラメーター

directory_name: str

必須

サブディレクトリの名前。

戻り値

ディレクトリクライアント。

の戻り値の型 :

ShareDirectoryClient

例

サブディレクトリクライアントを取得します。


   # Get a directory client and create the directory
   parent = share.get_directory_client("dir1")
   parent.create_directory()

   # Get a subdirectory client and create the subdirectory "dir1/dir2"
   subdirectory = parent.get_subdirectory_client("dir2")
   subdirectory.create_directory()

list_directories_and_files

ディレクトリのすべてのディレクトリとファイルを一覧表示します。

list_directories_and_files(name_starts_with: str | None = None, **kwargs: Any) -> ItemPaged

パラメーター

name_starts_with: str

必須

結果をフィルター処理して、名前が指定したプレフィックスで始まるエンティティのみを返します。

include: list[str]

応答に含める 1 つ以上のデータセットを指定するには、このパラメーターを含めます。使用できる str 値は、"timestamps"、"Etag"、"Attributes"、"PermissionKey" です。

バージョン 12.6.0 の新機能。

このキーワード (keyword)引数は、API バージョン '2020-10-02' で導入されました。

include_extended_info: bool

これが true に設定されている場合、ファイル ID は一覧表示された結果で返されます。

バージョン 12.6.0 の新機能。

このキーワード (keyword)引数は、API バージョン '2020-10-02' で導入されました。

timeout: int

戻り値

dict に似た DirectoryProperties と FileProperties の自動ページング iterable

の戻り値の型 :

ItemPaged[DirectoryProperties <xref:and> FileProperties]

例

ディレクトリとファイルを一覧表示します。


   # List the directories and files under the parent directory
   my_list = list(parent_dir.list_directories_and_files())
   print(my_list)

list_handles

ディレクトリまたはディレクトリの下のファイルで開かれたハンドルを一覧表示します。

list_handles(recursive: bool = False, **kwargs: Any) -> ItemPaged[Handle]

パラメーター

recursive: bool

必須

timeout: int

戻り値

ハンドルの自動ページング iterable

の戻り値の型 :

ItemPaged[Handle]

rename_directory

ソースディレクトリの名前を変更します。

: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_directory(new_name: str, **kwargs: Any) -> ShareDirectoryClient

パラメーター

metadata: Dict[str,str]

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

destination_lease: ShareLeaseClient または str

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

戻り値

新しいディレクトリクライアント。

の戻り値の型 :

ShareDirectoryClient

set_directory_metadata

ディレクトリのメタデータを設定します。

この操作を呼び出すと、その都度、ディレクトリに関連付けられている既存のメタデータがすべて置き換えられます。ディレクトリからすべてのメタデータを削除するには、空のメタデータ dict でこの操作を呼び出します。

set_directory_metadata(metadata: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]

パラメーター

metadata: dict(str, str)

必須

メタデータとしてディレクトリに関連付けられている名前と値のペア。

timeout: int

戻り値

ディレクトリ更新プロパティの dict (Etag と最終変更)。

の戻り値の型 :

dict(str, Any)

set_http_headers

ディレクトリに HTTP ヘッダーを設定します。

set_http_headers(file_attributes: str | NTFSAttributes = 'none', 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]

パラメーター

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 のいずれかを指定する必要があります。

permission_key: str

必須

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

file_change_time: str または datetime

ディレクトリの時刻を変更します。指定しない場合、変更時刻は現在の日付/時刻に設定されます。

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

timeout: int

戻り値

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

の戻り値の型 :

dict(str, Any)

upload_file

ディレクトリに新しいファイルを作成し、ShareFileClient を返してファイルを操作します。

upload_file(file_name: str, data: bytes | str | Iterable | IO, length: int | None = None, **kwargs) -> ShareFileClient

パラメーター

file_name: str

必須

ファイルの名前です。

data

必須

ファイルの内容。

length: int

必須

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

metadata: dict(str,str)

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

content_settings: ContentSettings

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

validate_content: bool

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

max_concurrency: int

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

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

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

timeout: int

encoding: str

既定値は UTF-8 です。

戻り値

ShareFileClient

の戻り値の型 :

ShareFileClient

例

ファイルをディレクトリにアップロードします。


   # Upload a file to the directory
   with open(SOURCE_FILE, "rb") as source:
       my_directory.upload_file(file_name="sample", data=source)

属性

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