Compartilhar via

DataLakeFileSystemClient class

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

Um DataLakeFileSystemClient representa uma URL para o sistema de arquivos do Armazenamento do Azure, permitindo que você manipule seus diretórios e arquivos.

Extends

StorageClient

Construtores

DataLakeFileSystemClient(string, Pipeline)

Cria uma instância de DataLakeFileSystemClient a partir da URL e do pipeline.
DataLakeFileSystemClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Cria uma instância de DataLakeFileSystemClient com base na URL e na credencial.

Propriedades

name

Nome do sistema de arquivos atual.

Propriedades herdadas

accountName
credential

Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do pacote @azure/identity para autenticar solicitações para o serviço. Você também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, AnonymousCredential será usado.
url

Valor da cadeia de caracteres de URL codificada.

Métodos

create(FileSystemCreateOptions)

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

Confira https://docs.microsoft.com/en-us/rest/api/storageservices/create-container
createIfNotExists(FileSystemCreateOptions)

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

Confira https://docs.microsoft.com/en-us/rest/api/storageservices/create-container
delete(FileSystemDeleteOptions)

Exclua o sistema de arquivos atual.

Confira https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container
deleteIfExists(FileSystemDeleteOptions)

Exclua o sistema de arquivos atual se ele existir.

Confira https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container
exists(FileSystemExistsOptions)

Retornará true se o sistema de arquivos representado por esse cliente existir; false caso contrário.

OBSERVAÇÃO: use essa função com cuidado, pois um sistema de arquivos existente pode ser excluído por outros clientes ou aplicativos. Vice-versa novo sistema de arquivos com o mesmo nome pode ser adicionado por outros clientes ou aplicativos após a conclusão dessa função.
generateSasStringToSign(FileSystemGenerateSasUrlOptions)

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

Gera uma cadeia de caracteres para assinar um URI de SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela credencial de chave compartilhada do cliente.

Confira https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(FileSystemGenerateSasUrlOptions)

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

Gera um URI de SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela credencial de chave compartilhada do cliente.

Confira https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasStringToSign(FileSystemGenerateSasUrlOptions, UserDelegationKey)

Gera uma cadeia de caracteres para assinar um URI de SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela chave de delegação do usuário de entrada.

Confira https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(FileSystemGenerateSasUrlOptions, UserDelegationKey)

Gera um URI de SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela chave de delegação do usuário de entrada.

Confira https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAccessPolicy(FileSystemGetAccessPolicyOptions)

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

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

Confira https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl
getDataLakeLeaseClient(string)

Obtenha um DataLakeLeaseClient que gerencia as concessões no sistema de arquivos.
getDirectoryClient(string)

Cria um objeto DataLakeDirectoryClient no sistema de arquivos atual.
getFileClient(string)

Cria um objeto DataLakeFileClient no sistema de arquivos atual.
getProperties(FileSystemGetPropertiesOptions)

Retorna todos os metadados definidos pelo usuário e as propriedades do sistema de arquivos para o sistema de arquivos especificado.

AVISO: O objeto metadata retornado na resposta terá suas chaves em letras minúsculas, mesmo que originalmente contivessem caracteres maiúsculos. Isso difere das chaves de metadados retornadas pelo método listFileSystems de DataLakeServiceClient usando a opção includeMetadata, que manterá sua caixa original.

Confira https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties
listDeletedPaths(ListDeletedPathsOptions)

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

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

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

Confira https://docs.microsoft.com/rest/api/storageservices/list-blobs
listPaths(ListPathsOptions)

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

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

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

Confira https://docs.microsoft.com/rest/api/storageservices/list-blobs
setAccessPolicy(PublicAccessType, SignedIdentifier<AccessPolicy>[], FileSystemSetAccessPolicyOptions)

Define as permissões para o sistema de arquivos especificado. As permissões indicam se os diretórios ou arquivos em um sistema de arquivos podem ser acessados publicamente.

Quando você define permissões para um sistema de arquivos, as permissões existentes são substituídas. Se nenhum acesso ou contêinerAcl for fornecido, a ACL do sistema de arquivos existente será removida.

Confira https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl
setMetadata(Metadata, FileSystemSetMetadataOptions)

Define um ou mais pares nome-valor definidos pelo usuário para o sistema de arquivos especificado.

Se nenhuma opção for fornecida ou nenhum metadado definido no parâmetro, os metadados do sistema de arquivos serão removidos.

Confira https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata
undeletePath(string, string, FileSystemUndeletePathOption)

Restaura um caminho com exclusão reversível.

Confira 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 da URL e do pipeline.

new DataLakeFileSystemClient(url: string, pipeline: Pipeline)

Parâmetros

url

string

Uma cadeia de caracteres do cliente apontando para o sistema de arquivos data lake do Armazenamento do Azure, como "https://myaccount.dfs.core.windows.net/filesystem". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.dfs.core.windows.net/filesystem?sasString".

pipeline
Pipeline

Chame newPipeline() para criar um pipeline padrão ou forneça um pipeline personalizado.

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

Cria uma instância de DataLakeFileSystemClient com base na URL e na credencial.

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

Parâmetros

url

string

Uma cadeia de caracteres do cliente apontando para o sistema de arquivos data lake do Armazenamento do Azure, como "https://myaccount.dfs.core.windows.net/filesystem". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.dfs.core.windows.net/filesystem?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do pacote @azure/identity para autenticar solicitações para o serviço. Você também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, AnonymousCredential será usado.

options
StoragePipelineOptions

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

Detalhes da propriedade

name

Nome do sistema de arquivos atual.

string name

Valor da propriedade

string

Detalhes das propriedades herdadas

accountName 

accountName: string

Valor da propriedade

string

herdado de StorageClient.accountName

credential

Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do pacote @azure/identity para autenticar solicitações para o serviço. Você também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, AnonymousCredential será usado.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valor da propriedade

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

herdado de StorageClient.credential

url

Valor da cadeia de caracteres de URL codificada.

url: string

Valor da propriedade

string

herdado de StorageClient.url

Detalhes do método

create(FileSystemCreateOptions)

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

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

Retornos

Promise<FileSystemCreateResponse>

createIfNotExists(FileSystemCreateOptions)

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

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

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

Parâmetros

options
FileSystemCreateOptions

Retornos

Promise<FileSystemCreateIfNotExistsResponse>

delete(FileSystemDeleteOptions)

Exclua o sistema de arquivos atual.

Confira 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 excluir o sistema de arquivos.

Retornos

Promise<FileSystemDeleteResponse>

deleteIfExists(FileSystemDeleteOptions)

Exclua o sistema de arquivos atual se ele existir.

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

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

Parâmetros

options
FileSystemDeleteOptions

Retornos

Promise<FileSystemDeleteIfExistsResponse>

exists(FileSystemExistsOptions)

Retornará true se o sistema de arquivos representado por esse cliente existir; false caso contrário.

OBSERVAÇÃO: use essa função com cuidado, pois um sistema de arquivos existente pode ser excluído por outros clientes ou aplicativos. Vice-versa novo sistema de arquivos com o mesmo nome pode ser adicionado por outros clientes ou aplicativos após a conclusão dessa função.

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

Parâmetros

options
FileSystemExistsOptions

Retornos

Promise<boolean>

generateSasStringToSign(FileSystemGenerateSasUrlOptions)

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

Gera uma cadeia de caracteres para assinar um URI de SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela credencial de chave compartilhada do cliente.

Confira https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: FileSystemGenerateSasUrlOptions): string

Parâmetros

options
FileSystemGenerateSasUrlOptions

Parâmetros opcionais.

Retornos

string

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

generateSasUrl(FileSystemGenerateSasUrlOptions)

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

Gera um URI de SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela credencial de chave compartilhada do cliente.

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

Retornos

Promise<string>

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

generateUserDelegationSasStringToSign(FileSystemGenerateSasUrlOptions, UserDelegationKey)

Gera uma cadeia de caracteres para assinar um URI de SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela chave de delegação do usuário de entrada.

Confira https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasStringToSign(options: FileSystemGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Parâmetros

options
FileSystemGenerateSasUrlOptions

Parâmetros opcionais.

userDelegationKey
UserDelegationKey

Valor retornado de blobServiceClient.getUserDelegationKey()

Retornos

string

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

generateUserDelegationSasUrl(FileSystemGenerateSasUrlOptions, UserDelegationKey)

Gera um URI de SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela chave de delegação do usuário de entrada.

Confira https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasUrl(options: FileSystemGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>

Parâmetros

options
FileSystemGenerateSasUrlOptions

Parâmetros opcionais.

userDelegationKey
UserDelegationKey

Valor retornado de blobServiceClient.getUserDelegationKey()

Retornos

Promise<string>

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

getAccessPolicy(FileSystemGetAccessPolicyOptions)

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

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

Confira 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 do sistema de arquivos.

Retornos

Promise<FileSystemGetAccessPolicyResponse>

getDataLakeLeaseClient(string)

Obtenha um DataLakeLeaseClient que gerencia as concessões no sistema de arquivos.

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parâmetros

proposeLeaseId

string

Opcional. ID de concessão proposta inicial.

Retornos

DataLakeLeaseClient

getDirectoryClient(string)

Cria um objeto DataLakeDirectoryClient no sistema de arquivos atual.

function getDirectoryClient(directoryName: string): DataLakeDirectoryClient

Parâmetros

directoryName

string

Retornos

DataLakeDirectoryClient

getFileClient(string)

Cria um objeto DataLakeFileClient no sistema de arquivos atual.

function getFileClient(fileName: string): DataLakeFileClient

Parâmetros

fileName

string

Retornos

DataLakeFileClient

getProperties(FileSystemGetPropertiesOptions)

Retorna todos os metadados definidos pelo usuário e as propriedades do sistema de arquivos para o sistema de arquivos especificado.

AVISO: O objeto metadata retornado na resposta terá suas chaves em letras minúsculas, mesmo que originalmente contivessem caracteres maiúsculos. Isso difere das chaves de metadados retornadas pelo método listFileSystems de DataLakeServiceClient usando a opção includeMetadata, que manterá sua caixa original.

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

Retornos

Promise<FileSystemGetPropertiesResponse>

listDeletedPaths(ListDeletedPathsOptions)

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

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

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

Confira 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 excluídos.

Retornos

PagedAsyncIterableIterator<DeletedPath, FileSystemListDeletedPathsResponse, PageSettings>

listPaths(ListPathsOptions)

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

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

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

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

Retornos

PagedAsyncIterableIterator<Path, FileSystemListPathsResponse, PageSettings>

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

Define as permissões para o sistema de arquivos especificado. As permissões indicam se os diretórios ou arquivos em um sistema de arquivos podem ser acessados publicamente.

Quando você define permissões para um sistema de arquivos, as permissões existentes são substituídas. Se nenhum acesso ou contêinerAcl for fornecido, a ACL do sistema de arquivos existente será removida.

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

fileSystemAcl

SignedIdentifier<AccessPolicy>[]

Opcional. Matriz de elementos cada um com uma ID exclusiva e detalhes da política de acesso.

options
FileSystemSetAccessPolicyOptions

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

Retornos

Promise<FileSystemSetAccessPolicyResponse>

setMetadata(Metadata, FileSystemSetMetadataOptions)

Define um ou mais pares nome-valor definidos pelo usuário para o sistema de arquivos especificado.

Se nenhuma opção for fornecida ou nenhum metadado definido no parâmetro, os metadados do sistema de arquivos serão removidos.

Confira 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 esse valor. Se nenhum valor fornecido, os metadados existentes serão removidos.

options
FileSystemSetMetadataOptions

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

Retornos

Promise<FileSystemSetMetadataResponse>

undeletePath(string, string, FileSystemUndeletePathOption)

Restaura um caminho com exclusão reversível.

Confira 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

Necessário. O caminho do caminho excluído.

deletionId

string

Necessário. A ID de exclusão associada ao caminho de exclusão reversível.

options
FileSystemUndeletePathOption

Retornos

Promise<FileSystemUndeletePathResponse>