Поделиться через

DataLakeServiceClient class

  • Ссылка
Пакет:
@azure/storage-file-datalake

DataLakeServiceClient позволяет управлять ресурсами и файловыми системами службы Azure Data Lake. Учетная запись хранения предоставляет пространство имен верхнего уровня для службы Data Lake.

Extends

StorageClient

Конструкторы

DataLakeServiceClient(string, Pipeline)

Создает экземпляр DataLakeServiceClient из URL-адреса и конвейера.
DataLakeServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Создает экземпляр DataLakeServiceClient из URL-адреса.

Унаследованные свойства

accountName
credential

Например, AnonymousCredential, StorageSharedKeyCredential или любые учетные данные из пакета @azure/identity для проверки подлинности запросов к службе. Можно также предоставить объект, реализующий интерфейс TokenCredential. Если не указано, используется AnonymousCredential.
url

Закодированное строковое значение URL-адреса.

Методы

fromConnectionString(string, StoragePipelineOptions)

Создает экземпляр DataLakeServiceClient из строки подключения.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Доступно только для DataLakeServiceClient, созданного с использованием учетных данных общего ключа.

Создает URI подписанного URL-адреса учетной записи (SAS) на основе свойств клиента и параметров, переданных в. SAS подписан учетными данными общего ключа клиента.

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

Доступно только для DataLakeServiceClient, созданного с использованием учетных данных общего ключа.

Создает строку для входа для подписанного URL-адреса учетной записи (SAS) на основе свойств клиента и параметров, переданных в. SAS подписан учетными данными общего ключа клиента.

См. https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas
getFileSystemClient(string)

Создает объект DataLakeFileSystemClient.
getProperties(ServiceGetPropertiesOptions)

Возвращает свойства конечной точки службы BLOB-объектов учетной записи хранения, включая свойства для правил аналитики хранилища и CORS (совместного использования ресурсов между источниками).

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

ДОСТУПНО ТОЛЬКО ПРИ ИСПОЛЬЗОВАНИИ ПРОВЕРКИ ПОДЛИННОСТИ МАРКЕРА НОСИТЕЛЯ (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
listFileSystems(ServiceListFileSystemsOptions)

Возвращает асинхронный итератор для перечисления всех файловых систем в указанной учетной записи.

.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
setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

Задает свойства для конечной точки службы BLOB-объектов учетной записи хранения, включая свойства для аналитики хранилища, правил CORS (совместного использования ресурсов между источниками) и параметров обратимого удаления.

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

Восстановите ранее удаленную файловую систему. Этот API работает только в том случае, если для учетной записи хранения включен обратимое удаление контейнера.

Сведения о конструкторе

DataLakeServiceClient(string, Pipeline)

Создает экземпляр DataLakeServiceClient из URL-адреса и конвейера.

new DataLakeServiceClient(url: string, pipeline: Pipeline)

Параметры

url

string

Строка клиента, указывающая на службу озера данных службы хранилища Azure, например "https://myaccount.dfs.core.windows.net". При использовании AnonymousCredential можно добавить SAS, например "https://myaccount.dfs.core.windows.net?sasString".

pipeline
Pipeline

Вызовите newPipeline() для создания конвейера по умолчанию или предоставления настраиваемого конвейера.

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

Создает экземпляр DataLakeServiceClient из URL-адреса.

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

Параметры

url

string

Строка клиента, указывающая на службу озера данных службы хранилища Azure, например "https://myaccount.dfs.core.windows.net". При использовании AnonymousCredential можно добавить SAS, например "https://myaccount.dfs.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Например, AnonymousCredential, StorageSharedKeyCredential или любые учетные данные из пакета @azure/identity для проверки подлинности запросов к службе. Можно также предоставить объект, реализующий интерфейс TokenCredential. Если не указано, используется AnonymousCredential.

options
StoragePipelineOptions

Необязательный. Параметры настройки конвейера HTTP.

Сведения об унаследованном свойстве

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

Сведения о методе

fromConnectionString(string, StoragePipelineOptions)

Создает экземпляр DataLakeServiceClient из строки подключения.

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

Параметры

connectionString

string

Строка подключения учетной записи или строка подключения SAS учетной записи хранения Azure. [ Примечание. Строка подключения учетной записи может использоваться только в среде выполнения NODE.JS. ] Пример строки подключения учетной записи — пример строки подключения SAS 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

Необязательный. Параметры настройки конвейера HTTP.

Возвращаемое значение

DataLakeServiceClient

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Доступно только для DataLakeServiceClient, созданного с использованием учетных данных общего ключа.

Создает URI подписанного URL-адреса учетной записи (SAS) на основе свойств клиента и параметров, переданных в. SAS подписан учетными данными общего ключа клиента.

См. https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas

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

Параметры

expiresOn

Date

Необязательный. Время, в течение которого подписанный URL-адрес становится недействительным. Значение по умолчанию — час спустя, если не указано.

permissions
AccountSASPermissions

Указывает список разрешений, связанных с SAS.

resourceTypes

string

Указывает типы ресурсов, связанные с сигнатурой общего доступа.

options
ServiceGenerateAccountSasUrlOptions

Необязательные параметры.

Возвращаемое значение

string

URI SAS учетной записи, состоящий из URI ресурса, представленного этим клиентом, за которым следует созданный маркер SAS.

generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Доступно только для DataLakeServiceClient, созданного с использованием учетных данных общего ключа.

Создает строку для входа для подписанного URL-адреса учетной записи (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

Параметры

expiresOn

Date

Необязательный. Время, в течение которого подписанный URL-адрес становится недействительным. Значение по умолчанию — час спустя, если не указано.

permissions
AccountSASPermissions

Указывает список разрешений, связанных с SAS.

resourceTypes

string

Указывает типы ресурсов, связанные с сигнатурой общего доступа.

options
ServiceGenerateAccountSasUrlOptions

Необязательные параметры.

Возвращаемое значение

string

URI SAS учетной записи, состоящий из URI ресурса, представленного этим клиентом, за которым следует созданный маркер SAS.

getFileSystemClient(string)

Создает объект DataLakeFileSystemClient.

function getFileSystemClient(fileSystemName: string): DataLakeFileSystemClient

Параметры

fileSystemName

string

Имя файловой системы.

Возвращаемое значение

DataLakeFileSystemClient

getProperties(ServiceGetPropertiesOptions)

Возвращает свойства конечной точки службы BLOB-объектов учетной записи хранения, включая свойства для правил аналитики хранилища и CORS (совместного использования ресурсов между источниками).

См. https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties

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

Параметры

options
ServiceGetPropertiesOptions

Параметры операции получения свойств службы.

Возвращаемое значение

Promise<DataLakeServiceGetPropertiesResponse>

Ответные данные для операции получения свойств службы.

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

ДОСТУПНО ТОЛЬКО ПРИ ИСПОЛЬЗОВАНИИ ПРОВЕРКИ ПОДЛИННОСТИ МАРКЕРА НОСИТЕЛЯ (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>

Параметры

startsOn

Date

Время начала для SAS делегирования пользователей. Должно быть в течение 7 дней текущего времени.

expiresOn

Date

Время окончания SAS делегирования пользователей. Должно быть в течение 7 дней текущего времени.

options
ServiceGetUserDelegationKeyOptions

Возвращаемое значение

Promise<ServiceGetUserDelegationKeyResponse>

listFileSystems(ServiceListFileSystemsOptions)

Возвращает асинхронный итератор для перечисления всех файловых систем в указанной учетной записи.

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

Параметры

options
ServiceListFileSystemsOptions

Возвращаемое значение

PagedAsyncIterableIterator<FileSystemItem, ServiceListFileSystemsSegmentResponse, PageSettings>

setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

Задает свойства для конечной точки службы BLOB-объектов учетной записи хранения, включая свойства для аналитики хранилища, правил CORS (совместного использования ресурсов между источниками) и параметров обратимого удаления.

См. https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties

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

Параметры

properties
DataLakeServiceProperties
options
ServiceSetPropertiesOptions

Параметры операции "Свойства набора служб".

Возвращаемое значение

Promise<ServiceSetPropertiesResponse>

Ответные данные для операции "Свойства набора служб".

undeleteFileSystem(string, string, ServiceUndeleteFileSystemOptions)

Восстановите ранее удаленную файловую систему. Этот API работает только в том случае, если для учетной записи хранения включен обратимое удаление контейнера.

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

Параметры

deletedFileSystemName

string

Имя исходной файловой системы.

deleteFileSystemVersion

string

Новое имя файловой системы.

options
ServiceUndeleteFileSystemOptions

Параметры настройки операции восстановления файловой системы.

Возвращаемое значение

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