Condividi tramite

DataLakeFileSystemClient class

  • Riferimento
Pacchetto:
@azure/storage-file-datalake

DataLakeFileSystemClient rappresenta un URL del file system di Archiviazione di Azure che consente di modificare le directory e i file.

Extends

StorageClient

Costruttori

DataLakeFileSystemClient(string, Pipeline)

Crea un'istanza di DataLakeFileSystemClient dall'URL e dalla pipeline.
DataLakeFileSystemClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Crea un'istanza di DataLakeFileSystemClient dall'URL e dalle credenziali.

Proprietà

name

Nome del file system corrente.

Proprietà ereditate

accountName
credential

Ad esempio AnonymousCredential, StorageSharedKeyCredential o qualsiasi credenziale del pacchetto @azure/identity per autenticare le richieste al servizio. È anche possibile fornire un oggetto che implementa l'interfaccia TokenCredential. Se non specificato, viene utilizzato AnonymousCredential.
url

Valore stringa URL codificato.

Metodi

create(FileSystemCreateOptions)

Crea un nuovo file system nell'account specificato. Se il file system con lo stesso nome esiste già, l'operazione non riesce.

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

Crea un nuovo file system nell'account specificato. Se il file system con lo stesso nome esiste già, non viene modificato.

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

Eliminare il file system corrente.

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

Eliminare il file system corrente, se esistente.

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

Restituisce true se il file system rappresentato dal client esiste; false in caso contrario.

NOTA: usare questa funzione con attenzione perché un file system esistente potrebbe essere eliminato da altri client o applicazioni. Viceversa, il nuovo file system con lo stesso nome potrebbe essere aggiunto da altri client o applicazioni al termine di questa funzione.
generateSasStringToSign(FileSystemGenerateSasUrlOptions)

Disponibile solo per DataLakeFileSystemClient costruito con credenziali chiave condivise.

Genera una stringa per firmare un URI di firma di accesso condiviso del servizio in base alle proprietà e ai parametri client passati. La firma di accesso condiviso è firmata dalle credenziali della chiave condivisa del client.

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

Disponibile solo per DataLakeFileSystemClient costruito con credenziali chiave condivise.

Genera un URI di firma di accesso condiviso del servizio in base alle proprietà e ai parametri client passati. La firma di accesso condiviso è firmata dalle credenziali della chiave condivisa del client.

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

Genera una stringa per firmare un URI di firma di accesso condiviso del servizio in base alle proprietà e ai parametri client passati. La firma di accesso condiviso è firmata dalla chiave di delega dell'utente di input.

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

Genera un URI di firma di accesso condiviso del servizio in base alle proprietà e ai parametri client passati. La firma di accesso condiviso è firmata dalla chiave di delega dell'utente di input.

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

Ottiene le autorizzazioni per il file system specificato. Le autorizzazioni indicano se è possibile accedere pubblicamente ai dati del file system.

AVVISO: la data JavaScript perderà potenzialmente la precisione durante l'analisi di startsOn e scadrà stringheOn. Ad esempio, new Date("2018-12-31T03:44:23.8827891Z").toISOString() otterrà "2018-12-31T03:44:23.882Z".

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

Ottenere un DataLakeLeaseClient che gestisce i lease nel file system.
getDirectoryClient(string)

Crea un oggetto DataLakeDirectoryClient nel file system corrente.
getFileClient(string)

Crea un oggetto DataLakeFileClient nel file system corrente.
getProperties(FileSystemGetPropertiesOptions)

Restituisce tutti i metadati e le proprietà di sistema definiti dall'utente per il file system specificato.

AVVISO: l'oggetto metadata restituito nella risposta avrà le relative chiavi in lettere minuscole, anche se originariamente contengono caratteri maiuscoli. Ciò differisce dalle chiavi di metadati restituite dal metodo listFileSystems di DataLakeServiceClient usando l'opzione includeMetadata, che manterrà le maiuscole e minuscole originali.

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

Restituisce un iteratore iteratore asincrono per elencare tutti i percorsi (directory e file) nel file system specificato.

.byPage() restituisce un iteratore iteratore iterabile asincrono per elencare i percorsi nelle pagine.

Esempio di utilizzo della sintassi for await:

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

Esempio con 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();
}

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

Esempio di utilizzo del paging con un marcatore:

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

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

Restituisce un iteratore iteratore asincrono per elencare tutti i percorsi (directory e file) nel file system specificato.

.byPage() restituisce un iteratore iteratore iterabile asincrono per elencare i percorsi nelle pagine.

Esempio di utilizzo della sintassi for await:

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

Esempio con 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();
}

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

Esempio di utilizzo del paging con un marcatore:

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

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

Imposta le autorizzazioni per il file system specificato. Le autorizzazioni indicano se è possibile accedere pubblicamente a directory o file in un file system.

Quando si impostano le autorizzazioni per un file system, le autorizzazioni esistenti vengono sostituite. Se non viene fornito alcun accesso o contenitoreAcl, l'ACL del file system esistente verrà rimosso.

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

Imposta una o più coppie nome-valore definite dall'utente per il file system specificato.

Se non viene specificata alcuna opzione o nessun metadato definito nel parametro , i metadati del file system verranno rimossi.

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

Ripristina un percorso eliminato leggero.

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

Dettagli costruttore

DataLakeFileSystemClient(string, Pipeline)

Crea un'istanza di DataLakeFileSystemClient dall'URL e dalla pipeline.

new DataLakeFileSystemClient(url: string, pipeline: Pipeline)

Parametri

url

string

Stringa client che punta al file system data lake di Archiviazione di Azure, ad esempio "https://myaccount.dfs.core.windows.net/filesystem". È possibile aggiungere una firma di accesso condiviso se si usa AnonymousCredential, ad esempio "https://myaccount.dfs.core.windows.net/filesystem?sasString".

pipeline
Pipeline

Chiamare newPipeline() per creare una pipeline predefinita o fornire una pipeline personalizzata.

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

Crea un'istanza di DataLakeFileSystemClient dall'URL e dalle credenziali.

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

Parametri

url

string

Stringa client che punta al file system data lake di Archiviazione di Azure, ad esempio "https://myaccount.dfs.core.windows.net/filesystem". È possibile aggiungere una firma di accesso condiviso se si usa AnonymousCredential, ad esempio "https://myaccount.dfs.core.windows.net/filesystem?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Ad esempio AnonymousCredential, StorageSharedKeyCredential o qualsiasi credenziale del pacchetto @azure/identity per autenticare le richieste al servizio. È anche possibile fornire un oggetto che implementa l'interfaccia TokenCredential. Se non specificato, viene utilizzato AnonymousCredential.

options
StoragePipelineOptions

Opzionale. Opzioni per configurare la pipeline HTTP.

Dettagli proprietà

name

Nome del file system corrente.

string name

Valore della proprietà

string

Dettagli proprietà ereditate

accountName 

accountName: string

Valore della proprietà

string

Ereditato da StorageClient.accountName

credential

Ad esempio AnonymousCredential, StorageSharedKeyCredential o qualsiasi credenziale del pacchetto @azure/identity per autenticare le richieste al servizio. È anche possibile fornire un oggetto che implementa l'interfaccia TokenCredential. Se non specificato, viene utilizzato AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valore della proprietà

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

ereditato da StorageClient.credential

url

Valore stringa URL codificato.

url: string

Valore della proprietà

string

Ereditato da StorageClient.url

Dettagli metodo

create(FileSystemCreateOptions)

Crea un nuovo file system nell'account specificato. Se il file system con lo stesso nome esiste già, l'operazione non riesce.

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

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

Parametri

options
FileSystemCreateOptions

Opzionale. Opzioni durante la creazione del file system.

Restituisce

Promise<FileSystemCreateResponse>

createIfNotExists(FileSystemCreateOptions)

Crea un nuovo file system nell'account specificato. Se il file system con lo stesso nome esiste già, non viene modificato.

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

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

Parametri

options
FileSystemCreateOptions

Restituisce

Promise<FileSystemCreateIfNotExistsResponse>

delete(FileSystemDeleteOptions)

Eliminare il file system corrente.

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

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

Parametri

options
FileSystemDeleteOptions

Opzionale. Opzioni durante l'eliminazione del file system.

Restituisce

Promise<FileSystemDeleteResponse>

deleteIfExists(FileSystemDeleteOptions)

Eliminare il file system corrente, se esistente.

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

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

Parametri

options
FileSystemDeleteOptions

Restituisce

Promise<FileSystemDeleteIfExistsResponse>

exists(FileSystemExistsOptions)

Restituisce true se il file system rappresentato dal client esiste; false in caso contrario.

NOTA: usare questa funzione con attenzione perché un file system esistente potrebbe essere eliminato da altri client o applicazioni. Viceversa, il nuovo file system con lo stesso nome potrebbe essere aggiunto da altri client o applicazioni al termine di questa funzione.

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

Parametri

options
FileSystemExistsOptions

Restituisce

Promise<boolean>

generateSasStringToSign(FileSystemGenerateSasUrlOptions)

Disponibile solo per DataLakeFileSystemClient costruito con credenziali chiave condivise.

Genera una stringa per firmare un URI di firma di accesso condiviso del servizio in base alle proprietà e ai parametri client passati. La firma di accesso condiviso è firmata dalle credenziali della chiave condivisa del client.

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

function generateSasStringToSign(options: FileSystemGenerateSasUrlOptions): string

Parametri

options
FileSystemGenerateSasUrlOptions

Parametri facoltativi.

Restituisce

string

URI di firma di accesso condiviso costituito dall'URI della risorsa rappresentata da questo client, seguito dal token di firma di accesso condiviso generato.

generateSasUrl(FileSystemGenerateSasUrlOptions)

Disponibile solo per DataLakeFileSystemClient costruito con credenziali chiave condivise.

Genera un URI di firma di accesso condiviso del servizio in base alle proprietà e ai parametri client passati. La firma di accesso condiviso è firmata dalle credenziali della chiave condivisa del client.

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

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

Parametri

options
FileSystemGenerateSasUrlOptions

Parametri facoltativi.

Restituisce

Promise<string>

URI di firma di accesso condiviso costituito dall'URI della risorsa rappresentata da questo client, seguito dal token di firma di accesso condiviso generato.

generateUserDelegationSasStringToSign(FileSystemGenerateSasUrlOptions, UserDelegationKey)

Genera una stringa per firmare un URI di firma di accesso condiviso del servizio in base alle proprietà e ai parametri client passati. La firma di accesso condiviso è firmata dalla chiave di delega dell'utente di input.

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

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

Parametri

options
FileSystemGenerateSasUrlOptions

Parametri facoltativi.

userDelegationKey
UserDelegationKey

Valore restituito di blobServiceClient.getUserDelegationKey()

Restituisce

string

URI di firma di accesso condiviso costituito dall'URI della risorsa rappresentata da questo client, seguito dal token di firma di accesso condiviso generato.

generateUserDelegationSasUrl(FileSystemGenerateSasUrlOptions, UserDelegationKey)

Genera un URI di firma di accesso condiviso del servizio in base alle proprietà e ai parametri client passati. La firma di accesso condiviso è firmata dalla chiave di delega dell'utente di input.

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

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

Parametri

options
FileSystemGenerateSasUrlOptions

Parametri facoltativi.

userDelegationKey
UserDelegationKey

Valore restituito di blobServiceClient.getUserDelegationKey()

Restituisce

Promise<string>

URI di firma di accesso condiviso costituito dall'URI della risorsa rappresentata da questo client, seguito dal token di firma di accesso condiviso generato.

getAccessPolicy(FileSystemGetAccessPolicyOptions)

Ottiene le autorizzazioni per il file system specificato. Le autorizzazioni indicano se è possibile accedere pubblicamente ai dati del file system.

AVVISO: la data JavaScript perderà potenzialmente la precisione durante l'analisi di startsOn e scadrà stringheOn. Ad esempio, new Date("2018-12-31T03:44:23.8827891Z").toISOString() otterrà "2018-12-31T03:44:23.882Z".

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

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

Parametri

options
FileSystemGetAccessPolicyOptions

Opzionale. Opzioni per il recupero dei criteri di accesso al file system.

Restituisce

Promise<FileSystemGetAccessPolicyResponse>

getDataLakeLeaseClient(string)

Ottenere un DataLakeLeaseClient che gestisce i lease nel file system.

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parametri

proposeLeaseId

string

Opzionale. ID lease proposto iniziale.

Restituisce

DataLakeLeaseClient

getDirectoryClient(string)

Crea un oggetto DataLakeDirectoryClient nel file system corrente.

function getDirectoryClient(directoryName: string): DataLakeDirectoryClient

Parametri

directoryName

string

Restituisce

DataLakeDirectoryClient

getFileClient(string)

Crea un oggetto DataLakeFileClient nel file system corrente.

function getFileClient(fileName: string): DataLakeFileClient

Parametri

fileName

string

Restituisce

DataLakeFileClient

getProperties(FileSystemGetPropertiesOptions)

Restituisce tutti i metadati e le proprietà di sistema definiti dall'utente per il file system specificato.

AVVISO: l'oggetto metadata restituito nella risposta avrà le relative chiavi in lettere minuscole, anche se originariamente contengono caratteri maiuscoli. Ciò differisce dalle chiavi di metadati restituite dal metodo listFileSystems di DataLakeServiceClient usando l'opzione includeMetadata, che manterrà le maiuscole e minuscole originali.

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

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

Parametri

options
FileSystemGetPropertiesOptions

Opzionale. Opzioni durante il recupero delle proprietà del file system.

Restituisce

Promise<FileSystemGetPropertiesResponse>

listDeletedPaths(ListDeletedPathsOptions)

Restituisce un iteratore iteratore asincrono per elencare tutti i percorsi (directory e file) nel file system specificato.

.byPage() restituisce un iteratore iteratore iterabile asincrono per elencare i percorsi nelle pagine.

Esempio di utilizzo della sintassi for await:

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

Esempio con 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();
}

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

Esempio di utilizzo del paging con un marcatore:

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

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

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

Parametri

options
ListDeletedPathsOptions

Opzionale. Opzioni quando si elencano i percorsi eliminati.

Restituisce

PagedAsyncIterableIterator<DeletedPath, FileSystemListDeletedPathsResponse, PageSettings>

listPaths(ListPathsOptions)

Restituisce un iteratore iteratore asincrono per elencare tutti i percorsi (directory e file) nel file system specificato.

.byPage() restituisce un iteratore iteratore iterabile asincrono per elencare i percorsi nelle pagine.

Esempio di utilizzo della sintassi for await:

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

Esempio con 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();
}

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

Esempio di utilizzo del paging con un marcatore:

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

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

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

Parametri

options
ListPathsOptions

Opzionale. Opzioni quando si elencano i percorsi.

Restituisce

PagedAsyncIterableIterator<Path, FileSystemListPathsResponse, PageSettings>

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

Imposta le autorizzazioni per il file system specificato. Le autorizzazioni indicano se è possibile accedere pubblicamente a directory o file in un file system.

Quando si impostano le autorizzazioni per un file system, le autorizzazioni esistenti vengono sostituite. Se non viene fornito alcun accesso o contenitoreAcl, l'ACL del file system esistente verrà rimosso.

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

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

Parametri

access
PublicAccessType

Opzionale. Livello di accesso pubblico ai dati nel file system.

fileSystemAcl

SignedIdentifier<AccessPolicy>[]

Opzionale. Matrice di elementi ognuno con un ID univoco e i dettagli dei criteri di accesso.

options
FileSystemSetAccessPolicyOptions

Opzionale. Opzioni quando si impostano i criteri di accesso al file system.

Restituisce

Promise<FileSystemSetAccessPolicyResponse>

setMetadata(Metadata, FileSystemSetMetadataOptions)

Imposta una o più coppie nome-valore definite dall'utente per il file system specificato.

Se non viene specificata alcuna opzione o nessun metadato definito nel parametro , i metadati del file system verranno rimossi.

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

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

Parametri

metadata
Metadata

Sostituire i metadati esistenti con questo valore. Se non viene specificato alcun valore, i metadati esistenti verranno rimossi.

options
FileSystemSetMetadataOptions

Opzionale. Opzioni per l'impostazione dei metadati del file system.

Restituisce

Promise<FileSystemSetMetadataResponse>

undeletePath(string, string, FileSystemUndeletePathOption)

Ripristina un percorso eliminato leggero.

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

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

Parametri

deletedPath

string

Obbligatorio. Percorso del percorso eliminato.

deletionId

string

Obbligatorio. ID di eliminazione associato al percorso eliminato leggero.

options
FileSystemUndeletePathOption

Restituisce

Promise<FileSystemUndeletePathResponse>