ShareFileClient class

Csomag:: @azure/storage-file-share

A ShareFileClient egy Azure Storage-fájl URL-címét jelöli.

Extends: StorageClient

Konstruktorok

ShareFileClient(string, Credential \| TokenCredential, ShareClientOptions)	Létrehozza a ShareFileClient egy példányát.
ShareFileClient(string, Pipeline, ShareClientConfig)	Létrehozza a ShareFileClient egy példányát.

Tulajdonságok

name	A fájl neve
path	A fájl teljes elérési útja
shareName	A fájlügyfélnek megfelelő megosztás neve

Örökölt tulajdonságok

accountName
url	URL-sztring értéke.

Metódusok

abortCopyFromURL(string, FileAbortCopyFromURLOptions)	Megszakít egy függőben lévő fájlmásolási műveletet, és egy nulla hosszúságú és teljes metaadatokat tartalmazó célfájlt hagy. Lásd: https://learn.microsoft.com/rest/api/storageservices/abort-copy-file
clearRange(number, number, FileClearRangeOptions)	Törli a megadott tartományt, és felszabadítja az adott tartomány tárterületét.
create(number, FileCreateOptions)	Létrehoz egy új fájlt, vagy lecserél egy fájlt. Vegye figyelembe, hogy csak tartalom nélkül inicializálja a fájlt. Lásd: https://learn.microsoft.com/rest/api/storageservices/create-file
createHardLink(string, FileCreateHardLinkOptions)	Csak NFS. Az elérési út által megadott fájlfájlra mutató kemény hivatkozást hoz létre.
createSymbolicLink(string, FileCreateSymbolicLinkOptions)	Csak NFS. Szimbolikus hivatkozást hoz létre.
delete(FileDeleteOptions)	Eltávolítja a fájlt a tárfiókból. Ha egy fájl sikeresen törölve van, a rendszer azonnal eltávolítja a tárfiók indexéből, és többé nem érhető el az ügyfelek számára. A fájl adatai később törlődnek a szolgáltatásból a szemétgyűjtés során. A fájl törlése sikertelen lesz a 409-ben (ütközés) és a SharingViolation hibakóddal, ha a fájl SMB-ügyfélen van megnyitva. A fájl törlése nem támogatott megosztási pillanatképek esetén, amely egy megosztás írásvédett másolata. A megosztási pillanatképen végrehajtott művelet végrehajtása 400-zal meghiúsul (InvalidQueryParameterValue) Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-file2
deleteIfExists(FileDeleteOptions)	Eltávolítja a fájlt a tárfiókból, ha létezik. Ha egy fájl sikeresen törölve van, a rendszer azonnal eltávolítja a tárfiók indexéből, és többé nem érhető el az ügyfelek számára. A fájl adatai később törlődnek a szolgáltatásból a szemétgyűjtés során. A fájl törlése sikertelen lesz a 409-ben (ütközés) és a SharingViolation hibakóddal, ha a fájl SMB-ügyfélen van megnyitva. A fájl törlése nem támogatott megosztási pillanatképek esetén, amely egy megosztás írásvédett másolata. A megosztási pillanatképen végrehajtott művelet végrehajtása 400-zal meghiúsul (InvalidQueryParameterValue) Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-file2
download(number, number, FileDownloadOptions)	Beolvassa vagy letölti a fájlt a rendszerből, beleértve annak metaadatait és tulajdonságait. A Node.jsaz adatok olvasható streamben `readableStreamBody` A böngészőkben az adatok ígéretes `contentAsBlob` Lásd: https://learn.microsoft.com/rest/api/storageservices/get-file
downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions)	CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Egy Azure-fájlt a pufferrel párhuzamosan tölt le. Az eltolás és a darabszám megadása nem kötelező, a teljes fájl letöltéséhez adja meg a 0-t. Figyelmeztetés: A pufferek legfeljebb egy gigabájtnyi fájlt támogathatnak 32 bites rendszereken, vagy körülbelül két gigabájtot a 64 bites rendszereken a Node.js/V8 korlátozásai miatt. Ennél nagyobb fájlok esetén fontolja meg downloadToFile.
downloadToBuffer(number, number, FileDownloadToBufferOptions)	CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL Egy Azure-fájlt a pufferrel párhuzamosan tölt le. Az eltolás és a darabszám megadása nem kötelező, a teljes fájl letöltéséhez adja meg a 0-t mindkettőhöz Figyelmeztetés: A pufferek legfeljebb egy gigabájtnyi fájlt támogathatnak 32 bites rendszereken, vagy körülbelül két gigabájtot a 64 bites rendszereken a Node.js/V8 korlátozásai miatt. Ennél nagyobb fájlok esetén fontolja meg downloadToFile.
downloadToFile(string, number, number, FileDownloadOptions)	CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Letölt egy Azure-blobot egy helyi fájlba. Sikertelen, ha a megadott fájl elérési útja már kilép. Az eltolás és a darabszám megadása nem kötelező, a teljes blob letöltéséhez adja meg a 0- és a nem definiált értékeket.
exists(FileExistsOptions)	Igaz értéket ad vissza, ha a megadott fájl létezik; máskülönben hamis. MEGJEGYZÉS: Ezt a függvényt körültekintően használja, mivel előfordulhat, hogy egy meglévő fájlt más ügyfelek vagy alkalmazások törölnek. Fordítva, előfordulhat, hogy a függvény befejezése után más ügyfelek vagy alkalmazások új fájlokat adnak hozzá.
forceCloseAllHandles(FileForceCloseHandlesOptions)	Kényszerítse a fájl összes fogópontjának bezárását. Lásd: https://learn.microsoft.com/rest/api/storageservices/force-close-handles
forceCloseHandle(string, FileForceCloseHandlesOptions)	Kényszerítse be egy fájl adott leírójának bezárását. Lásd: https://learn.microsoft.com/rest/api/storageservices/force-close-handles
generateSasStringToSign(FileGenerateSasUrlOptions)	Csak megosztott kulcsú hitelesítő adatokkal létrehozott ügyfelek számára érhető el. Sztringet hoz létre a szolgáltatás megosztott hozzáférésű jogosultságkódjának (SAS) URI-jának aláírásához a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá. Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(FileGenerateSasUrlOptions)	Csak megosztott kulcsú hitelesítő adatokkal létrehozott ügyfelek számára érhető el. Szolgáltatásmegosztási jogosultságkód (SAS) URI-t hoz létre a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá. Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
getProperties(FileGetPropertiesOptions)	A felhasználó által definiált metaadatokat, a szabványos HTTP-tulajdonságokat és a fájl rendszertulajdonságait adja vissza. Nem adja vissza a fájl tartalmát. Lásd: https://learn.microsoft.com/rest/api/storageservices/get-file-properties
getRangeList(FileGetRangeListOptions)	Egy fájl érvényes tartományainak listáját adja vissza.
getRangeListDiff(string, FileGetRangeListOptions)	Az előző megosztási pillanatkép és a fájl közötti különbséget tartalmazó tartományok listáját adja vissza.
getShareLeaseClient(string)	Szerezz be egy ShareLeaseClient, amely kezeli a fájl bérleteit.
getSymbolicLink(FileGetSymbolicLinkOptions)	Csak NFS. Lekéri egy szimbolikus hivatkozás tartalmát.
listHandles(FileListHandlesOptions)	Egy aszinkron iterátort ad vissza az összes fogópont listázásához. a megadott fiók alatt. A .byPage() egy aszinkron iterátort ad vissza a lapok fogópontjainak listázásához.
rename(string, FileRenameOptions)	Fájl átnevezése. Ez az API csak egy fájl átnevezését támogatja ugyanabban a megosztásban.
resize(number, FileResizeOptions)	Fájl átméretezése. Lásd: https://learn.microsoft.com/rest/api/storageservices/set-file-properties
setHttpHeaders(FileHttpHeaders, FileSetHttpHeadersOptions)	BEÁLLÍTJA a HTTP-fejléceket a fájlon. Ha nincs megadva beállítás, vagy nincs megadva érték a fájl HTTP-fejléceihez a beállításokban, a program törli az érték nélküli FÁJL HTTP-fejléceit. Lásd: https://learn.microsoft.com/rest/api/storageservices/set-file-properties
setMetadata(Metadata, FileSetMetadataOptions)	Frissíti a felhasználó által megadott metaadatokat a megadott fájlhoz. Ha a beállításparaméterben nincsenek megadva metaadatok, a fájl metaadatai el lesznek távolítva. Lásd: https://learn.microsoft.com/rest/api/storageservices/set-file-metadata
setProperties(FileProperties)	Beállítja a fájl tulajdonságait. Lásd: https://learn.microsoft.com/rest/api/storageservices/set-file-properties
startCopyFromURL(string, FileStartCopyOptions)	Blobot vagy fájlt másol egy célfájlba a tárfiókon belül.
uploadData(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, FileParallelUploadOptions)	Létrehoz egy új Azure-fájlt, vagy lecserél egy meglévő Azure-fájlt, majd feltölt egy Puffer(Node)/Blob/ArrayBuffer/ArrayBufferView fájlt.
uploadFile(string, FileParallelUploadOptions)	CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Létrehoz egy új Azure-fájlt, vagy lecserél egy meglévő Azure-fájlt, majd feltölt egy helyi fájlt.
uploadRange(RequestBodyType, number, number, FileUploadRangeOptions)	Töltsön fel egy bájttartományt egy fájlba. Ez a művelet csak meglévő fájlon hívható meg. Nem módosítja a fájl méretét, tulajdonságait vagy metaadatait. A tartomány kezdetét és számát is meg kell adni. A tartomány mérete legfeljebb 4 MB lehet.
uploadRangeFromURL(string, number, number, number, FileUploadRangeFromURLOptions)	Töltsön fel egy bájttartományt egy fájlba, ahol a tartalom egy másik fájl URL-címéről olvasható. A tartomány mérete legfeljebb 4 MB lehet.
uploadResetableStream((offset: number, count?: number) => ReadableStream, number, FileParallelUploadOptions)	CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Elfogad egy Node.js olvasható stream-előállítót, és blokkokban feltölt egy Azure-fájlba. Az olvasható stream-előállítónak egy Node.js olvasható streamet kell visszaadnia a megadott eltolástól kezdve. Az eltolás a feltöltendő Azure-fájl eltolása.
uploadSeekableBlob((offset: number, size: number) => Blob, number, FileParallelUploadOptions)	CSAK BÖNGÉSZŐKBEN ÉRHETŐ EL. Feltölt egy böngészőblobobjektumot egy Azure-fájlba. Adatforrásként blobFactory szükséges, amelynek egy blobobjektumot kell visszaadnia a megadott eltolással és mérettel.
uploadStream(Readable, number, number, number, FileUploadStreamOptions)	CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL. Létrehoz egy új Azure-fájlt, vagy lecserél egy meglévő Azure-fájlt, majd feltölt egy Node.js olvasható streamet. Ez a metódus megpróbál létrehozni egy Azure-fájlt, majd megkezdi az adattömb adattömb szerinti feltöltését. Az adattömb méretét `bufferSize` paraméter határozza meg. Győződjön meg arról, hogy a stream lehetséges mérete nem haladja meg a fájlméretet. TELJESÍTMÉNYJAVÍTÁSI TIPPEK: A bemeneti stream highWaterMark tulajdonsága jobb, ha ugyanazt az értéket a bufferSize paraméterrel állítja be, így elkerülhetők a Puffer.concat() műveletek.
withShareSnapshot(string)	Létrehoz egy új ShareFileClient objektumot, amely megegyezik a forrással, de a megadott megosztási pillanatkép-időbélyeggel. A "" megadása eltávolítja a pillanatképet, és egy URL-címet ad vissza az alap ShareFileClienthez.

Konstruktor adatai

Létrehozza a ShareFileClient egy példányát.

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

Paraméterek

url: string

Egy Azure Storage-fájlra mutató URL-sztring, például "https://myaccount.file.core.windows.net/myshare/mydirectory/file". Az SAS hozzáfűzhető, ha AnonymousCredentialt használ, például "https://myaccount.file.core.windows.net/myshare/mydirectory/file?sasString". Ez a metódus egy kódolt VAGY nem kódolt, fájlra mutató URL-címet fogad el. A kódolt URL-sztring nem lesz kétszer feloldva, csak az URL-elérési út speciális karakterei lesznek feloldva. Ha azonban egy fájl vagy könyvtárnév %tartalmaz, a fájl- vagy könyvtárnevet az URL-címben kell kódolni. Például a "myfile%" nevű fájl url-címe "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25".

credential: Credential | TokenCredential

Ilyen például a StorageSharedKeyCredential vagy a TokenCredential, ha nincs megadva, akkor az AnonymousCredentialt használja a rendszer.

options: ShareClientOptions

Optional. A HTTP-folyamat konfigurálására vonatkozó beállítások.

Létrehozza a ShareFileClient egy példányát.

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

Paraméterek

url: string

pipeline: Pipeline

A newPipeline() hívása egy alapértelmezett folyamat létrehozásához vagy egy testreszabott folyamat megadásához.

options: ShareClientConfig

Tulajdonság adatai

A fájl neve

string name

Tulajdonság értéke

string

A fájl teljes elérési útja

string path

Tulajdonság értéke

string

A fájlügyfélnek megfelelő megosztás neve

string shareName

Tulajdonság értéke

string

Örökölt tulajdonság részletei

accountName: string

Tulajdonság értéke

string

örökölt StorageClient.accountName

URL-sztring értéke.

url: string

Tulajdonság értéke

string

örökölt StorageClient.url-címről

Metódus adatai

Megszakít egy függőben lévő fájlmásolási műveletet, és egy nulla hosszúságú és teljes metaadatokat tartalmazó célfájlt hagy.

Lásd: https://learn.microsoft.com/rest/api/storageservices/abort-copy-file

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

Paraméterek

copyId: string

A Fájl másolása művelet azonosítója a megszakításhoz.

options: FileAbortCopyFromURLOptions

Az URL-címről történő másolás megszakításának beállításai.

Válaszok

Promise<FileAbortCopyResponse>

Törli a megadott tartományt, és felszabadítja az adott tartomány tárterületét.

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

Paraméterek

offset: number

contentLength: number

options: FileClearRangeOptions

A Tartomány törlése művelet beállításai.

Válaszok

Promise<FileUploadRangeResponse>

Létrehoz egy új fájlt, vagy lecserél egy fájlt. Vegye figyelembe, hogy csak tartalom nélkül inicializálja a fájlt.

Lásd: https://learn.microsoft.com/rest/api/storageservices/create-file

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

Paraméterek

size: number

A fájl maximális méretét adja meg bájtban, legfeljebb 4 TB-ig.

options: FileCreateOptions

A Fájl létrehozása művelet beállításai.

Válaszok

Promise<FileCreateResponse>

Válaszadatok a Fájl létrehozása művelethez.

Példahasználat:

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

Csak NFS. Az elérési út által megadott fájlfájlra mutató kemény hivatkozást hoz létre.

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

Paraméterek

targetFile: string

A fájl elérési útja a kemény hivatkozás létrehozásához, a megosztást nem beleértve. Például: "targetDirectory/targetSubDirectory/.../targetFile"

options: FileCreateHardLinkOptions

A hard link művelet létrehozásának lehetőségei.

Válaszok

Promise<FileCreateHardLinkResponse>

Csak NFS. Szimbolikus hivatkozást hoz létre.

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

Paraméterek

linkText: string

Az eredeti fájl elérési útja, amelyre a szimbolikus hivatkozás mutat. Az elérési út karakterlánc típusú, amely nincs feloldva, és a rendszer úgy van tárolva, ahogy van. Az elérési út lehet abszolút elérési út vagy relatív elérési út a szimbolikus hivatkozásfájlban tárolt tartalomtól függően.

options: FileCreateSymbolicLinkOptions

A hard link művelet létrehozásának lehetőségei.

Válaszok

Promise<FileCreateSymbolicLinkResponse>

Eltávolítja a fájlt a tárfiókból. Ha egy fájl sikeresen törölve van, a rendszer azonnal eltávolítja a tárfiók indexéből, és többé nem érhető el az ügyfelek számára. A fájl adatai később törlődnek a szolgáltatásból a szemétgyűjtés során.

A fájl törlése sikertelen lesz a 409-ben (ütközés) és a SharingViolation hibakóddal, ha a fájl SMB-ügyfélen van megnyitva.

A fájl törlése nem támogatott megosztási pillanatképek esetén, amely egy megosztás írásvédett másolata. A megosztási pillanatképen végrehajtott művelet végrehajtása 400-zal meghiúsul (InvalidQueryParameterValue)

Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-file2

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

Paraméterek

options: FileDeleteOptions

Fájltörlési művelet beállításai.

Válaszok

Promise<FileDeleteResponse>

Válaszadatok a fájltörlési művelethez.

Eltávolítja a fájlt a tárfiókból, ha létezik. Ha egy fájl sikeresen törölve van, a rendszer azonnal eltávolítja a tárfiók indexéből, és többé nem érhető el az ügyfelek számára. A fájl adatai később törlődnek a szolgáltatásból a szemétgyűjtés során.

A fájl törlése sikertelen lesz a 409-ben (ütközés) és a SharingViolation hibakóddal, ha a fájl SMB-ügyfélen van megnyitva.

Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-file2

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

Paraméterek

options: FileDeleteOptions

Válaszok

Promise<FileDeleteIfExistsResponse>

Beolvassa vagy letölti a fájlt a rendszerből, beleértve annak metaadatait és tulajdonságait.

A Node.jsaz adatok olvasható streamben readableStreamBody
A böngészőkben az adatok ígéretes contentAsBlob

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-file

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

Paraméterek

offset: number

A fájl letöltésének helye 0-nál nagyobb vagy egyenlő

count: number

A letöltendő adatok száma 0-nál nagyobb. A letöltés a végéhez ér, ha nincs meghatározva

options: FileDownloadOptions

Fájlletöltési művelet beállításai.

Válaszok

Promise<FileDownloadResponseModel>

Válaszadatok a fájlletöltési művelethez.

Példahasználat (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);
  });
}

Példahasználatra (böngészők):

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

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

Egy Azure-fájlt a pufferrel párhuzamosan tölt le. Az eltolás és a darabszám megadása nem kötelező, a teljes fájl letöltéséhez adja meg a 0-t.

Figyelmeztetés: A pufferek legfeljebb egy gigabájtnyi fájlt támogathatnak 32 bites rendszereken, vagy körülbelül két gigabájtot a 64 bites rendszereken a Node.js/V8 korlátozásai miatt. Ennél nagyobb fájlok esetén fontolja meg downloadToFile.

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

Paraméterek

buffer: Buffer

A kitöltéshez szükséges puffernek a darabszámnál nagyobb hosszúságúnak kell lennie

offset: number

Az Azure-fájl letöltésének helye

count: number

Mennyi adatot kell letölteni. A letöltés a végéhez ér, ha nem definiált állapotot ad át

options: FileDownloadToBufferOptions

Válaszok

Promise<Buffer>

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL

Egy Azure-fájlt a pufferrel párhuzamosan tölt le. Az eltolás és a darabszám megadása nem kötelező, a teljes fájl letöltéséhez adja meg a 0-t mindkettőhöz

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

Paraméterek

offset: number

Az Azure-fájl letöltésének helye

count: number

Mennyi adatot kell letölteni. A letöltés a végéhez ér, ha nem definiált állapotot ad át

options: FileDownloadToBufferOptions

Válaszok

Promise<Buffer>

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

Letölt egy Azure-blobot egy helyi fájlba. Sikertelen, ha a megadott fájl elérési útja már kilép. Az eltolás és a darabszám megadása nem kötelező, a teljes blob letöltéséhez adja meg a 0- és a nem definiált értékeket.

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

Paraméterek

filePath: string

offset: number

A blokkblob letöltésének helye.

count: number

Mennyi adatot kell letölteni. A letöltés a végéhez ér, amikor nem definiált állapotot ad át.

options: FileDownloadOptions

A Blob letöltési beállításai.

Válaszok

Promise<FileDownloadResponseModel>

A blobletöltési művelet válaszadatai, de az olvashatóStreamBody értéke nincs meghatározva, mivel a tartalom már be van írva egy helyi fájlba a megadott elérési úton.

Igaz értéket ad vissza, ha a megadott fájl létezik; máskülönben hamis.

MEGJEGYZÉS: Ezt a függvényt körültekintően használja, mivel előfordulhat, hogy egy meglévő fájlt más ügyfelek vagy alkalmazások törölnek. Fordítva, előfordulhat, hogy a függvény befejezése után más ügyfelek vagy alkalmazások új fájlokat adnak hozzá.

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

Paraméterek

options: FileExistsOptions

beállítási lehetőségeket a Exists művelethez.

Válaszok

Promise<boolean>

Kényszerítse a fájl összes fogópontjának bezárását.

Lásd: https://learn.microsoft.com/rest/api/storageservices/force-close-handles

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

Paraméterek

options: FileForceCloseHandlesOptions

A leírók bezárásának kényszerítési lehetőségei.

Válaszok

Promise<CloseHandlesInfo>

Kényszerítse be egy fájl adott leírójának bezárását.

Lásd: https://learn.microsoft.com/rest/api/storageservices/force-close-handles

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

Paraméterek

handleId: string

Adott leíróazonosító nem lehet "*" csillag. A forceCloseAllHandles() használatával zárja be az összes fogópontot.

options: FileForceCloseHandlesOptions

Válaszok

Promise<FileForceCloseHandlesResponse>

Csak megosztott kulcsú hitelesítő adatokkal létrehozott ügyfelek számára érhető el.

Sztringet hoz létre a szolgáltatás megosztott hozzáférésű jogosultságkódjának (SAS) URI-jának aláírásához a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: FileGenerateSasUrlOptions): string

Paraméterek

options: FileGenerateSasUrlOptions

Nem kötelező paraméterek.

Válaszok

string

Az ügyfél által képviselt erőforrás URI-ját tartalmazó SAS URI, amelyet a létrehozott SAS-jogkivonat követ.

Csak megosztott kulcsú hitelesítő adatokkal létrehozott ügyfelek számára érhető el.

Szolgáltatásmegosztási jogosultságkód (SAS) URI-t hoz létre a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: FileGenerateSasUrlOptions): string

Paraméterek

options: FileGenerateSasUrlOptions

Nem kötelező paraméterek.

Válaszok

string

Az ügyfél által képviselt erőforrás URI-ját tartalmazó SAS URI, amelyet a létrehozott SAS-jogkivonat követ.

A felhasználó által definiált metaadatokat, a szabványos HTTP-tulajdonságokat és a fájl rendszertulajdonságait adja vissza. Nem adja vissza a fájl tartalmát.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-file-properties

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

Paraméterek

options: FileGetPropertiesOptions

A Fájlbeolvasási tulajdonságok művelet beállításai.

Válaszok

Promise<FileGetPropertiesResponse>

A Fájlbeolvasás tulajdonságai művelet válaszadatai.

Egy fájl érvényes tartományainak listáját adja vissza.

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

Paraméterek

options: FileGetRangeListOptions

A Fájl lekérése tartománylista műveletének beállításai.

Válaszok

Promise<FileGetRangeListResponse>

Az előző megosztási pillanatkép és a fájl közötti különbséget tartalmazó tartományok listáját adja vissza.

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

Paraméterek

prevShareSnapshot: string

Az előző pillanatkép paraméter egy átlátszatlan DateTime-érték, amely megadja az előző megosztási pillanatképet, amelyet össze kell hasonlítani.

options: FileGetRangeListOptions

Válaszok

Promise<FileGetRangeListDiffResponse>

Szerezz be egy ShareLeaseClient, amely kezeli a fájl bérleteit.

function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient

Paraméterek

proposeLeaseId: string

Kezdeti javasolt bérletazonosító.

Válaszok

ShareLeaseClient

Új ShareLeaseClient-objektum a fájl bérleteinek kezeléséhez.

Csak NFS. Lekéri egy szimbolikus hivatkozás tartalmát.

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

Paraméterek

options: FileGetSymbolicLinkOptions

Lehetőségek a szimbolikus hivatkozás működéséhez.

Válaszok

Promise<FileGetSymbolicLinkResponse>

Egy aszinkron iterátort ad vissza az összes fogópont listázásához. a megadott fiók alatt.

A .byPage() egy aszinkron iterátort ad vissza a lapok fogópontjainak listázásához.

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

Paraméterek

options: FileListHandlesOptions

A kezelőművelet listabeállításai.

Lapozást támogató asyncIterableIterator.

Válaszok

PagedAsyncIterableIterator<HandleItem, FileListHandlesResponse, PageSettings>

Fájl átnevezése. Ez az API csak egy fájl átnevezését támogatja ugyanabban a megosztásban.

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

Paraméterek

destinationPath: string

Megadja az átnevezendő cél elérési útját. Az elérési út kódolva lesz egy URL-címre a cél megadásához.

options: FileRenameOptions

Az átnevezési művelet beállításai.

Válaszok

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

Válaszadatok a fájl átnevezési műveletéhez.

Példahasználat:

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

Fájl átméretezése.

Lásd: https://learn.microsoft.com/rest/api/storageservices/set-file-properties

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

Paraméterek

length: number

A megadott méretre méretezi át a fájlt bájtban. Ha a megadott bájtérték kisebb, mint a fájl aktuális mérete, akkor a megadott bájtérték feletti összes tartomány törlődik.

options: FileResizeOptions

Fájl átméretezési műveletének beállításai.

Válaszok

Promise<FileSetHTTPHeadersResponse>

Válaszadatok a Fájlkészlet HTTP-fejlécek műveletéhez.

BEÁLLÍTJA a HTTP-fejléceket a fájlon.

Ha nincs megadva beállítás, vagy nincs megadva érték a fájl HTTP-fejléceihez a beállításokban, a program törli az érték nélküli FÁJL HTTP-fejléceit.

Lásd: https://learn.microsoft.com/rest/api/storageservices/set-file-properties

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

Paraméterek

fileHttpHeaders: FileHttpHeaders

options: FileSetHttpHeadersOptions

A HTTP-fejlécek fájlkészletének beállításai.

Válaszok

Promise<FileSetHTTPHeadersResponse>

Válaszadatok a Fájlkészlet HTTP-fejlécek műveletéhez.

Frissíti a felhasználó által megadott metaadatokat a megadott fájlhoz.

Ha a beállításparaméterben nincsenek megadva metaadatok, a fájl metaadatai el lesznek távolítva.

Lásd: https://learn.microsoft.com/rest/api/storageservices/set-file-metadata

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

Paraméterek

metadata: Metadata

Ha nincs megadva metaadat, az összes meglévő címtár-metaadat el lesz távolítva

options: FileSetMetadataOptions

A Fájlkészlet metaadatok műveletének beállításai.

Válaszok

Promise<FileSetMetadataResponse>

Válaszadatok a Fájlkészlet metaadatai művelethez.

Beállítja a fájl tulajdonságait.

Lásd: https://learn.microsoft.com/rest/api/storageservices/set-file-properties

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

Paraméterek

properties: FileProperties

Fájl tulajdonságai. A fájl HTTP-fejlécei (pl. Content-Type) esetén, ha nincsenek megadva értékek, a meglévő HTTP-fejlécek törlődnek. Más fájltulajdonságok (például fileAttributes) esetén, ha nincsenek megadva értékek, a meglévő értékek megmaradnak.

Válaszok

Promise<SetPropertiesResponse>

Blobot vagy fájlt másol egy célfájlba a tárfiókon belül.

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

Paraméterek

copySource: string

Megadja a forrásfájl vagy blob URL-címét, legfeljebb 2 KB hosszúságú. Ha egy fájlt egy másik fájlba szeretne másolni ugyanabban a tárfiókban, használhatja a megosztott kulcsot a forrásfájl hitelesítéséhez. Ha egy fájlt egy másik tárfiókból másol, vagy ha egy blobot ugyanabból a tárfiókból vagy egy másik tárfiókból másol, akkor a forrásfájlt vagy a blobot közös hozzáférésű aláírással kell hitelesítenie. Ha a forrás nyilvános blob, a másolási művelet végrehajtásához nincs szükség hitelesítésre. A megosztási pillanatképek fájlja másolási forrásként is megadható.

options: FileStartCopyOptions

Fájlindítási másolási művelet beállításai.

Válaszok

Promise<FileStartCopyResponse>

Létrehoz egy új Azure-fájlt, vagy lecserél egy meglévő Azure-fájlt, majd feltölt egy Puffer(Node)/Blob/ArrayBuffer/ArrayBufferView fájlt.

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

Paraméterek

data: Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer(Node), Blob, ArrayBuffer vagy ArrayBufferView

options: FileParallelUploadOptions

Válaszok

Promise<void>

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

Létrehoz egy új Azure-fájlt, vagy lecserél egy meglévő Azure-fájlt, majd feltölt egy helyi fájlt.

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

Paraméterek

filePath: string

A helyi fájl teljes elérési útja

options: FileParallelUploadOptions

Válaszok

Promise<void>

Töltsön fel egy bájttartományt egy fájlba. Ez a művelet csak meglévő fájlon hívható meg. Nem módosítja a fájl méretét, tulajdonságait vagy metaadatait. A tartomány kezdetét és számát is meg kell adni. A tartomány mérete legfeljebb 4 MB lehet.

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

Paraméterek

body: HttpRequestBody

Blob, sztring, ArrayBuffer, ArrayBufferView vagy olyan függvény, amely egy új olvasható adatfolyamot ad vissza, amelynek eltolása az adatforrás kezdetétől származik.

offset: number

A feltölteni kívánt cél Azure-fájl eltolása.

contentLength: number

A törzs hossza bájtban. A Buffer.byteLength() használatával kiszámíthatja egy sztring törzshosszát, beleértve a nem Base64/Hex kódolású karaktereket is.

options: FileUploadRangeOptions

A Fájlfeltöltési tartomány művelet beállításai.

Válaszok

Promise<FileUploadRangeResponse>

Válaszadatok a Fájlfeltöltési tartomány művelethez.

Példahasználat:

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

Töltsön fel egy bájttartományt egy fájlba, ahol a tartalom egy másik fájl URL-címéről olvasható. A tartomány mérete legfeljebb 4 MB lehet.

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

Paraméterek

sourceURL: string

Adjon meg egy URL-címet a másolási forráshoz, amely lehet, hogy a hitelesítéshez szükséges közös hozzáférésű jogosultságkód (SAS).

sourceOffset: number

A forrás eltolása, amelyből másolni szeretne. Adja át a 0-t a forrásfájl elejéről való másoláshoz.

destOffset: number

Célfájl eltolása.

count: number

A forrásfájlból feltöltendő bájtok száma.

options: FileUploadRangeFromURLOptions

A fájl konfigurálására szolgáló beállítások – Tartomány feltöltése URL-műveletből.

Válaszok

Promise<FileUploadRangeFromURLResponse>

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

Elfogad egy Node.js olvasható stream-előállítót, és blokkokban feltölt egy Azure-fájlba. Az olvasható stream-előállítónak egy Node.js olvasható streamet kell visszaadnia a megadott eltolástól kezdve. Az eltolás a feltöltendő Azure-fájl eltolása.

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

Paraméterek

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

Egy Node.js olvasható streamet ad vissza a megadott eltolástól kezdve

size: number

Az Azure-fájl mérete

options: FileParallelUploadOptions

Válaszok

Promise<void>

CSAK BÖNGÉSZŐKBEN ÉRHETŐ EL.

Feltölt egy böngészőblobobjektumot egy Azure-fájlba. Adatforrásként blobFactory szükséges, amelynek egy blobobjektumot kell visszaadnia a megadott eltolással és mérettel.

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

Paraméterek

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

size: number

options: FileParallelUploadOptions

Válaszok

Promise<void>

CSAK NODE.JS FUTTATÓKÖRNYEZETBEN ÉRHETŐ EL.

Létrehoz egy új Azure-fájlt, vagy lecserél egy meglévő Azure-fájlt, majd feltölt egy Node.js olvasható streamet. Ez a metódus megpróbál létrehozni egy Azure-fájlt, majd megkezdi az adattömb adattömb szerinti feltöltését. Az adattömb méretét bufferSize paraméter határozza meg. Győződjön meg arról, hogy a stream lehetséges mérete nem haladja meg a fájlméretet.

TELJESÍTMÉNYJAVÍTÁSI TIPPEK:

A bemeneti stream highWaterMark tulajdonsága jobb, ha ugyanazt az értéket a bufferSize paraméterrel állítja be, így elkerülhetők a Puffer.concat() műveletek.

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

Paraméterek

stream: Readable

Node.js olvasható streamet. A fájlméretnek kisebbnek vagy egyenlőnek kell lennie.

size: number

A létrehozandó fájl mérete. A maximális megengedett méret 4 TB. Ha ez az érték nagyobb, mint a stream mérete, üres bájtok lesznek a fájlszélben.

bufferSize: number

A bájtokban lefoglalt összes puffer mérete, valamint a feltöltött fájl adattömb/tartománymérete is. A méretnek 0-nál nagyobbnak és kisebbnek kell lennie, mint 4 * 1024 * 1024 (4 MB)

maxBuffers: number

A maximális pufferek a feltöltés során lesznek lefoglalva, pozitív korreláció a maximális feltöltési egyidejűséggel

options: FileUploadStreamOptions

Válaszok

Promise<void>

Létrehoz egy új ShareFileClient objektumot, amely megegyezik a forrással, de a megadott megosztási pillanatkép-időbélyeggel. A "" megadása eltávolítja a pillanatképet, és egy URL-címet ad vissza az alap ShareFileClienthez.

function withShareSnapshot(shareSnapshot: string): ShareFileClient

Paraméterek

shareSnapshot: string

A megosztási pillanatkép időbélyege.

Válaszok

ShareFileClient

Egy új ShareFileClient objektum, amely megegyezik a forrással, de a megadott megosztási pillanatkép-időbélyeggel.

Megosztás a következőn keresztül:

ShareFileClient class

Konstruktorok

Tulajdonságok

Örökölt tulajdonságok

Metódusok

Konstruktor adatai

ShareFileClient(string, Credential | TokenCredential, ShareClientOptions)

Paraméterek

ShareFileClient(string, Pipeline, ShareClientConfig)

Paraméterek

Tulajdonság adatai

name

Tulajdonság értéke

path

Tulajdonság értéke

shareName

Tulajdonság értéke

Örökölt tulajdonság részletei

accountName

Tulajdonság értéke

url

Tulajdonság értéke

Metódus adatai

abortCopyFromURL(string, FileAbortCopyFromURLOptions)

Paraméterek

Válaszok

clearRange(number, number, FileClearRangeOptions)

Paraméterek

Válaszok

create(number, FileCreateOptions)

Paraméterek

Válaszok

createHardLink(string, FileCreateHardLinkOptions)

Paraméterek

Válaszok

createSymbolicLink(string, FileCreateSymbolicLinkOptions)

Paraméterek

Válaszok

delete(FileDeleteOptions)

Paraméterek

Válaszok

deleteIfExists(FileDeleteOptions)

Paraméterek

Válaszok

download(number, number, FileDownloadOptions)

Paraméterek

Válaszok

downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions)

Paraméterek

Válaszok

downloadToBuffer(number, number, FileDownloadToBufferOptions)

Paraméterek

Válaszok

downloadToFile(string, number, number, FileDownloadOptions)

Paraméterek

Válaszok

exists(FileExistsOptions)

Paraméterek

Válaszok

forceCloseAllHandles(FileForceCloseHandlesOptions)

Paraméterek

Válaszok

forceCloseHandle(string, FileForceCloseHandlesOptions)

Paraméterek

Válaszok

generateSasStringToSign(FileGenerateSasUrlOptions)

Paraméterek

Válaszok

generateSasUrl(FileGenerateSasUrlOptions)

Paraméterek

Válaszok

getProperties(FileGetPropertiesOptions)

Paraméterek

Válaszok

getRangeList(FileGetRangeListOptions)

Paraméterek

Válaszok

getRangeListDiff(string, FileGetRangeListOptions)

Paraméterek