DataLakeFileSystemClient class

Hiermee maakt u een exemplaar van DataLakeFileSystemClient op basis van url en pijplijn.

new DataLakeFileSystemClient(url: string, pipeline: Pipeline)

Parameters

Hiermee maakt u een exemplaar van DataLakeFileSystemClient op basis van url en referentie.

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

Parameters

Naam van het huidige bestandssysteem.

string name

Waarde van eigenschap

accountName: string

Waarde van eigenschap

overgenomen van StorageClient.accountName

Zoals AnonymousCredential, StorageSharedKeyCredential of referenties van het @azure/identity-pakket om aanvragen voor de service te verifiëren. U kunt ook een object opgeven waarmee de TokenCredential-interface wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Waarde van eigenschap

overgenomen van StorageClient.credential

Gecodeerde URL-tekenreekswaarde.

url: string

Waarde van eigenschap

overgenomen van StorageClient.url

Hiermee maakt u een nieuw bestandssysteem onder het opgegeven account. Als het bestandssysteem met dezelfde naam al bestaat, mislukt de bewerking.

Zie https://free.blessedness.top/rest/api/storageservices/create-container

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

Parameters

Retouren

Hiermee maakt u een nieuw bestandssysteem onder het opgegeven account. Als het bestandssysteem met dezelfde naam al bestaat, wordt het niet gewijzigd.

Zie https://free.blessedness.top/rest/api/storageservices/create-container

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

Parameters

Retouren

Verwijder het huidige bestandssysteem.

Zie https://free.blessedness.top/rest/api/storageservices/delete-container

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

Parameters

Retouren

Verwijder het huidige bestandssysteem als het bestaat.

Zie https://free.blessedness.top/rest/api/storageservices/delete-container

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

Parameters

Retouren

Retourneert waar als het bestandssysteem dat wordt vertegenwoordigd door deze client bestaat; anders onwaar.

OPMERKING: gebruik deze functie met zorg omdat een bestaand bestandssysteem kan worden verwijderd door andere clients of toepassingen. Omgekeerd kan het nieuwe bestandssysteem met dezelfde naam worden toegevoegd door andere clients of toepassingen nadat deze functie is voltooid.

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

Parameters

Retouren

Alleen beschikbaar voor DataLakeFileSystemClient die is samengesteld met een gedeelde sleutelreferentie.

Hiermee wordt een tekenreeks gegenereerd die moet worden ondertekend voor een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client.

Zie https://free.blessedness.top/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: FileSystemGenerateSasUrlOptions): string

Parameters

Retouren

De SAS-URI die bestaat uit de URI voor de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.

Alleen beschikbaar voor DataLakeFileSystemClient die is samengesteld met een gedeelde sleutelreferentie.

Hiermee genereert u een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client.

Zie https://free.blessedness.top/rest/api/storageservices/constructing-a-service-sas

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

Parameters

Retouren

De SAS-URI die bestaat uit de URI voor de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.

Hiermee wordt een tekenreeks gegenereerd die moet worden ondertekend voor een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS is ondertekend door de overdrachtssleutel van de invoergebruiker.

Zie https://free.blessedness.top/rest/api/storageservices/constructing-a-service-sas

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

Parameters

Retouren

De SAS-URI die bestaat uit de URI voor de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.

Hiermee genereert u een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS is ondertekend door de overdrachtssleutel van de invoergebruiker.

Zie https://free.blessedness.top/rest/api/storageservices/constructing-a-service-sas

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

Parameters

Retouren

De SAS-URI die bestaat uit de URI voor de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.

Hiermee haalt u de machtigingen voor het opgegeven bestandssysteem op. De machtigingen geven aan of bestandssysteemgegevens openbaar toegankelijk zijn.

WAARSCHUWING: JavaScript-datum verliest mogelijk precisie bij het parseren van startsOn- en expiresOn-tekenreeksen. Nieuwe datum("2018-12-31T03:44:23.8827891Z").toISOString() krijgt bijvoorbeeld '2018-12-31T03:44:23.882Z'.

Zie https://free.blessedness.top/rest/api/storageservices/get-container-acl

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

Parameters

Retouren

Haal een DataLakeLeaseClient- op die leases beheert op het bestandssysteem.

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parameters

Retouren

Hiermee maakt u een DataLakeDirectoryClient--object onder het huidige bestandssysteem.

function getDirectoryClient(directoryName: string): DataLakeDirectoryClient

Parameters

Retouren

Hiermee maakt u een DataLakeFileClient--object onder het huidige bestandssysteem.

function getFileClient(fileName: string): DataLakeFileClient

Parameters

Retouren

Retourneert alle door de gebruiker gedefinieerde metagegevens en systeemeigenschappen voor het opgegeven bestandssysteem.

WAARSCHUWING: het metadata object dat in het antwoord wordt geretourneerd, bevat de sleutels in kleine letters, zelfs als ze oorspronkelijk hoofdletters bevatten. Dit verschilt van de metagegevenssleutels die worden geretourneerd door de listFileSystems methode van DataLakeServiceClient met behulp van de optie includeMetadata, waarmee de oorspronkelijke behuizing wordt behouden.

Zie https://free.blessedness.top/rest/api/storageservices/get-container-properties

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

Parameters

Retouren

Retourneert een asynchrone iterator om alle paden (mappen en bestanden) onder het opgegeven bestandssysteem weer te geven.

.byPage() retourneert een asynchrone iterator om de paden in pagina's weer te geven.

Voorbeeld van for await syntaxis:

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

Voorbeeld met: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());
}

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

Voorbeeld van het gebruik van paging met een markering:

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

Zie https://free.blessedness.top/rest/api/storageservices/list-blobs

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

Parameters

Retouren

Retourneert een asynchrone iterator om alle paden (mappen en bestanden) onder het opgegeven bestandssysteem weer te geven.

.byPage() retourneert een asynchrone iterator om de paden in pagina's weer te geven.

Voorbeeld van for await syntaxis:

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

Voorbeeld met: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());
}

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

Voorbeeld van het gebruik van paging met een markering:

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

Zie https://free.blessedness.top/rest/api/storageservices/list-blobs

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

Parameters

Retouren

Hiermee stelt u de machtigingen voor het opgegeven bestandssysteem in. De machtigingen geven aan of mappen of bestanden in een bestandssysteem openbaar toegankelijk zijn.

Wanneer u machtigingen voor een bestandssysteem instelt, worden de bestaande machtigingen vervangen. Als er geen toegang of containerAcl is opgegeven, wordt de bestaande ACL van het bestandssysteem verwijderd.

Zie https://free.blessedness.top/rest/api/storageservices/set-container-acl

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

Parameters

Retouren

Hiermee stelt u een of meer door de gebruiker gedefinieerde naam-waardeparen in voor het opgegeven bestandssysteem.

Als er geen optie is opgegeven of als er geen metagegevens zijn gedefinieerd in de parameter, worden de metagegevens van het bestandssysteem verwijderd.

Zie https://free.blessedness.top/rest/api/storageservices/set-container-metadata

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

Parameters

Retouren

Hiermee herstelt u een voorlopig verwijderd pad.

Zie https://free.blessedness.top/rest/api/storageservices/undelete-blob

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

Parameters

Retouren