Dela via

DataLakeServiceClient class

Paket:
@azure/storage-file-datalake

Med DataLakeServiceClient kan du manipulera Azure Data Lake-tjänstresurser och filsystem. Lagringskontot tillhandahåller namnområdet på den översta nivån för Data Lake-tjänsten.

Extends

StorageClient

Konstruktorer

DataLakeServiceClient(string, Pipeline)

Skapar en instans av DataLakeServiceClient från URL och pipeline.
DataLakeServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Skapar en instans av DataLakeServiceClient från URL:en.

Ärvda egenskaper

accountName
credential

Till exempel AnonymousCredential, StorageSharedKeyCredential eller eventuella autentiseringsuppgifter från @azure/identity-paketet för att autentisera begäranden till tjänsten. Du kan också ange ett objekt som implementerar TokenCredential-gränssnittet. Om det inte anges används AnonymousCredential.
url

Kodat URL-strängvärde.

Metoder

fromConnectionString(string, StoragePipelineOptions)

Skapar en instans av DataLakeServiceClient från anslutningssträngen.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Endast tillgängligt för DataLakeServiceClient som skapats med en delad nyckelautentiseringsuppgift.

Genererar en SAS-URI (Signatur för delad åtkomst) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

Se https://learn.microsoft.com/rest/api/storageservices/create-account-sas
generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Endast tillgängligt för DataLakeServiceClient som skapats med en delad nyckelautentiseringsuppgift.

Genererar sträng för att signera för ett konto med signatur för delad åtkomst (SAS) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

Se https://learn.microsoft.com/rest/api/storageservices/create-account-sas
getFileSystemClient(string)

Skapar ett DataLakeFileSystemClient--objekt.
getProperties(ServiceGetPropertiesOptions)

Hämtar egenskaperna för ett lagringskontos blobtjänstslutpunkt, inklusive egenskaper för lagringsanalys och CORS-regler (resursdelning mellan ursprung).

Se https://learn.microsoft.com/rest/api/storageservices/get-blob-service-properties
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

ENDAST TILLGÄNGLIGT NÄR DU ANVÄNDER BEARER TOKEN AUTHENTICATION (TokenCredential).

Hämtar en användardelegeringsnyckel för Data Lake-tjänsten. Detta är bara en giltig åtgärd när du använder ägartokenautentisering.

Example

import {
  DataLakeServiceClient,
  generateDataLakeSASQueryParameters,
  FileSystemSASPermissions,
  SASProtocol,
} from "@azure/storage-file-datalake";

const account = "<account>";
const sas = "<sas token>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net${sas}`,
);

const fileSystemName = "<file system name>";
const accountName = "<account name>";
const startsOn = new Date();
const expiresOn = new Date(+new Date() + 86400 * 1000);
// 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();

Se https://learn.microsoft.com/rest/api/storageservices/get-user-delegation-key
listFileSystems(ServiceListFileSystemsOptions)

Returnerar en iterbar iterator som kan asynkroniseras för att visa en lista över alla filsystem under det angivna kontot.

.byPage() returnerar en iterator som kan itereras asynkron för att visa en lista över filsystemen på sidor.

Exempel med for await syntax:

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

let i = 1;
const fileSystems = datalakeServiceClient.listFileSystems();
for await (const fileSystem of fileSystems) {
  console.log(`File system ${i++}: ${fileSystem.name}`);
}

Exempel med iter.next():

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

let i = 1;
const fileSystems = datalakeServiceClient.listFileSystems();
let { value, done } = await fileSystems.next();
while (!done) {
  console.log(`File system ${i++}: ${value.name}`);
  ({ value, done } = await fileSystems.next());
}

Exempel med byPage():

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

let i = 1;
for await (const response of datalakeServiceClient.listFileSystems().byPage({ maxPageSize: 20 })) {
  if (response.fileSystemItems) {
    for (const fileSystem of response.fileSystemItems) {
      console.log(`File System ${i++}: ${fileSystem.name}`);
    }
  }
}

Exempel med växling med en markör:

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

let i = 1;
let fileSystems = datalakeServiceClient.listFileSystems().byPage({ maxPageSize: 2 });
let response = (await fileSystems.next()).value;
// Prints 2 file systems
if (response.fileSystemItems) {
  for (const fileSystem of response.fileSystemItems) {
    console.log(`File system ${i++}: ${fileSystem.name}`);
  }
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
fileSystems = datalakeServiceClient
  .listFileSystems()
  .byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await fileSystems.next()).value;
// Prints 10 file systems
if (response.fileSystemItems) {
  for (const fileSystem of response.fileSystemItems) {
    console.log(`File system ${i++}: ${fileSystem.name}`);
  }
}

Se https://learn.microsoft.com/rest/api/storageservices/list-containers2
setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

Anger egenskaper för ett lagringskontos blobtjänstslutpunkt, inklusive egenskaper för Lagringsanalys, CORS-regler (resursdelning mellan ursprung) och inställningar för mjuk borttagning.

Se https://learn.microsoft.com/rest/api/storageservices/set-blob-service-properties
undeleteFileSystem(string, string, ServiceUndeleteFileSystemOptions)

Återställ ett tidigare borttaget filsystem. Det här API:et fungerar bara om mjuk borttagning av containrar är aktiverat för lagringskontot.

Konstruktorinformation

DataLakeServiceClient(string, Pipeline)

Skapar en instans av DataLakeServiceClient från URL och pipeline.

new DataLakeServiceClient(url: string, pipeline: Pipeline)

Parametrar

url

string

En klientsträng som pekar på Azure Storage Data Lake-tjänsten, till exempel "https://myaccount.dfs.core.windows.net". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.dfs.core.windows.net?sasString".

pipeline
Pipeline

Anropa newPipeline() för att skapa en standardpipeline eller ange en anpassad pipeline.

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

Skapar en instans av DataLakeServiceClient från URL:en.

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

Parametrar

url

string

En klientsträng som pekar på Azure Storage Data Lake-tjänsten, till exempel "https://myaccount.dfs.core.windows.net". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.dfs.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Till exempel AnonymousCredential, StorageSharedKeyCredential eller eventuella autentiseringsuppgifter från @azure/identity-paketet för att autentisera begäranden till tjänsten. Du kan också ange ett objekt som implementerar TokenCredential-gränssnittet. Om det inte anges används AnonymousCredential.

options
StoragePipelineOptions

Optional. Alternativ för att konfigurera HTTP-pipelinen.

Information om ärvda egenskaper

accountName 

accountName: string

Egenskapsvärde

string

ärvd från StorageClient.accountName

credential

Till exempel AnonymousCredential, StorageSharedKeyCredential eller eventuella autentiseringsuppgifter från @azure/identity-paketet för att autentisera begäranden till tjänsten. Du kan också ange ett objekt som implementerar TokenCredential-gränssnittet. Om det inte anges används AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Egenskapsvärde

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

ärvd från StorageClient.credential

url

Kodat URL-strängvärde.

url: string

Egenskapsvärde

string

ärvd från StorageClient.url

Metodinformation

fromConnectionString(string, StoragePipelineOptions)

Skapar en instans av DataLakeServiceClient från anslutningssträngen.

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

Parametrar

connectionString

string

Kontoanslutningssträng eller en SAS-anslutningssträng för ett Azure Storage-konto. [ Obs! Kontoanslutningssträngen kan bara användas i NODE.JS körning. ] Exempel på kontoanslutningssträng – DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net EXEMPEL på SAS-anslutningssträng – 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

options
StoragePipelineOptions

Optional. Alternativ för att konfigurera HTTP-pipelinen.

Returer

DataLakeServiceClient

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Endast tillgängligt för DataLakeServiceClient som skapats med en delad nyckelautentiseringsuppgift.

Genererar en SAS-URI (Signatur för delad åtkomst) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

Se https://learn.microsoft.com/rest/api/storageservices/create-account-sas

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

Parametrar

expiresOn

Date

Optional. Den tidpunkt då signaturen för delad åtkomst blir ogiltig. Standardvärdet är en timme senare om det inte anges.

permissions
AccountSASPermissions

Anger listan över behörigheter som ska associeras med SAS.

resourceTypes

string

Anger de resurstyper som är associerade med signaturen för delad åtkomst.

options
ServiceGenerateAccountSasUrlOptions

Valfria parametrar.

Returer

string

En SAS-URI för kontot som består av URI:n för den resurs som representeras av den här klienten, följt av den genererade SAS-token.

generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Endast tillgängligt för DataLakeServiceClient som skapats med en delad nyckelautentiseringsuppgift.

Genererar sträng för att signera för ett konto med signatur för delad åtkomst (SAS) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

Se https://learn.microsoft.com/rest/api/storageservices/create-account-sas

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

Parametrar

expiresOn

Date

Optional. Den tidpunkt då signaturen för delad åtkomst blir ogiltig. Standardvärdet är en timme senare om det inte anges.

permissions
AccountSASPermissions

Anger listan över behörigheter som ska associeras med SAS.

resourceTypes

string

Anger de resurstyper som är associerade med signaturen för delad åtkomst.

options
ServiceGenerateAccountSasUrlOptions

Valfria parametrar.

Returer

string

En SAS-URI för kontot som består av URI:n för den resurs som representeras av den här klienten, följt av den genererade SAS-token.

getFileSystemClient(string)

Skapar ett DataLakeFileSystemClient--objekt.

function getFileSystemClient(fileSystemName: string): DataLakeFileSystemClient

Parametrar

fileSystemName

string

Filsystemnamn.

Returer

DataLakeFileSystemClient

getProperties(ServiceGetPropertiesOptions)

Hämtar egenskaperna för ett lagringskontos blobtjänstslutpunkt, inklusive egenskaper för lagringsanalys och CORS-regler (resursdelning mellan ursprung).

Se https://learn.microsoft.com/rest/api/storageservices/get-blob-service-properties

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

Parametrar

options
ServiceGetPropertiesOptions

Alternativ för åtgärden Hämta egenskaper för tjänsten.

Returer

Promise<DataLakeServiceGetPropertiesResponse>

Svarsdata för åtgärden Hämta egenskaper för tjänsten.

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

ENDAST TILLGÄNGLIGT NÄR DU ANVÄNDER BEARER TOKEN AUTHENTICATION (TokenCredential).

Hämtar en användardelegeringsnyckel för Data Lake-tjänsten. Detta är bara en giltig åtgärd när du använder ägartokenautentisering.

Example

import {
  DataLakeServiceClient,
  generateDataLakeSASQueryParameters,
  FileSystemSASPermissions,
  SASProtocol,
} from "@azure/storage-file-datalake";

const account = "<account>";
const sas = "<sas token>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net${sas}`,
);

const fileSystemName = "<file system name>";
const accountName = "<account name>";
const startsOn = new Date();
const expiresOn = new Date(+new Date() + 86400 * 1000);
// 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();

Se https://learn.microsoft.com/rest/api/storageservices/get-user-delegation-key

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

Parametrar

startsOn

Date

Starttiden för SAS för användardelegering. Måste vara inom 7 dagar från den aktuella tiden.

expiresOn

Date

Sluttiden för SAS för användardelegering. Måste vara inom 7 dagar från den aktuella tiden.

options
ServiceGetUserDelegationKeyOptions

Returer

Promise<ServiceGetUserDelegationKeyResponse>

listFileSystems(ServiceListFileSystemsOptions)

Returnerar en iterbar iterator som kan asynkroniseras för att visa en lista över alla filsystem under det angivna kontot.

.byPage() returnerar en iterator som kan itereras asynkron för att visa en lista över filsystemen på sidor.

Exempel med for await syntax:

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

let i = 1;
const fileSystems = datalakeServiceClient.listFileSystems();
for await (const fileSystem of fileSystems) {
  console.log(`File system ${i++}: ${fileSystem.name}`);
}

Exempel med iter.next():

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

let i = 1;
const fileSystems = datalakeServiceClient.listFileSystems();
let { value, done } = await fileSystems.next();
while (!done) {
  console.log(`File system ${i++}: ${value.name}`);
  ({ value, done } = await fileSystems.next());
}

Exempel med byPage():

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

let i = 1;
for await (const response of datalakeServiceClient.listFileSystems().byPage({ maxPageSize: 20 })) {
  if (response.fileSystemItems) {
    for (const fileSystem of response.fileSystemItems) {
      console.log(`File System ${i++}: ${fileSystem.name}`);
    }
  }
}

Exempel med växling med en markör:

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

let i = 1;
let fileSystems = datalakeServiceClient.listFileSystems().byPage({ maxPageSize: 2 });
let response = (await fileSystems.next()).value;
// Prints 2 file systems
if (response.fileSystemItems) {
  for (const fileSystem of response.fileSystemItems) {
    console.log(`File system ${i++}: ${fileSystem.name}`);
  }
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
fileSystems = datalakeServiceClient
  .listFileSystems()
  .byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await fileSystems.next()).value;
// Prints 10 file systems
if (response.fileSystemItems) {
  for (const fileSystem of response.fileSystemItems) {
    console.log(`File system ${i++}: ${fileSystem.name}`);
  }
}

Se https://learn.microsoft.com/rest/api/storageservices/list-containers2

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

Parametrar

options
ServiceListFileSystemsOptions

Returer

PagedAsyncIterableIterator<FileSystemItem, ServiceListFileSystemsSegmentResponse, PageSettings>

setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

Anger egenskaper för ett lagringskontos blobtjänstslutpunkt, inklusive egenskaper för Lagringsanalys, CORS-regler (resursdelning mellan ursprung) och inställningar för mjuk borttagning.

Se https://learn.microsoft.com/rest/api/storageservices/set-blob-service-properties

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

Parametrar

properties
DataLakeServiceProperties
options
ServiceSetPropertiesOptions

Alternativ för åtgärden Egenskaper för tjänstuppsättning.

Returer

Promise<ServiceSetPropertiesResponse>

Svarsdata för åtgärden Egenskaper för tjänstuppsättning.

undeleteFileSystem(string, string, ServiceUndeleteFileSystemOptions)

Återställ ett tidigare borttaget filsystem. Det här API:et fungerar bara om mjuk borttagning av containrar är aktiverat för lagringskontot.

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

Parametrar

deletedFileSystemName

string

Namnet på källfilsystemet.

deleteFileSystemVersion

string

Det nya namnet på filsystemet.

options
ServiceUndeleteFileSystemOptions

Alternativ för att konfigurera återställning av filsystem.

Returer

Promise<{ fileSystemClient: DataLakeFileSystemClient, fileSystemUndeleteResponse: ContainerUndeleteResponse }>