ShareClient クラス

  • リファレンス

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

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

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

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

コンストラクター

ShareClient(account_url: str, share_name: 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_share_url 。

share_name
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" をストレージ アカウント キーにする必要があります。
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 です。

メソッド

acquire_lease

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

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

バージョン 12.5.0 の新機能。
close

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

バージョン 12.4.0 の新機能。
set_share_quota

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

acquire_lease

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

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

バージョン 12.5.0 の新機能。

acquire_lease(**kwargs: Any) -> ShareLeaseClient

パラメーター

lease_duration
int

リース期間 (秒単位) を指定します。無期限のリースには -1 を指定します。 無限リースでない場合は、15 ～ 60 秒を指定できます。 更新または変更を使用してリース期間を変更することはできません。 既定値は -1 (無限リース) です。

lease_id
str

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

timeout
int

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

戻り値

ShareLeaseClient オブジェクト。

の戻り値の型 :

ShareLeaseClient

例

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


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

close

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

close()

create_directory

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

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

パラメーター

directory_name
str
必須

ディレクトリの名前。

metadata

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

timeout
int

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

戻り値

ShareDirectoryClient

の戻り値の型 :

ShareDirectoryClient

create_permission_for_share

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

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

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

パラメーター

file_permission
str
必須

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

timeout
int

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

戻り値

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

の戻り値の型 :

str

create_share

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

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

パラメーター

metadata
dict(str,str)

共有にメタデータとして関連付けられている名前と値のペア。

quota
int

割り当てるクォータ。

access_tier

共有のアクセス層を指定します。 使用可能な値: 'TransactionOptimized'、'Hot'、'Cool'

timeout
int

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

protocols
str または ShareProtocols

共有で有効にするプロトコル。 共有で有効にできるプロトコルは 1 つだけです。

root_squash
str または ShareRootSquash

共有に設定するルート squash。 NFS 共有に対してのみ有効です。 使用できる値は、'NoRootSquash'、'RootSquash'、'AllSquash' です。

戻り値

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

の戻り値の型 :

Dict[str, Any]

例

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


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

create_snapshot

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

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

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

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

パラメーター

metadata
dict(str,str)

共有にメタデータとして関連付けられている名前と値のペア。

timeout
int

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

戻り値

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

の戻り値の型 :

dict[str, Any]

例

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


   share.create_snapshot()

delete_directory

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

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

パラメーター

directory_name
str
必須

ディレクトリの名前。

timeout
int

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

の戻り値の型 :

None

delete_share

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

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

パラメーター

delete_snapshots
bool
必須

スナップショットを削除するかどうかを示します。

lease

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

バージョン 12.5.0 の新機能。

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

timeout
int

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

例

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


   share.delete_share(delete_snapshots=True)

from_connection_string

接続文字列から 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

パラメーター

conn_str
str
必須

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

share_name
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" をストレージ アカウント キーにする必要があります。

戻り値

共有クライアント。

の戻り値の型 :

ShareClient

例

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


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

from_share_url 

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

パラメーター

share_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" をストレージ アカウント キーにする必要があります。

戻り値

共有クライアント。

の戻り値の型 :

ShareClient

get_directory_client

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

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

パラメーター

directory_path
str
既定値: None

指定したディレクトリへのパス。

戻り値

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

の戻り値の型 :

ShareDirectoryClient

get_file_client

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

get_file_client(file_path: str) -> ShareFileClient

パラメーター

file_path
str
必須

指定したファイルへのパス。

戻り値

ファイル クライアント。

の戻り値の型 :

ShareFileClient

get_permission_for_share

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

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

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

パラメーター

permission_key
str
必須

取得するファイルアクセス許可のキー

timeout
int

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

戻り値

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

の戻り値の型 :

str

get_share_access_policy

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

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

パラメーター

timeout
int

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

lease

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

バージョン 12.5.0 の新機能。

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

戻り値

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

の戻り値の型 :

dict[str, Any]

get_share_properties

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

get_share_properties(**kwargs: Any) -> ShareProperties

パラメーター

timeout
int

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

lease

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

バージョン 12.5.0 の新機能。

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

戻り値

共有プロパティ。

の戻り値の型 :

ShareProperties

例

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


   properties = share.get_share_properties()

get_share_stats

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

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

get_share_stats(**kwargs: Any) -> int

パラメーター

timeout
int

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

lease

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

バージョン 12.5.0 の新機能。

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

戻り値

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

の戻り値の型 :

int

list_directories_and_files

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

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]]

パラメーター

directory_name
str
必須

ディレクトリの名前。

name_starts_with
str
必須

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

marker
str
必須

不透明な継続トークン。 この値は、前のジェネレーター オブジェクトの next_marker フィールドから取得できます。 指定した場合、このジェネレーターはこの時点から結果の返しを開始します。

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

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

戻り値

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

の戻り値の型 :

Iterable[Dict[str,str]]

例

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


   # 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

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

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

パラメーター

signed_identifiers
dict(str, AccessPolicy)
必須

共有に関連付けるアクセス ポリシーのディクショナリ。 ディクショナリには、最大 5 つの要素を含めることができます。 空のディクショナリを使用すると、サービスに設定されているアクセス ポリシーがクリアされます。

timeout
int

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

lease

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

バージョン 12.5.0 の新機能。

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

戻り値

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

の戻り値の型 :

dict(str, Any)

set_share_metadata

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

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

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

パラメーター

metadata
dict(str, str)
必須

共有にメタデータとして関連付けられている名前と値のペア。

timeout
int

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

lease

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

バージョン 12.5.0 の新機能。

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

戻り値

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

の戻り値の型 :

dict(str, Any)

例

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


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

set_share_properties

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

バージョン 12.4.0 の新機能。

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

パラメーター

access_tier
str または <xref:azure.storage.fileshare.models.ShareAccessTier>

共有のアクセス層を指定します。 使用可能な値: 'TransactionOptimized'、'Hot'、および 'Cool'

quota
int

共有の最大サイズを GB 単位で指定します。 0 より大きく、5 TB 以下である必要があります。

timeout
int

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

root_squash
str または ShareRootSquash

共有に設定するルート squash。 NFS 共有に対してのみ有効です。 使用できる値は、'NoRootSquash'、'RootSquash'、'AllSquash' です。

lease

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

戻り値

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

の戻り値の型 :

dict(str, Any)

例

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


   # 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

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

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

パラメーター

quota
int
必須

共有の最大サイズを GB 単位で指定します。 0 より大きく、5 TB 以下である必要があります。

timeout
int

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

lease

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

バージョン 12.5.0 の新機能。

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

戻り値

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

の戻り値の型 :

dict(str, Any)

例

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


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

属性

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