Partager via

DataLakeFileSystemClient class

Paquet:
@azure/storage-file-datalake

Un DataLakeFileSystemClient représente une URL vers le système de fichiers Stockage Azure, ce qui vous permet de manipuler ses répertoires et fichiers.

Extends

StorageClient

Constructeurs

DataLakeFileSystemClient(string, Pipeline)

Crée une instance de DataLakeFileSystemClient à partir de l’URL et du pipeline.
DataLakeFileSystemClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Crée une instance de DataLakeFileSystemClient à partir de l’URL et des informations d’identification.

Propriétés

name

Nom du système de fichiers actuel.

Propriétés héritées

accountName
credential

Tels que AnonymousCredential, StorageSharedKeyCredential ou toutes les informations d’identification du package @azure/identity pour authentifier les demandes auprès du service. Vous pouvez également fournir un objet qui implémente l’interface TokenCredential. Si ce n’est pas spécifié, AnonymousCredential est utilisé.
url

Valeur de chaîne d’URL encodée.

Méthodes

create(FileSystemCreateOptions)

Crée un système de fichiers sous le compte spécifié. Si le système de fichiers portant le même nom existe déjà, l’opération échoue.

Voir https://learn.microsoft.com/rest/api/storageservices/create-container
createIfNotExists(FileSystemCreateOptions)

Crée un système de fichiers sous le compte spécifié. Si le système de fichiers portant le même nom existe déjà, il n’est pas modifié.

Voir https://learn.microsoft.com/rest/api/storageservices/create-container
delete(FileSystemDeleteOptions)

Supprimez le système de fichiers actuel.

Voir https://learn.microsoft.com/rest/api/storageservices/delete-container
deleteIfExists(FileSystemDeleteOptions)

Supprimez le système de fichiers actuel s’il existe.

Voir https://learn.microsoft.com/rest/api/storageservices/delete-container
exists(FileSystemExistsOptions)

Retourne true si le système de fichiers représenté par ce client existe ; false sinon.

REMARQUE : utilisez cette fonction avec soin, car un système de fichiers existant peut être supprimé par d’autres clients ou applications. Inversement, un nouveau système de fichiers portant le même nom peut être ajouté par d’autres clients ou applications une fois cette fonction terminée.
generateSasStringToSign(FileSystemGenerateSasUrlOptions)

Disponible uniquement pour DataLakeFileSystemClient construit avec des informations d’identification de clé partagée.

Génère une chaîne à signer pour un URI de signature d’accès partagé de service (SAP) en fonction des propriétés et paramètres du client transmis. La SAP est signée par les informations d’identification de clé partagée du client.

Voir https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(FileSystemGenerateSasUrlOptions)

Disponible uniquement pour DataLakeFileSystemClient construit avec des informations d’identification de clé partagée.

Génère un URI de signature d’accès partagé (SAP) de service en fonction des propriétés et paramètres du client transmis. La SAP est signée par les informations d’identification de clé partagée du client.

Voir https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasStringToSign(FileSystemGenerateSasUrlOptions, UserDelegationKey)

Génère une chaîne à signer pour un URI de signature d’accès partagé de service (SAP) en fonction des propriétés et paramètres du client transmis. La SAP est signée par la clé de délégation d’utilisateur d’entrée.

Voir https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(FileSystemGenerateSasUrlOptions, UserDelegationKey)

Génère un URI de signature d’accès partagé (SAP) de service en fonction des propriétés et paramètres du client transmis. La SAP est signée par la clé de délégation d’utilisateur d’entrée.

Voir https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
getAccessPolicy(FileSystemGetAccessPolicyOptions)

Obtient les autorisations pour le système de fichiers spécifié. Les autorisations indiquent si les données du système de fichiers sont accessibles publiquement.

AVERTISSEMENT : La date JavaScript perd potentiellement la précision lorsque l’analyse démarreOn et expire les chaînesOn. Par exemple, nouvelle Date(« 2018-12-31T03:44:23.8827891Z »). toISOString() obtient « 2018-12-31T03:44:23.882Z ».

Voir https://learn.microsoft.com/rest/api/storageservices/get-container-acl
getDataLakeLeaseClient(string)

Obtenez un DataLakeLeaseClient qui gère les baux sur le système de fichiers.
getDirectoryClient(string)

Crée un objet DataLakeDirectoryClient sous le système de fichiers actuel.
getFileClient(string)

Crée un objet DataLakeFileClient sous le système de fichiers actuel.
getProperties(FileSystemGetPropertiesOptions)

Retourne toutes les métadonnées et propriétés système définies par l’utilisateur pour le système de fichiers spécifié.

AVERTISSEMENT : l’objet metadata retourné dans la réponse aura ses clés en minuscules, même s’ils contenaient initialement des caractères majuscules. Cela diffère des clés de métadonnées retournées par la méthode listFileSystems de DataLakeServiceClient à l’aide de l’option de includeMetadata, qui conserve sa casse d’origine.

Voir https://learn.microsoft.com/rest/api/storageservices/get-container-properties
listDeletedPaths(ListDeletedPathsOptions)

Retourne un itérateur itérable asynchrone pour répertorier tous les chemins d’accès (répertoires et fichiers) sous le système de fichiers spécifié.

.byPage() retourne un itérateur itérable asynchrone pour répertorier les chemins d’accès dans les pages.

Exemple utilisant for await syntaxe :

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

const fileSystemName = "<file system name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);

let i = 1;
const deletedPaths = fileSystemClient.listDeletedPaths();
for await (const deletedPath of deletedPaths) {
  console.log(`Deleted path ${i++}: ${deletedPath.name}, deleted on: ${deletedPath.deletedOn}`);
}

Exemple utilisant iter.next() :

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

const fileSystemName = "<file system name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);

let i = 1;
const deletedPaths = fileSystemClient.listDeletedPaths();
let { value, done } = await deletedPaths.next();
while (!done) {
  console.log(`Deleted path ${i++}: ${value.name}, deleted on: ${value.deletedOn}`);
  ({ value, done } = await deletedPaths.next());
}

Exemple utilisant byPage() :

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

const fileSystemName = "<file system name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);

let i = 1;
for await (const response of fileSystemClient.listDeletedPaths().byPage({ maxPageSize: 20 })) {
  if (response.pathItems) {
    for (const deletedPath of response.pathItems) {
      console.log(`Deleted path ${i++}: ${deletedPath.name}, deleted on: ${deletedPath.deletedOn}`);
    }
  }
}

Exemple d’utilisation de la pagination avec un marqueur :

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

const fileSystemName = "<file system name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);

let i = 1;
let deletedPaths = fileSystemClient.listDeletedPaths().byPage({ maxPageSize: 2 });
let response = (await deletedPaths.next()).value;
// Prints 2 deleted paths
if (response.deletedPathItems) {
  for (const deletedPath of response.deletedPathItems) {
    console.log(`Deleted path ${i++}: ${deletedPath.name}, deleted on: ${deletedPath.deletedOn}`);
  }
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
deletedPaths = fileSystemClient
  .listDeletedPaths()
  .byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await deletedPaths.next()).value;
// Prints 10 deleted paths
if (response.deletedPathItems) {
  for (const deletedPath of response.deletedPathItems) {
    console.log(`Deleted path ${i++}: ${deletedPath.name}, deleted on: ${deletedPath.deletedOn}`);
  }
}

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

Retourne un itérateur itérable asynchrone pour répertorier tous les chemins d’accès (répertoires et fichiers) sous le système de fichiers spécifié.

.byPage() retourne un itérateur itérable asynchrone pour répertorier les chemins d’accès dans les pages.

Exemple utilisant for await syntaxe :

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

const fileSystemName = "<file system name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);

let i = 1;
const paths = fileSystemClient.listPaths();
for await (const path of paths) {
  console.log(`Path ${i++}: ${path.name}, is directory: ${path.isDirectory}`);
}

Exemple utilisant iter.next() :

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

const fileSystemName = "<file system name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);

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

Exemple utilisant byPage() :

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

const fileSystemName = "<file system name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);

let i = 1;
for await (const response of fileSystemClient.listPaths().byPage({ maxPageSize: 20 })) {
  if (response.pathItems) {
    for (const path of response.pathItems) {
      console.log(`Path ${i++}: ${path.name}, is directory: ${path.isDirectory}`);
    }
  }
}

Exemple d’utilisation de la pagination avec un marqueur :

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

const fileSystemName = "<file system name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);

let i = 1;
let paths = fileSystemClient.listPaths().byPage({ maxPageSize: 2 });
let response = (await paths.next()).value;
// Prints 2 paths
if (response.pathItems) {
  for (const path of response.pathItems) {
    console.log(`Path ${i++}: ${path.name}, is directory: ${path.isDirectory}`);
  }
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
paths = fileSystemClient.listPaths().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await paths.next()).value;
// Prints 10 paths
if (response.pathItems) {
  for (const path of response.pathItems) {
    console.log(`Path ${i++}: ${path.name}, is directory: ${path.isDirectory}`);
  }
}

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

Définit les autorisations pour le système de fichiers spécifié. Les autorisations indiquent si les répertoires ou les fichiers d’un système de fichiers sont accessibles publiquement.

Lorsque vous définissez des autorisations pour un système de fichiers, les autorisations existantes sont remplacées. Si aucun accès ou conteneurAcl n’est fourni, la liste de contrôle d’accès du système de fichiers existante est supprimée.

Voir https://learn.microsoft.com/rest/api/storageservices/set-container-acl
setMetadata(Metadata, FileSystemSetMetadataOptions)

Définit une ou plusieurs paires nom-valeur définies par l’utilisateur pour le système de fichiers spécifié.

Si aucune option n’est fournie ou aucune métadonnées définie dans le paramètre, les métadonnées du système de fichiers sont supprimées.

Voir https://learn.microsoft.com/rest/api/storageservices/set-container-metadata
undeletePath(string, string, FileSystemUndeletePathOption)

Restaure un chemin supprimé de manière réversible.

Voir https://learn.microsoft.com/rest/api/storageservices/undelete-blob

Détails du constructeur

DataLakeFileSystemClient(string, Pipeline)

Crée une instance de DataLakeFileSystemClient à partir de l’URL et du pipeline.

new DataLakeFileSystemClient(url: string, pipeline: Pipeline)

Paramètres

url

string

Chaîne cliente pointant vers le système de fichiers Data Lake Stockage Azure, par exemple «https://myaccount.dfs.core.windows.net/filesystem". Vous pouvez ajouter une SAP si vous utilisez AnonymousCredential, par exemple «https://myaccount.dfs.core.windows.net/filesystem?sasString".

pipeline
Pipeline

Appelez newPipeline() pour créer un pipeline par défaut ou fournissez un pipeline personnalisé.

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

Crée une instance de DataLakeFileSystemClient à partir de l’URL et des informations d’identification.

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

Paramètres

url

string

Chaîne cliente pointant vers le système de fichiers Data Lake Stockage Azure, par exemple «https://myaccount.dfs.core.windows.net/filesystem". Vous pouvez ajouter une SAP si vous utilisez AnonymousCredential, par exemple «https://myaccount.dfs.core.windows.net/filesystem?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Tels que AnonymousCredential, StorageSharedKeyCredential ou toutes les informations d’identification du package @azure/identity pour authentifier les demandes auprès du service. Vous pouvez également fournir un objet qui implémente l’interface TokenCredential. Si ce n’est pas spécifié, AnonymousCredential est utilisé.

options
StoragePipelineOptions

Optional. Options de configuration du pipeline HTTP.

Détails de la propriété

name

Nom du système de fichiers actuel.

string name

Valeur de propriété

string

Détails de la propriété héritée

accountName 

accountName: string

Valeur de propriété

string

héritée de StorageClient.accountName

credential

Tels que AnonymousCredential, StorageSharedKeyCredential ou toutes les informations d’identification du package @azure/identity pour authentifier les demandes auprès du service. Vous pouvez également fournir un objet qui implémente l’interface TokenCredential. Si ce n’est pas spécifié, AnonymousCredential est utilisé.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valeur de propriété

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

héritée de StorageClient.credential

url

Valeur de chaîne d’URL encodée.

url: string

Valeur de propriété

string

héritée de StorageClient.url

Détails de la méthode

create(FileSystemCreateOptions)

Crée un système de fichiers sous le compte spécifié. Si le système de fichiers portant le même nom existe déjà, l’opération échoue.

Voir https://learn.microsoft.com/rest/api/storageservices/create-container

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

Paramètres

options
FileSystemCreateOptions

Optional. Options lors de la création d’un système de fichiers.

Retours

Promise<FileSystemCreateResponse>

createIfNotExists(FileSystemCreateOptions)

Crée un système de fichiers sous le compte spécifié. Si le système de fichiers portant le même nom existe déjà, il n’est pas modifié.

Voir https://learn.microsoft.com/rest/api/storageservices/create-container

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

Paramètres

options
FileSystemCreateOptions

Retours

Promise<FileSystemCreateIfNotExistsResponse>

delete(FileSystemDeleteOptions)

Supprimez le système de fichiers actuel.

Voir https://learn.microsoft.com/rest/api/storageservices/delete-container

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

Paramètres

options
FileSystemDeleteOptions

Optional. Options lors de la suppression du système de fichiers.

Retours

Promise<FileSystemDeleteResponse>

deleteIfExists(FileSystemDeleteOptions)

Supprimez le système de fichiers actuel s’il existe.

Voir https://learn.microsoft.com/rest/api/storageservices/delete-container

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

Paramètres

options
FileSystemDeleteOptions

Retours

Promise<FileSystemDeleteIfExistsResponse>

exists(FileSystemExistsOptions)

Retourne true si le système de fichiers représenté par ce client existe ; false sinon.

REMARQUE : utilisez cette fonction avec soin, car un système de fichiers existant peut être supprimé par d’autres clients ou applications. Inversement, un nouveau système de fichiers portant le même nom peut être ajouté par d’autres clients ou applications une fois cette fonction terminée.

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

Paramètres

options
FileSystemExistsOptions

Retours

Promise<boolean>

generateSasStringToSign(FileSystemGenerateSasUrlOptions)

Disponible uniquement pour DataLakeFileSystemClient construit avec des informations d’identification de clé partagée.

Génère une chaîne à signer pour un URI de signature d’accès partagé de service (SAP) en fonction des propriétés et paramètres du client transmis. La SAP est signée par les informations d’identification de clé partagée du client.

Voir https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: FileSystemGenerateSasUrlOptions): string

Paramètres

options
FileSystemGenerateSasUrlOptions

Paramètres facultatifs.

Retours

string

URI SAP constitué de l’URI de la ressource représentée par ce client, suivi du jeton SAP généré.

generateSasUrl(FileSystemGenerateSasUrlOptions)

Disponible uniquement pour DataLakeFileSystemClient construit avec des informations d’identification de clé partagée.

Génère un URI de signature d’accès partagé (SAP) de service en fonction des propriétés et paramètres du client transmis. La SAP est signée par les informations d’identification de clé partagée du client.

Voir https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

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

Paramètres

options
FileSystemGenerateSasUrlOptions

Paramètres facultatifs.

Retours

Promise<string>

URI SAP constitué de l’URI de la ressource représentée par ce client, suivi du jeton SAP généré.

generateUserDelegationSasStringToSign(FileSystemGenerateSasUrlOptions, UserDelegationKey)

Génère une chaîne à signer pour un URI de signature d’accès partagé de service (SAP) en fonction des propriétés et paramètres du client transmis. La SAP est signée par la clé de délégation d’utilisateur d’entrée.

Voir https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

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

Paramètres

options
FileSystemGenerateSasUrlOptions

Paramètres facultatifs.

userDelegationKey
UserDelegationKey

Valeur de retour de blobServiceClient.getUserDelegationKey()

Retours

string

URI SAP constitué de l’URI de la ressource représentée par ce client, suivi du jeton SAP généré.

generateUserDelegationSasUrl(FileSystemGenerateSasUrlOptions, UserDelegationKey)

Génère un URI de signature d’accès partagé (SAP) de service en fonction des propriétés et paramètres du client transmis. La SAP est signée par la clé de délégation d’utilisateur d’entrée.

Voir https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

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

Paramètres

options
FileSystemGenerateSasUrlOptions

Paramètres facultatifs.

userDelegationKey
UserDelegationKey

Valeur de retour de blobServiceClient.getUserDelegationKey()

Retours

Promise<string>

URI SAP constitué de l’URI de la ressource représentée par ce client, suivi du jeton SAP généré.

getAccessPolicy(FileSystemGetAccessPolicyOptions)

Obtient les autorisations pour le système de fichiers spécifié. Les autorisations indiquent si les données du système de fichiers sont accessibles publiquement.

AVERTISSEMENT : La date JavaScript perd potentiellement la précision lorsque l’analyse démarreOn et expire les chaînesOn. Par exemple, nouvelle Date(« 2018-12-31T03:44:23.8827891Z »). toISOString() obtient « 2018-12-31T03:44:23.882Z ».

Voir https://learn.microsoft.com/rest/api/storageservices/get-container-acl

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

Paramètres

options
FileSystemGetAccessPolicyOptions

Optional. Options lors de l’obtention de la stratégie d’accès au système de fichiers.

Retours

Promise<FileSystemGetAccessPolicyResponse>

getDataLakeLeaseClient(string)

Obtenez un DataLakeLeaseClient qui gère les baux sur le système de fichiers.

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Paramètres

proposeLeaseId

string

Optional. ID de bail initial proposé.

Retours

DataLakeLeaseClient

getDirectoryClient(string)

Crée un objet DataLakeDirectoryClient sous le système de fichiers actuel.

function getDirectoryClient(directoryName: string): DataLakeDirectoryClient

Paramètres

directoryName

string

Retours

DataLakeDirectoryClient

getFileClient(string)

Crée un objet DataLakeFileClient sous le système de fichiers actuel.

function getFileClient(fileName: string): DataLakeFileClient

Paramètres

fileName

string

Retours

DataLakeFileClient

getProperties(FileSystemGetPropertiesOptions)

Retourne toutes les métadonnées et propriétés système définies par l’utilisateur pour le système de fichiers spécifié.

AVERTISSEMENT : l’objet metadata retourné dans la réponse aura ses clés en minuscules, même s’ils contenaient initialement des caractères majuscules. Cela diffère des clés de métadonnées retournées par la méthode listFileSystems de DataLakeServiceClient à l’aide de l’option de includeMetadata, qui conserve sa casse d’origine.

Voir https://learn.microsoft.com/rest/api/storageservices/get-container-properties

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

Paramètres

options
FileSystemGetPropertiesOptions

Optional. Options lors de l’obtention des propriétés du système de fichiers.

Retours

Promise<FileSystemGetPropertiesResponse>

listDeletedPaths(ListDeletedPathsOptions)

Retourne un itérateur itérable asynchrone pour répertorier tous les chemins d’accès (répertoires et fichiers) sous le système de fichiers spécifié.

.byPage() retourne un itérateur itérable asynchrone pour répertorier les chemins d’accès dans les pages.

Exemple utilisant for await syntaxe :

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

const fileSystemName = "<file system name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);

let i = 1;
const deletedPaths = fileSystemClient.listDeletedPaths();
for await (const deletedPath of deletedPaths) {
  console.log(`Deleted path ${i++}: ${deletedPath.name}, deleted on: ${deletedPath.deletedOn}`);
}

Exemple utilisant iter.next() :

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

const fileSystemName = "<file system name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);

let i = 1;
const deletedPaths = fileSystemClient.listDeletedPaths();
let { value, done } = await deletedPaths.next();
while (!done) {
  console.log(`Deleted path ${i++}: ${value.name}, deleted on: ${value.deletedOn}`);
  ({ value, done } = await deletedPaths.next());
}

Exemple utilisant byPage() :

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

const fileSystemName = "<file system name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);

let i = 1;
for await (const response of fileSystemClient.listDeletedPaths().byPage({ maxPageSize: 20 })) {
  if (response.pathItems) {
    for (const deletedPath of response.pathItems) {
      console.log(`Deleted path ${i++}: ${deletedPath.name}, deleted on: ${deletedPath.deletedOn}`);
    }
  }
}

Exemple d’utilisation de la pagination avec un marqueur :

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

const fileSystemName = "<file system name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);

let i = 1;
let deletedPaths = fileSystemClient.listDeletedPaths().byPage({ maxPageSize: 2 });
let response = (await deletedPaths.next()).value;
// Prints 2 deleted paths
if (response.deletedPathItems) {
  for (const deletedPath of response.deletedPathItems) {
    console.log(`Deleted path ${i++}: ${deletedPath.name}, deleted on: ${deletedPath.deletedOn}`);
  }
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
deletedPaths = fileSystemClient
  .listDeletedPaths()
  .byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await deletedPaths.next()).value;
// Prints 10 deleted paths
if (response.deletedPathItems) {
  for (const deletedPath of response.deletedPathItems) {
    console.log(`Deleted path ${i++}: ${deletedPath.name}, deleted on: ${deletedPath.deletedOn}`);
  }
}

Voir https://learn.microsoft.com/rest/api/storageservices/list-blobs

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

Paramètres

options
ListDeletedPathsOptions

Optional. Options lors de la liste des chemins supprimés.

Retours

PagedAsyncIterableIterator<DeletedPath, FileSystemListDeletedPathsResponse, PageSettings>

listPaths(ListPathsOptions)

Retourne un itérateur itérable asynchrone pour répertorier tous les chemins d’accès (répertoires et fichiers) sous le système de fichiers spécifié.

.byPage() retourne un itérateur itérable asynchrone pour répertorier les chemins d’accès dans les pages.

Exemple utilisant for await syntaxe :

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

const fileSystemName = "<file system name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);

let i = 1;
const paths = fileSystemClient.listPaths();
for await (const path of paths) {
  console.log(`Path ${i++}: ${path.name}, is directory: ${path.isDirectory}`);
}

Exemple utilisant iter.next() :

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

const fileSystemName = "<file system name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);

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

Exemple utilisant byPage() :

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

const fileSystemName = "<file system name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);

let i = 1;
for await (const response of fileSystemClient.listPaths().byPage({ maxPageSize: 20 })) {
  if (response.pathItems) {
    for (const path of response.pathItems) {
      console.log(`Path ${i++}: ${path.name}, is directory: ${path.isDirectory}`);
    }
  }
}

Exemple d’utilisation de la pagination avec un marqueur :

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

const fileSystemName = "<file system name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);

let i = 1;
let paths = fileSystemClient.listPaths().byPage({ maxPageSize: 2 });
let response = (await paths.next()).value;
// Prints 2 paths
if (response.pathItems) {
  for (const path of response.pathItems) {
    console.log(`Path ${i++}: ${path.name}, is directory: ${path.isDirectory}`);
  }
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
paths = fileSystemClient.listPaths().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await paths.next()).value;
// Prints 10 paths
if (response.pathItems) {
  for (const path of response.pathItems) {
    console.log(`Path ${i++}: ${path.name}, is directory: ${path.isDirectory}`);
  }
}

Voir https://learn.microsoft.com/rest/api/storageservices/list-blobs

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

Paramètres

options
ListPathsOptions

Optional. Options lors de la liste des chemins d’accès.

Retours

PagedAsyncIterableIterator<Path, FileSystemListPathsResponse, PageSettings>

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

Définit les autorisations pour le système de fichiers spécifié. Les autorisations indiquent si les répertoires ou les fichiers d’un système de fichiers sont accessibles publiquement.

Lorsque vous définissez des autorisations pour un système de fichiers, les autorisations existantes sont remplacées. Si aucun accès ou conteneurAcl n’est fourni, la liste de contrôle d’accès du système de fichiers existante est supprimée.

Voir https://learn.microsoft.com/rest/api/storageservices/set-container-acl

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

Paramètres

access
PublicAccessType

Optional. Niveau d’accès public aux données dans le système de fichiers.

fileSystemAcl

SignedIdentifier<AccessPolicy>[]

Optional. Tableau d’éléments ayant chacun un ID unique et des détails de la stratégie d’accès.

options
FileSystemSetAccessPolicyOptions

Optional. Options lors de la définition de la stratégie d’accès au système de fichiers.

Retours

Promise<FileSystemSetAccessPolicyResponse>

setMetadata(Metadata, FileSystemSetMetadataOptions)

Définit une ou plusieurs paires nom-valeur définies par l’utilisateur pour le système de fichiers spécifié.

Si aucune option n’est fournie ou aucune métadonnées définie dans le paramètre, les métadonnées du système de fichiers sont supprimées.

Voir https://learn.microsoft.com/rest/api/storageservices/set-container-metadata

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

Paramètres

metadata
Metadata

Remplacez les métadonnées existantes par cette valeur. Si aucune valeur n’est fournie, les métadonnées existantes seront supprimées.

options
FileSystemSetMetadataOptions

Optional. Options lors de la définition des métadonnées du système de fichiers.

Retours

Promise<FileSystemSetMetadataResponse>

undeletePath(string, string, FileSystemUndeletePathOption)

Restaure un chemin supprimé de manière réversible.

Voir https://learn.microsoft.com/rest/api/storageservices/undelete-blob

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

Paramètres

deletedPath

string

Required. Chemin d’accès du chemin supprimé.

deletionId

string

Required. ID de suppression associé au chemin supprimé de manière réversible.

options
FileSystemUndeletePathOption

Retours

Promise<FileSystemUndeletePathResponse>