Delen via

DataLakeFileSystemClient class

  • Referentie
Pakket:
@azure/storage-file-datalake

Een DataLakeFileSystemClient vertegenwoordigt een URL naar het Azure Storage-bestandssysteem, zodat u de mappen en bestanden kunt bewerken.

Uitbreiding

StorageClient

Constructors

DataLakeFileSystemClient(string, Pipeline)

Hiermee maakt u een exemplaar van DataLakeFileSystemClient op basis van url en pijplijn.
DataLakeFileSystemClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

Eigenschappen

name

Naam van het huidige bestandssysteem.

Overgenomen eigenschappen

accountName
credential

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

Gecodeerde URL-tekenreekswaarde.

Methoden

create(FileSystemCreateOptions)

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

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

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

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

Verwijder het huidige bestandssysteem.

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

Verwijder het huidige bestandssysteem als het bestaat.

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

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.
generateSasStringToSign(FileSystemGenerateSasUrlOptions)

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://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(FileSystemGenerateSasUrlOptions)

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://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasStringToSign(FileSystemGenerateSasUrlOptions, UserDelegationKey)

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://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(FileSystemGenerateSasUrlOptions, UserDelegationKey)

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://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAccessPolicy(FileSystemGetAccessPolicyOptions)

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://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl
getDataLakeLeaseClient(string)

Haal een DataLakeLeaseClient- op die leases beheert op het bestandssysteem.
getDirectoryClient(string)

Hiermee maakt u een DataLakeDirectoryClient--object onder het huidige bestandssysteem.
getFileClient(string)

Hiermee maakt u een DataLakeFileClient--object onder het huidige bestandssysteem.
getProperties(FileSystemGetPropertiesOptions)

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://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties
listDeletedPaths(ListDeletedPathsOptions)

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:

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

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

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

Voorbeeld van het gebruik van paging met een markering:

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

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

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:

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

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

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

Voorbeeld van het gebruik van paging met een markering:

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

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

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://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl
setMetadata(Metadata, FileSystemSetMetadataOptions)

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://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata
undeletePath(string, string, FileSystemUndeletePathOption)

Hiermee herstelt u een voorlopig verwijderd pad.

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

Constructordetails

DataLakeFileSystemClient(string, Pipeline)

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

new DataLakeFileSystemClient(url: string, pipeline: Pipeline)

Parameters

url

string

Een clienttekenreeks die verwijst naar het Bestandssysteem van Azure Storage Data Lake, zoals 'https://myaccount.dfs.core.windows.net/filesystem". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals 'https://myaccount.dfs.core.windows.net/filesystem?sasString".

pipeline
Pipeline

Roep newPipeline() aan om een standaardpijplijn te maken of geef een aangepaste pijplijn op.

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

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

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

Parameters

url

string

Een clienttekenreeks die verwijst naar het Bestandssysteem van Azure Storage Data Lake, zoals 'https://myaccount.dfs.core.windows.net/filesystem". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals 'https://myaccount.dfs.core.windows.net/filesystem?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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.

options
StoragePipelineOptions

Facultatief. Opties voor het configureren van de HTTP-pijplijn.

Eigenschapdetails

name

Naam van het huidige bestandssysteem.

string name

Waarde van eigenschap

string

Details van overgenomen eigenschap

accountName 

accountName: string

Waarde van eigenschap

string

overgenomen van StorageClient.accountName

credential

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

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

overgenomen van StorageClient.credential

url

Gecodeerde URL-tekenreekswaarde.

url: string

Waarde van eigenschap

string

overgenomen van StorageClient.url

Methodedetails

create(FileSystemCreateOptions)

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

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

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

Parameters

options
FileSystemCreateOptions

Facultatief. Opties bij het maken van een bestandssysteem.

Retouren

Promise<FileSystemCreateResponse>

createIfNotExists(FileSystemCreateOptions)

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

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

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

Parameters

options
FileSystemCreateOptions

Retouren

Promise<FileSystemCreateIfNotExistsResponse>

delete(FileSystemDeleteOptions)

Verwijder het huidige bestandssysteem.

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

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

Parameters

options
FileSystemDeleteOptions

Facultatief. Opties bij het verwijderen van bestandssysteem.

Retouren

Promise<FileSystemDeleteResponse>

deleteIfExists(FileSystemDeleteOptions)

Verwijder het huidige bestandssysteem als het bestaat.

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

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

Parameters

options
FileSystemDeleteOptions

Retouren

Promise<FileSystemDeleteIfExistsResponse>

exists(FileSystemExistsOptions)

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

options
FileSystemExistsOptions

Retouren

Promise<boolean>

generateSasStringToSign(FileSystemGenerateSasUrlOptions)

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://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: FileSystemGenerateSasUrlOptions): string

Parameters

options
FileSystemGenerateSasUrlOptions

Optionele parameters.

Retouren

string

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

generateSasUrl(FileSystemGenerateSasUrlOptions)

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://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

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

Parameters

options
FileSystemGenerateSasUrlOptions

Optionele parameters.

Retouren

Promise<string>

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

generateUserDelegationSasStringToSign(FileSystemGenerateSasUrlOptions, UserDelegationKey)

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://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

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

Parameters

options
FileSystemGenerateSasUrlOptions

Optionele parameters.

userDelegationKey
UserDelegationKey

Retourwaarde van blobServiceClient.getUserDelegationKey()

Retouren

string

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

generateUserDelegationSasUrl(FileSystemGenerateSasUrlOptions, UserDelegationKey)

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://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

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

Parameters

options
FileSystemGenerateSasUrlOptions

Optionele parameters.

userDelegationKey
UserDelegationKey

Retourwaarde van blobServiceClient.getUserDelegationKey()

Retouren

Promise<string>

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

getAccessPolicy(FileSystemGetAccessPolicyOptions)

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://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl

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

Parameters

options
FileSystemGetAccessPolicyOptions

Facultatief. Opties bij het verkrijgen van toegangsbeleid voor bestandssysteem.

Retouren

Promise<FileSystemGetAccessPolicyResponse>

getDataLakeLeaseClient(string)

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

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parameters

proposeLeaseId

string

Facultatief. Oorspronkelijke voorgestelde lease-id.

Retouren

DataLakeLeaseClient

getDirectoryClient(string)

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

function getDirectoryClient(directoryName: string): DataLakeDirectoryClient

Parameters

directoryName

string

Retouren

DataLakeDirectoryClient

getFileClient(string)

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

function getFileClient(fileName: string): DataLakeFileClient

Parameters

fileName

string

Retouren

DataLakeFileClient

getProperties(FileSystemGetPropertiesOptions)

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://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties

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

Parameters

options
FileSystemGetPropertiesOptions

Facultatief. Opties bij het ophalen van eigenschappen van het bestandssysteem.

Retouren

Promise<FileSystemGetPropertiesResponse>

listDeletedPaths(ListDeletedPathsOptions)

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:

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

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

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

Voorbeeld van het gebruik van paging met een markering:

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

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

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

Parameters

options
ListDeletedPathsOptions

Facultatief. Opties bij het weergeven van verwijderde paden.

Retouren

PagedAsyncIterableIterator<DeletedPath, FileSystemListDeletedPathsResponse, PageSettings>

listPaths(ListPathsOptions)

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:

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

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

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

Voorbeeld van het gebruik van paging met een markering:

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

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

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

Parameters

options
ListPathsOptions

Facultatief. Opties bij het weergeven van paden.

Retouren

PagedAsyncIterableIterator<Path, FileSystemListPathsResponse, PageSettings>

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

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://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl

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

Parameters

access
PublicAccessType

Facultatief. Het niveau van openbare toegang tot gegevens in het bestandssysteem.

fileSystemAcl

SignedIdentifier<AccessPolicy>[]

Facultatief. Matrix van elementen met elk een unieke id en details van het toegangsbeleid.

options
FileSystemSetAccessPolicyOptions

Facultatief. Opties bij het instellen van toegangsbeleid voor bestandssysteem.

Retouren

Promise<FileSystemSetAccessPolicyResponse>

setMetadata(Metadata, FileSystemSetMetadataOptions)

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://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata

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

Parameters

metadata
Metadata

Vervang bestaande metagegevens door deze waarde. Als er geen waarde is opgegeven, worden de bestaande metagegevens verwijderd.

options
FileSystemSetMetadataOptions

Facultatief. Opties bij het instellen van metagegevens van het bestandssysteem.

Retouren

Promise<FileSystemSetMetadataResponse>

undeletePath(string, string, FileSystemUndeletePathOption)

Hiermee herstelt u een voorlopig verwijderd pad.

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

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

Parameters

deletedPath

string

Vereist. Het pad van het verwijderde pad.

deletionId

string

Vereist. De verwijderings-id die is gekoppeld aan het pad voor voorlopig verwijderd.

options
FileSystemUndeletePathOption

Retouren

Promise<FileSystemUndeletePathResponse>