次の方法で共有

DataLakeFileSystemClient class

  • リファレンス
パッケージ:
@azure/storage-file-datalake

DataLakeFileSystemClient は、Azure Storage ファイル システムへの URL を表し、ディレクトリとファイルを操作できます。

Extends

StorageClient

コンストラクター

DataLakeFileSystemClient(string, Pipeline)

URL とパイプラインから DataLakeFileSystemClient のインスタンスを作成します。
DataLakeFileSystemClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

URL と資格情報から DataLakeFileSystemClient のインスタンスを作成します。

プロパティ

name

現在のファイル システムの名前。

継承されたプロパティ

accountName
credential

AnonymousCredential、StorageSharedKeyCredential、サービスへの要求を認証するための @azure/identity パッケージの資格情報など。 TokenCredential インターフェイスを実装するオブジェクトを指定することもできます。 指定しない場合は、AnonymousCredential が使用されます。
url

エンコードされた URL 文字列値。

メソッド

create(FileSystemCreateOptions)

指定したアカウントの下に新しいファイル システムを作成します。 同じ名前のファイル システムが既に存在する場合、操作は失敗します。

https://docs.microsoft.com/en-us/rest/api/storageservices/create-container を参照してください
createIfNotExists(FileSystemCreateOptions)

指定したアカウントの下に新しいファイル システムを作成します。 同じ名前のファイル システムが既に存在する場合は、変更されません。

https://docs.microsoft.com/en-us/rest/api/storageservices/create-container を参照してください
delete(FileSystemDeleteOptions)

現在のファイル システムを削除します。

https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container を参照してください
deleteIfExists(FileSystemDeleteOptions)

現在のファイル システムが存在する場合は削除します。

https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container を参照してください
exists(FileSystemExistsOptions)

このクライアントによって表されるファイル システムが存在する場合は true を返します。それ以外の場合は false。

注: 既存のファイル システムは他のクライアントまたはアプリケーションによって削除される可能性があるため、この関数は注意して使用してください。 その逆も同じ名前の新しいファイル システムは、この関数の完了後に他のクライアントまたはアプリケーションによって追加される可能性があります。
generateSasStringToSign(FileSystemGenerateSasUrlOptions)

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

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

https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas を参照してください
generateSasUrl(FileSystemGenerateSasUrlOptions)

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

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

https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas を参照してください
generateUserDelegationSasStringToSign(FileSystemGenerateSasUrlOptions, UserDelegationKey)

渡されたクライアントのプロパティとパラメーターに基づいて、サービス Shared Access Signature (SAS) URI に署名する文字列を生成します。 SAS は、入力ユーザー委任キーによって署名されます。

https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas を参照してください
generateUserDelegationSasUrl(FileSystemGenerateSasUrlOptions, UserDelegationKey)

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

https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas を参照してください
getAccessPolicy(FileSystemGetAccessPolicyOptions)

指定したファイル システムのアクセス許可を取得します。 アクセス許可は、ファイル システム データにパブリックにアクセスできるかどうかを示します。

警告: startsOn 文字列と expiresOn 文字列を解析すると、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-container-acl を参照してください
getDataLakeLeaseClient(string)

ファイル システムのリースを管理する DataLakeLeaseClient を取得します。
getDirectoryClient(string)

現在のファイル システムに DataLakeDirectoryClient オブジェクトを作成します。
getFileClient(string)

現在のファイル システムに DataLakeFileClient オブジェクトを作成します。
getProperties(FileSystemGetPropertiesOptions)

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

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

https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties を参照してください
listDeletedPaths(ListDeletedPathsOptions)

指定したファイル システムのすべてのパス (ディレクトリとファイル) を一覧表示する非同期反復可能な反復子を返します。

.byPage() は、ページ内のパスを一覧表示する非同期反復可能な反復子を返します。

for await 構文の使用例:

// Get the fileSystemClient before you run these snippets,
// Can be obtained from `serviceClient.getFileSystemClient("<your-filesystem-name>");`
let i = 1;
for await (const deletePath of fileSystemClient.listDeletedPaths()) {
  console.log(`Path ${i++}: ${deletePath.name}`);
}

iter.next() の使用例:

let i = 1;
let iter = fileSystemClient.listDeletedPaths();
let deletedPathItem = await iter.next();
while (!deletedPathItem.done) {
  console.log(`Path ${i++}: ${deletedPathItem.value.name}`);
  pathItem = await iter.next();
}

byPage() の使用例:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of fileSystemClient.listDeletedPaths().byPage({ maxPageSize: 20 })) {
  for (const deletePath of response.pathItems) {
    console.log(`Path ${i++}: ${deletePath.name}`);
  }
}

マーカーでのページングの使用例:

let i = 1;
let iterator = fileSystemClient.listDeletedPaths().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 path names
for (const path of response.pathItems) {
  console.log(`Path ${i++}: ${path.name}}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = fileSystemClient.listDeletedPaths().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 path names
for (const deletePath of response.deletedPathItems) {
  console.log(`Path ${i++}: ${deletePath.name}`);
}

https://docs.microsoft.com/rest/api/storageservices/list-blobs を参照してください
listPaths(ListPathsOptions)

指定したファイル システムのすべてのパス (ディレクトリとファイル) を一覧表示する非同期反復可能な反復子を返します。

.byPage() は、ページ内のパスを一覧表示する非同期反復可能な反復子を返します。

for await 構文の使用例:

// Get the fileSystemClient before you run these snippets,
// Can be obtained from `serviceClient.getFileSystemClient("<your-filesystem-name>");`
let i = 1;
for await (const path of fileSystemClient.listPaths()) {
  console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}

iter.next() の使用例:

let i = 1;
let iter = fileSystemClient.listPaths();
let pathItem = await iter.next();
while (!pathItem.done) {
  console.log(`Path ${i++}: ${pathItem.value.name}, isDirectory?: ${pathItem.value.isDirectory}`);
  pathItem = await iter.next();
}

byPage() の使用例:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of fileSystemClient.listPaths().byPage({ maxPageSize: 20 })) {
  for (const path of response.pathItems) {
    console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
  }
}

マーカーでのページングの使用例:

let i = 1;
let iterator = fileSystemClient.listPaths().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 path names
for (const path of response.pathItems) {
  console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = fileSystemClient.listPaths().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 path names
for (const path of response.pathItems) {
  console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}

https://docs.microsoft.com/rest/api/storageservices/list-blobs を参照してください
setAccessPolicy(PublicAccessType, SignedIdentifier<AccessPolicy>[], FileSystemSetAccessPolicyOptions)

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

ファイル システムのアクセス許可を設定すると、既存のアクセス許可が置き換えられます。 アクセスまたは containerAcl が指定されていない場合は、既存のファイル システム ACL が削除されます。

https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl を参照してください
setMetadata(Metadata, FileSystemSetMetadataOptions)

指定したファイル システムの 1 つ以上のユーザー定義の名前と値のペアを設定します。

オプションが指定されていない場合、またはパラメーターにメタデータが定義されていない場合は、ファイル システムメタデータが削除されます。

https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata を参照してください
undeletePath(string, string, FileSystemUndeletePathOption)

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

https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob を参照してください

コンストラクターの詳細

DataLakeFileSystemClient(string, Pipeline)

URL とパイプラインから DataLakeFileSystemClient のインスタンスを作成します。

new DataLakeFileSystemClient(url: string, pipeline: Pipeline)

パラメーター

url

string

"https://myaccount.dfs.core.windows.net/filesystem" など、Azure Storage データ レイク ファイル システムを指すクライアント文字列。 "https://myaccount.dfs.core.windows.net/filesystem?sasString" など、AnonymousCredential を使用している場合は SAS を追加できます。

pipeline
Pipeline

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

DataLakeFileSystemClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

URL と資格情報から DataLakeFileSystemClient のインスタンスを作成します。

new DataLakeFileSystemClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

パラメーター

url

string

"https://myaccount.dfs.core.windows.net/filesystem" など、Azure Storage データ レイク ファイル システムを指すクライアント文字列。 "https://myaccount.dfs.core.windows.net/filesystem?sasString" など、AnonymousCredential を使用している場合は SAS を追加できます。

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

AnonymousCredential、StorageSharedKeyCredential、サービスへの要求を認証するための @azure/identity パッケージの資格情報など。 TokenCredential インターフェイスを実装するオブジェクトを指定することもできます。 指定しない場合は、AnonymousCredential が使用されます。

options
StoragePipelineOptions

随意。 HTTP パイプラインを構成するためのオプション。

プロパティの詳細

name

現在のファイル システムの名前。

string name

プロパティ値

string

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

accountName 

accountName: string

プロパティ値

string

StorageClient.accountName から継承された

credential

AnonymousCredential、StorageSharedKeyCredential、サービスへの要求を認証するための @azure/identity パッケージの資格情報など。 TokenCredential インターフェイスを実装するオブジェクトを指定することもできます。 指定しない場合は、AnonymousCredential が使用されます。

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

プロパティ値

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

StorageClient.credential から継承された

url

エンコードされた URL 文字列値。

url: string

プロパティ値

string

StorageClient.url から継承された

メソッドの詳細

create(FileSystemCreateOptions)

指定したアカウントの下に新しいファイル システムを作成します。 同じ名前のファイル システムが既に存在する場合、操作は失敗します。

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

function create(options?: FileSystemCreateOptions): Promise<FileSystemCreateResponse>

パラメーター

options
FileSystemCreateOptions

随意。 ファイル システムを作成するときのオプション。

戻り値

Promise<FileSystemCreateResponse>

createIfNotExists(FileSystemCreateOptions)

指定したアカウントの下に新しいファイル システムを作成します。 同じ名前のファイル システムが既に存在する場合は、変更されません。

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

function createIfNotExists(options?: FileSystemCreateOptions): Promise<FileSystemCreateIfNotExistsResponse>

パラメーター

options
FileSystemCreateOptions

戻り値

Promise<FileSystemCreateIfNotExistsResponse>

delete(FileSystemDeleteOptions)

現在のファイル システムを削除します。

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

function delete(options?: FileSystemDeleteOptions): Promise<FileSystemDeleteResponse>

パラメーター

options
FileSystemDeleteOptions

随意。 ファイル システムを削除するときのオプション。

戻り値

Promise<FileSystemDeleteResponse>

deleteIfExists(FileSystemDeleteOptions)

現在のファイル システムが存在する場合は削除します。

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

function deleteIfExists(options?: FileSystemDeleteOptions): Promise<FileSystemDeleteIfExistsResponse>

パラメーター

options
FileSystemDeleteOptions

戻り値

Promise<FileSystemDeleteIfExistsResponse>

exists(FileSystemExistsOptions)

このクライアントによって表されるファイル システムが存在する場合は true を返します。それ以外の場合は false。

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

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

パラメーター

options
FileSystemExistsOptions

戻り値

Promise<boolean>

generateSasStringToSign(FileSystemGenerateSasUrlOptions)

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

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

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

function generateSasStringToSign(options: FileSystemGenerateSasUrlOptions): string

パラメーター

options
FileSystemGenerateSasUrlOptions

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

戻り値

string

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

generateSasUrl(FileSystemGenerateSasUrlOptions)

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

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

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

function generateSasUrl(options: FileSystemGenerateSasUrlOptions): Promise<string>

パラメーター

options
FileSystemGenerateSasUrlOptions

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

戻り値

Promise<string>

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

generateUserDelegationSasStringToSign(FileSystemGenerateSasUrlOptions, UserDelegationKey)

渡されたクライアントのプロパティとパラメーターに基づいて、サービス Shared Access Signature (SAS) URI に署名する文字列を生成します。 SAS は、入力ユーザー委任キーによって署名されます。

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

function generateUserDelegationSasStringToSign(options: FileSystemGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

パラメーター

options
FileSystemGenerateSasUrlOptions

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

userDelegationKey
UserDelegationKey

blobServiceClient.getUserDelegationKey() の戻り値

戻り値

string

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

generateUserDelegationSasUrl(FileSystemGenerateSasUrlOptions, UserDelegationKey)

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

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

function generateUserDelegationSasUrl(options: FileSystemGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>

パラメーター

options
FileSystemGenerateSasUrlOptions

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

userDelegationKey
UserDelegationKey

blobServiceClient.getUserDelegationKey() の戻り値

戻り値

Promise<string>

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

getAccessPolicy(FileSystemGetAccessPolicyOptions)

指定したファイル システムのアクセス許可を取得します。 アクセス許可は、ファイル システム データにパブリックにアクセスできるかどうかを示します。

警告: startsOn 文字列と expiresOn 文字列を解析すると、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-container-acl を参照してください

function getAccessPolicy(options?: FileSystemGetAccessPolicyOptions): Promise<FileSystemGetAccessPolicyResponse>

パラメーター

options
FileSystemGetAccessPolicyOptions

随意。 ファイル システム アクセス ポリシーを取得するときのオプション。

戻り値

Promise<FileSystemGetAccessPolicyResponse>

getDataLakeLeaseClient(string)

ファイル システムのリースを管理する DataLakeLeaseClient を取得します。

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

パラメーター

proposeLeaseId

string

随意。 最初に提案されたリース ID。

戻り値

DataLakeLeaseClient

getDirectoryClient(string)

現在のファイル システムに DataLakeDirectoryClient オブジェクトを作成します。

function getDirectoryClient(directoryName: string): DataLakeDirectoryClient

パラメーター

directoryName

string

戻り値

DataLakeDirectoryClient

getFileClient(string)

現在のファイル システムに DataLakeFileClient オブジェクトを作成します。

function getFileClient(fileName: string): DataLakeFileClient

パラメーター

fileName

string

戻り値

DataLakeFileClient

getProperties(FileSystemGetPropertiesOptions)

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

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

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

function getProperties(options?: FileSystemGetPropertiesOptions): Promise<FileSystemGetPropertiesResponse>

パラメーター

options
FileSystemGetPropertiesOptions

随意。 ファイル システムのプロパティを取得するときのオプション。

戻り値

Promise<FileSystemGetPropertiesResponse>

listDeletedPaths(ListDeletedPathsOptions)

指定したファイル システムのすべてのパス (ディレクトリとファイル) を一覧表示する非同期反復可能な反復子を返します。

.byPage() は、ページ内のパスを一覧表示する非同期反復可能な反復子を返します。

for await 構文の使用例:

// Get the fileSystemClient before you run these snippets,
// Can be obtained from `serviceClient.getFileSystemClient("<your-filesystem-name>");`
let i = 1;
for await (const deletePath of fileSystemClient.listDeletedPaths()) {
  console.log(`Path ${i++}: ${deletePath.name}`);
}

iter.next() の使用例:

let i = 1;
let iter = fileSystemClient.listDeletedPaths();
let deletedPathItem = await iter.next();
while (!deletedPathItem.done) {
  console.log(`Path ${i++}: ${deletedPathItem.value.name}`);
  pathItem = await iter.next();
}

byPage() の使用例:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of fileSystemClient.listDeletedPaths().byPage({ maxPageSize: 20 })) {
  for (const deletePath of response.pathItems) {
    console.log(`Path ${i++}: ${deletePath.name}`);
  }
}

マーカーでのページングの使用例:

let i = 1;
let iterator = fileSystemClient.listDeletedPaths().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 path names
for (const path of response.pathItems) {
  console.log(`Path ${i++}: ${path.name}}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = fileSystemClient.listDeletedPaths().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 path names
for (const deletePath of response.deletedPathItems) {
  console.log(`Path ${i++}: ${deletePath.name}`);
}

https://docs.microsoft.com/rest/api/storageservices/list-blobs を参照してください

function listDeletedPaths(options?: ListDeletedPathsOptions): PagedAsyncIterableIterator<DeletedPath, FileSystemListDeletedPathsResponse, PageSettings>

パラメーター

options
ListDeletedPathsOptions

随意。 削除されたパスを一覧表示するときのオプション。

戻り値

PagedAsyncIterableIterator<DeletedPath, FileSystemListDeletedPathsResponse, PageSettings>

listPaths(ListPathsOptions)

指定したファイル システムのすべてのパス (ディレクトリとファイル) を一覧表示する非同期反復可能な反復子を返します。

.byPage() は、ページ内のパスを一覧表示する非同期反復可能な反復子を返します。

for await 構文の使用例:

// Get the fileSystemClient before you run these snippets,
// Can be obtained from `serviceClient.getFileSystemClient("<your-filesystem-name>");`
let i = 1;
for await (const path of fileSystemClient.listPaths()) {
  console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}

iter.next() の使用例:

let i = 1;
let iter = fileSystemClient.listPaths();
let pathItem = await iter.next();
while (!pathItem.done) {
  console.log(`Path ${i++}: ${pathItem.value.name}, isDirectory?: ${pathItem.value.isDirectory}`);
  pathItem = await iter.next();
}

byPage() の使用例:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of fileSystemClient.listPaths().byPage({ maxPageSize: 20 })) {
  for (const path of response.pathItems) {
    console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
  }
}

マーカーでのページングの使用例:

let i = 1;
let iterator = fileSystemClient.listPaths().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 path names
for (const path of response.pathItems) {
  console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = fileSystemClient.listPaths().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 path names
for (const path of response.pathItems) {
  console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}

https://docs.microsoft.com/rest/api/storageservices/list-blobs を参照してください

function listPaths(options?: ListPathsOptions): PagedAsyncIterableIterator<Path, FileSystemListPathsResponse, PageSettings>

パラメーター

options
ListPathsOptions

随意。 パスを一覧表示するときのオプション。

戻り値

PagedAsyncIterableIterator<Path, FileSystemListPathsResponse, PageSettings>

setAccessPolicy(PublicAccessType, SignedIdentifier<AccessPolicy>[], FileSystemSetAccessPolicyOptions)

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

ファイル システムのアクセス許可を設定すると、既存のアクセス許可が置き換えられます。 アクセスまたは containerAcl が指定されていない場合は、既存のファイル システム ACL が削除されます。

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

function setAccessPolicy(access?: PublicAccessType, fileSystemAcl?: SignedIdentifier<AccessPolicy>[], options?: FileSystemSetAccessPolicyOptions): Promise<FileSystemSetAccessPolicyResponse>

パラメーター

access
PublicAccessType

随意。 ファイル システム内のデータへのパブリック アクセスのレベル。

fileSystemAcl

SignedIdentifier<AccessPolicy>[]

随意。 一意の ID とアクセス ポリシーの詳細を持つ要素の配列。

options
FileSystemSetAccessPolicyOptions

随意。 ファイル システム アクセス ポリシーを設定するときのオプション。

戻り値

Promise<FileSystemSetAccessPolicyResponse>

setMetadata(Metadata, FileSystemSetMetadataOptions)

指定したファイル システムの 1 つ以上のユーザー定義の名前と値のペアを設定します。

オプションが指定されていない場合、またはパラメーターにメタデータが定義されていない場合は、ファイル システムメタデータが削除されます。

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

function setMetadata(metadata?: Metadata, options?: FileSystemSetMetadataOptions): Promise<FileSystemSetMetadataResponse>

パラメーター

metadata
Metadata

既存のメタデータをこの値に置き換えます。 値が指定されていない場合、既存のメタデータは削除されます。

options
FileSystemSetMetadataOptions

随意。 ファイル システム メタデータを設定するときのオプション。

戻り値

Promise<FileSystemSetMetadataResponse>

undeletePath(string, string, FileSystemUndeletePathOption)

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

https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob を参照してください

function undeletePath(deletedPath: string, deletionId: string, options?: FileSystemUndeletePathOption): Promise<FileSystemUndeletePathResponse>

パラメーター

deletedPath

string

必須。 削除されたパスのパス。

deletionId

string

必須。 論理的に削除されたパスに関連付けられている削除 ID。

options
FileSystemUndeletePathOption

戻り値

Promise<FileSystemUndeletePathResponse>