ShareServiceClient クラス

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

close()

指定したアカウントの下に新しい共有を作成します。 同じ名前の共有が既に存在する場合、操作は失敗します。 新しく作成された共有と対話するクライアントを返します。

create_share(share_name: str, **kwargs) -> ShareClient

パラメーター

戻り値

新しく作成された共有の ShareClient。

の戻り値の型 :

例

ファイル共有サービスで共有を作成します。

   file_service.create_share(share_name="fileshare1")

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

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

パラメーター

の戻り値の型 :

例

ファイル共有サービスで共有を削除します。

   file_service.delete_share(share_name="fileshare1")

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

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

パラメーター

戻り値

ファイル共有サービス クライアント。

の戻り値の型 :

例

接続文字列を使用して共有サービス クライアントを作成します。

   from azure.storage.fileshare import ShareServiceClient
   share_service_client = ShareServiceClient.from_connection_string(self.connection_string)

Azure Storage Analyticsを含むストレージ アカウントのファイル共有サービスのプロパティを取得します。

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

パラメーター

戻り値

分析ログ、時間/分メトリック、cors ルールなどのファイル サービス プロパティを含むディクショナリ。

の戻り値の型 :

例

ファイル共有サービスのプロパティを取得します。

   properties = file_service.get_service_properties()

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

get_share_client(share: ShareProperties | str, snapshot: Dict[str, Any] | str | None = None) -> ShareClient

パラメーター

戻り値

ShareClient。

の戻り値の型 :

例

共有クライアントを取得します。

   from azure.storage.fileshare import ShareServiceClient
   file_service = ShareServiceClient.from_connection_string(self.connection_string)

   # Get a share client to interact with a specific share
   share = file_service.get_share_client("fileshare2")

指定したアカウントの dict に似た ShareProperties の自動ページング iterable を返します。 ジェネレーターは、サービスによって返された継続トークンに遅れて従い、すべての共有が返されたときに停止します。

list_shares(name_starts_with: str | None = None, include_metadata: bool | None = False, include_snapshots: bool | None = False, **kwargs) -> ItemPaged[ShareProperties]

パラメーター

戻り値

ShareProperties の iterable (自動ページング) です。

の戻り値の型 :

例

ファイル共有サービスの共有を一覧表示します。

   # List the shares in the file service
   my_shares = list(file_service.list_shares())

   # Print the shares
   for share in my_shares:
       print(share)

Azure Storage Analyticsを含むストレージ アカウントのファイル共有サービスのプロパティを設定します。 要素 (hour_metricsなど) が None のままの場合、その機能に対するサービスの既存の設定は保持されます。

set_service_properties(hour_metrics: Metrics | None = None, minute_metrics: Metrics | None = None, cors: List[CorsRule] | None = None, protocol: ShareProtocolSettings | None = None, **kwargs) -> None

パラメーター

の戻り値の型 :

例

ファイル共有サービスのプロパティを設定します。

   # Create service properties
   from azure.storage.fileshare import Metrics, CorsRule, RetentionPolicy

   # Create metrics for requests statistics
   hour_metrics = Metrics(enabled=True, include_apis=True, retention_policy=RetentionPolicy(enabled=True, days=5))
   minute_metrics = Metrics(enabled=True, include_apis=True,
                            retention_policy=RetentionPolicy(enabled=True, days=5))

   # Create CORS rules
   cors_rule1 = CorsRule(['www.xyz.com'], ['GET'])
   allowed_origins = ['www.xyz.com', "www.ab.com", "www.bc.com"]
   allowed_methods = ['GET', 'PUT']
   max_age_in_seconds = 500
   exposed_headers = ["x-ms-meta-data*", "x-ms-meta-source*", "x-ms-meta-abc", "x-ms-meta-bcd"]
   allowed_headers = ["x-ms-meta-data*", "x-ms-meta-target*", "x-ms-meta-xyz", "x-ms-meta-foo"]
   cors_rule2 = CorsRule(
       allowed_origins,
       allowed_methods,
       max_age_in_seconds=max_age_in_seconds,
       exposed_headers=exposed_headers,
       allowed_headers=allowed_headers)

   cors = [cors_rule1, cors_rule2]

   # Set the service properties
   file_service.set_service_properties(hour_metrics, minute_metrics, cors)

論理的に削除された共有を復元します。

操作は、削除アイテム保持ポリシーで設定された指定した日数以内に使用された場合にのみ成功します。

バージョン 12.2.0 の新機能: この操作は API バージョン '2019-12-12' で導入されました。

undelete_share(deleted_share_name: str, deleted_share_version: str, **kwargs: Any) -> ShareClient

パラメーター

戻り値

削除されていない共有の ShareClient。

の戻り値の型 :

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

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

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

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

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

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

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

例外

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

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

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

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