DataLakeServiceClient class

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

new DataLakeServiceClient(url: string, pipeline: Pipeline)

パラメーター

URL から DataLakeServiceClient のインスタンスを作成します。

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

パラメーター

accountName: string

プロパティ値

StorageClient.accountName から継承された

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

プロパティ値

StorageClient.credential から継承された

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

url: string

プロパティ値

StorageClient.url から継承された

接続文字列から DataLakeServiceClient のインスタンスを作成します。

static function fromConnectionString(connectionString: string, options?: StoragePipelineOptions): DataLakeServiceClient

パラメーター

戻り値

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

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

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

function generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string

パラメーター

戻り値

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

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

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

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

function generateSasStringToSign(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string

パラメーター

戻り値

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

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

function getFileSystemClient(fileSystemName: string): DataLakeFileSystemClient

パラメーター

戻り値

ストレージ アカウントの BLOB サービス エンドポイントのプロパティ (Storage Analytics および CORS (クロスオリジン リソース共有) ルールのプロパティを含む) を取得します。

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

function getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>

パラメーター

戻り値

サービスのプロパティの取得操作の応答データ。

ベアラー トークン認証 (TokenCredential) を使用している場合にのみ使用できます。

Data Lake サービスのユーザー委任キーを取得します。 これは、ベアラー トークン認証を使用する場合にのみ有効な操作です。

「例」

// Generate user delegation SAS for a file system
const userDelegationKey = await dataLakeServiceClient.getUserDelegationKey(startsOn, expiresOn);
const fileSystemSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: FileSystemSASPermissions.parse("racwdl"), // Required
    startsOn, // Required. Date type
    expiresOn, // Optional. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
  },
  userDelegationKey, // UserDelegationKey
  accountName
).toString();

https://learn.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key を参照してください

function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions): Promise<ServiceGetUserDelegationKeyResponse>

パラメーター

戻り値

指定したアカウントのすべてのファイル システムを一覧表示する非同期反復可能反復子を返します。

.byPage() は非同期反復可能な反復子を返して、ページ内のファイル システムを一覧表示します。

for await 構文の使用例:

let i = 1;
for await (const fileSystem of serviceClient.listFileSystems()) {
  console.log(`FileSystem ${i++}: ${fileSystem.name}`);
}

iter.next()の使用例:

let i = 1;
const iter = serviceClient.listFileSystems();
let fileSystemItem = await iter.next();
while (!fileSystemItem.done) {
  console.log(`FileSystem ${i++}: ${fileSystemItem.value.name}`);
  fileSystemItem = await iter.next();
}

byPage()の使用例:

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of serviceClient.listFileSystems().byPage({ maxPageSize: 20 })) {
  if (response.fileSystemItems) {
    for (const fileSystem of response.fileSystemItems) {
      console.log(`FileSystem ${i++}: ${fileSystem.name}`);
    }
  }
}

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

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

// Prints 2 file system names
if (response.fileSystemItems) {
  for (const fileSystem of response.fileSystemItems) {
    console.log(`FileSystem ${i++}: ${fileSystem.name}`);
  }
}

// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = serviceClient
  .listContainers()
  .byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 file system names
if (response.fileSystemItems) {
  for (const fileSystem of response.fileSystemItems) {
     console.log(`FileSystem ${i++}: ${fileSystem.name}`);
  }
}

https://learn.microsoft.com/en-us/rest/api/storageservices/list-containers2 を参照してください

function listFileSystems(options?: ServiceListFileSystemsOptions): PagedAsyncIterableIterator<FileSystemItem, ServiceListFileSystemsSegmentResponse, PageSettings>

パラメーター

戻り値

Storage Analytics のプロパティ、CORS (クロスオリジン リソース共有) ルール、論理的な削除設定など、ストレージ アカウントの BLOB サービス エンドポイントのプロパティを設定します。

https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties を参照してください

function setProperties(properties: BlobServiceProperties, options?: ServiceSetPropertiesOptions): Promise<ServiceSetPropertiesResponse>

パラメーター

戻り値

サービス セットのプロパティ操作の応答データ。

以前に削除したファイル システムを復元します。 この API は、ストレージ アカウントに対してコンテナーの論理的な削除が有効になっている場合にのみ機能します。

function undeleteFileSystem(deletedFileSystemName: string, deleteFileSystemVersion: string, options?: ServiceUndeleteFileSystemOptions): Promise<{ fileSystemClient: DataLakeFileSystemClient, fileSystemUndeleteResponse: ContainerUndeleteResponse }>

パラメーター

戻り値