ShareServiceClient クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
ShareServiceClientでは、Azure Storage サービスのリソースと共有を操作できます。 ストレージ アカウントは、ファイル サービスの最上位レベルの名前空間を提供します。
public class ShareServiceClient
type ShareServiceClient = class
Public Class ShareServiceClient
- 継承
-
ShareServiceClient
コンストラクター
ShareServiceClient() |
モック作成のために クラスの ShareServiceClient 新しいインスタンスを初期化します。 |
ShareServiceClient(String) |
ShareServiceClient クラスの新しいインスタンスを初期化します。 |
ShareServiceClient(String, ShareClientOptions) |
ShareServiceClient クラスの新しいインスタンスを初期化します。 |
ShareServiceClient(Uri, AzureSasCredential, ShareClientOptions) |
ShareServiceClient クラスの新しいインスタンスを初期化します。 |
ShareServiceClient(Uri, ShareClientOptions) |
ShareServiceClient クラスの新しいインスタンスを初期化します。 |
ShareServiceClient(Uri, StorageSharedKeyCredential, ShareClientOptions) |
ShareServiceClient クラスの新しいインスタンスを初期化します。 |
ShareServiceClient(Uri, TokenCredential, ShareClientOptions) |
ShareServiceClient クラスの新しいインスタンスを初期化します。 サービス レベルの操作では、トークン資格情報認証はサポートされないことに注意してください。 このコンストラクターは、トークン資格情報認証を持つ を ShareServiceClient 派生させるために使用できる の ShareClient 構築を可能にするために存在します。 は現在、トークン認証に必要であることにも注意してください ShareTokenIntent 。 |
プロパティ
AccountName |
ファイル サービス クライアントに対応するストレージ アカウント名を取得します。 |
CanGenerateAccountSasUri |
クライアントが SAS を生成できるかどうかを判断します。 クライアントが で認証されている場合。StorageSharedKeyCredential |
Uri |
ファイル サービスのプライマリ Uri エンドポイントを取得します。 |
メソッド
CreateShare(String, ShareCreateOptions, CancellationToken) |
CreateShare(String, ShareCreateOptions, CancellationToken)の操作は、指定されたアカウントに新しい共有を作成します。 同じ名前の共有が既に存在する場合、操作は失敗します。 詳細については、「 共有を作成します。 |
CreateShareAsync(String, ShareCreateOptions, CancellationToken) |
CreateShare(String, ShareCreateOptions, CancellationToken)の操作は、指定されたアカウントに新しい共有を作成します。 同じ名前の共有が既に存在する場合、操作は失敗します。 詳細については、「 共有を作成します。 |
DeleteShare(String, ShareDeleteOptions, CancellationToken) |
指定した共有または共有スナップショットに削除のマークを付けます。 共有または共有スナップショットとその中に含まれるファイルは、後でガベージ コレクション中に削除されます。これには数分かかる場合があります。 現在、このメソッドは常にスナップショットを削除します。 x-ms-delete-snapshots に個別の値を指定する方法はありません。 詳細については、「 共有を削除します。 |
DeleteShareAsync(String, ShareDeleteOptions, CancellationToken) |
指定した共有または共有スナップショットに削除のマークを付けます。 共有または共有スナップショットとその中に含まれるファイルは、後でガベージ コレクション中に削除されます。これには数分かかる場合があります。 現在、このメソッドは常にスナップショットを削除します。 x-ms-delete-snapshots に個別の値を指定する方法はありません。 詳細については、「 共有を削除します。 |
GenerateAccountSasUri(AccountSasBuilder) |
は GenerateAccountSasUri(AccountSasBuilder) 、 Uri 渡されたクライアント プロパティとビルダーに基づいて Share Account Shared Access Signature (SAS) を生成する を返します。 SAS は、クライアントの共有キー資格情報によって署名されます。 クライアントが Service Sas に署名できるかどうかをチェックするには、「」を参照してくださいCanGenerateAccountSasUri。 詳細については、「 アカウント SAS の構築。 |
GenerateAccountSasUri(AccountSasPermissions, DateTimeOffset, AccountSasResourceTypes) |
は GenerateAccountSasUri(AccountSasPermissions, DateTimeOffset, AccountSasResourceTypes) 、 Uri 渡されたクライアントのプロパティとパラメーターに基づいて Share Account Shared Access Signature (SAS) を生成する を返します。 SAS は、クライアントの共有キー資格情報によって署名されます。 クライアントが Service Sas に署名できるかどうかをチェックするには、「」を参照してくださいCanGenerateAccountSasUri。 詳細については、「 アカウント SAS の構築。 |
GetProperties(CancellationToken) |
この操作ではGetProperties(CancellationToken)、ストレージ アカウントのファイル サービスのプロパティ (Storage Analyticsおよび CORS (クロスオリジン リソース共有) ルールのプロパティを含む) を取得します。 詳細については、「 ファイル サービスのプロパティを取得します。 |
GetPropertiesAsync(CancellationToken) |
この操作ではGetPropertiesAsync(CancellationToken)、ストレージ アカウントのファイル サービスのプロパティ (Storage Analyticsおよび CORS (クロスオリジン リソース共有) ルールのプロパティを含む) を取得します。 詳細については、「 ファイル サービスのプロパティを取得します。 |
GetShareClient(String) |
の末尾Uriに を |
GetShares(ShareTraits, ShareStates, String, CancellationToken) |
この操作は GetShares(ShareTraits, ShareStates, String, CancellationToken) 、ストレージ アカウント内の共有の非同期シーケンスを返します。 共有を列挙すると、すべての値をフェッチするときに、サービスに対して複数の要求が行われる場合があります。 詳細については、「 共有を一覧表示します。 |
GetSharesAsync(ShareTraits, ShareStates, String, CancellationToken) |
この操作は GetSharesAsync(ShareTraits, ShareStates, String, CancellationToken) 、ストレージ アカウント内の共有の非同期コレクションを返します。 共有を列挙すると、すべての値をフェッチするときに、サービスに対して複数の要求が行われる場合があります。 詳細については、「 共有を一覧表示します。 |
SetProperties(ShareServiceProperties, CancellationToken) |
この操作ではSetProperties(ShareServiceProperties, CancellationToken)、ストレージ アカウントのファイル サービス エンドポイントのプロパティを設定します。これには、Storage Analytics、CORS (クロスオリジン リソース共有) ルールのプロパティ、論理的な削除設定が含まれます。 この操作を使用して、バージョンが指定されていない File サービスに対するすべての受信要求の既定の要求バージョンを設定することもできます。 詳細については、「 ファイル サービスのプロパティを設定します。 |
SetPropertiesAsync(ShareServiceProperties, CancellationToken) |
この操作ではSetPropertiesAsync(ShareServiceProperties, CancellationToken)、ストレージ アカウントのファイル サービス エンドポイントのプロパティを設定します。これには、Storage Analytics、CORS (クロスオリジン リソース共有) ルールのプロパティ、論理的な削除設定が含まれます。 この操作を使用して、バージョンが指定されていない File サービスに対するすべての受信要求の既定の要求バージョンを設定することもできます。 詳細については、「 ファイル サービスのプロパティを設定します。 |
UndeleteShare(String, String, CancellationToken) |
以前に削除した共有を復元します。 この API は、共有に関連付けられているストレージ アカウントに対して [論理的な削除の共有] が有効になっている場合にのみ機能します。 |
UndeleteShareAsync(String, String, CancellationToken) |
以前に削除した共有を復元します。 この API は、共有に関連付けられているストレージ アカウントに対して [論理的な削除の共有] が有効になっている場合にのみ機能します。 |
適用対象
Azure SDK for .NET