DataLakeFileSystemClient class
En DataLakeFileSystemClient representerar en URL till Azure Storage-filsystemet så att du kan ändra dess kataloger och filer.
- Extends
-
StorageClient
Konstruktorer
Data |
Skapar en instans av DataLakeFileSystemClient från URL och pipeline. |
Data |
Skapar en instans av DataLakeFileSystemClient från URL och autentiseringsuppgifter. |
Egenskaper
name | Namnet på det aktuella filsystemet. |
Ärvda egenskaper
account |
|
credential | Till exempel AnonymousCredential, StorageSharedKeyCredential eller autentiseringsuppgifter från paketet för att autentisera |
url | Kodat URL-strängvärde. |
Metoder
create(File |
Skapar ett nytt filsystem under det angivna kontot. Om filsystemet med samma namn redan finns misslyckas åtgärden. Se https://docs.microsoft.com/en-us/rest/api/storageservices/create-container |
create |
Skapar ett nytt filsystem under det angivna kontot. Om filsystemet med samma namn redan finns ändras det inte. Se https://docs.microsoft.com/en-us/rest/api/storageservices/create-container |
delete(File |
Ta bort det aktuella filsystemet. Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container |
delete |
Ta bort det aktuella filsystemet om det finns. Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container |
exists(File |
Returnerar sant om filsystemet som representeras av den här klienten finns. annars falskt. Obs! Använd den här funktionen med försiktighet eftersom ett befintligt filsystem kan tas bort av andra klienter eller program. Tvärtom kan ett nytt filsystem med samma namn läggas till av andra klienter eller program när den här funktionen har slutförts. |
generate |
Endast tillgängligt för DataLakeFileSystemClient som skapats med en autentiseringsuppgift med delad nyckel. Genererar en SAS-URI (Service Shared Access Signature) baserat på de klientegenskaper och parametrar som skickas. SAS signeras av klientens autentiseringsuppgifter för delad nyckel. Se https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas |
get |
Hämtar behörigheterna för det angivna filsystemet. Behörigheterna anger om filsystemdata kan nås offentligt. VARNING! JavaScript-datum kan förlora precision när du parsar startsOn och expiresOn-strängar. Till exempel får new Date("2018-12-31T03:44:23.8827891Z").toISOString() "2018-12-31T03:44:23.882Z". Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl |
get |
Hämta en DataLakeLeaseClient som hanterar lån i filsystemet. |
get |
Skapar ett DataLakeDirectoryClient-objekt under det aktuella filsystemet. |
get |
Skapar ett DataLakeFileClient-objekt under det aktuella filsystemet. |
get |
Returnerar alla användardefinierade metadata och systemegenskaper för det angivna filsystemet. VARNING! Objektet Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties |
list |
Returnerar en iterabel iterator som kan asynkroniseras för att visa alla sökvägar (kataloger och filer) under det angivna filsystemet. .byPage() returnerar en iterabel iterator som kan asynkroniseras för att visa sökvägarna på sidor. Exempel med syntax
Exempel med
Exempel med
Exempel med växling med en markör:
Se https://docs.microsoft.com/rest/api/storageservices/list-blobs |
list |
Returnerar en iterabel iterator som kan asynkroniseras för att visa alla sökvägar (kataloger och filer) under det angivna filsystemet. .byPage() returnerar en iterabel iterator som kan asynkroniseras för att visa sökvägarna på sidor. Exempel med syntax
Exempel med
Exempel med
Exempel med växling med en markör:
Se https://docs.microsoft.com/rest/api/storageservices/list-blobs |
set |
Anger behörigheter för det angivna filsystemet. Behörigheterna anger om kataloger eller filer i ett filsystem kan kommas åt offentligt. När du anger behörigheter för ett filsystem ersätts de befintliga behörigheterna. Om ingen åtkomst eller containerAcl har angetts tas det befintliga filsystemets ACL bort. Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl |
set |
Anger ett eller flera användardefinierade namn/värde-par för det angivna filsystemet. Om inget alternativ anges eller inga metadata definieras i parametern tas filsystemets metadata bort. Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata |
undelete |
Återställer en mjukt borttagen sökväg. Se https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob |
Konstruktorinformation
DataLakeFileSystemClient(string, Pipeline)
Skapar en instans av DataLakeFileSystemClient från URL och pipeline.
new DataLakeFileSystemClient(url: string, pipeline: Pipeline)
Parametrar
- url
-
string
En klientsträng som pekar på Azure Storages data lake-filsystem, till exempel "https://myaccount.dfs.core.windows.net/filesystem". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.dfs.core.windows.net/filesystem?sasString".
- pipeline
- Pipeline
Anropa newPipeline() för att skapa en standardpipeline eller ange en anpassad pipeline.
DataLakeFileSystemClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Skapar en instans av DataLakeFileSystemClient från URL och autentiseringsuppgifter.
new DataLakeFileSystemClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
Parametrar
- url
-
string
En klientsträng som pekar på Azure Storages data lake-filsystem, till exempel "https://myaccount.dfs.core.windows.net/filesystem". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.dfs.core.windows.net/filesystem?sasString".
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Till exempel AnonymousCredential, StorageSharedKeyCredential eller autentiseringsuppgifter från paketet för att autentisera @azure/identity
begäranden till tjänsten. Du kan också ange ett objekt som implementerar TokenCredential-gränssnittet. Om det inte anges används AnonymousCredential.
- options
- StoragePipelineOptions
Valfritt. Alternativ för att konfigurera HTTP-pipelinen.
Egenskapsinformation
name
Namnet på det aktuella filsystemet.
string name
Egenskapsvärde
string
Information om ärvda egenskaper
accountName
accountName: string
Egenskapsvärde
string
Ärvd från StorageClient.accountName
credential
Till exempel AnonymousCredential, StorageSharedKeyCredential eller autentiseringsuppgifter från paketet för att autentisera @azure/identity
begäranden till tjänsten. Du kan också ange ett objekt som implementerar TokenCredential-gränssnittet. Om det inte anges används AnonymousCredential.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Egenskapsvärde
Ärvd från StorageClient.credential
url
Kodat URL-strängvärde.
url: string
Egenskapsvärde
string
Ärvd från StorageClient.url
Metodinformation
create(FileSystemCreateOptions)
Skapar ett nytt filsystem under det angivna kontot. Om filsystemet med samma namn redan finns misslyckas åtgärden.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/create-container
function create(options?: FileSystemCreateOptions): Promise<FileSystemCreateResponse>
Parametrar
- options
- FileSystemCreateOptions
Valfritt. Alternativ när du skapar filsystem.
Returer
Promise<FileSystemCreateResponse>
createIfNotExists(FileSystemCreateOptions)
Skapar ett nytt filsystem under det angivna kontot. Om filsystemet med samma namn redan finns ändras det inte.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/create-container
function createIfNotExists(options?: FileSystemCreateOptions): Promise<FileSystemCreateIfNotExistsResponse>
Parametrar
- options
- FileSystemCreateOptions
Returer
Promise<FileSystemCreateIfNotExistsResponse>
delete(FileSystemDeleteOptions)
Ta bort det aktuella filsystemet.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container
function delete(options?: FileSystemDeleteOptions): Promise<FileSystemDeleteResponse>
Parametrar
- options
- FileSystemDeleteOptions
Valfritt. Alternativ vid borttagning av filsystem.
Returer
Promise<FileSystemDeleteResponse>
deleteIfExists(FileSystemDeleteOptions)
Ta bort det aktuella filsystemet om det finns.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container
function deleteIfExists(options?: FileSystemDeleteOptions): Promise<FileSystemDeleteIfExistsResponse>
Parametrar
- options
- FileSystemDeleteOptions
Returer
Promise<FileSystemDeleteIfExistsResponse>
exists(FileSystemExistsOptions)
Returnerar sant om filsystemet som representeras av den här klienten finns. annars falskt.
Obs! Använd den här funktionen med försiktighet eftersom ett befintligt filsystem kan tas bort av andra klienter eller program. Tvärtom kan ett nytt filsystem med samma namn läggas till av andra klienter eller program när den här funktionen har slutförts.
function exists(options?: FileSystemExistsOptions): Promise<boolean>
Parametrar
- options
- FileSystemExistsOptions
Returer
Promise<boolean>
generateSasUrl(FileSystemGenerateSasUrlOptions)
Endast tillgängligt för DataLakeFileSystemClient som skapats med en autentiseringsuppgift med delad nyckel.
Genererar en SAS-URI (Service Shared Access Signature) baserat på de klientegenskaper och parametrar som skickas. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateSasUrl(options: FileSystemGenerateSasUrlOptions): Promise<string>
Parametrar
- options
- FileSystemGenerateSasUrlOptions
Valfria parametrar.
Returer
Promise<string>
SAS-URI:n som består av URI:n för den resurs som representeras av den här klienten, följt av den genererade SAS-token.
getAccessPolicy(FileSystemGetAccessPolicyOptions)
Hämtar behörigheterna för det angivna filsystemet. Behörigheterna anger om filsystemdata kan nås offentligt.
VARNING! JavaScript-datum kan förlora precision när du parsar startsOn och expiresOn-strängar. Till exempel får new Date("2018-12-31T03:44:23.8827891Z").toISOString() "2018-12-31T03:44:23.882Z".
Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl
function getAccessPolicy(options?: FileSystemGetAccessPolicyOptions): Promise<FileSystemGetAccessPolicyResponse>
Parametrar
- options
- FileSystemGetAccessPolicyOptions
Valfritt. Alternativ när du hämtar åtkomstprincip för filsystem.
Returer
Promise<FileSystemGetAccessPolicyResponse>
getDataLakeLeaseClient(string)
Hämta en DataLakeLeaseClient som hanterar lån i filsystemet.
function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient
Parametrar
- proposeLeaseId
-
string
Valfritt. Ursprungligt föreslaget låne-ID.
Returer
getDirectoryClient(string)
Skapar ett DataLakeDirectoryClient-objekt under det aktuella filsystemet.
function getDirectoryClient(directoryName: string): DataLakeDirectoryClient
Parametrar
- directoryName
-
string
Returer
getFileClient(string)
Skapar ett DataLakeFileClient-objekt under det aktuella filsystemet.
function getFileClient(fileName: string): DataLakeFileClient
Parametrar
- fileName
-
string
Returer
getProperties(FileSystemGetPropertiesOptions)
Returnerar alla användardefinierade metadata och systemegenskaper för det angivna filsystemet.
VARNING! Objektet metadata
som returneras i svaret har sina nycklar i gemener, även om de ursprungligen innehöll versaler. Detta skiljer sig från de metadatanycklar som returneras av listFileSystems
metoden DataLakeServiceClient med hjälp includeMetadata
av alternativet, som behåller sitt ursprungliga hölje.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties
function getProperties(options?: FileSystemGetPropertiesOptions): Promise<FileSystemGetPropertiesResponse>
Parametrar
- options
- FileSystemGetPropertiesOptions
Valfritt. Alternativ när filsystemegenskaper hämtas.
Returer
Promise<FileSystemGetPropertiesResponse>
listDeletedPaths(ListDeletedPathsOptions)
Returnerar en iterabel iterator som kan asynkroniseras för att visa alla sökvägar (kataloger och filer) under det angivna filsystemet.
.byPage() returnerar en iterabel iterator som kan asynkroniseras för att visa sökvägarna på sidor.
Exempel med syntax 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}`);
}
Exempel med 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();
}
Exempel med 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}`);
}
}
Exempel med växling med en markör:
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}`);
}
Se https://docs.microsoft.com/rest/api/storageservices/list-blobs
function listDeletedPaths(options?: ListDeletedPathsOptions): PagedAsyncIterableIterator<DeletedPath, FileSystemListDeletedPathsResponse, PageSettings>
Parametrar
- options
- ListDeletedPathsOptions
Valfritt. Alternativ när du listar borttagna sökvägar.
Returer
listPaths(ListPathsOptions)
Returnerar en iterabel iterator som kan asynkroniseras för att visa alla sökvägar (kataloger och filer) under det angivna filsystemet.
.byPage() returnerar en iterabel iterator som kan asynkroniseras för att visa sökvägarna på sidor.
Exempel med syntax 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}`);
}
Exempel med 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();
}
Exempel med 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}`);
}
}
Exempel med växling med en markör:
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}`);
}
Se https://docs.microsoft.com/rest/api/storageservices/list-blobs
function listPaths(options?: ListPathsOptions): PagedAsyncIterableIterator<Path, FileSystemListPathsResponse, PageSettings>
Parametrar
- options
- ListPathsOptions
Valfritt. Alternativ när sökvägar listas.
Returer
setAccessPolicy(PublicAccessType, SignedIdentifier<AccessPolicy>[], FileSystemSetAccessPolicyOptions)
Anger behörigheter för det angivna filsystemet. Behörigheterna anger om kataloger eller filer i ett filsystem kan kommas åt offentligt.
När du anger behörigheter för ett filsystem ersätts de befintliga behörigheterna. Om ingen åtkomst eller containerAcl har angetts tas det befintliga filsystemets ACL bort.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl
function setAccessPolicy(access?: PublicAccessType, fileSystemAcl?: SignedIdentifier<AccessPolicy>[], options?: FileSystemSetAccessPolicyOptions): Promise<FileSystemSetAccessPolicyResponse>
Parametrar
- access
- PublicAccessType
Valfritt. Nivån för offentlig åtkomst till data i filsystemet.
- fileSystemAcl
Valfritt. Matris med element som var och en har ett unikt ID och information om åtkomstprincipen.
- options
- FileSystemSetAccessPolicyOptions
Valfritt. Alternativ när du anger åtkomstprincip för filsystem.
Returer
Promise<FileSystemSetAccessPolicyResponse>
setMetadata(Metadata, FileSystemSetMetadataOptions)
Anger ett eller flera användardefinierade namn/värde-par för det angivna filsystemet.
Om inget alternativ anges eller inga metadata definieras i parametern tas filsystemets metadata bort.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata
function setMetadata(metadata?: Metadata, options?: FileSystemSetMetadataOptions): Promise<FileSystemSetMetadataResponse>
Parametrar
- metadata
- Metadata
Ersätt befintliga metadata med det här värdet. Om inget värde anges tas befintliga metadata bort.
- options
- FileSystemSetMetadataOptions
Valfritt. Alternativ vid inställning av filsystemmetadata.
Returer
Promise<FileSystemSetMetadataResponse>
undeletePath(string, string, FileSystemUndeletePathOption)
Återställer en mjukt borttagen sökväg.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
function undeletePath(deletedPath: string, deletionId: string, options?: FileSystemUndeletePathOption): Promise<FileSystemUndeletePathResponse>
Parametrar
- deletedPath
-
string
Krävs. Sökvägen till den borttagna sökvägen.
- deletionId
-
string
Krävs. Det borttagnings-ID som är associerat med den mjukt borttagna sökvägen.
- options
- FileSystemUndeletePathOption
Returer
Promise<FileSystemUndeletePathResponse>