DataLakeServiceClient class

Tworzy wystąpienie elementu DataLakeServiceClient z adresu URL i potoku.

new DataLakeServiceClient(url: string, pipeline: Pipeline)

Parametry

Tworzy wystąpienie klasy DataLakeServiceClient na podstawie adresu URL.

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

Parametry

accountName: string

Wartość właściwości

dziedziczone z StorageClient.accountName

Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z pakietu @azure/identity do uwierzytelniania żądań do usługi. Można również podać obiekt, który implementuje interfejs TokenCredential. Jeśli nie zostanie określony, zostanie użyty parametr AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Wartość właściwości

dziedziczone z StorageClient.credential

Wartość zakodowanego ciągu adresu URL.

url: string

Wartość właściwości

dziedziczone z StorageClient.url

Tworzy wystąpienie klasy DataLakeServiceClient na podstawie parametrów połączenia.

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

Parametry

Zwraca

Dostępny tylko dla elementu DataLakeServiceClient skonstruowany przy użyciu poświadczeń klucza współużytkowanego.

Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) konta na podstawie przekazanych właściwości i parametrów klienta. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza wspólnego klienta.

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

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

Parametry

Zwraca

Identyfikator URI sygnatury dostępu współdzielonego konta składający się z identyfikatora URI do zasobu reprezentowanego przez tego klienta, a następnie wygenerowany token SAS.

Dostępny tylko dla elementu DataLakeServiceClient skonstruowany przy użyciu poświadczeń klucza współużytkowanego.

Generuje ciąg do podpisania dla konta Sygnatura dostępu współdzielonego (SAS) na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza wspólnego klienta.

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

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

Parametry

Zwraca

Identyfikator URI sygnatury dostępu współdzielonego konta składający się z identyfikatora URI do zasobu reprezentowanego przez tego klienta, a następnie wygenerowany token SAS.

Tworzy obiekt DataLakeFileSystemClient.

function getFileSystemClient(fileSystemName: string): DataLakeFileSystemClient

Parametry

Zwraca

Pobiera właściwości punktu końcowego usługi Blob Service konta magazynu, w tym właściwości reguł analizy magazynu i mechanizmu CORS (współużytkowanie zasobów między źródłami).

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

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

Parametry

Zwraca

Dane odpowiedzi dla operacji Pobieranie właściwości usługi.

DOSTĘPNE TYLKO W PRZYPADKU KORZYSTANIA Z UWIERZYTELNIANIA TOKENU ELEMENTU NOŚNEGO (TokenCredential).

Pobiera klucz delegowania użytkownika dla usługi Data Lake. Jest to tylko prawidłowa operacja podczas korzystania z uwierzytelniania tokenu elementu nośnego.

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();

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

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

Parametry

Zwraca

Zwraca iterator asynchroniczny, aby wyświetlić listę wszystkich systemów plików w ramach określonego konta.

Funkcja .byPage() zwraca iterator asynchroniczny w celu wyświetlenia listy systemów plików na stronach.

Przykład użycia składni for await:

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}`);
}

Przykład użycia 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());
}

Przykład użycia 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}`);
    }
  }
}

Przykład użycia stronicowania ze znacznikiem:

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}`);
  }
}

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

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

Parametry

Zwraca

Ustawia właściwości punktu końcowego usługi Blob Service konta magazynu, w tym właściwości dla reguł analizy magazynu, mechanizmu CORS (współużytkowania zasobów między źródłami) i ustawień usuwania nietrwałego.

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

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

Parametry

Zwraca

Dane odpowiedzi dla operacji Właściwości zestawu usług.

Przywróć wcześniej usunięty system plików. Ten interfejs API działa tylko wtedy, gdy dla konta magazynu jest włączone usuwanie nietrwałe kontenera.

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

Parametry

Zwraca