ShareClient クラス

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

共有にアクティブなリースがない場合、共有サービスは共有にリースを作成し、新しいリースを返します。

バージョン 12.5.0 の新機能。

acquire_lease(**kwargs: Any) -> ShareLeaseClient

パラメーター

戻り値

ShareLeaseClient オブジェクト。

の戻り値の型 :

例

株式のリースを取得する。

   share.create_directory("mydir")
   lease = share.acquire_lease()
   share.get_share_properties(lease=lease)
   share.delete_share(lease=lease)

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

close()

共有内にディレクトリを作成し、ディレクトリと対話するクライアントを返します。

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

パラメーター

戻り値

ShareDirectoryClient

の戻り値の型 :

共有レベルでアクセス許可 (セキュリティ記述子) を作成します。

この 'アクセス許可' は、共有内のファイルまたはディレクトリに使用できます。 'permission' が既に存在する場合は、そのキーを返し、それ以外の場合は共有レベルで新しいアクセス許可を作成し、そのキーを返します。

create_permission_for_share(file_permission: str, **kwargs: Any) -> str

パラメーター

戻り値

ファイルのアクセス許可キー

の戻り値の型 :

アカウントの下に新しい共有を作成します。 同じ名前の共有が既に存在する場合、操作は失敗します。

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

パラメーター

戻り値

共有更新されたプロパティの dict (Etag と最終更新日)。

の戻り値の型 :

例

ファイル共有を作成します。

   # Create share with Access Tier set to Hot
   share.create_share(access_tier=ShareAccessTier("Hot"))

共有のスナップショットを作成します。

スナップショットは、ある時点で取得される共有の読み取り専用バージョンです。 読み取り、コピー、または削除はできますが、変更することはできません。 スナップショットを使用すると、一度に表示される共有をバックアップできます。

共有のスナップショットは、スナップショットの取得元の基本共有と同じ名前を持ち、DateTime 値を追加して、スナップショットが取得された時刻を示します。

create_snapshot(**kwargs: Any | None) -> Dict[str, Any]

パラメーター

戻り値

共有更新プロパティの dict (スナップショット ID、Etag、最終更新日)。

の戻り値の型 :

例

ファイル共有のスナップショットを作成します。

   share.create_snapshot()

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

delete_directory(directory_name: str, **kwargs: Any) -> None

パラメーター

の戻り値の型 :

指定した共有を削除対象としてマークします。 共有は後でガベージ コレクション中に削除されます。

delete_share(delete_snapshots: bool | None = False, **kwargs) -> None

パラメーター

例

共有とスナップショットを削除します。

   share.delete_share(delete_snapshots=True)

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

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

パラメーター

戻り値

共有クライアント。

の戻り値の型 :

例

接続文字列から共有クライアントを取得します。

   from azure.storage.fileshare import ShareClient
   share = ShareClient.from_connection_string(self.connection_string, "sharesamples2")

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

パラメーター

戻り値

共有クライアント。

の戻り値の型 :

指定したディレクトリと対話するクライアントを取得します。 ディレクトリがまだ存在している必要はありません。

get_directory_client(directory_path: str | None = None) -> ShareDirectoryClient

パラメーター

戻り値

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

の戻り値の型 :

指定したファイルと対話するクライアントを取得します。 ファイルがまだ存在している必要はありません。

get_file_client(file_path: str) -> ShareFileClient

パラメーター

戻り値

ファイル クライアント。

の戻り値の型 :

特定のキーのアクセス許可 (セキュリティ記述子) を取得します。

この 'アクセス許可' は、共有内のファイル/ディレクトリに使用できます。

get_permission_for_share(permission_key: str, **kwargs: Any) -> str

パラメーター

戻り値

ファイルのアクセス許可 (ポータブル SDDL)

の戻り値の型 :

共有のアクセス許可を取得します。 アクセス許可は、共有内のファイルにパブリックにアクセスできるかどうかを示します。

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

パラメーター

戻り値

dict 内のポリシー情報にアクセスします。

の戻り値の型 :

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

get_share_properties(**kwargs: Any) -> ShareProperties

パラメーター

戻り値

共有プロパティ。

の戻り値の型 :

例

共有プロパティを取得します。

   properties = share.get_share_properties()

共有に格納されているデータのおおよそのサイズをバイト単位で取得します。

この値には、最近作成または最近サイズ変更されたすべてのファイルが含まれていない場合があることに注意してください。

get_share_stats(**kwargs: Any) -> int

パラメーター

戻り値

共有に格納されているデータのおおよそのサイズ (バイト単位)。

の戻り値の型 :

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

list_directories_and_files(directory_name: str | None = None, name_starts_with: str | None = None, marker: str | None = None, **kwargs: Any) -> Iterable[Dict[str, str]]

パラメーター

戻り値

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

の戻り値の型 :

例

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

   # Create a directory in the share
   dir_client = share.create_directory("mydir")

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

   # List files in the directory
   my_files = list(share.list_directories_and_files(directory_name="mydir"))
   print(my_files)

共有アクセス署名で使用できる共有または保存されたアクセス ポリシーのアクセス許可を設定します。 アクセス許可は、共有内のファイルにパブリックにアクセスできるかどうかを示します。

set_share_access_policy(signed_identifiers: Dict[str, AccessPolicy], **kwargs: Any) -> Dict[str, str]

パラメーター

戻り値

共有更新されたプロパティの dict (Etag と最終更新日)。

の戻り値の型 :

共有のメタデータを設定します。

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

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

パラメーター

戻り値

共有更新されたプロパティの dict (Etag と最終更新日)。

の戻り値の型 :

例

共有メタデータを設定します。

   data = {'category': 'test'}
   share.set_share_metadata(metadata=data)

共有プロパティを設定します。

バージョン 12.4.0 の新機能。

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

パラメーター

戻り値

共有更新されたプロパティの dict (Etag と最終更新日)。

の戻り値の型 :

例

共有プロパティを設定します。

   # Set the tier for the first share to Hot
   share1.set_share_properties(access_tier="Hot")
   # Set the quota for the first share to 3
   share1.set_share_properties(quota=3)
   # Set the tier for the second share to Cool and quota to 2
   share2.set_share_properties(access_tier=ShareAccessTier("Cool"), quota=2)

   # Get the shares' properties
   print(share1.get_share_properties().access_tier)
   print(share1.get_share_properties().quota)
   print(share2.get_share_properties().access_tier)
   print(share2.get_share_properties().quota)

共有のクォータを設定します。

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

パラメーター

戻り値

共有更新されたプロパティの dict (Etag と最終更新日)。

の戻り値の型 :

例

共有クォータを設定します。

   # Set the quota for the share to 1GB
   share.set_share_quota(quota=1)

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

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

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

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

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

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

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

例外

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

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

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

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