Udostępnij za pośrednictwem

DataLakeServiceClient class

  • Odwołanie
Pakiet:
@azure/storage-file-datalake

Obiekt DataLakeServiceClient umożliwia manipulowanie zasobami i systemami plików usługi Azure Data Lake. Konto magazynu zapewnia przestrzeń nazw najwyższego poziomu dla usługi Data Lake.

Rozszerzenie

StorageClient

Konstruktory

DataLakeServiceClient(string, Pipeline)

Tworzy wystąpienie elementu DataLakeServiceClient z adresu URL i potoku.
DataLakeServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Tworzy wystąpienie klasy DataLakeServiceClient na podstawie adresu URL.

Właściwości dziedziczone

accountName
credential

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.
url

Wartość zakodowanego ciągu adresu URL.

Metody

fromConnectionString(string, StoragePipelineOptions)

Tworzy wystąpienie klasy DataLakeServiceClient na podstawie parametrów połączenia.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

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/en-us/rest/api/storageservices/create-account-sas
generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

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/en-us/rest/api/storageservices/create-account-sas
getFileSystemClient(string)

Tworzy obiekt DataLakeFileSystemClient.
getProperties(ServiceGetPropertiesOptions)

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/en-us/rest/api/storageservices/get-blob-service-properties
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

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.

Przykład

// 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/en-us/rest/api/storageservices/get-user-delegation-key
listFileSystems(ServiceListFileSystemsOptions)

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:

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

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

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

Przykład użycia stronicowania ze znacznikiem:

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

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

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/en-us/rest/api/storageservices/set-blob-service-properties
undeleteFileSystem(string, string, ServiceUndeleteFileSystemOptions)

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.

Szczegóły konstruktora

DataLakeServiceClient(string, Pipeline)

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

new DataLakeServiceClient(url: string, pipeline: Pipeline)

Parametry

url

string

Ciąg klienta wskazujący usługę Data Lake usługi Azure Storage, taką jak "https://myaccount.dfs.core.windows.net". Sygnaturę dostępu współdzielonego można dołączyć, jeśli jest używana funkcja AnonymousCredential, na przykład "https://myaccount.dfs.core.windows.net?sasString".

pipeline
Pipeline

Wywołaj metodę newPipeline(), aby utworzyć domyślny potok lub podaj dostosowany potok.

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

Tworzy wystąpienie klasy DataLakeServiceClient na podstawie adresu URL.

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

Parametry

url

string

Ciąg klienta wskazujący usługę Data Lake usługi Azure Storage, taką jak "https://myaccount.dfs.core.windows.net". Sygnaturę dostępu współdzielonego można dołączyć, jeśli jest używana funkcja AnonymousCredential, na przykład "https://myaccount.dfs.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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.

options
StoragePipelineOptions

Fakultatywny. Opcje konfigurowania potoku HTTP.

Szczegóły właściwości dziedziczonej

accountName 

accountName: string

Wartość właściwości

string

dziedziczone z StorageClient.accountName

credential

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

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

dziedziczone z StorageClient.credential

url

Wartość zakodowanego ciągu adresu URL.

url: string

Wartość właściwości

string

dziedziczone z StorageClient.url

Szczegóły metody

fromConnectionString(string, StoragePipelineOptions)

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

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

Parametry

connectionString

string

Parametry połączenia konta lub parametry połączenia sygnatury dostępu współdzielonego konta usługi Azure Storage. [ Uwaga — parametry połączenia konta mogą być używane tylko w środowisku uruchomieniowym NODE.JS. ] Przykład parametrów połączenia konta — przykład parametrów połączenia sygnatury dostępu współdzielonego DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net — 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

Fakultatywny. Opcje konfigurowania potoku HTTP.

Zwraca

DataLakeServiceClient

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

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/en-us/rest/api/storageservices/create-account-sas

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

Parametry

expiresOn

Date

Fakultatywny. Czas, w którym sygnatura dostępu współdzielonego staje się nieprawidłowa. Wartość domyślna na godzinę później, jeśli nie zostanie określona.

permissions
AccountSASPermissions

Określa listę uprawnień do skojarzenia z sygnaturą dostępu współdzielonego.

resourceTypes

string

Określa typy zasobów skojarzone z sygnaturą dostępu współdzielonego.

options
ServiceGenerateAccountSasUrlOptions

Parametry opcjonalne.

Zwraca

string

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.

generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

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/en-us/rest/api/storageservices/create-account-sas

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

Parametry

expiresOn

Date

Fakultatywny. Czas, w którym sygnatura dostępu współdzielonego staje się nieprawidłowa. Wartość domyślna na godzinę później, jeśli nie zostanie określona.

permissions
AccountSASPermissions

Określa listę uprawnień do skojarzenia z sygnaturą dostępu współdzielonego.

resourceTypes

string

Określa typy zasobów skojarzone z sygnaturą dostępu współdzielonego.

options
ServiceGenerateAccountSasUrlOptions

Parametry opcjonalne.

Zwraca

string

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.

getFileSystemClient(string)

Tworzy obiekt DataLakeFileSystemClient.

function getFileSystemClient(fileSystemName: string): DataLakeFileSystemClient

Parametry

fileSystemName

string

Nazwa systemu plików.

Zwraca

DataLakeFileSystemClient

getProperties(ServiceGetPropertiesOptions)

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/en-us/rest/api/storageservices/get-blob-service-properties

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

Parametry

options
ServiceGetPropertiesOptions

Opcje operacji Pobierz właściwości usługi.

Zwraca

Promise<DataLakeServiceGetPropertiesResponse>

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

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

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.

Przykład

// 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/en-us/rest/api/storageservices/get-user-delegation-key

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

Parametry

startsOn

Date

Godzina rozpoczęcia sygnatury dostępu współdzielonego delegowania użytkownika. Musi należeć do 7 dni od bieżącego czasu.

expiresOn

Date

Godzina zakończenia sygnatury dostępu współdzielonego delegowania użytkownika. Musi należeć do 7 dni od bieżącego czasu.

options
ServiceGetUserDelegationKeyOptions

Zwraca

Promise<ServiceGetUserDelegationKeyResponse>

listFileSystems(ServiceListFileSystemsOptions)

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:

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

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

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

Przykład użycia stronicowania ze znacznikiem:

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

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

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

Parametry

options
ServiceListFileSystemsOptions

Zwraca

PagedAsyncIterableIterator<FileSystemItem, ServiceListFileSystemsSegmentResponse, PageSettings>

setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

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/en-us/rest/api/storageservices/set-blob-service-properties

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

Parametry

properties
DataLakeServiceProperties
options
ServiceSetPropertiesOptions

Opcje operacji Właściwości zestawu usług.

Zwraca

Promise<ServiceSetPropertiesResponse>

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

undeleteFileSystem(string, string, ServiceUndeleteFileSystemOptions)

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

deletedFileSystemName

string

Nazwa źródłowego systemu plików.

deleteFileSystemVersion

string

Nowa nazwa systemu plików.

options
ServiceUndeleteFileSystemOptions

Opcje konfigurowania operacji przywracania systemu plików.

Zwraca

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