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

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

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

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

См. раздел https://docs.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://docs.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://docs.microsoft.com/en-us/rest/api/storageservices/list-containers2
setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

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

См. раздел https://docs.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"". Вы можете добавить SAS с помощью AnonymousCredential, например "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"". Вы можете добавить SAS с помощью AnonymousCredential, например "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 среде выполнения. ] Пример строки подключения учетной записи —DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Пример строки подключения SAS: 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://docs.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

Указывает типы ресурсов, связанные с подписанным URL-адресом.

options
ServiceGenerateAccountSasUrlOptions

Дополнительные параметры.

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

string

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

getFileSystemClient(string)

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

function getFileSystemClient(fileSystemName: string): DataLakeFileSystemClient

Параметры

fileSystemName

string

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

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

DataLakeFileSystemClient

getProperties(ServiceGetPropertiesOptions)

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

См. раздел https://docs.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://docs.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://docs.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://docs.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 }>