ShareFileClient class

Paket:: @azure/storage-file-share

En ShareFileClient representerar en URL till en Azure Storage-fil.

Extends: StorageClient

Konstruktorer

ShareFileClient(string, Credential \| TokenCredential, ShareClientOptions)	Skapar en instans av ShareFileClient.
ShareFileClient(string, Pipeline, ShareClientConfig)	Skapar en instans av ShareFileClient.

Egenskaper

name	Namnet på filen
path	Filens fullständiga sökväg
shareName	Resursnamnet som motsvarar den här filklienten

Ärvda egenskaper

accountName
url	URL-strängvärde.

Metoder

abortCopyFromURL(string, FileAbortCopyFromURLOptions)	Avbryter en väntande kopieringsfilåtgärd och lämnar en målfil med noll längd och fullständiga metadata. Se https://learn.microsoft.com/rest/api/storageservices/abort-copy-file
clearRange(number, number, FileClearRangeOptions)	Rensar det angivna intervallet och frigör det utrymme som används i lagringen för det intervallet.
create(number, FileCreateOptions)	Skapar en ny fil eller ersätter en fil. Observera att den endast initierar filen utan innehåll. Se https://learn.microsoft.com/rest/api/storageservices/create-file
createHardLink(string, FileCreateHardLinkOptions)	Endast NFS. Skapar en hård länk till den filfil som anges av sökvägen.
createSymbolicLink(string, FileCreateSymbolicLinkOptions)	Endast NFS. Skapar en symbolisk länk.
delete(FileDeleteOptions)	Tar bort filen från lagringskontot. När en fil har tagits bort tas den omedelbart bort från lagringskontots index och är inte längre tillgänglig för klienter. Filens data tas senare bort från tjänsten under skräpinsamlingen. Ta bort fil misslyckas med statuskoden 409 (konflikt) och felkoden SharingViolation om filen är öppen på en SMB-klient. Ta bort fil stöds inte på en resursögonblicksbild, vilket är en skrivskyddad kopia av en resurs. Ett försök att utföra den här åtgärden på en resursögonblicksbild misslyckas med 400 (InvalidQueryParameterValue) Se https://learn.microsoft.com/rest/api/storageservices/delete-file2
deleteIfExists(FileDeleteOptions)	Tar bort filen från lagringskontot om den finns. När en fil har tagits bort tas den omedelbart bort från lagringskontots index och är inte längre tillgänglig för klienter. Filens data tas senare bort från tjänsten under skräpinsamlingen. Ta bort fil misslyckas med statuskoden 409 (konflikt) och felkoden SharingViolation om filen är öppen på en SMB-klient. Ta bort fil stöds inte på en resursögonblicksbild, vilket är en skrivskyddad kopia av en resurs. Ett försök att utföra den här åtgärden på en resursögonblicksbild misslyckas med 400 (InvalidQueryParameterValue) Se https://learn.microsoft.com/rest/api/storageservices/delete-file2
download(number, number, FileDownloadOptions)	Läser eller laddar ned en fil från systemet, inklusive dess metadata och egenskaper. I Node.jsreturnerar data i en läsbar dataström `readableStreamBody` I webbläsare returneras data i ett löfte `contentAsBlob` Se https://learn.microsoft.com/rest/api/storageservices/get-file
downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions)	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar ned en Azure-fil parallellt med en buffert. Förskjutning och antal är valfria, skicka 0 för att båda ska kunna ladda ned 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 i Node.js/V8. För filer som är större än den här storleken bör du ladda nedToFile.
downloadToBuffer(number, number, FileDownloadToBufferOptions)	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME Laddar ned en Azure-fil parallellt med en buffert. Förskjutning och antal är valfria, skicka 0 för båda för att ladda ned 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 i Node.js/V8. För filer som är större än den här storleken bör du ladda nedToFile.
downloadToFile(string, number, number, FileDownloadOptions)	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Laddar ned en Azure Blob 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 bloben.
exists(FileExistsOptions)	Returnerar sant om den angivna filen 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. Vice versa nya filer kan läggas till av andra klienter eller program när den här funktionen har slutförts.
forceCloseAllHandles(FileForceCloseHandlesOptions)	Framtvinga stängning av alla referenser för en fil. Se https://learn.microsoft.com/rest/api/storageservices/force-close-handles
forceCloseHandle(string, FileForceCloseHandlesOptions)	Framtvinga stängning av ett specifikt handtag för en fil. Se https://learn.microsoft.com/rest/api/storageservices/force-close-handles
generateSasStringToSign(FileGenerateSasUrlOptions)	Endast tillgängligt för klienter som skapats med en delad nyckelautentiseringsuppgifter. Genererar sträng för att signera för en SAS-URI (Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel. Se https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(FileGenerateSasUrlOptions)	Endast tillgängligt för klienter som skapats med en delad nyckelautentiseringsuppgifter. Genererar en SAS-URI (Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel. Se https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
getProperties(FileGetPropertiesOptions)	Returnerar alla användardefinierade metadata, http-standardegenskaper och systemegenskaper för filen. Det returnerar inte innehållet i filen. Se https://learn.microsoft.com/rest/api/storageservices/get-file-properties
getRangeList(FileGetRangeListOptions)	Returnerar listan över giltiga intervall för en fil.
getRangeListDiff(string, FileGetRangeListOptions)	Returnerar listan med intervall som skiljer sig mellan en tidigare resursögonblicksbild och den här filen.
getShareLeaseClient(string)	Hämta en ShareLeaseClient- som hanterar lån för filen.
getSymbolicLink(FileGetSymbolicLinkOptions)	Endast NFS. Hämtar innehållet i en symbolisk länk.
listHandles(FileListHandlesOptions)	Returnerar en iterbar iterator som kan asynkronas för att visa alla referenser. under det angivna kontot. .byPage() returnerar en iterator som kan itereras asynkron för att visa en lista över handtagen på sidor.
rename(string, FileRenameOptions)	Byter namn på en fil. Det här API:et har endast stöd för att byta namn på en fil i samma resurs.
resize(number, FileResizeOptions)	Ändra storlek på fil. Se https://learn.microsoft.com/rest/api/storageservices/set-file-properties
setHttpHeaders(FileHttpHeaders, FileSetHttpHeadersOptions)	Anger HTTP-huvuden på filen. Om inget alternativ har angetts, eller inget värde som angetts för filens HTTP-huvuden i alternativen, rensas dessa HTTP-filhuvuden utan värde. Se https://learn.microsoft.com/rest/api/storageservices/set-file-properties
setMetadata(Metadata, FileSetMetadataOptions)	Uppdaterar användardefinierade metadata för den angivna filen. Om inga metadata definieras i alternativparametern tas filmetadata bort. Se https://learn.microsoft.com/rest/api/storageservices/set-file-metadata
setProperties(FileProperties)	Anger egenskaper för filen. Se https://learn.microsoft.com/rest/api/storageservices/set-file-properties
startCopyFromURL(string, FileStartCopyOptions)	Kopierar en blob eller fil till en målfil i lagringskontot.
uploadData(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, FileParallelUploadOptions)	Skapar en ny Azure-fil eller ersätter en befintlig Azure-fil och laddar sedan upp en Buffer(Node)/Blob/ArrayBuffer/ArrayBufferView till den.
uploadFile(string, FileParallelUploadOptions)	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Skapar en ny Azure-fil eller ersätter en befintlig Azure-fil och laddar sedan upp en lokal fil till den.
uploadRange(RequestBodyType, number, number, FileUploadRangeOptions)	Ladda upp ett intervall med byte till en fil. Den här åtgärden kan bara anropas på en befintlig fil. Det ändrar inte filens storlek, egenskaper eller metadata. Både början och antalet för intervallet måste anges. Intervallet kan vara upp till 4 MB stort.
uploadRangeFromURL(string, number, number, number, FileUploadRangeFromURLOptions)	Ladda upp ett intervall med byte till en fil där innehållet läse från en annan fils URL. Intervallet kan vara upp till 4 MB stort.
uploadResetableStream((offset: number, count?: number) => ReadableStream, number, FileParallelUploadOptions)	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Accepterar en Node.js läsbar dataströmfabrik och laddas upp i block till en Azure-fil. Den läsbara dataströmfabriken måste returnera en Node.js läsbar ström från den definierade förskjutningen. Förskjutningen är förskjutningen i Azure-filen som ska laddas upp.
uploadSeekableBlob((offset: number, size: number) => Blob, number, FileParallelUploadOptions)	ENDAST TILLGÄNGLIGT I WEBBLÄSARE. Laddar upp ett webbläsarblobobjekt till en Azure-fil. Kräver en blobFactory som datakälla, som måste returnera ett Blob-objekt med förskjutningen och den angivna storleken.
uploadStream(Readable, number, number, number, FileUploadStreamOptions)	ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME. Skapar en ny Azure-fil eller ersätter en befintlig Azure-fil och laddar sedan upp en Node.js läsbar dataström till den. Den här metoden försöker skapa en Azure-fil och börjar sedan ladda upp segment för segment. Storleken på segment definieras av `bufferSize` parameter. Kontrollera att den potentiella storleken på dataströmmen inte överskrider filstorleken. TIPS FÖR PRESTANDAFÖRBÄTTRING: HighWaterMark för indataström är bättre att ange samma värde med bufferSize-parametern, vilket undviker buffer.concat()-åtgärder.
withShareSnapshot(string)	Skapar ett nytt ShareFileClient-objekt som är identiskt med källan men med den angivna tidsstämpeln för resursögonblicksbilder. Ange "" tar bort ögonblicksbilden och returnerar en URL till den grundläggande ShareFileClient.

Konstruktorinformation

Skapar en instans av ShareFileClient.

new ShareFileClient(url: string, credential?: Credential | TokenCredential, options?: ShareClientOptions)

Parametrar

url: string

En URL-sträng som pekar på Azure Storage-filen, till exempel "https://myaccount.file.core.windows.net/myshare/mydirectory/file". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.file.core.windows.net/myshare/mydirectory/file?sasString". Den här metoden accepterar en kodad URL eller en icke-kodad URL som pekar på en fil. Kodad URL-sträng kommer INTE att undantagas två gånger, endast specialtecken i URL-sökvägen kommer att undantagas. Men om ett fil- eller katalognamn innehåller %måste fil- eller katalognamnet kodas i URL:en. Till exempel en fil med namnet "myfile%", ska URL:en vara "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25".

credential: Credential | TokenCredential

Till exempel , StorageSharedKeyCredential eller TokenCredential, Om det inte anges används AnonymousCredential.

options: ShareClientOptions

Optional. Alternativ för att konfigurera HTTP-pipelinen.

Skapar en instans av ShareFileClient.

new ShareFileClient(url: string, pipeline: Pipeline, options?: ShareClientConfig)

Parametrar

url: string

pipeline: Pipeline

Anropa newPipeline() för att skapa en standardpipeline eller ange en anpassad pipeline.

options: ShareClientConfig

Egenskapsinformation

Namnet på filen

string name

Egenskapsvärde

string

Filens fullständiga sökväg

string path

Egenskapsvärde

string

Resursnamnet som motsvarar den här filklienten

string shareName

Egenskapsvärde

string

Information om ärvda egenskaper

accountName: string

Egenskapsvärde

string

ärvd från StorageClient.accountName

URL-strängvärde.

url: string

Egenskapsvärde

string

ärvd från StorageClient.url

Metodinformation

Avbryter en väntande kopieringsfilåtgärd och lämnar en målfil med noll längd och fullständiga metadata.

Se https://learn.microsoft.com/rest/api/storageservices/abort-copy-file

function abortCopyFromURL(copyId: string, options?: FileAbortCopyFromURLOptions): Promise<FileAbortCopyResponse>

Parametrar

copyId: string

ID för åtgärden Kopiera fil som ska avbrytas.

options: FileAbortCopyFromURLOptions

Alternativ för att avbryta kopiering av fil från URL-åtgärd.

Returer

Promise<FileAbortCopyResponse>

Rensar det angivna intervallet och frigör det utrymme som används i lagringen för det intervallet.

function clearRange(offset: number, contentLength: number, options?: FileClearRangeOptions): Promise<FileUploadRangeResponse>

Parametrar

offset: number

contentLength: number

options: FileClearRangeOptions

Alternativ för åtgärden Filrensningsintervall.

Returer

Promise<FileUploadRangeResponse>

Skapar en ny fil eller ersätter en fil. Observera att den endast initierar filen utan innehåll.

Se https://learn.microsoft.com/rest/api/storageservices/create-file

function create(size: number, options?: FileCreateOptions): Promise<FileCreateResponse>

Parametrar

size: number

Anger den maximala storleken i byte för filen, upp till 4 TB.

options: FileCreateOptions

Alternativ för åtgärden Filskapande.

Returer

Promise<FileCreateResponse>

Svarsdata för åtgärden Skapa fil.

Exempel på användning:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

const shareName = "<share name>";
const directoryName = "<directory name>";
const directoryClient = serviceClient.getShareClient(shareName).getDirectoryClient(directoryName);

const content = "Hello World!";
const fileName = `newdirectory${+new Date()}`;
const fileClient = directoryClient.getFileClient(fileName);
await fileClient.create(content.length);
console.log(`Create file ${fileName} successfully`);

// Upload file range
await fileClient.uploadRange(content, 0, content.length);
console.log(`Upload file range "${content}" to ${fileName} successfully`);

Endast NFS. Skapar en hård länk till den filfil som anges av sökvägen.

function createHardLink(targetFile: string, options?: FileCreateHardLinkOptions): Promise<FileCreateHardLinkResponse>

Parametrar

targetFile: string

Sökväg till filen som du vill skapa den hårda länken till, inte resursen. Exempel: "targetDirectory/targetSubDirectory/.../targetFile"

options: FileCreateHardLinkOptions

Alternativ för att skapa en hårdlänksåtgärd.

Returer

Promise<FileCreateHardLinkResponse>

Endast NFS. Skapar en symbolisk länk.

function createSymbolicLink(linkText: string, options?: FileCreateSymbolicLinkOptions): Promise<FileCreateSymbolicLinkResponse>

Parametrar

linkText: string

Sökvägen till den ursprungliga filen som den symboliska länken pekar på. Sökvägen är av typen sträng som inte matchas och lagras som den är. Sökvägen kan vara den absoluta sökvägen eller den relativa sökvägen beroende på innehållet som lagras i den symboliska länkfilen.

options: FileCreateSymbolicLinkOptions

Alternativ för att skapa en hårdlänksåtgärd.

Returer

Promise<FileCreateSymbolicLinkResponse>

Tar bort filen från lagringskontot. När en fil har tagits bort tas den omedelbart bort från lagringskontots index och är inte längre tillgänglig för klienter. Filens data tas senare bort från tjänsten under skräpinsamlingen.

Ta bort fil misslyckas med statuskoden 409 (konflikt) och felkoden SharingViolation om filen är öppen på en SMB-klient.

Ta bort fil stöds inte på en resursögonblicksbild, vilket är en skrivskyddad kopia av en resurs. Ett försök att utföra den här åtgärden på en resursögonblicksbild misslyckas med 400 (InvalidQueryParameterValue)

Se https://learn.microsoft.com/rest/api/storageservices/delete-file2

function delete(options?: FileDeleteOptions): Promise<FileDeleteResponse>

Parametrar

options: FileDeleteOptions

Alternativ för åtgärden Filborttagning.

Returer

Promise<FileDeleteResponse>

Svarsdata för åtgärden Filborttagning.

Tar bort filen från lagringskontot om den finns. När en fil har tagits bort tas den omedelbart bort från lagringskontots index och är inte längre tillgänglig för klienter. Filens data tas senare bort från tjänsten under skräpinsamlingen.

Ta bort fil misslyckas med statuskoden 409 (konflikt) och felkoden SharingViolation om filen är öppen på en SMB-klient.

Se https://learn.microsoft.com/rest/api/storageservices/delete-file2

function deleteIfExists(options?: FileDeleteOptions): Promise<FileDeleteIfExistsResponse>

Parametrar

options: FileDeleteOptions

Returer

Promise<FileDeleteIfExistsResponse>

Läser eller laddar ned en fil från systemet, inklusive dess metadata och egenskaper.

I Node.jsreturnerar data i en läsbar dataström readableStreamBody
I webbläsare returneras data i ett löfte contentAsBlob

Se https://learn.microsoft.com/rest/api/storageservices/get-file

function download(offset?: number, count?: number, options?: FileDownloadOptions): Promise<FileDownloadResponseModel>

Parametrar

offset: number

Från vilken position filen ska laddas ned, större än eller lika med 0

count: number

Hur mycket data som ska laddas ned, större än 0. Laddas ned till slutet när det är odefinierat

options: FileDownloadOptions

Alternativ för filnedladdning.

Returer

Promise<FileDownloadResponseModel>

Svarsdata för åtgärden Filnedladdning.

Exempel på användning (Node.js):

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

const shareName = "<share name>";
const fileName = "<file name>";
const fileClient = serviceClient
  .getShareClient(shareName)
  .rootDirectoryClient.getFileClient(fileName);

// Get file content from position 0 to the end
// In Node.js, get downloaded data by accessing downloadFileResponse.readableStreamBody
const downloadFileResponse = await fileClient.download();
if (downloadFileResponse.readableStreamBody) {
  const buffer = await streamToBuffer(downloadFileResponse.readableStreamBody);
  console.log(`Downloaded file content: ${buffer.toString()}`);
}

// [Node.js only] A helper method used to read a Node.js readable stream into a Buffer
async function streamToBuffer(readableStream: NodeJS.ReadableStream): Promise<Buffer> {
  return new Promise((resolve, reject) => {
    const chunks: Buffer[] = [];
    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):

import { ShareServiceClient } from "@azure/storage-file-share";

const account = "<account name>";
const sas = "<service Shared Access Signature Token>";

const serviceClient = new ShareServiceClient(`https://${account}.file.core.windows.net?${sas}`);

const shareName = "<share name>";
const fileName = "<file name>";
const fileClient = serviceClient
  .getShareClient(shareName)
  .rootDirectoryClient.getFileClient(fileName);

// Get file content from position 0 to the end
// In browsers, get downloaded data by accessing downloadFileResponse.blobBody
const downloadFileResponse = await fileClient.download(0);
if (downloadFileResponse.blobBody) {
  console.log(`Downloaded file content: ${(await downloadFileResponse.blobBody).text()}`);
}

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

Laddar ned en Azure-fil parallellt med en buffert. Förskjutning och antal är valfria, skicka 0 för att båda ska kunna ladda ned 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 i Node.js/V8. För filer som är större än den här storleken bör du ladda nedToFile.

function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: FileDownloadToBufferOptions): 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 Azure-filen ska laddas ned

count: number

Hur mycket data som ska laddas ned. Kommer att laddas ned till slutet när odefinierade skickas

options: FileDownloadToBufferOptions

Returer

Promise<Buffer>

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME

Laddar ned en Azure-fil parallellt med en buffert. Förskjutning och antal är valfria, skicka 0 för båda för att ladda ned hela filen

function downloadToBuffer(offset?: number, count?: number, options?: FileDownloadToBufferOptions): Promise<Buffer>

Parametrar

offset: number

Från vilken position Azure-filen ska laddas ned

count: number

Hur mycket data som ska laddas ned. Kommer att laddas ned till slutet när odefinierade skickas

options: FileDownloadToBufferOptions

Returer

Promise<Buffer>

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

Laddar ned en Azure Blob 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 bloben.

function downloadToFile(filePath: string, offset?: number, count?: number, options?: FileDownloadOptions): Promise<FileDownloadResponseModel>

Parametrar

filePath: string

offset: number

Från vilken position blockbloben ska laddas ned.

count: number

Hur mycket data som ska laddas ned. Laddas ned till slutet när odefinierade skickas.

options: FileDownloadOptions

Alternativ för alternativ för blobnedladdning.

Returer

Promise<FileDownloadResponseModel>

Svarsdata för blobnedladdningså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.

Returnerar sant om den angivna filen 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. Vice versa nya filer kan läggas till av andra klienter eller program när den här funktionen har slutförts.

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

Parametrar

options: FileExistsOptions

alternativ för åtgärden Finns.

Returer

Promise<boolean>

Framtvinga stängning av alla referenser för en fil.

Se https://learn.microsoft.com/rest/api/storageservices/force-close-handles

function forceCloseAllHandles(options?: FileForceCloseHandlesOptions): Promise<CloseHandlesInfo>

Parametrar

options: FileForceCloseHandlesOptions

Alternativ för att framtvinga åtgärder för att stänga handtagen.

Returer

Promise<CloseHandlesInfo>

Framtvinga stängning av ett specifikt handtag för en fil.

Se https://learn.microsoft.com/rest/api/storageservices/force-close-handles

function forceCloseHandle(handleId: string, options?: FileForceCloseHandlesOptions): Promise<FileForceCloseHandlesResponse>

Parametrar

handleId: string

Specifikt handtags-ID, kan inte vara asterisk "*". Använd forceCloseAllHandles() för att stänga alla handtag.

options: FileForceCloseHandlesOptions

Returer

Promise<FileForceCloseHandlesResponse>

Endast tillgängligt för klienter som skapats med en delad nyckelautentiseringsuppgifter.

Genererar sträng för att signera för en SAS-URI (Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

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

function generateSasStringToSign(options: FileGenerateSasUrlOptions): string

Parametrar

options: FileGenerateSasUrlOptions

Valfria parametrar.

Returer

string

SAS-URI:n som består av URI:n till den resurs som representeras av den här klienten, följt av den genererade SAS-token.

Endast tillgängligt för klienter som skapats med en delad nyckelautentiseringsuppgifter.

Genererar en SAS-URI (Service Shared Access Signature) baserat på klientegenskaperna och parametrarna som skickas in. SAS signeras av klientens autentiseringsuppgifter för delad nyckel.

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

function generateSasUrl(options: FileGenerateSasUrlOptions): string

Parametrar

options: FileGenerateSasUrlOptions

Valfria parametrar.

Returer

string

SAS-URI:n som består av URI:n till den resurs som representeras av den här klienten, följt av den genererade SAS-token.

Returnerar alla användardefinierade metadata, http-standardegenskaper och systemegenskaper för filen. Det returnerar inte innehållet i filen.

Se https://learn.microsoft.com/rest/api/storageservices/get-file-properties

function getProperties(options?: FileGetPropertiesOptions): Promise<FileGetPropertiesResponse>

Parametrar

options: FileGetPropertiesOptions

Alternativ för åtgärden Hämta egenskaper för fil.

Returer

Promise<FileGetPropertiesResponse>

Svarsdata för åtgärden Hämta egenskaper för fil.

Returnerar listan över giltiga intervall för en fil.

function getRangeList(options?: FileGetRangeListOptions): Promise<FileGetRangeListResponse>

Parametrar

options: FileGetRangeListOptions

Alternativ för åtgärden Fil hämta intervalllista.

Returer

Promise<FileGetRangeListResponse>

Returnerar listan med intervall som skiljer sig mellan en tidigare resursögonblicksbild och den här filen.

function getRangeListDiff(prevShareSnapshot: string, options?: FileGetRangeListOptions): Promise<FileGetRangeListDiffResponse>

Parametrar

prevShareSnapshot: string

Den tidigare ögonblicksbildsparametern är ett ogenomskinliga DateTime-värde som anger den föregående resursögonblicksbilden att jämföra med.

options: FileGetRangeListOptions

Returer

Promise<FileGetRangeListDiffResponse>

Hämta en ShareLeaseClient- som hanterar lån för filen.

function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient

Parametrar

proposeLeaseId: string

Ursprungligt föreslaget låne-ID.

Returer

ShareLeaseClient

Ett nytt ShareLeaseClient-objekt för att hantera lån på filen.

Endast NFS. Hämtar innehållet i en symbolisk länk.

function getSymbolicLink(options?: FileGetSymbolicLinkOptions): Promise<FileGetSymbolicLinkResponse>

Parametrar

options: FileGetSymbolicLinkOptions

Alternativ för att få symbolisk länkoperation.

Returer

Promise<FileGetSymbolicLinkResponse>

Returnerar en iterbar iterator som kan asynkronas för att visa alla referenser. under det angivna kontot.

.byPage() returnerar en iterator som kan itereras asynkron för att visa en lista över handtagen på sidor.

function listHandles(options?: FileListHandlesOptions): PagedAsyncIterableIterator<HandleItem, FileListHandlesResponse, PageSettings>

Parametrar

options: FileListHandlesOptions

Alternativ för att lista hanterar åtgärder.

En asyncIterableIterator som stöder växling.

Returer

PagedAsyncIterableIterator<HandleItem, FileListHandlesResponse, PageSettings>

Byter namn på en fil. Det här API:et har endast stöd för att byta namn på en fil i samma resurs.

function rename(destinationPath: string, options?: FileRenameOptions): Promise<{ destinationFileClient: ShareFileClient, fileRenameResponse: FileRenameResponse }>

Parametrar

destinationPath: string

Anger målsökvägen som du vill byta namn på till. Sökvägen kodas för att placeras i en URL för att ange målet.

options: FileRenameOptions

Alternativ för att byta namn på åtgärden.

Returer

Promise<{ destinationFileClient: ShareFileClient, fileRenameResponse: FileRenameResponse }>

Svarsdata för filbytesåtgärden.

Exempel på användning:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

const shareName = "<share name>";
const directoryName = "<directory name>";
const fileName = "<file name>";
const destinationPath = "<destination path>";
const fileClient = serviceClient
  .getShareClient(shareName)
  .getDirectoryClient(directoryName)
  .getFileClient(fileName);

await fileClient.rename(destinationPath);

Ändra storlek på fil.

Se https://learn.microsoft.com/rest/api/storageservices/set-file-properties

function resize(length: number, options?: FileResizeOptions): Promise<FileSetHTTPHeadersResponse>

Parametrar

length: number

Ändrar storlek på en fil till den angivna storleken i byte. Om det angivna bytevärdet är mindre än filens aktuella storlek rensas alla intervall ovanför det angivna bytevärdet.

options: FileResizeOptions

Alternativ för åtgärden Filstorlek.

Returer

Promise<FileSetHTTPHeadersResponse>

Svarsdata för åtgärden Http-huvuden för filuppsättning.

Anger HTTP-huvuden på filen.

Om inget alternativ har angetts, eller inget värde som angetts för filens HTTP-huvuden i alternativen, rensas dessa HTTP-filhuvuden utan värde.

Se https://learn.microsoft.com/rest/api/storageservices/set-file-properties

function setHttpHeaders(fileHttpHeaders?: FileHttpHeaders, options?: FileSetHttpHeadersOptions): Promise<FileSetHTTPHeadersResponse>

Parametrar

fileHttpHeaders: FileHttpHeaders

options: FileSetHttpHeadersOptions

Alternativ för åtgärden Ange HTTP-huvuden.

Returer

Promise<FileSetHTTPHeadersResponse>

Svarsdata för åtgärden Http-huvuden för filuppsättning.

Uppdaterar användardefinierade metadata för den angivna filen.

Om inga metadata definieras i alternativparametern tas filmetadata bort.

Se https://learn.microsoft.com/rest/api/storageservices/set-file-metadata

function setMetadata(metadata?: Metadata, options?: FileSetMetadataOptions): Promise<FileSetMetadataResponse>

Parametrar

metadata: Metadata

Om inga metadata tillhandahålls tas alla befintliga katalogmetadata bort

options: FileSetMetadataOptions

Alternativ för åtgärden Filuppsättningsmetadata.

Returer

Promise<FileSetMetadataResponse>

Svarsdata för åtgärden Filuppsättningsmetadata.

Anger egenskaper för filen.

Se https://learn.microsoft.com/rest/api/storageservices/set-file-properties

function setProperties(properties?: FileProperties): Promise<SetPropertiesResponse>

Parametrar

properties: FileProperties

Egenskaper för filer. För HTTP-filhuvuden(t.ex. Innehållstyp) tas befintliga HTTP-huvuden bort om inga värden anges. För andra filegenskaper(t.ex. fileAttributes) bevaras befintliga värden om inga värden anges.

Returer

Promise<SetPropertiesResponse>

Kopierar en blob eller fil till en målfil i lagringskontot.

function startCopyFromURL(copySource: string, options?: FileStartCopyOptions): Promise<FileStartCopyResponse>

Parametrar

copySource: string

Anger URL:en för källfilen eller bloben, upp till 2 kB. Om du vill kopiera en fil till en annan fil inom samma lagringskonto kan du använda delad nyckel för att autentisera källfilen. Om du kopierar en fil från ett annat lagringskonto, eller om du kopierar en blob från samma lagringskonto eller ett annat lagringskonto, måste du autentisera källfilen eller bloben med en signatur för delad åtkomst. Om källan är en offentlig blob krävs ingen autentisering för att utföra kopieringsåtgärden. En fil i en resursögonblicksbild kan också anges som en kopieringskälla.

options: FileStartCopyOptions

Alternativ för åtgärden Starta kopiering av fil.

Returer

Promise<FileStartCopyResponse>

Skapar en ny Azure-fil eller ersätter en befintlig Azure-fil och laddar sedan upp en Buffer(Node)/Blob/ArrayBuffer/ArrayBufferView till den.

function uploadData(data: Blob | ArrayBuffer | ArrayBufferView | Buffer, options?: FileParallelUploadOptions): Promise<void>

Parametrar

data: Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer(Node), Blob, ArrayBuffer eller ArrayBufferView

options: FileParallelUploadOptions

Returer

Promise<void>

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

Skapar en ny Azure-fil eller ersätter en befintlig Azure-fil och laddar sedan upp en lokal fil till den.

function uploadFile(filePath: string, options?: FileParallelUploadOptions): Promise<void>

Parametrar

filePath: string

Fullständig sökväg för lokal fil

options: FileParallelUploadOptions

Returer

Promise<void>

Ladda upp ett intervall med byte till en fil. Den här åtgärden kan bara anropas på en befintlig fil. Det ändrar inte filens storlek, egenskaper eller metadata. Både början och antalet för intervallet måste anges. Intervallet kan vara upp till 4 MB stort.

function uploadRange(body: RequestBodyType, offset: number, contentLength: number, options?: FileUploadRangeOptions): Promise<FileUploadRangeResponse>

Parametrar

body: HttpRequestBody

Blob, string, ArrayBuffer, ArrayBufferView eller en funktion som returnerar en ny läsbar ström vars förskjutning kommer från datakällans början.

offset: number

Förskjutningsposition för den Azure-målfil som ska laddas upp.

contentLength: number

Längd på brödtext i byte. Använd Buffer.byteLength() för att beräkna brödtextlängden för en sträng, inklusive icke-Base64/Hex-kodade tecken.

options: FileUploadRangeOptions

Alternativ för åtgärden Filuppladdningsintervall.

Returer

Promise<FileUploadRangeResponse>

Svarsdata för åtgärden Filuppladdningsintervall.

Exempel på användning:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

const shareName = "<share name>";
const directoryName = "<directory name>";
const directoryClient = serviceClient.getShareClient(shareName).getDirectoryClient(directoryName);

const content = "Hello World!";
const fileName = `newdirectory${+new Date()}`;
const fileClient = directoryClient.getFileClient(fileName);
await fileClient.create(content.length);
console.log(`Create file ${fileName} successfully`);

// Upload file range
await fileClient.uploadRange(content, 0, content.length);
console.log(`Upload file range "${content}" to ${fileName} successfully`);

Ladda upp ett intervall med byte till en fil där innehållet läse från en annan fils URL. Intervallet kan vara upp till 4 MB stort.

function uploadRangeFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: FileUploadRangeFromURLOptions): Promise<FileUploadRangeFromURLResponse>

Parametrar

sourceURL: string

Ange en URL till kopieringskällan, signatur för delad åtkomst (SAS) som kanske behövs för autentisering.

sourceOffset: number

Källförskjutningen som ska kopieras från. Skicka 0 för att kopiera från början av källfilen.

destOffset: number

Förskjutning av målfilen.

count: number

Antal byte som ska laddas upp från källfilen.

options: FileUploadRangeFromURLOptions

Alternativ för att konfigurera fil – Ladda upp intervall från URL-åtgärden.

Returer

Promise<FileUploadRangeFromURLResponse>

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

Accepterar en Node.js läsbar dataströmfabrik och laddas upp i block till en Azure-fil. Den läsbara dataströmfabriken måste returnera en Node.js läsbar ström från den definierade förskjutningen. Förskjutningen är förskjutningen i Azure-filen som ska laddas upp.

function uploadResetableStream(streamFactory: (offset: number, count?: number) => ReadableStream, size: number, options?: FileParallelUploadOptions): Promise<void>

Parametrar

streamFactory: (offset: number, count?: number) => ReadableStream

Returnerar en Node.js läsbar ström med början från den förskjutning som har definierats

size: number

Storleken på Azure-filen

options: FileParallelUploadOptions

Returer

Promise<void>

ENDAST TILLGÄNGLIGT I WEBBLÄSARE.

Laddar upp ett webbläsarblobobjekt till en Azure-fil. Kräver en blobFactory som datakälla, som måste returnera ett Blob-objekt med förskjutningen och den angivna storleken.

function uploadSeekableBlob(blobFactory: (offset: number, size: number) => Blob, size: number, options?: FileParallelUploadOptions): Promise<void>

Parametrar

blobFactory: (offset: number, size: number) => Blob

size: number

options: FileParallelUploadOptions

Returer

Promise<void>

ENDAST TILLGÄNGLIGT I NODE.JS RUNTIME.

Skapar en ny Azure-fil eller ersätter en befintlig Azure-fil och laddar sedan upp en Node.js läsbar dataström till den. Den här metoden försöker skapa en Azure-fil och börjar sedan ladda upp segment för segment. Storleken på segment definieras av bufferSize parameter. Kontrollera att den potentiella storleken på dataströmmen inte överskrider filstorleken.

TIPS FÖR PRESTANDAFÖRBÄTTRING:

HighWaterMark för indataström är bättre att ange samma värde med bufferSize-parametern, vilket undviker buffer.concat()-åtgärder.

function uploadStream(stream: Readable, size: number, bufferSize: number, maxBuffers: number, options?: FileUploadStreamOptions): Promise<void>

Parametrar

stream: Readable

Node.js läsbar ström. Måste vara mindre eller lika med filstorleken.

size: number

Storleken på filen som ska skapas. Maximal storlek som tillåts är 4 TB. Om det här värdet är större än strömstorleken kommer det att finnas tomma byte i filsvansen.

bufferSize: number

Storleken på varje buffert som allokeras i byte, även storleken på segment/intervall under den uppladdade filen. Storleken måste vara större än 0 och mindre än eller lika med 4 * 1024 * 1024 (4 MB)

maxBuffers: number

Maximalt antal buffertar allokeras under uppladdningen, positiv korrelation med maximal samtidighet vid uppladdning

options: FileUploadStreamOptions

Returer

Promise<void>

Skapar ett nytt ShareFileClient-objekt som är identiskt med källan men med den angivna tidsstämpeln för resursögonblicksbilder. Ange "" tar bort ögonblicksbilden och returnerar en URL till den grundläggande ShareFileClient.

function withShareSnapshot(shareSnapshot: string): ShareFileClient

Parametrar

shareSnapshot: string

Tidsstämpeln för resursögonblicksbild.

Returer

ShareFileClient

Ett nytt ShareFileClient-objekt som är identiskt med källan men med den angivna tidsstämpeln för resursögonblicksbilder.

Dela via

ShareFileClient class

Konstruktorer

Egenskaper

Ärvda egenskaper

Metoder

Konstruktorinformation

ShareFileClient(string, Credential | TokenCredential, ShareClientOptions)

Parametrar

ShareFileClient(string, Pipeline, ShareClientConfig)

Parametrar

Egenskapsinformation

name

Egenskapsvärde

path

Egenskapsvärde

shareName

Egenskapsvärde

Information om ärvda egenskaper

accountName

Egenskapsvärde

url

Egenskapsvärde

Metodinformation

abortCopyFromURL(string, FileAbortCopyFromURLOptions)

Parametrar

Returer

clearRange(number, number, FileClearRangeOptions)

Parametrar

Returer

create(number, FileCreateOptions)

Parametrar

Returer

createHardLink(string, FileCreateHardLinkOptions)

Parametrar

Returer

createSymbolicLink(string, FileCreateSymbolicLinkOptions)

Parametrar

Returer

delete(FileDeleteOptions)

Parametrar

Returer

deleteIfExists(FileDeleteOptions)

Parametrar

Returer

download(number, number, FileDownloadOptions)

Parametrar

Returer

downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions)

Parametrar

Returer

downloadToBuffer(number, number, FileDownloadToBufferOptions)

Parametrar

Returer

downloadToFile(string, number, number, FileDownloadOptions)

Parametrar

Returer

exists(FileExistsOptions)

Parametrar

Returer

forceCloseAllHandles(FileForceCloseHandlesOptions)

Parametrar

Returer

forceCloseHandle(string, FileForceCloseHandlesOptions)

Parametrar

Returer

generateSasStringToSign(FileGenerateSasUrlOptions)

Parametrar

Returer

generateSasUrl(FileGenerateSasUrlOptions)

Parametrar

Returer

getProperties(FileGetPropertiesOptions)

Parametrar

Returer

getRangeList(FileGetRangeListOptions)

Parametrar

Returer

getRangeListDiff(string, FileGetRangeListOptions)

Parametrar