Partilhar via


DataLakeFileSystemClient class

Um DataLakeFileSystemClient representa um URL para o sistema de ficheiros do Armazenamento do Azure que lhe permite manipular os respetivos diretórios e ficheiros.

Extends

StorageClient

Construtores

DataLakeFileSystemClient(string, Pipeline)

Cria uma instância de DataLakeFileSystemClient a partir do URL e do pipeline.

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

Cria uma instância de DataLakeFileSystemClient a partir do URL e da credencial.

Propriedades

name

Nome do sistema de ficheiros atual.

Propriedades Herdadas

accountName
credential

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

url

Valor da cadeia de URL codificado.

Métodos

create(FileSystemCreateOptions)

Cria um novo sistema de ficheiros na conta especificada. Se o sistema de ficheiros com o mesmo nome já existir, a operação falhará.

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

createIfNotExists(FileSystemCreateOptions)

Cria um novo sistema de ficheiros na conta especificada. Se o sistema de ficheiros com o mesmo nome já existir, não será alterado.

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

delete(FileSystemDeleteOptions)

Elimine o sistema de ficheiros atual.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container

deleteIfExists(FileSystemDeleteOptions)

Elimine o sistema de ficheiros atual, se existir.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container

exists(FileSystemExistsOptions)

Devolve true se o sistema de Ficheiros representado por este cliente existir; falso, caso contrário.

NOTA: utilize esta função com cuidado, uma vez que um sistema de ficheiros existente pode ser eliminado por outros clientes ou aplicações. Vice-versa novo sistema de ficheiros com o mesmo nome pode ser adicionado por outros clientes ou aplicações após a conclusão desta função.

generateSasUrl(FileSystemGenerateSasUrlOptions)

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

Gera um URI de Assinatura de Acesso Partilhado do Serviço (SAS) 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/constructing-a-service-sas

getAccessPolicy(FileSystemGetAccessPolicyOptions)

Obtém as permissões para o sistema de ficheiros especificado. As permissões indicam se os dados do sistema de ficheiros podem ser acedidos publicamente.

AVISO: a Data de JavaScript perderá potencialmente a precisão ao analisar startsOn e expira Em cadeias. Por exemplo, a nova Data("2018-12-31T03:44:23.8827891Z").toISOString() obterá "2018-12-31T03:44:23.882Z".

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl

getDataLakeLeaseClient(string)

Obtenha um DataLakeLeaseClient que gere as concessões no sistema de ficheiros.

getDirectoryClient(string)

Cria um objeto DataLakeDirectoryClient no sistema de ficheiros atual.

getFileClient(string)

Cria um objeto DataLakeFileClient no sistema de ficheiros atual.

getProperties(FileSystemGetPropertiesOptions)

Devolve todos os metadados definidos pelo utilizador e as propriedades do sistema para o sistema de ficheiros especificado.

AVISO: O metadata objeto devolvido na resposta terá as respetivas teclas em minúsculas, mesmo que tenham originalmente carateres em maiúsculas. Isto difere das chaves de metadados devolvidas pelo listFileSystems método dataLakeServiceClient com a opção includeMetadata , que irá manter a sua caixa original.

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

listDeletedPaths(ListDeletedPathsOptions)

Devolve um iterador iterável assíncrono para listar todos os caminhos (diretórios e ficheiros) no sistema de ficheiros especificado.

.byPage() devolve um iterador iterável assíncrono para listar os caminhos nas páginas.

Exemplo com for await sintaxe:

// Get the fileSystemClient before you run these snippets,
// Can be obtained from `serviceClient.getFileSystemClient("<your-filesystem-name>");`
let i = 1;
for await (const deletePath of fileSystemClient.listDeletedPaths()) {
  console.log(`Path ${i++}: ${deletePath.name}`);
}

Exemplo com iter.next():

let i = 1;
let iter = fileSystemClient.listDeletedPaths();
let deletedPathItem = await iter.next();
while (!deletedPathItem.done) {
  console.log(`Path ${i++}: ${deletedPathItem.value.name}`);
  pathItem = await iter.next();
}

Exemplo com byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of fileSystemClient.listDeletedPaths().byPage({ maxPageSize: 20 })) {
  for (const deletePath of response.pathItems) {
    console.log(`Path ${i++}: ${deletePath.name}`);
  }
}

Exemplo a utilizar a paginação com um marcador:

let i = 1;
let iterator = fileSystemClient.listDeletedPaths().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 path names
for (const path of response.pathItems) {
  console.log(`Path ${i++}: ${path.name}}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = fileSystemClient.listDeletedPaths().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 path names
for (const deletePath of response.deletedPathItems) {
  console.log(`Path ${i++}: ${deletePath.name}`);
}

Veja https://docs.microsoft.com/rest/api/storageservices/list-blobs

listPaths(ListPathsOptions)

Devolve um iterador iterável assíncrono para listar todos os caminhos (diretórios e ficheiros) no sistema de ficheiros especificado.

.byPage() devolve um iterador iterável assíncrono para listar os caminhos nas páginas.

Exemplo com for await sintaxe:

// Get the fileSystemClient before you run these snippets,
// Can be obtained from `serviceClient.getFileSystemClient("<your-filesystem-name>");`
let i = 1;
for await (const path of fileSystemClient.listPaths()) {
  console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}

Exemplo com iter.next():

let i = 1;
let iter = fileSystemClient.listPaths();
let pathItem = await iter.next();
while (!pathItem.done) {
  console.log(`Path ${i++}: ${pathItem.value.name}, isDirectory?: ${pathItem.value.isDirectory}`);
  pathItem = await iter.next();
}

Exemplo com byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of fileSystemClient.listPaths().byPage({ maxPageSize: 20 })) {
  for (const path of response.pathItems) {
    console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
  }
}

Exemplo a utilizar a paginação com um marcador:

let i = 1;
let iterator = fileSystemClient.listPaths().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 path names
for (const path of response.pathItems) {
  console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = fileSystemClient.listPaths().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 path names
for (const path of response.pathItems) {
  console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}

Veja https://docs.microsoft.com/rest/api/storageservices/list-blobs

setAccessPolicy(PublicAccessType, SignedIdentifier<AccessPolicy>[], FileSystemSetAccessPolicyOptions)

Define as permissões para o sistema de ficheiros especificado. As permissões indicam se os diretórios ou ficheiros num sistema de ficheiros podem ser acedidos publicamente.

Quando define permissões para um sistema de ficheiros, as permissões existentes são substituídas. Se não for fornecido qualquer acesso ou containerAcl, a ACL do sistema de ficheiros existente será removida.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl

setMetadata(Metadata, FileSystemSetMetadataOptions)

Define um ou mais pares nome-valor definidos pelo utilizador para o sistema de ficheiros especificado.

Se não for fornecida nenhuma opção ou se não forem definidos metadados no parâmetro, os metadados do sistema de ficheiros serão removidos.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata

undeletePath(string, string, FileSystemUndeletePathOption)

Restaura um caminho eliminado de forma recuperável.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob

Detalhes do Construtor

DataLakeFileSystemClient(string, Pipeline)

Cria uma instância de DataLakeFileSystemClient a partir do URL e do pipeline.

new DataLakeFileSystemClient(url: string, pipeline: Pipeline)

Parâmetros

url

string

Uma Cadeia de cliente a apontar para o sistema de ficheiros data lake do Armazenamento do Microsoft Azure, como "https://myaccount.dfs.core.windows.net/filesystem". Pode acrescentar uma SAS se utilizar AnonymousCredential, como "https://myaccount.dfs.core.windows.net/filesystem?sasString".

pipeline
Pipeline

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

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

Cria uma instância de DataLakeFileSystemClient a partir do URL e da credencial.

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

Parâmetros

url

string

Uma Cadeia de cliente a apontar para o sistema de ficheiros data lake do Armazenamento do Microsoft Azure, como "https://myaccount.dfs.core.windows.net/filesystem". Pode acrescentar uma SAS se utilizar AnonymousCredential, como "https://myaccount.dfs.core.windows.net/filesystem?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Tal como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do @azure/identity pacote para autenticar pedidos para o 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 de Propriedade

name

Nome do sistema de ficheiros atual.

string name

Valor de Propriedade

string

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 para o 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

Herdado de StorageClient.credential

url

Valor da cadeia de URL codificado.

url: string

Valor de Propriedade

string

Herdado de StorageClient.url

Detalhes de Método

create(FileSystemCreateOptions)

Cria um novo sistema de ficheiros na conta especificada. Se o sistema de ficheiros com o mesmo nome já existir, a operação falhará.

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

function create(options?: FileSystemCreateOptions): Promise<FileSystemCreateResponse>

Parâmetros

options
FileSystemCreateOptions

Opcional. Opções ao criar o sistema de ficheiros.

Devoluções

createIfNotExists(FileSystemCreateOptions)

Cria um novo sistema de ficheiros na conta especificada. Se o sistema de ficheiros com o mesmo nome já existir, não será alterado.

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

function createIfNotExists(options?: FileSystemCreateOptions): Promise<FileSystemCreateIfNotExistsResponse>

Parâmetros

Devoluções

delete(FileSystemDeleteOptions)

Elimine o sistema de ficheiros atual.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container

function delete(options?: FileSystemDeleteOptions): Promise<FileSystemDeleteResponse>

Parâmetros

options
FileSystemDeleteOptions

Opcional. Opções ao eliminar o sistema de ficheiros.

Devoluções

deleteIfExists(FileSystemDeleteOptions)

Elimine o sistema de ficheiros atual, se existir.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container

function deleteIfExists(options?: FileSystemDeleteOptions): Promise<FileSystemDeleteIfExistsResponse>

Parâmetros

Devoluções

exists(FileSystemExistsOptions)

Devolve true se o sistema de Ficheiros representado por este cliente existir; falso, caso contrário.

NOTA: utilize esta função com cuidado, uma vez que um sistema de ficheiros existente pode ser eliminado por outros clientes ou aplicações. Vice-versa novo sistema de ficheiros com o mesmo nome pode ser adicionado por outros clientes ou aplicações após a conclusão desta função.

function exists(options?: FileSystemExistsOptions): Promise<boolean>

Parâmetros

Devoluções

Promise<boolean>

generateSasUrl(FileSystemGenerateSasUrlOptions)

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

Gera um URI de Assinatura de Acesso Partilhado do Serviço (SAS) 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/constructing-a-service-sas

function generateSasUrl(options: FileSystemGenerateSasUrlOptions): Promise<string>

Parâmetros

options
FileSystemGenerateSasUrlOptions

Parâmetros opcionais.

Devoluções

Promise<string>

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

getAccessPolicy(FileSystemGetAccessPolicyOptions)

Obtém as permissões para o sistema de ficheiros especificado. As permissões indicam se os dados do sistema de ficheiros podem ser acedidos publicamente.

AVISO: a Data de JavaScript perderá potencialmente a precisão ao analisar startsOn e expira Em cadeias. Por exemplo, a nova Data("2018-12-31T03:44:23.8827891Z").toISOString() obterá "2018-12-31T03:44:23.882Z".

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl

function getAccessPolicy(options?: FileSystemGetAccessPolicyOptions): Promise<FileSystemGetAccessPolicyResponse>

Parâmetros

options
FileSystemGetAccessPolicyOptions

Opcional. Opções ao obter a política de acesso ao sistema de ficheiros.

Devoluções

getDataLakeLeaseClient(string)

Obtenha um DataLakeLeaseClient que gere as concessões no sistema de ficheiros.

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parâmetros

proposeLeaseId

string

Opcional. ID de concessão proposta inicial.

Devoluções

getDirectoryClient(string)

Cria um objeto DataLakeDirectoryClient no sistema de ficheiros atual.

function getDirectoryClient(directoryName: string): DataLakeDirectoryClient

Parâmetros

directoryName

string

Devoluções

getFileClient(string)

Cria um objeto DataLakeFileClient no sistema de ficheiros atual.

function getFileClient(fileName: string): DataLakeFileClient

Parâmetros

fileName

string

Devoluções

getProperties(FileSystemGetPropertiesOptions)

Devolve todos os metadados definidos pelo utilizador e as propriedades do sistema para o sistema de ficheiros especificado.

AVISO: O metadata objeto devolvido na resposta terá as respetivas teclas em minúsculas, mesmo que tenham originalmente carateres em maiúsculas. Isto difere das chaves de metadados devolvidas pelo listFileSystems método dataLakeServiceClient com a opção includeMetadata , que irá manter a sua caixa original.

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

function getProperties(options?: FileSystemGetPropertiesOptions): Promise<FileSystemGetPropertiesResponse>

Parâmetros

options
FileSystemGetPropertiesOptions

Opcional. Opções ao obter propriedades do sistema de ficheiros.

Devoluções

listDeletedPaths(ListDeletedPathsOptions)

Devolve um iterador iterável assíncrono para listar todos os caminhos (diretórios e ficheiros) no sistema de ficheiros especificado.

.byPage() devolve um iterador iterável assíncrono para listar os caminhos nas páginas.

Exemplo com for await sintaxe:

// Get the fileSystemClient before you run these snippets,
// Can be obtained from `serviceClient.getFileSystemClient("<your-filesystem-name>");`
let i = 1;
for await (const deletePath of fileSystemClient.listDeletedPaths()) {
  console.log(`Path ${i++}: ${deletePath.name}`);
}

Exemplo com iter.next():

let i = 1;
let iter = fileSystemClient.listDeletedPaths();
let deletedPathItem = await iter.next();
while (!deletedPathItem.done) {
  console.log(`Path ${i++}: ${deletedPathItem.value.name}`);
  pathItem = await iter.next();
}

Exemplo com byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of fileSystemClient.listDeletedPaths().byPage({ maxPageSize: 20 })) {
  for (const deletePath of response.pathItems) {
    console.log(`Path ${i++}: ${deletePath.name}`);
  }
}

Exemplo a utilizar a paginação com um marcador:

let i = 1;
let iterator = fileSystemClient.listDeletedPaths().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 path names
for (const path of response.pathItems) {
  console.log(`Path ${i++}: ${path.name}}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = fileSystemClient.listDeletedPaths().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 path names
for (const deletePath of response.deletedPathItems) {
  console.log(`Path ${i++}: ${deletePath.name}`);
}

Veja https://docs.microsoft.com/rest/api/storageservices/list-blobs

function listDeletedPaths(options?: ListDeletedPathsOptions): PagedAsyncIterableIterator<DeletedPath, FileSystemListDeletedPathsResponse, PageSettings>

Parâmetros

options
ListDeletedPathsOptions

Opcional. Opções ao listar caminhos eliminados.

Devoluções

listPaths(ListPathsOptions)

Devolve um iterador iterável assíncrono para listar todos os caminhos (diretórios e ficheiros) no sistema de ficheiros especificado.

.byPage() devolve um iterador iterável assíncrono para listar os caminhos nas páginas.

Exemplo com for await sintaxe:

// Get the fileSystemClient before you run these snippets,
// Can be obtained from `serviceClient.getFileSystemClient("<your-filesystem-name>");`
let i = 1;
for await (const path of fileSystemClient.listPaths()) {
  console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}

Exemplo com iter.next():

let i = 1;
let iter = fileSystemClient.listPaths();
let pathItem = await iter.next();
while (!pathItem.done) {
  console.log(`Path ${i++}: ${pathItem.value.name}, isDirectory?: ${pathItem.value.isDirectory}`);
  pathItem = await iter.next();
}

Exemplo com byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of fileSystemClient.listPaths().byPage({ maxPageSize: 20 })) {
  for (const path of response.pathItems) {
    console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
  }
}

Exemplo a utilizar a paginação com um marcador:

let i = 1;
let iterator = fileSystemClient.listPaths().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 path names
for (const path of response.pathItems) {
  console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = fileSystemClient.listPaths().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 path names
for (const path of response.pathItems) {
  console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}

Veja https://docs.microsoft.com/rest/api/storageservices/list-blobs

function listPaths(options?: ListPathsOptions): PagedAsyncIterableIterator<Path, FileSystemListPathsResponse, PageSettings>

Parâmetros

options
ListPathsOptions

Opcional. Opções ao listar caminhos.

Devoluções

setAccessPolicy(PublicAccessType, SignedIdentifier<AccessPolicy>[], FileSystemSetAccessPolicyOptions)

Define as permissões para o sistema de ficheiros especificado. As permissões indicam se os diretórios ou ficheiros num sistema de ficheiros podem ser acedidos publicamente.

Quando define permissões para um sistema de ficheiros, as permissões existentes são substituídas. Se não for fornecido qualquer acesso ou containerAcl, a ACL do sistema de ficheiros existente será removida.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl

function setAccessPolicy(access?: PublicAccessType, fileSystemAcl?: SignedIdentifier<AccessPolicy>[], options?: FileSystemSetAccessPolicyOptions): Promise<FileSystemSetAccessPolicyResponse>

Parâmetros

access
PublicAccessType

Opcional. O nível de acesso público aos dados no sistema de ficheiros.

fileSystemAcl

SignedIdentifier<AccessPolicy>[]

Opcional. Matriz de elementos com um ID exclusivo e detalhes da política de acesso.

options
FileSystemSetAccessPolicyOptions

Opcional. Opções ao definir a política de acesso ao sistema de ficheiros.

Devoluções

setMetadata(Metadata, FileSystemSetMetadataOptions)

Define um ou mais pares nome-valor definidos pelo utilizador para o sistema de ficheiros especificado.

Se não for fornecida nenhuma opção ou se não forem definidos metadados no parâmetro, os metadados do sistema de ficheiros serão removidos.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata

function setMetadata(metadata?: Metadata, options?: FileSystemSetMetadataOptions): Promise<FileSystemSetMetadataResponse>

Parâmetros

metadata
Metadata

Substitua os metadados existentes por este valor. Se não for fornecido nenhum valor, os metadados existentes serão removidos.

options
FileSystemSetMetadataOptions

Opcional. Opções ao definir metadados do sistema de ficheiros.

Devoluções

undeletePath(string, string, FileSystemUndeletePathOption)

Restaura um caminho eliminado de forma recuperável.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob

function undeletePath(deletedPath: string, deletionId: string, options?: FileSystemUndeletePathOption): Promise<FileSystemUndeletePathResponse>

Parâmetros

deletedPath

string

Obrigatório. O caminho do caminho eliminado.

deletionId

string

Obrigatório. O ID de eliminação associado ao caminho eliminado de forma recuperável.

Devoluções