Partilhar via

DataLakeServiceClient class

  • Referência
Pacote:
@azure/storage-file-datalake

O DataLakeServiceClient permite-lhe manipular recursos de serviço e sistemas de ficheiros do Azure Data Lake. A conta de armazenamento fornece o espaço de nomes de nível superior para o serviço Data Lake.

Extends

StorageClient

Construtores

DataLakeServiceClient(string, Pipeline)

Cria uma instância de DataLakeServiceClient a partir de url e pipeline.
DataLakeServiceClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Cria uma instância de DataLakeServiceClient a partir do URL.

Propriedades Herdadas

accountName
credential

Tal como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do @azure/identity pacote para autenticar pedidos no serviço. Também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, é utilizado AnonymousCredential.
url

Valor de cadeia de URL codificado.

Métodos

fromConnectionString(string, StoragePipelineOptions)

Cria uma instância de DataLakeServiceClient a partir da cadeia de ligação.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponível apenas para DataLakeServiceClient construído com uma credencial de chave partilhada.

Gera um URI de Assinatura de Acesso Partilhado (SAS) de conta com base nas propriedades e parâmetros do cliente transmitidos. A SAS é assinada pela credencial de chave partilhada do cliente.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas
getFileSystemClient(string)

Cria um objeto DataLakeFileSystemClient .
getProperties(ServiceGetPropertiesOptions)

Obtém as propriedades do ponto final de serviço blob de uma conta de armazenamento, incluindo propriedades para regras de Análise de Armazenamento e CORS (Partilha de Recursos Entre Origens).

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

APENAS DISPONÍVEL AO UTILIZAR A AUTENTICAÇÃO DO TOKEN DO PORTADOR (TokenCredential).

Obtém uma chave de delegação de utilizador para o serviço Data Lake. Esta é apenas uma operação válida ao utilizar a autenticação de tokens de portador.

Exemplo

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

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key
listFileSystems(ServiceListFileSystemsOptions)

Devolve um iterador iterável assíncrono para listar todos os sistemas de ficheiros na conta especificada.

.byPage() devolve um iterador iterável assíncrono para listar os sistemas de ficheiros em páginas.

Exemplo com for await sintaxe:

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

Exemplo com 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();
}

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

Exemplo com a paginação com um marcador:

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

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

Define propriedades para o ponto final de serviço blob de uma conta de armazenamento, incluindo propriedades para Análise de Armazenamento, regras CORS (Partilha de Recursos de Várias Origens) e definições de eliminação recuperável.

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

Restaure um Sistema de Ficheiros eliminado anteriormente. Esta API só funciona se a Eliminação Recuperável de Contentores estiver ativada para a conta de armazenamento.

Detalhes do Construtor

DataLakeServiceClient(string, Pipeline)

Cria uma instância de DataLakeServiceClient a partir de url e pipeline.

new DataLakeServiceClient(url: string, pipeline: Pipeline)

Parâmetros

url

string

Uma cadeia de cliente que aponta para o serviço data lake do Armazenamento do Azure, como "https://myaccount.dfs.core.windows.net". Pode acrescentar uma SAS se utilizar AnonymousCredential, como "https://myaccount.dfs.core.windows.net?sasString".

pipeline
Pipeline

Chame newPipeline() para criar um pipeline predefinido ou forneça um pipeline personalizado.

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

Cria uma instância de DataLakeServiceClient a partir do URL.

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

Parâmetros

url

string

Uma cadeia de cliente que aponta para o serviço data lake do Armazenamento do Azure, como "https://myaccount.dfs.core.windows.net". Pode acrescentar uma SAS se utilizar AnonymousCredential, como "https://myaccount.dfs.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Tal como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do @azure/identity pacote para autenticar pedidos no serviço. Também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, é utilizado AnonymousCredential.

options
StoragePipelineOptions

Opcional. Opções para configurar o pipeline HTTP.

Detalhes da Propriedade Herdada

accountName 

accountName: string

Valor de Propriedade

string

Herdado de StorageClient.accountName

credential

Tal como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do @azure/identity pacote para autenticar pedidos no serviço. Também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, é utilizado AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valor de Propriedade

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Herdado de StorageClient.credential

url

Valor de cadeia de URL codificado.

url: string

Valor de Propriedade

string

Herdado de StorageClient.url

Detalhes de Método

fromConnectionString(string, StoragePipelineOptions)

Cria uma instância de DataLakeServiceClient a partir da cadeia de ligação.

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

Parâmetros

connectionString

string

Cadeia de ligação de conta ou uma cadeia de ligação SAS de uma conta de armazenamento do Azure. [ Nota - A cadeia de ligação de conta só pode ser utilizada no NODE.JS runtime. ] Exemplo de cadeia de ligação de conta -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Exemplo de cadeia de ligação 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

Opcional. Opções para configurar o pipeline HTTP.

Devoluções

DataLakeServiceClient

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Disponível apenas para DataLakeServiceClient construído com uma credencial de chave partilhada.

Gera um URI de Assinatura de Acesso Partilhado (SAS) de conta com base nas propriedades e parâmetros do cliente transmitidos. A SAS é assinada pela credencial de chave partilhada do cliente.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas

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

Parâmetros

expiresOn

Date

Opcional. O momento em que a assinatura de acesso partilhado se torna inválida. Predefinição para uma hora mais tarde, se não for especificado.

permissions
AccountSASPermissions

Especifica a lista de permissões a associar à SAS.

resourceTypes

string

Especifica os tipos de recursos associados à assinatura de acesso partilhado.

options
ServiceGenerateAccountSasUrlOptions

Parâmetros opcionais.

Devoluções

string

Um URI de SAS de conta que consiste no URI para o recurso representado por este cliente, seguido do token de SAS gerado.

getFileSystemClient(string)

Cria um objeto DataLakeFileSystemClient .

function getFileSystemClient(fileSystemName: string): DataLakeFileSystemClient

Parâmetros

fileSystemName

string

Nome do sistema de ficheiros.

Devoluções

DataLakeFileSystemClient

getProperties(ServiceGetPropertiesOptions)

Obtém as propriedades do ponto final de serviço blob de uma conta de armazenamento, incluindo propriedades para regras de Análise de Armazenamento e CORS (Partilha de Recursos Entre Origens).

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties

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

Parâmetros

options
ServiceGetPropertiesOptions

Opções para a operação Obter Propriedades do Serviço.

Devoluções

Promise<DataLakeServiceGetPropertiesResponse>

Dados de resposta para a operação Obter Propriedades do Serviço.

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

APENAS DISPONÍVEL AO UTILIZAR A AUTENTICAÇÃO DO TOKEN DO PORTADOR (TokenCredential).

Obtém uma chave de delegação de utilizador para o serviço Data Lake. Esta é apenas uma operação válida ao utilizar a autenticação de tokens de portador.

Exemplo

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

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key

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

Parâmetros

startsOn

Date

A hora de início da SAS de delegação de utilizador. Tem de estar dentro de 7 dias a contar da hora atual.

expiresOn

Date

A hora de fim da SAS de delegação de utilizador. Tem de estar dentro de 7 dias a contar da hora atual.

options
ServiceGetUserDelegationKeyOptions

Devoluções

Promise<ServiceGetUserDelegationKeyResponse>

listFileSystems(ServiceListFileSystemsOptions)

Devolve um iterador iterável assíncrono para listar todos os sistemas de ficheiros na conta especificada.

.byPage() devolve um iterador iterável assíncrono para listar os sistemas de ficheiros em páginas.

Exemplo com for await sintaxe:

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

Exemplo com 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();
}

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

Exemplo com a paginação com um marcador:

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

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/list-containers2

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

Parâmetros

options
ServiceListFileSystemsOptions

Devoluções

PagedAsyncIterableIterator<FileSystemItem, ServiceListFileSystemsSegmentResponse, PageSettings>

setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

Define propriedades para o ponto final de serviço blob de uma conta de armazenamento, incluindo propriedades para Análise de Armazenamento, regras CORS (Partilha de Recursos de Várias Origens) e definições de eliminação recuperável.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties

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

Parâmetros

properties
DataLakeServiceProperties
options
ServiceSetPropertiesOptions

Opções para a operação Propriedades do Conjunto de Serviços.

Devoluções

Promise<ServiceSetPropertiesResponse>

Dados de resposta para a operação Propriedades do Conjunto de Serviços.

undeleteFileSystem(string, string, ServiceUndeleteFileSystemOptions)

Restaure um Sistema de Ficheiros eliminado anteriormente. Esta API só funciona se a Eliminação Recuperável de Contentores estiver ativada para a conta de armazenamento.

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

Parâmetros

deletedFileSystemName

string

O nome do Sistema de Ficheiros de origem.

deleteFileSystemVersion

string

O novo nome do Sistema de Ficheiros.

options
ServiceUndeleteFileSystemOptions

Opções para configurar a operação de Restauro do Sistema de Ficheiros.

Devoluções

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