ShareClient class

リファレンス

パッケージ:: @azure/storage-file-share

ShareClient は、Azure Storage 共有への URL を表し、ディレクトリとファイルを操作できます。

Extends: StorageClient

コンストラクター

ShareClient(string, Credential_2 \| TokenCredential, ShareClientOptions)	ShareClient のインスタンスを作成します。
ShareClient(string, Pipeline, ShareClientConfig)	ShareClient のインスタンスを作成します。
ShareClient(string, string, ShareClientOptions)

プロパティ

name

共有の名前

rootDirectoryClient

この共有のルートディレクトリのディレクトリクライアントを取得します。ルートディレクトリは常に存在し、削除できないことに注意してください。

ルートディレクトリの新しい ShareDirectoryClient オブジェクト。

継承されたプロパティ

accountName
url	URL 文字列値。

メソッド

create(ShareCreateOptions)	指定したアカウントの下に新しい共有を作成します。同じ名前の共有が既に存在する場合、操作は失敗します。「https://docs.microsoft.com/en-us/rest/api/storageservices/create-share」を参照してください。
createDirectory(string, DirectoryCreateOptions)	この共有の下に新しいサブディレクトリを作成します。「https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory」を参照してください。
createFile(string, number, FileCreateOptions)	新しいファイルを作成するか、この共有のルートディレクトリにあるファイルを置き換えます。これは、コンテンツを含まないファイルのみを初期化します。「https://docs.microsoft.com/en-us/rest/api/storageservices/create-file」を参照してください。
createIfNotExists(ShareCreateOptions)	指定したアカウントの下に新しい共有を作成します。同じ名前の共有が既に存在する場合は、変更されません。「https://docs.microsoft.com/en-us/rest/api/storageservices/create-share」を参照してください。
createPermission(string, ShareCreatePermissionOptions)	共有レベルでファイルアクセス許可 (セキュリティ記述子) を作成します。作成されたセキュリティ記述子は、共有内のファイル/ディレクトリに使用できます。「https://docs.microsoft.com/en-us/rest/api/storageservices/create-permission」を参照してください。
createSnapshot(ShareCreateSnapshotOptions)	共有の読み取り専用スナップショットを作成します。
delete(ShareDeleteMethodOptions)	指定した共有に削除のマークを付けます。共有とその中に含まれるディレクトリまたはファイルは、後でガベージコレクション中に削除されます。「https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share」を参照してください。
deleteDirectory(string, DirectoryDeleteOptions)	この共有の下にある指定された空のサブディレクトリを削除します。ディレクトリを空にしてから削除する必要があることに注意してください。「https://docs.microsoft.com/en-us/rest/api/storageservices/delete-directory」を参照してください。
deleteFile(string, FileDeleteOptions)	この共有のルートディレクトリの下にあるファイルをストレージアカウントから削除します。正常に削除されたファイルは、その時点でストレージアカウントのインデックスから削除され、クライアントからアクセスできなくなります。ファイルのデータは、後でガベージコレクション中にサービスから削除されます。ファイルが SMB クライアントで開かれている場合、ファイルの削除は状態コード 409 (競合) とエラーコード `SharingViolation` で失敗します。共有スナップショット (共有の読み取り専用コピー) では、ファイルの削除はサポートされていません。共有スナップショットでこの操作を実行しようとすると、400 (`InvalidQueryParameterValue`) で失敗します「https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2」を参照してください。
deleteIfExists(ShareDeleteMethodOptions)	指定した共有が存在する場合は、削除のマークを付けます。共有とその中に含まれるディレクトリまたはファイルは、後でガベージコレクション中に削除されます。「https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share」を参照してください。
exists(ShareExistsOptions)	このクライアントで表される Azrue 共有リソースが存在する場合は true を返します。それ以外の場合は false。注: 既存の共有は他のクライアントまたはアプリケーションによって削除される可能性があるため、この関数は注意して使用してください。その逆も同様に、この関数の完了後に、他のクライアントまたはアプリケーションによって新しい共有が追加される可能性があります。
generateSasUrl(ShareGenerateSasUrlOptions)	共有キー資格情報を使用して構築された ShareClient でのみ使用できます。渡されたクライアントプロパティとパラメーターに基づいて、サービス Shared Access Signature (SAS) URI を生成します。 SAS は、クライアントの共有キー資格情報によって署名されます。「https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas」を参照してください。
getAccessPolicy(ShareGetAccessPolicyOptions)	指定した共有のアクセス許可を取得します。アクセス許可は、共有データにパブリックにアクセスできるかどうかを示します。警告: JavaScript 日付は、開始文字列と有効期限文字列を解析するときに精度が失われる可能性があります。たとえば、新しい Date("2018-12-31T03:44:23.8827891Z").toISOString() は "2018-12-31T03:44:23.882Z" を取得します。「https://docs.microsoft.com/en-us/rest/api/storageservices/get-share-acl」を参照してください。
getDirectoryClient(string)	ShareDirectoryClient オブジェクトを作成します。
getPermission(string, ShareGetPermissionOptions)	セキュリティ記述子を示す特定のファイルアクセス許可キーのセキュリティ記述子定義言語 (SDDL) を取得します。「https://docs.microsoft.com/en-us/rest/api/storageservices/get-permission」を参照してください。
getProperties(ShareGetPropertiesOptions)	指定した共有のすべてのユーザー定義メタデータとシステムプロパティを返します。「https://docs.microsoft.com/en-us/rest/api/storageservices/get-share-properties」を参照してください。警告: 応答で返されるオブジェクトのキーは `metadata` 、最初に大文字が含まれていた場合でも小文字になります。これは、オプションを使用して `includeMetadata`ShareServiceClient のメソッドによって`listShares`返されるメタデータキーとは異なり、元の大文字と小文字が保持されます。
getStatistics(ShareGetStatisticsOptions)	共有に関連する統計を取得します。
setAccessPolicy(SignedIdentifier[], ShareSetAccessPolicyOptions)	指定した共有のアクセス許可を設定します。アクセス許可は、共有内のディレクトリまたはファイルにパブリックにアクセスできるかどうかを示します。共有のアクセス許可を設定すると、既存のアクセス許可が置き換えられます。 shareAcl が指定されていない場合は、既存の共有 ACL が削除されます。共有に保存されているアクセスポリシーを確立すると、有効になるまでに最大 30 秒かかる場合があります。その間、アクセスポリシーがアクティブになるまでは、保存されているアクセスポリシーに関連付けられている共有アクセス署名は、ステータスコード 403 (Forbidden) が返されて失敗します。「https://docs.microsoft.com/en-us/rest/api/storageservices/set-share-acl」を参照してください。
setMetadata(Metadata, ShareSetMetadataOptions)	指定した共有に対して 1 つ以上のユーザー定義の名前と値のペアを設定します。オプションが指定されていない場合、またはオプションパラメーターにメタデータが定義されていない場合、共有メタデータは削除されます。「https://docs.microsoft.com/en-us/rest/api/storageservices/set-share-metadata」を参照してください。
setProperties(ShareSetPropertiesOptions)	共有のプロパティを設定します。
setQuota(number, ShareSetQuotaOptions)	指定した共有のクォータを設定します。
withSnapshot(string)	指定したスナップショットタイムスタンプを使用して、ソースと同じ新しい ShareClient オブジェクトを作成します。 "" を指定すると、スナップショットが削除され、ベース共有への URL が返されます。

コンストラクターの詳細

ShareClient のインスタンスを作成します。

new ShareClient(url: string, credential?: Credential_2 | TokenCredential, options?: ShareClientOptions)

パラメーター

url: string

"https://myaccount.file.core.windows.net/share" など、Azure Storage ファイル共有を指す URL 文字列。 AnonymousCredential を使用している場合は、SAS を追加できます (例: "https://myaccount.file.core.windows.net/share?sasString")。

credential: Credential | TokenCredential

AnonymousCredential や StorageSharedKeyCredential など。指定しない場合は、AnonymousCredential が使用されます。

options: ShareClientOptions

省略可能。 HTTP パイプラインを構成するためのオプション。

ShareClient のインスタンスを作成します。

new ShareClient(url: string, pipeline: Pipeline, options?: ShareClientConfig)

パラメーター

url: string

pipeline: Pipeline

newPipeline() を呼び出して既定のパイプラインを作成するか、カスタマイズされたパイプラインを指定します。

options: ShareClientConfig

new ShareClient(connectionString: string, name: string, options?: ShareClientOptions)

パラメーター

connectionString: string

アカウント接続文字列または Azure ストレージアカウントの SAS 接続文字列。 [ 注 - アカウント接続文字列は、NODE.JSランタイムでのみ使用できます。 ] アカウント接続文字列の例 -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS 接続文字列の例 - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

name: string

共有名。

options: ShareClientOptions

省略可能。 HTTP パイプラインを構成するためのオプション。

プロパティの詳細

共有の名前

string name

プロパティ値

string

ルートディレクトリの新しい ShareDirectoryClient オブジェクト。

ShareDirectoryClient rootDirectoryClient

プロパティ値

ShareDirectoryClient

継承されたプロパティの詳細

accountName: string

プロパティ値

string

継承元 StorageClient.accountName

URL 文字列値。

url: string

プロパティ値

string

継承元 StorageClient.url

メソッドの詳細

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

「https://docs.microsoft.com/en-us/rest/api/storageservices/create-share」を参照してください。

function create(options?: ShareCreateOptions): Promise<ShareCreateResponse>

パラメーター

options: ShareCreateOptions

作成操作を共有するオプション。

戻り値

Promise<ShareCreateResponse>

作成の共有操作の応答データ。

この共有の下に新しいサブディレクトリを作成します。

「https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory」を参照してください。

function createDirectory(directoryName: string, options?: DirectoryCreateOptions): Promise<{ directoryClient: ShareDirectoryClient, directoryCreateResponse: DirectoryCreateResponse }>

パラメーター

directoryName: string

options: DirectoryCreateOptions

[ディレクトリの作成] 操作のオプション。

戻り値

Promise<{ directoryClient: ShareDirectoryClient, directoryCreateResponse: DirectoryCreateResponse }>

ディレクトリ作成応答データと、対応するディレクトリクライアント。

新しいファイルを作成するか、この共有のルートディレクトリにあるファイルを置き換えます。これは、コンテンツを含まないファイルのみを初期化します。

「https://docs.microsoft.com/en-us/rest/api/storageservices/create-file」を参照してください。

function createFile(fileName: string, size: number, options?: FileCreateOptions): Promise<{ fileClient: ShareFileClient, fileCreateResponse: FileCreateResponse }>

パラメーター

fileName: string

size: number

ファイルの最大サイズ (最大 4 TB) をバイト単位で指定します。

options: FileCreateOptions

[ファイルの作成] 操作のオプション。

戻り値

Promise<{ fileClient: ShareFileClient, fileCreateResponse: FileCreateResponse }>

ファイル作成応答データと、対応するファイルクライアント。

指定したアカウントの下に新しい共有を作成します。同じ名前の共有が既に存在する場合は、変更されません。

「https://docs.microsoft.com/en-us/rest/api/storageservices/create-share」を参照してください。

function createIfNotExists(options?: ShareCreateOptions): Promise<ShareCreateIfNotExistsResponse>

パラメーター

options: ShareCreateOptions

戻り値

Promise<ShareCreateIfNotExistsResponse>

共有レベルでファイルアクセス許可 (セキュリティ記述子) を作成します。作成されたセキュリティ記述子は、共有内のファイル/ディレクトリに使用できます。

「https://docs.microsoft.com/en-us/rest/api/storageservices/create-permission」を参照してください。

function createPermission(filePermission: string, options?: ShareCreatePermissionOptions): Promise<ShareCreatePermissionResponse>

パラメーター

filePermission: string

SDDL で説明されているファイルのアクセス許可

options: ShareCreatePermissionOptions

[アクセス許可の作成] 操作を共有するためのオプション。

戻り値

Promise<ShareCreatePermissionResponse>

共有の読み取り専用スナップショットを作成します。

function createSnapshot(options?: ShareCreateSnapshotOptions): Promise<ShareCreateSnapshotResponse>

パラメーター

options: ShareCreateSnapshotOptions

スナップショットの作成操作を共有するオプション。

戻り値

Promise<ShareCreateSnapshotResponse>

[スナップショットの作成の共有] 操作の応答データ。

指定した共有に削除のマークを付けます。共有とその中に含まれるディレクトリまたはファイルは、後でガベージコレクション中に削除されます。

「https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share」を参照してください。

function delete(options?: ShareDeleteMethodOptions): Promise<ShareDeleteResponse>

パラメーター

options: ShareDeleteMethodOptions

削除操作を共有するオプション。

戻り値

Promise<ShareDeleteResponse>

Share Delete 操作の応答データ。

この共有の下にある指定された空のサブディレクトリを削除します。ディレクトリを空にしてから削除する必要があることに注意してください。

「https://docs.microsoft.com/en-us/rest/api/storageservices/delete-directory」を参照してください。

function deleteDirectory(directoryName: string, options?: DirectoryDeleteOptions): Promise<DirectoryDeleteResponse>

パラメーター

directoryName: string

options: DirectoryDeleteOptions

ディレクトリ削除操作のオプション。

戻り値

Promise<DirectoryDeleteResponse>

ディレクトリ削除応答データ。

この共有のルートディレクトリの下にあるファイルをストレージアカウントから削除します。正常に削除されたファイルは、その時点でストレージアカウントのインデックスから削除され、クライアントからアクセスできなくなります。ファイルのデータは、後でガベージコレクション中にサービスから削除されます。

ファイルが SMB クライアントで開かれている場合、ファイルの削除は状態コード 409 (競合) とエラーコード SharingViolation で失敗します。

共有スナップショット (共有の読み取り専用コピー) では、ファイルの削除はサポートされていません。共有スナップショットでこの操作を実行しようとすると、400 (InvalidQueryParameterValue) で失敗します

「https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2」を参照してください。

function deleteFile(fileName: string, options?: FileDeleteOptions): Promise<FileDeleteResponse>

パラメーター

fileName: string

options: FileDeleteOptions

[ファイルの削除] 操作のオプション。

戻り値

Promise<FileDeleteResponse>

Promise ファイルの応答データを削除します。

指定した共有が存在する場合は、削除のマークを付けます。共有とその中に含まれるディレクトリまたはファイルは、後でガベージコレクション中に削除されます。

「https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share」を参照してください。

function deleteIfExists(options?: ShareDeleteMethodOptions): Promise<ShareDeleteIfExistsResponse>

パラメーター

options: ShareDeleteMethodOptions

戻り値

Promise<ShareDeleteIfExistsResponse>

このクライアントで表される Azrue 共有リソースが存在する場合は true を返します。それ以外の場合は false。

注: 既存の共有は他のクライアントまたはアプリケーションによって削除される可能性があるため、この関数は注意して使用してください。その逆も同様に、この関数の完了後に、他のクライアントまたはアプリケーションによって新しい共有が追加される可能性があります。

function exists(options?: ShareExistsOptions): Promise<boolean>

パラメーター

options: ShareExistsOptions

オプションを [Exists]\(存在する\) 操作に設定します。

戻り値

Promise<boolean>

共有キー資格情報を使用して構築された ShareClient でのみ使用できます。

渡されたクライアントプロパティとパラメーターに基づいて、サービス Shared Access Signature (SAS) URI を生成します。 SAS は、クライアントの共有キー資格情報によって署名されます。

「https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas」を参照してください。

function generateSasUrl(options: ShareGenerateSasUrlOptions): string

パラメーター

options: ShareGenerateSasUrlOptions

省略可能なパラメーター。

戻り値

string

このクライアントによって表されるリソースへの URI と、生成された SAS トークンで構成される SAS URI。

指定した共有のアクセス許可を取得します。アクセス許可は、共有データにパブリックにアクセスできるかどうかを示します。

警告: JavaScript 日付は、開始文字列と有効期限文字列を解析するときに精度が失われる可能性があります。たとえば、新しい Date("2018-12-31T03:44:23.8827891Z").toISOString() は "2018-12-31T03:44:23.882Z" を取得します。

「https://docs.microsoft.com/en-us/rest/api/storageservices/get-share-acl」を参照してください。

function getAccessPolicy(options?: ShareGetAccessPolicyOptions): Promise<ShareGetAccessPolicyResponse>

パラメーター

options: ShareGetAccessPolicyOptions

戻り値

Promise<ShareGetAccessPolicyResponse>

アクセスポリシーの取得操作の応答データ。

ShareDirectoryClient オブジェクトを作成します。

function getDirectoryClient(directoryName: string): ShareDirectoryClient

パラメーター

directoryName: string

ディレクトリ名

戻り値

ShareDirectoryClient

指定されたディレクトリ名の ShareDirectoryClient オブジェクト。

セキュリティ記述子を示す特定のファイルアクセス許可キーのセキュリティ記述子定義言語 (SDDL) を取得します。

「https://docs.microsoft.com/en-us/rest/api/storageservices/get-permission」を参照してください。

function getPermission(filePermissionKey: string, options?: ShareGetPermissionOptions): Promise<ShareGetPermissionResponse>

パラメーター

filePermissionKey: string

アクセス許可のセキュリティ記述子を示すファイルアクセス許可キー。

options: ShareGetPermissionOptions

[アクセス許可の作成] 操作を共有するためのオプション。

戻り値

Promise<ShareGetPermissionResponse>

指定した共有のすべてのユーザー定義メタデータとシステムプロパティを返します。

「https://docs.microsoft.com/en-us/rest/api/storageservices/get-share-properties」を参照してください。

警告: 応答で返されるオブジェクトのキーは metadata 、最初に大文字が含まれていた場合でも小文字になります。これは、オプションを使用して includeMetadataShareServiceClient のメソッドによってlistShares返されるメタデータキーとは異なり、元の大文字と小文字が保持されます。

function getProperties(options?: ShareGetPropertiesOptions): Promise<ShareGetPropertiesResponse>

パラメーター

options: ShareGetPropertiesOptions

戻り値

Promise<ShareGetPropertiesResponse>

Share Get Properties 操作の応答データ。

共有に関連する統計を取得します。

function getStatistics(options?: ShareGetStatisticsOptions): Promise<ShareGetStatisticsResponse>

パラメーター

options: ShareGetStatisticsOptions

戻り値

Promise<ShareGetStatisticsResponse>

[統計の取得の共有] 操作の応答データ。

指定した共有のアクセス許可を設定します。アクセス許可は、共有内のディレクトリまたはファイルにパブリックにアクセスできるかどうかを示します。

共有のアクセス許可を設定すると、既存のアクセス許可が置き換えられます。 shareAcl が指定されていない場合は、既存の共有 ACL が削除されます。

共有に保存されているアクセスポリシーを確立すると、有効になるまでに最大 30 秒かかる場合があります。その間、アクセスポリシーがアクティブになるまでは、保存されているアクセスポリシーに関連付けられている共有アクセス署名は、ステータスコード 403 (Forbidden) が返されて失敗します。

「https://docs.microsoft.com/en-us/rest/api/storageservices/set-share-acl」を参照してください。

function setAccessPolicy(shareAcl?: SignedIdentifier[], options?: ShareSetAccessPolicyOptions): Promise<ShareSetAccessPolicyResponse>

パラメーター

shareAcl: SignedIdentifier[]

一意の ID とアクセスポリシーの詳細を持つ、署名付き識別子の配列。

options: ShareSetAccessPolicyOptions

戻り値

Promise<ShareSetAccessPolicyResponse>

Share Set Access Policy 操作の応答データ。

指定した共有に対して 1 つ以上のユーザー定義の名前と値のペアを設定します。

オプションが指定されていない場合、またはオプションパラメーターにメタデータが定義されていない場合、共有メタデータは削除されます。

「https://docs.microsoft.com/en-us/rest/api/storageservices/set-share-metadata」を参照してください。

function setMetadata(metadata?: Metadata, options?: ShareSetMetadataOptions): Promise<ShareSetMetadataResponse>

パラメーター

metadata: Metadata

メタデータが指定されていない場合は、既存のすべてのディレクトリメタデータが削除されます。

options: ShareSetMetadataOptions

戻り値

Promise<ShareSetMetadataResponse>

メタデータの共有設定操作の応答データ。

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

function setProperties(options?: ShareSetPropertiesOptions): Promise<ShareSetPropertiesResponse>

パラメーター

options: ShareSetPropertiesOptions

戻り値

Promise<ShareSetPropertiesResponse>

[プロパティの共有] 操作の応答データ。

警告

この API は非推奨になりました。

Use setProperties instead.

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

function setQuota(quotaInGB: number, options?: ShareSetQuotaOptions): Promise<ShareSetQuotaResponse>

パラメーター

quotaInGB: number

共有の最大サイズをギガバイト単位で指定します

options: ShareSetQuotaOptions

戻り値

Promise<ShareSetQuotaResponse>

共有クォータの取得操作の応答データ。

指定したスナップショットタイムスタンプを使用して、ソースと同じ新しい ShareClient オブジェクトを作成します。 "" を指定すると、スナップショットが削除され、ベース共有への URL が返されます。

function withSnapshot(snapshot: string): ShareClient

パラメーター

snapshot: string

スナップショットのタイムスタンプ。

戻り値

ShareClient

新しい ShareClient オブジェクトは、ソースと同じですが、指定されたスナップショットタイムスタンプを持ちます

次の方法で共有

ShareClient class

コンストラクター

プロパティ

継承されたプロパティ

メソッド

コンストラクターの詳細

ShareClient(string, Credential_2 | TokenCredential, ShareClientOptions)

パラメーター

ShareClient(string, Pipeline, ShareClientConfig)

パラメーター

ShareClient(string, string, ShareClientOptions)

パラメーター

プロパティの詳細

name

プロパティ値

rootDirectoryClient

プロパティ値

継承されたプロパティの詳細

accountName

プロパティ値

url

プロパティ値

メソッドの詳細

create(ShareCreateOptions)

パラメーター

戻り値

createDirectory(string, DirectoryCreateOptions)

パラメーター

戻り値

createFile(string, number, FileCreateOptions)

パラメーター

戻り値

createIfNotExists(ShareCreateOptions)

パラメーター

戻り値

createPermission(string, ShareCreatePermissionOptions)

パラメーター

戻り値

createSnapshot(ShareCreateSnapshotOptions)

パラメーター

戻り値

delete(ShareDeleteMethodOptions)

パラメーター

戻り値

deleteDirectory(string, DirectoryDeleteOptions)

パラメーター

戻り値

deleteFile(string, FileDeleteOptions)

パラメーター

戻り値

deleteIfExists(ShareDeleteMethodOptions)

パラメーター

戻り値

exists(ShareExistsOptions)

パラメーター

戻り値

generateSasUrl(ShareGenerateSasUrlOptions)

パラメーター

戻り値

getAccessPolicy(ShareGetAccessPolicyOptions)

パラメーター

戻り値

getDirectoryClient(string)

パラメーター

戻り値

getPermission(string, ShareGetPermissionOptions)

パラメーター

戻り値

getProperties(ShareGetPropertiesOptions)

パラメーター

戻り値

getStatistics(ShareGetStatisticsOptions)

パラメーター

戻り値

setAccessPolicy(SignedIdentifier[], ShareSetAccessPolicyOptions)

パラメーター

戻り値

setMetadata(Metadata, ShareSetMetadataOptions)

パラメーター