DataLakeFileClient class
En DataLakeFileClient representerar en URL till Azure Storage-filen.
- Extends
Konstruktorer
Data |
Skapar en instans av DataLakeFileClient från URL och pipeline. |
Data |
Skapar en instans av DataLakeFileClient från URL och autentiseringsuppgifter. |
Egenskaper
file |
Namnet på det aktuella filsystemet. |
name | Namn på aktuell sökväg (katalog eller fil). |
Ärvda egenskaper
account |
|
credential | Till exempel AnonymousCredential, StorageSharedKeyCredential eller autentiseringsuppgifter från paketet för att autentisera |
url | Kodat URL-strängvärde. |
Metoder
append(Request |
Laddar upp data som ska läggas till i en fil. Data kan bara läggas till i en fil. Om du vill använda perviously uppladdade data på en fil anropar du flush. Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update |
create(File |
Skapa en fil. Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create |
create(Path |
Skapa en fil. Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create |
create |
Skapa en fil om den inte redan finns. Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create |
create |
Skapa en fil om den inte redan finns. Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create |
flush(number, File |
Tömer (skriver) data som tidigare har bifogats till en fil. |
generate |
Endast tillgängligt för klienter 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 |
query(string, File |
Snabbfråga för en JSON- eller CSV-formaterad fil. Exempel på användning (Node.js):
|
read(number, number, File |
Laddar ned en fil från tjänsten, inklusive dess metadata och egenskaper.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
Exempel på användning (webbläsare):
|
read |
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Läser en Data Lake-fil parallellt med en buffert. Förskjutning och antal är valfria, skicka 0 för att båda ska kunna läsa hela filen. Varning! Buffertar kan bara ha stöd för filer upp till ungefär en gigabyte på 32-bitarssystem eller cirka två gigabyte på 64-bitarssystem på grund av begränsningar för Node.js/V8. Överväg att läsaToFile för filer som är större än den här storleken. |
read |
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME Läser en Data Lake-fil parallellt med en buffert. Förskjutning och antal är valfria, skicka 0 för att båda ska läsa hela filen Varning! Buffertar kan bara ha stöd för filer upp till ungefär en gigabyte på 32-bitarssystem eller cirka två gigabyte på 64-bitarssystem på grund av begränsningar för Node.js/V8. Överväg att läsaToFile för filer som är större än den här storleken. |
read |
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar ned en Data Lake-fil till en lokal fil. Misslyckas om den angivna filsökvägen redan avslutas. Förskjutning och antal är valfria, skicka 0 respektive odefinierat för att ladda ned hela filen. |
set |
Anger en förfallotid för en fil, när den tiden har uppnåtts tas filen bort. |
upload(Blob | Array |
Laddar upp en buffert(Node.js)/Blob/ArrayBuffer/ArrayBufferView till en fil. |
upload |
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar upp en lokal fil till en Data Lake-fil. |
upload |
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar upp en Node.js läsbar dataström till en Data Lake-fil. Den här metoden försöker skapa en fil och börjar sedan ladda upp segment för segment. Kontrollera att den potentiella storleken på strömmen inte överskrider FILE_MAX_SIZE_BYTES och att det potentiella antalet segment inte överskrider BLOCK_BLOB_MAX_BLOCKS. TIPS FÖR PRESTANDAFÖRBÄTTRING:
|
Ärvda metoder
Konstruktorinformation
DataLakeFileClient(string, Pipeline)
Skapar en instans av DataLakeFileClient från URL och pipeline.
new DataLakeFileClient(url: string, pipeline: Pipeline)
Parametrar
- url
-
string
En klientsträng som pekar på Azure Storage-datasjöfilen, till exempel "https://myaccount.dfs.core.windows.net/filesystem/file". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.dfs.core.windows.net/filesystem/directory/file?sasString".
- pipeline
- Pipeline
Anropa newPipeline() för att skapa en standardpipeline eller ange en anpassad pipeline.
DataLakeFileClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Skapar en instans av DataLakeFileClient från URL och autentiseringsuppgifter.
new DataLakeFileClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
Parametrar
- url
-
string
En klientsträng som pekar på Azure Storage-datasjöfilen, till exempel "https://myaccount.dfs.core.windows.net/filesystem/file". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.dfs.core.windows.net/filesystem/directory/file?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 inget anges används AnonymousCredential.
- options
- StoragePipelineOptions
Valfritt. Alternativ för att konfigurera HTTP-pipelinen.
Egenskapsinformation
fileSystemName
Namnet på det aktuella filsystemet.
string fileSystemName
Egenskapsvärde
string
name
Namn på aktuell sökväg (katalog eller fil).
string name
Egenskapsvärde
string
Information om ärvda egenskaper
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ånDataLakePathClient.credential
url
Metodinformation
append(RequestBodyType, number, number, FileAppendOptions)
Laddar upp data som ska läggas till i en fil. Data kan bara läggas till i en fil. Om du vill använda perviously uppladdade data på en fil anropar du flush.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function append(body: RequestBodyType, offset: number, length: number, options?: FileAppendOptions): Promise<FileAppendResponse>
Parametrar
- body
- HttpRequestBody
Innehåll som ska laddas upp.
- offset
-
number
Lägg till förskjutning i byte.
- length
-
number
Längden på innehållet som ska läggas till i byte.
- options
- FileAppendOptions
Valfritt. Alternativ när data ska läggas till.
Returer
Promise<FileAppendResponse>
create(FileCreateOptions)
Skapa en fil.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function create(options?: FileCreateOptions): Promise<FileCreateResponse>
Parametrar
- options
- FileCreateOptions
Valfritt. Alternativ när du skapar en fil.
Returer
Promise<FileCreateResponse>
create(PathResourceTypeModel, PathCreateOptions)
Skapa en fil.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function create(resourceType: PathResourceTypeModel, options?: PathCreateOptions): Promise<PathCreateResponse>
Parametrar
- resourceType
- PathResourceTypeModel
Resurstyp, måste vara "fil" för DataLakeFileClient.
- options
- PathCreateOptions
Valfritt. Alternativ när du skapar en fil.
Returer
Promise<PathCreateResponse>
createIfNotExists(FileCreateIfNotExistsOptions)
Skapa en fil om den inte redan finns.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function createIfNotExists(options?: FileCreateIfNotExistsOptions): Promise<FileCreateIfNotExistsResponse>
Parametrar
- options
- FileCreateIfNotExistsOptions
Valfritt. Alternativ när du skapar en fil.
Returer
Promise<FileCreateIfNotExistsResponse>
createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)
Skapa en fil om den inte redan finns.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function createIfNotExists(resourceType: PathResourceTypeModel, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>
Parametrar
- resourceType
- PathResourceTypeModel
Resurstyp, måste vara "fil" för DataLakeFileClient.
- options
- PathCreateIfNotExistsOptions
Returer
Promise<PathCreateIfNotExistsResponse>
flush(number, FileFlushOptions)
Tömer (skriver) data som tidigare har bifogats till en fil.
function flush(position: number, options?: FileFlushOptions): Promise<FileFlushResponse>
Parametrar
- position
-
number
Filposition att tömma. Med den här parametern kan anroparen ladda upp data parallellt och styra i vilken ordning den läggs till i filen. Det krävs när du laddar upp data som ska läggas till i filen och vid tömning av tidigare uppladdade data till filen. Värdet måste vara den position där data ska läggas till. Uppladdade data rensas inte omedelbart, eller skrivs, till filen. För att rensa måste tidigare uppladdade data vara sammanhängande, positionsparametern måste anges och vara lika med filens längd när alla data har skrivits och det får inte finnas en begärandeentitetstext som ingår i begäran.
- options
- FileFlushOptions
Valfritt. Alternativ vid tömning av data.
Returer
Promise<FileFlushResponse>
generateSasUrl(FileGenerateSasUrlOptions)
Endast tillgängligt för klienter 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: FileGenerateSasUrlOptions): Promise<string>
Parametrar
- options
- FileGenerateSasUrlOptions
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.
query(string, FileQueryOptions)
Snabbfråga för en JSON- eller CSV-formaterad fil.
Exempel på användning (Node.js):
// Query and convert a file to a string
const queryResponse = await fileClient.query("select * from BlobStorage");
const downloaded = (await streamToBuffer(queryResponse.readableStreamBody)).toString();
console.log("Query file content:", downloaded);
async function streamToBuffer(readableStream) {
return new Promise((resolve, reject) => {
const chunks = [];
readableStream.on("data", (data) => {
chunks.push(data instanceof Buffer ? data : Buffer.from(data));
});
readableStream.on("end", () => {
resolve(Buffer.concat(chunks));
});
readableStream.on("error", reject);
});
}
function query(query: string, options?: FileQueryOptions): Promise<FileReadResponse>
Parametrar
- query
-
string
- options
- FileQueryOptions
Returer
Promise<FileReadResponse>
read(number, number, FileReadOptions)
Laddar ned en fil från tjänsten, inklusive dess metadata och egenskaper.
- I Node.js returnerar data i en läsbar dataström readableStreamBody
- I webbläsare returnerar data i ett löftesinnehållAsBlob
Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
- Exempel på användning (Node.js):
// Download and convert a file to a string
const downloadResponse = await fileClient.read();
const downloaded = await streamToBuffer(downloadResponse.readableStreamBody);
console.log("Downloaded file content:", downloaded.toString());
async function streamToBuffer(readableStream) {
return new Promise((resolve, reject) => {
const chunks = [];
readableStream.on("data", (data) => {
chunks.push(data instanceof Buffer ? data : Buffer.from(data));
});
readableStream.on("end", () => {
resolve(Buffer.concat(chunks));
});
readableStream.on("error", reject);
});
}
Exempel på användning (webbläsare):
// Download and convert a file to a string
const downloadResponse = await fileClient.read();
const downloaded = await blobToString(await downloadResponse.contentAsBlob);
console.log("Downloaded file content", downloaded);
async function blobToString(blob: Blob): Promise<string> {
const fileReader = new FileReader();
return new Promise<string>((resolve, reject) => {
fileReader.onloadend = (ev: any) => {
resolve(ev.target!.result);
};
fileReader.onerror = reject;
fileReader.readAsText(blob);
});
}
function read(offset?: number, count?: number, options?: FileReadOptions): Promise<FileReadResponse>
Parametrar
- offset
-
number
Valfritt. Standardvärdet är 0 förskjutning till läsfil.
- count
-
number
Valfritt. Hur många byte som ska läsas kommer standard att läsas från förskjutning till slutet.
- options
- FileReadOptions
Valfritt. Alternativ när du läser filen.
Returer
Promise<FileReadResponse>
readToBuffer(Buffer, number, number, FileReadToBufferOptions)
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.
Läser en Data Lake-fil parallellt med en buffert. Förskjutning och antal är valfria, skicka 0 för att båda ska kunna läsa hela filen.
Varning! Buffertar kan bara ha stöd för filer upp till ungefär en gigabyte på 32-bitarssystem eller cirka två gigabyte på 64-bitarssystem på grund av begränsningar för Node.js/V8. Överväg att läsaToFile för filer som är större än den här storleken.
function readToBuffer(buffer: Buffer, offset?: number, count?: number, options?: FileReadToBufferOptions): Promise<Buffer>
Parametrar
- buffer
-
Buffer
Buffert som ska fyllas, måste ha en längd som är större än antalet
- offset
-
number
Från vilken position Data Lake-filen ska läsas
- count
-
number
Hur mycket data som ska läsas. Läse till slutet när odefinierade skickas
- options
- FileReadToBufferOptions
Returer
Promise<Buffer>
readToBuffer(number, number, FileReadToBufferOptions)
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME
Läser en Data Lake-fil parallellt med en buffert. Förskjutning och antal är valfria, skicka 0 för att båda ska läsa hela filen
Varning! Buffertar kan bara ha stöd för filer upp till ungefär en gigabyte på 32-bitarssystem eller cirka två gigabyte på 64-bitarssystem på grund av begränsningar för Node.js/V8. Överväg att läsaToFile för filer som är större än den här storleken.
function readToBuffer(offset?: number, count?: number, options?: FileReadToBufferOptions): Promise<Buffer>
Parametrar
- offset
-
number
Från vilken position Data Lake-filen ska läsas (i byte)
- count
-
number
Hur mycket data (i byte) som ska läsas. Läse till slutet när odefinierade skickas
- options
- FileReadToBufferOptions
Returer
Promise<Buffer>
readToFile(string, number, number, FileReadOptions)
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.
Laddar ned en Data Lake-fil till en lokal fil. Misslyckas om den angivna filsökvägen redan avslutas. Förskjutning och antal är valfria, skicka 0 respektive odefinierat för att ladda ned hela filen.
function readToFile(filePath: string, offset?: number, count?: number, options?: FileReadOptions): Promise<FileReadResponse>
Parametrar
- filePath
-
string
- offset
-
number
Från vilken position filen ska laddas ned.
- count
-
number
Hur mycket data som ska laddas ned. Laddas ned till slutet när odefinierade skickas.
- options
- FileReadOptions
Alternativ för att läsa Data Lake-filen.
Returer
Promise<FileReadResponse>
Svarsdata för filläsningsåtgärden, men med readableStreamBody inställt på odefinierat eftersom dess innehåll redan har lästs och skrivits till en lokal fil på den angivna sökvägen.
setExpiry(FileExpiryMode, FileSetExpiryOptions)
Anger en förfallotid för en fil, när den tiden har uppnåtts tas filen bort.
function setExpiry(mode: FileExpiryMode, options?: FileSetExpiryOptions): Promise<FileSetExpiryResponse>
Parametrar
- mode
- FileExpiryMode
- options
- FileSetExpiryOptions
Returer
Promise<FileSetExpiryResponse>
upload(Blob | ArrayBuffer | ArrayBufferView | Buffer, FileParallelUploadOptions)
Laddar upp en buffert(Node.js)/Blob/ArrayBuffer/ArrayBufferView till en fil.
function upload(data: Blob | ArrayBuffer | ArrayBufferView | Buffer, options?: FileParallelUploadOptions): Promise<FileUploadResponse>
Parametrar
- data
-
Blob | ArrayBuffer | ArrayBufferView | Buffer
Buffer(Node), Blob, ArrayBuffer eller ArrayBufferView
- options
- FileParallelUploadOptions
Returer
Promise<FileUploadResponse>
uploadFile(string, FileParallelUploadOptions)
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.
Laddar upp en lokal fil till en Data Lake-fil.
function uploadFile(filePath: string, options?: FileParallelUploadOptions): Promise<FileUploadResponse>
Parametrar
- filePath
-
string
Fullständig sökväg till den lokala filen
- options
- FileParallelUploadOptions
Returer
Promise<FileUploadResponse>
uploadStream(Readable, FileParallelUploadOptions)
ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.
Laddar upp en Node.js läsbar dataström till en Data Lake-fil. Den här metoden försöker skapa en fil och börjar sedan ladda upp segment för segment. Kontrollera att den potentiella storleken på strömmen inte överskrider FILE_MAX_SIZE_BYTES och att det potentiella antalet segment inte överskrider BLOCK_BLOB_MAX_BLOCKS.
TIPS FÖR PRESTANDAFÖRBÄTTRING:
- HighWaterMark för indataströmmen är bättre att ange samma värde med parametern options.chunkSize, vilket undviker Åtgärder för Buffer.concat().
function uploadStream(stream: Readable, options?: FileParallelUploadOptions): Promise<FileUploadResponse>
Parametrar
- stream
-
Readable
Node.js läsbar ström.
- options
- FileParallelUploadOptions
Returer
Promise<FileUploadResponse>
Ärvd metodinformation
delete(boolean, PathDeleteOptions)
Ta bort aktuell sökväg (katalog eller fil).
Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>
Parametrar
- recursive
-
boolean
Obligatoriskt och giltigt endast när resursen är en katalog. Om det är "sant" tas alla sökvägar under katalogen bort.
- options
- PathDeleteOptions
Valfritt. Alternativ vid borttagning av sökväg.
Returer
Promise<PathDeleteResponse>
Ärvd frånDataLakePathClient.delete
deleteIfExists(boolean, PathDeleteOptions)
Ta bort aktuell sökväg (katalog eller fil) om den finns.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>
Parametrar
- recursive
-
boolean
Obligatoriskt och giltigt endast när resursen är en katalog. Om det är "sant" tas alla sökvägar under katalogen bort.
- options
- PathDeleteOptions
Returer
Promise<PathDeleteIfExistsResponse>
Ärvd frånDataLakePathClient.deleteIfExists
exists(PathExistsOptions)
Returnerar sant om Data Lake-filen som representeras av den här klienten finns. annars falskt.
Obs! Använd den här funktionen med försiktighet eftersom en befintlig fil kan tas bort av andra klienter eller program. Tvärtom kan nya filer läggas till av andra klienter eller program när den här funktionen har slutförts.
function exists(options?: PathExistsOptions): Promise<boolean>
Parametrar
- options
- PathExistsOptions
alternativ för åtgärden Finns.
Returer
Promise<boolean>
Ärvd frånDataLakePathClient.exists
getAccessControl(PathGetAccessControlOptions)
Returnerar åtkomstkontrolldata för en sökväg (filkatalog).
Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties
function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>
Parametrar
- options
- PathGetAccessControlOptions
Valfritt. Alternativ när du hämtar filåtkomstkontroll.
Returer
Promise<PathGetAccessControlResponse>
Ärvd frånDataLakePathClient.getAccessControl
getDataLakeLeaseClient(string)
Hämta en DataLakeLeaseClient som hanterar lån på sökvägen (katalog eller fil).
function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient
Parametrar
- proposeLeaseId
-
string
Valfritt. Ursprungligt föreslaget låne-ID.
Returer
getProperties(PathGetPropertiesOptions)
Returnerar alla användardefinierade metadata, http-standardegenskaper och systemegenskaper för sökvägen (katalog eller fil).
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 metoderna i DataLakeFileSystemClient som listar sökvägar med hjälp av includeMetadata
alternativet, vilket behåller deras ursprungliga hölje.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>
Parametrar
- options
- PathGetPropertiesOptions
Valfritt. Alternativ när du hämtar sökvägsegenskaper.
Returer
Promise<PathGetPropertiesResponse>
Ärvd frånDataLakePathClient.getProperties
move(string, PathMoveOptions)
Flytta katalog eller fil i samma filsystem.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>
Parametrar
- destinationPath
-
string
Målkatalogsökväg som "katalog" eller filsökväg "katalog/fil". Om destinationPath autentiseras med SAS lägger du till SAS i målsökvägen som "directory/file?sasToken".
- options
- PathMoveOptions
Valfritt. Alternativ när du flyttar katalog eller fil.
Returer
Promise<PathMoveResponse>
Ärvd frånDataLakePathClient.move
move(string, string, PathMoveOptions)
Flytta katalog eller fil till ett annat filsystem.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
function move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>
Parametrar
- destinationFileSystem
-
string
Målfilsystem som "filsystem".
- destinationPath
-
string
Målkatalogsökväg som "katalog" eller filsökväg "katalog/fil" Om destinationPath autentiseras med SAS lägger du till SAS i målsökvägen som "directory/file?sasToken".
- options
- PathMoveOptions
Valfritt. Alternativ när du flyttar katalog eller fil.
Returer
Promise<PathMoveResponse>
Ärvd frånDataLakePathClient.move
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Tar bort Access Control på en sökväg och undersökvägar.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>
Parametrar
POSIX-åtkomstkontrollistan för filen eller katalogen.
Valfritt. Alternativ
Returer
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)
Ange åtkomstkontrolldata för en sökväg (filkatalog).
Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>
Parametrar
- acl
POSIX-åtkomstkontrollistan för filen eller katalogen.
- options
- PathSetAccessControlOptions
Valfritt. Alternativ när du anger åtkomstkontroll för sökväg.
Returer
Promise<PathSetAccessControlResponse>
Ärvd frånDataLakePathClient.setAccessControl
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Anger Access Control på en sökväg och undersökvägar.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function setAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>
Parametrar
- acl
POSIX-åtkomstkontrollistan för filen eller katalogen.
Valfritt. Alternativ
Returer
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)
Anger systemegenskaper på sökvägen (katalog eller fil).
Om inget värde anges, eller inget värde som angetts för de angivna HTTP-huvudena för bloben, rensas dessa HTTP-blobhuvuden utan värde.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
function setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>
Parametrar
- httpHeaders
- PathHttpHeaders
- options
- PathSetHttpHeadersOptions
Returer
Promise<PathSetHttpHeadersResponse>
Ärvd frånDataLakePathClient.setHttpHeaders
setMetadata(Metadata, PathSetMetadataOptions)
Anger användardefinierade metadata för den angivna sökvägen (filkatalogen) som ett eller flera namn/värde-par.
Om inget alternativ har angetts eller inga metadata definierats i parametern tas sökvägsmetadata bort.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>
Parametrar
- metadata
- Metadata
Valfritt. Ersätt befintliga metadata med det här värdet. Om inget värde anges tas befintliga metadata bort.
- options
- PathSetMetadataOptions
Valfritt. Alternativ när du anger sökvägsmetadata.
Returer
Promise<PathSetMetadataResponse>
Ärvd frånDataLakePathClient.setMetadata
setPermissions(PathPermissions, PathSetPermissionsOptions)
Anger filbehörigheter på en sökväg.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>
Parametrar
- permissions
- PathPermissions
POSIX-åtkomstbehörigheterna för filägaren, filägargruppen och andra.
- options
- PathSetPermissionsOptions
Valfritt. Alternativ när du anger sökvägsbehörigheter.
Returer
Promise<PathSetPermissionsResponse>
Ärvd frånDataLakePathClient.setPermissions
toDirectoryClient()
Konvertera aktuell DataLakePathClient till DataLakeDirectoryClient om den aktuella sökvägen är en katalog.
function toDirectoryClient(): DataLakeDirectoryClient
Returer
Ärvd frånDataLakePathClient.toDirectoryClient
toFileClient()
Konvertera aktuell DataLakePathClient till DataLakeFileClient om den aktuella sökvägen är en fil.
function toFileClient(): DataLakeFileClient
Returer
Ärvd frånDataLakePathClient.toFileClient
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
Ändrar Access Control på en sökväg och undersökvägar.
Se https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
function updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>
Parametrar
- acl
POSIX-åtkomstkontrollistan för filen eller katalogen.
Valfritt. Alternativ