ShareFileClient class

Balíček:: @azure/storage-file-share

ShareFileClient představuje adresu URL souboru Azure Storage.

Extends: StorageClient

Konstruktory

ShareFileClient(string, Credential \| TokenCredential, ShareClientOptions)	Vytvoří instanci ShareFileClient.
ShareFileClient(string, Pipeline, ShareClientConfig)	Vytvoří instanci ShareFileClient.

Vlastnosti

name	Název souboru
path	Úplná cesta k souboru
shareName	Název sdílené složky odpovídající tomuto klientovi souborů

Zděděné vlastnosti

accountName
url	Hodnota řetězce adresy URL.

Metody

abortCopyFromURL(string, FileAbortCopyFromURLOptions)	Přeruší čekající operaci kopírování souboru a ponechá cílový soubor s nulovou délkou a úplnými metadaty. Viz https://learn.microsoft.com/rest/api/storageservices/abort-copy-file
clearRange(number, number, FileClearRangeOptions)	Vymaže zadaný rozsah a uvolní místo použité v úložišti pro danou oblast.
create(number, FileCreateOptions)	Vytvoří nový soubor nebo nahradí soubor. Všimněte si, že inicializuje pouze soubor bez obsahu. Viz https://learn.microsoft.com/rest/api/storageservices/create-file
createHardLink(string, FileCreateHardLinkOptions)	Pouze systém souborů NFS. Vytvoří pevný odkaz na soubor určený cestou.
createSymbolicLink(string, FileCreateSymbolicLinkOptions)	Pouze systém souborů NFS. Vytvoří symbolický odkaz.
delete(FileDeleteOptions)	Odebere soubor z účtu úložiště. Když se soubor úspěšně odstraní, okamžitě se odebere z indexu účtu úložiště a už není přístupný pro klienty. Data souboru se později ze služby během uvolňování paměti odeberou. Odstranění souboru selže se stavovým kódem 409 (Konflikt) a kód chyby SharingViolation, pokud je soubor otevřený v klientovi SMB. Odstranění souboru není podporováno na snímku sdílené složky, což je kopie sdílené složky jen pro čtení. Pokus o provedení této operace na snímku sdílené složky selže se 400 (InvalidQueryParameterValue) Viz https://learn.microsoft.com/rest/api/storageservices/delete-file2
deleteIfExists(FileDeleteOptions)	Odebere soubor z účtu úložiště, pokud existuje. Když se soubor úspěšně odstraní, okamžitě se odebere z indexu účtu úložiště a už není přístupný pro klienty. Data souboru se později ze služby během uvolňování paměti odeberou. Odstranění souboru selže se stavovým kódem 409 (Konflikt) a kód chyby SharingViolation, pokud je soubor otevřený v klientovi SMB. Odstranění souboru není podporováno na snímku sdílené složky, což je kopie sdílené složky jen pro čtení. Pokus o provedení této operace na snímku sdílené složky selže se 400 (InvalidQueryParameterValue) Viz https://learn.microsoft.com/rest/api/storageservices/delete-file2
download(number, number, FileDownloadOptions)	Načte nebo stáhne soubor ze systému, včetně jeho metadat a vlastností. V Node.jsvrací data v `readableStreamBody` čitelného datového proudu. V prohlížečích se data vrací ve slibu `contentAsBlob` Viz https://learn.microsoft.com/rest/api/storageservices/get-file
downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions)	K DISPOZICI POUZE V NODE.JS RUNTIME. Stáhne soubor Azure paralelně do vyrovnávací paměti. Posun a počet jsou volitelné, předání 0 pro stažení celého souboru. Upozornění: Vyrovnávací paměti můžou podporovat pouze soubory až o jeden gigabajt v 32bitových systémech nebo přibližně 2 gigabajty v 64bitových systémech kvůli omezením Node.js/V8. U souborů větších, než je tato velikost, zvažte downloadToFile.
downloadToBuffer(number, number, FileDownloadToBufferOptions)	K DISPOZICI POUZE V NODE.JS RUNTIME Stáhne soubor Azure paralelně do vyrovnávací paměti. Posun a počet jsou volitelné, předání 0 pro stažení celého souboru Upozornění: Vyrovnávací paměti můžou podporovat pouze soubory až o jeden gigabajt v 32bitových systémech nebo přibližně 2 gigabajty v 64bitových systémech kvůli omezením Node.js/V8. U souborů větších, než je tato velikost, zvažte downloadToFile.
downloadToFile(string, number, number, FileDownloadOptions)	K DISPOZICI POUZE V NODE.JS RUNTIME. Stáhne objekt blob Azure do místního souboru. Selže, pokud se daná cesta k souboru již ukončí. Posun a počet jsou volitelné, předání 0 a nedefinované, aby se stáhl celý objekt blob.
exists(FileExistsOptions)	Vrátí hodnotu true, pokud zadaný soubor existuje; jinak nepravda. POZNÁMKA: Tuto funkci používejte opatrně, protože existující soubor může být odstraněn jinými klienty nebo aplikacemi. Po dokončení této funkce mohou být nové soubory přidány jinými klienty nebo aplikacemi.
forceCloseAllHandles(FileForceCloseHandlesOptions)	Vynutit zavření všech popisovačů souboru. Viz https://learn.microsoft.com/rest/api/storageservices/force-close-handles
forceCloseHandle(string, FileForceCloseHandlesOptions)	Vynuťte zavření určitého popisovače souboru. Viz https://learn.microsoft.com/rest/api/storageservices/force-close-handles
generateSasStringToSign(FileGenerateSasUrlOptions)	K dispozici pouze pro klienty vytvořené pomocí přihlašovacích údajů sdíleného klíče. Vygeneruje řetězec pro podepsání identifikátoru URI sdíleného přístupového podpisu služby (SAS) na základě vlastností klienta a parametrů předaných. Sas je podepsán přihlašovacími údaji sdíleného klíče klienta. Viz https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(FileGenerateSasUrlOptions)	K dispozici pouze pro klienty vytvořené pomocí přihlašovacích údajů sdíleného klíče. Vygeneruje identifikátor URI sdíleného přístupového podpisu (SAS) služby na základě vlastností klienta a parametrů předaných. Sas je podepsán přihlašovacími údaji sdíleného klíče klienta. Viz https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
getProperties(FileGetPropertiesOptions)	Vrátí všechna uživatelsky definovaná metadata, standardní vlastnosti HTTP a systémové vlastnosti souboru. Nevrací obsah souboru. Viz https://learn.microsoft.com/rest/api/storageservices/get-file-properties
getRangeList(FileGetRangeListOptions)	Vrátí seznam platných oblastí pro soubor.
getRangeListDiff(string, FileGetRangeListOptions)	Vrátí seznam oblastí, které se liší mezi předchozím snímkem sdílené složky a tímto souborem.
getShareLeaseClient(string)	Získejte ShareLeaseClient, který spravuje zapůjčení souboru.
getSymbolicLink(FileGetSymbolicLinkOptions)	Pouze systém souborů NFS. Získá obsah symbolického odkazu.
listHandles(FileListHandlesOptions)	Vrátí asynchronní iterátor, který zobrazí seznam všech popisovačů. pod zadaným účtem. .byPage() vrátí asynchronní iterátor pro výpis popisovačů na stránkách.
rename(string, FileRenameOptions)	Přejmenuje soubor. Toto rozhraní API podporuje přejmenování souboru pouze ve stejné sdílené složce.
resize(number, FileResizeOptions)	Změňte velikost souboru. Viz https://learn.microsoft.com/rest/api/storageservices/set-file-properties
setHttpHeaders(FileHttpHeaders, FileSetHttpHeadersOptions)	Nastaví hlavičky HTTP v souboru. Pokud není k dispozici žádná možnost nebo žádná hodnota zadaná pro hlavičky HTTP souboru v možnostech, tyto hlavičky HTTP souboru bez hodnoty se vymažou. Viz https://learn.microsoft.com/rest/api/storageservices/set-file-properties
setMetadata(Metadata, FileSetMetadataOptions)	Aktualizuje uživatelsky definovaná metadata pro zadaný soubor. Pokud v parametru možnosti nejsou definována žádná metadata, odeberou se metadata souboru. Viz https://learn.microsoft.com/rest/api/storageservices/set-file-metadata
setProperties(FileProperties)	Nastaví vlastnosti souboru. Viz https://learn.microsoft.com/rest/api/storageservices/set-file-properties
startCopyFromURL(string, FileStartCopyOptions)	Zkopíruje objekt blob nebo soubor do cílového souboru v rámci účtu úložiště.
uploadData(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, FileParallelUploadOptions)	Vytvoří nový soubor Azure nebo nahradí existující soubor Azure a pak do něj nahraje vyrovnávací paměť (uzel)/Blob/ArrayBuffer/ArrayBufferView.
uploadFile(string, FileParallelUploadOptions)	K DISPOZICI POUZE V NODE.JS RUNTIME. Vytvoří nový soubor Azure nebo nahradí existující soubor Azure a pak do něj nahraje místní soubor.
uploadRange(RequestBodyType, number, number, FileUploadRangeOptions)	Nahrajte do souboru rozsah bajtů. Tuto operaci lze volat pouze u existujícího souboru. Nezmění velikost, vlastnosti ani metadata souboru. Je nutné zadat počáteční i počet rozsahu. Rozsah může mít velikost až 4 MB.
uploadRangeFromURL(string, number, number, number, FileUploadRangeFromURLOptions)	Nahrajte rozsah bajtů do souboru, kde se obsah načítá z adresy URL jiného souboru. Rozsah může mít velikost až 4 MB.
uploadResetableStream((offset: number, count?: number) => ReadableStream, number, FileParallelUploadOptions)	K DISPOZICI POUZE V NODE.JS RUNTIME. Přijímá Node.js objekt pro čtení streamu a nahrává se do souboru Azure v blocích. Objekt pro čtení streamu musí vrátit Node.js čitelný datový proud počínaje definovaným posunem. Posun je posun v souboru Azure, který se má nahrát.
uploadSeekableBlob((offset: number, size: number) => Blob, number, FileParallelUploadOptions)	K DISPOZICI POUZE V PROHLÍŽEČÍCH. Nahraje objekt blob prohlížeče do souboru Azure. Vyžaduje objekt blobFactory jako zdroj dat, který musí vrátit objekt blob se zadaným posunem a velikostí.
uploadStream(Readable, number, number, number, FileUploadStreamOptions)	K DISPOZICI POUZE V NODE.JS RUNTIME. Vytvoří nový soubor Azure nebo nahradí existující soubor Azure a pak do něj nahraje Node.js stream s možností čtení. Tato metoda se pokusí vytvořit soubor Azure a pak začne nahrávat blok dat podle bloků dat. Velikost bloku dat je definována parametrem `bufferSize`. Ujistěte se, že potenciální velikost streamu nepřekračuje velikost souboru. TIPY KE ZLEPŠENÍ VÝKONU: Vstupní datový proud highWaterMark je lepší nastavit stejnou hodnotu s parametrem bufferSize, což zabrání operacím Buffer.concat().
withShareSnapshot(string)	Vytvoří nový objekt ShareFileClient shodný se zdrojem, ale se zadaným časovým razítkem snímku sdílené složky. Zadejte "" odebere snímek a vrátí adresu URL základního ShareFileClient.

Podrobnosti konstruktoru

Vytvoří instanci ShareFileClient.

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

Parametry

url: string

Řetězec adresy URL odkazující na soubor Azure Storage, například "https://myaccount.file.core.windows.net/myshare/mydirectory/file". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.file.core.windows.net/myshare/mydirectory/file?sasString". Tato metoda přijímá zakódovanou adresu URL nebo nekódovanou adresu URL odkazující na soubor. Kódovaný řetězec adresy URL nebude uchvácen dvakrát, pouze speciální znaky v cestě URL budou uchvácené. Pokud však název souboru nebo adresáře obsahuje %, musí být název souboru nebo adresáře kódován v adrese URL. Například soubor s názvem "myfile%", adresa URL by měla být "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25".

credential: Credential | TokenCredential

Například , StorageSharedKeyCredential nebo TokenCredential, Pokud není zadán, AnonymousCredential se používá.

options: ShareClientOptions

Optional. Možnosti konfigurace kanálu HTTP

Vytvoří instanci ShareFileClient.

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

Parametry

url: string

pipeline: Pipeline

Voláním metody newPipeline() vytvořte výchozí kanál nebo zadejte přizpůsobený kanál.

options: ShareClientConfig

Podrobnosti vlastnosti

Název souboru

string name

Hodnota vlastnosti

string

Úplná cesta k souboru

string path

Hodnota vlastnosti

string

Název sdílené složky odpovídající tomuto klientovi souborů

string shareName

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

accountName: string

Hodnota vlastnosti

string

zděděno ze StorageClient.accountName

Hodnota řetězce adresy URL.

url: string

Hodnota vlastnosti

string

zděděno ze StorageClient.url

Podrobnosti metody

Přeruší čekající operaci kopírování souboru a ponechá cílový soubor s nulovou délkou a úplnými metadaty.

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

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

Parametry

copyId: string

ID operace Kopírování souboru k přerušení.

options: FileAbortCopyFromURLOptions

Možnosti operace přerušení kopírování souboru z adresy URL

Návraty

Promise<FileAbortCopyResponse>

Vymaže zadaný rozsah a uvolní místo použité v úložišti pro danou oblast.

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

Parametry

offset: number

contentLength: number

options: FileClearRangeOptions

Možnosti operace Vymazat rozsah souboru

Návraty

Promise<FileUploadRangeResponse>

Vytvoří nový soubor nebo nahradí soubor. Všimněte si, že inicializuje pouze soubor bez obsahu.

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

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

Parametry

size: number

Určuje maximální velikost v bajtech souboru až do 4 TB.

options: FileCreateOptions

Možnosti operace Vytvoření souboru

Návraty

Promise<FileCreateResponse>

Data odpovědí pro operaci Vytvoření souboru.

Příklad použití:

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

Pouze systém souborů NFS. Vytvoří pevný odkaz na soubor určený cestou.

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

Parametry

targetFile: string

Cesta k souboru pro vytvoření pevného odkazu, který neobsahuje sdílenou složku. Příklad: targetDirectory/targetSubDirectory/.../targetFile

options: FileCreateHardLinkOptions

Možnosti vytvoření operace pevného propojení

Návraty

Promise<FileCreateHardLinkResponse>

Pouze systém souborů NFS. Vytvoří symbolický odkaz.

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

Parametry

linkText: string

Cesta k původnímu souboru, na který symbolický odkaz ukazuje. Cesta je typu string, který není přeložen a je uložen tak, jak je. Cesta může být absolutní cesta nebo relativní cesta v závislosti na obsahu uloženém v souboru symbolické vazby.

options: FileCreateSymbolicLinkOptions

Možnosti vytvoření operace pevného propojení

Návraty

Promise<FileCreateSymbolicLinkResponse>

Odebere soubor z účtu úložiště. Když se soubor úspěšně odstraní, okamžitě se odebere z indexu účtu úložiště a už není přístupný pro klienty. Data souboru se později ze služby během uvolňování paměti odeberou.

Odstranění souboru selže se stavovým kódem 409 (Konflikt) a kód chyby SharingViolation, pokud je soubor otevřený v klientovi SMB.

Odstranění souboru není podporováno na snímku sdílené složky, což je kopie sdílené složky jen pro čtení. Pokus o provedení této operace na snímku sdílené složky selže se 400 (InvalidQueryParameterValue)

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

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

Parametry

options: FileDeleteOptions

Možnosti operace odstranění souboru

Návraty

Promise<FileDeleteResponse>

Data odpovědí pro operaci Odstranění souboru.

Odebere soubor z účtu úložiště, pokud existuje. Když se soubor úspěšně odstraní, okamžitě se odebere z indexu účtu úložiště a už není přístupný pro klienty. Data souboru se později ze služby během uvolňování paměti odeberou.

Odstranění souboru selže se stavovým kódem 409 (Konflikt) a kód chyby SharingViolation, pokud je soubor otevřený v klientovi SMB.

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

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

Parametry

options: FileDeleteOptions

Návraty

Promise<FileDeleteIfExistsResponse>

Načte nebo stáhne soubor ze systému, včetně jeho metadat a vlastností.

V Node.jsvrací data v readableStreamBody čitelného datového proudu.
V prohlížečích se data vrací ve slibu contentAsBlob

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

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

Parametry

offset: number

Ze které pozice souboru ke stažení, větší než nebo rovno 0

count: number

Kolik dat se má stáhnout, větší než 0 Po nedefinované verzi se stáhne na konec.

options: FileDownloadOptions

Možnosti operace stažení souboru

Návraty

Promise<FileDownloadResponseModel>

Data odpovědí pro operaci Stažení souboru.

Příklad použití (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říklad použití (prohlížeče):

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

K DISPOZICI POUZE V NODE.JS RUNTIME.

Stáhne soubor Azure paralelně do vyrovnávací paměti. Posun a počet jsou volitelné, předání 0 pro stažení celého souboru.

Upozornění: Vyrovnávací paměti můžou podporovat pouze soubory až o jeden gigabajt v 32bitových systémech nebo přibližně 2 gigabajty v 64bitových systémech kvůli omezením Node.js/V8. U souborů větších, než je tato velikost, zvažte downloadToFile.

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

Parametry

buffer: Buffer

Vyrovnávací paměť, která se má vyplnit, musí mít délku větší než počet.

offset: number

Ze které pozice souboru Azure ke stažení

count: number

Kolik dat se má stáhnout. Při předání nedefinovaného souboru se stáhne na konec.

options: FileDownloadToBufferOptions

Návraty

Promise<Buffer>

K DISPOZICI POUZE V NODE.JS RUNTIME

Stáhne soubor Azure paralelně do vyrovnávací paměti. Posun a počet jsou volitelné, předání 0 pro stažení celého souboru

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

Parametry

offset: number

Ze které pozice souboru Azure ke stažení

count: number

Kolik dat se má stáhnout. Při předání nedefinovaného souboru se stáhne na konec.

options: FileDownloadToBufferOptions

Návraty

Promise<Buffer>

K DISPOZICI POUZE V NODE.JS RUNTIME.

Stáhne objekt blob Azure do místního souboru. Selže, pokud se daná cesta k souboru již ukončí. Posun a počet jsou volitelné, předání 0 a nedefinované, aby se stáhl celý objekt blob.

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

Parametry

filePath: string

offset: number

Z jaké pozice objektu blob bloku se má stáhnout.

count: number

Kolik dat se má stáhnout. Při předání nedefinovaného souboru se stáhne na konec.

options: FileDownloadOptions

Možnosti stahování objektů blob

Návraty

Promise<FileDownloadResponseModel>

Data odpovědi pro operaci stažení objektu blob, ale s parametrem readableStreamBody nastavenou na nedefinovanou, protože jeho obsah je již přečten a zapsán do místního souboru v zadané cestě.

Vrátí hodnotu true, pokud zadaný soubor existuje; jinak nepravda.

POZNÁMKA: Tuto funkci používejte opatrně, protože existující soubor může být odstraněn jinými klienty nebo aplikacemi. Po dokončení této funkce mohou být nové soubory přidány jinými klienty nebo aplikacemi.

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

Parametry

options: FileExistsOptions

možnosti pro operaci Existuje.

Návraty

Promise<boolean>

Vynutit zavření všech popisovačů souboru.

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

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

Parametry

options: FileForceCloseHandlesOptions

Možnosti vynucení operace zavření popisovačů

Návraty

Promise<CloseHandlesInfo>

Vynuťte zavření určitého popisovače souboru.

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

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

Parametry

handleId: string

Konkrétní ID popisovače nemůže být hvězdička "*". Pomocí forceCloseAllHandles() zavřete všechny popisovače.

options: FileForceCloseHandlesOptions

Návraty

Promise<FileForceCloseHandlesResponse>

K dispozici pouze pro klienty vytvořené pomocí přihlašovacích údajů sdíleného klíče.

Vygeneruje řetězec pro podepsání identifikátoru URI sdíleného přístupového podpisu služby (SAS) na základě vlastností klienta a parametrů předaných. Sas je podepsán přihlašovacími údaji sdíleného klíče klienta.

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

function generateSasStringToSign(options: FileGenerateSasUrlOptions): string

Parametry

options: FileGenerateSasUrlOptions

Volitelné parametry.

Návraty

string

Identifikátor URI SAS, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.

K dispozici pouze pro klienty vytvořené pomocí přihlašovacích údajů sdíleného klíče.

Vygeneruje identifikátor URI sdíleného přístupového podpisu (SAS) služby na základě vlastností klienta a parametrů předaných. Sas je podepsán přihlašovacími údaji sdíleného klíče klienta.

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

function generateSasUrl(options: FileGenerateSasUrlOptions): string

Parametry

options: FileGenerateSasUrlOptions

Volitelné parametry.

Návraty

string

Identifikátor URI SAS, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.

Vrátí všechna uživatelsky definovaná metadata, standardní vlastnosti HTTP a systémové vlastnosti souboru. Nevrací obsah souboru.

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

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

Parametry

options: FileGetPropertiesOptions

Možnosti operace Získání vlastností souboru

Návraty

Promise<FileGetPropertiesResponse>

Data odpovědí pro operaci Získání vlastností souboru.

Vrátí seznam platných oblastí pro soubor.

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

Parametry

options: FileGetRangeListOptions

Možnosti operace Získání rozsahu souborů

Návraty

Promise<FileGetRangeListResponse>

Vrátí seznam oblastí, které se liší mezi předchozím snímkem sdílené složky a tímto souborem.

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

Parametry

prevShareSnapshot: string

Předchozí parametr snímku je neprůhlená hodnota DateTime, která určuje předchozí snímek sdílené složky pro porovnání.

options: FileGetRangeListOptions

Návraty

Promise<FileGetRangeListDiffResponse>

Získejte ShareLeaseClient, který spravuje zapůjčení souboru.

function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient

Parametry

proposeLeaseId: string

Počáteční navrhované ID zapůjčení

Návraty

ShareLeaseClient

Nový objekt ShareLeaseClient pro správu zapůjčení v souboru.

Pouze systém souborů NFS. Získá obsah symbolického odkazu.

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

Parametry

options: FileGetSymbolicLinkOptions

Možnosti pro získání operace symbolického odkazu.

Návraty

Promise<FileGetSymbolicLinkResponse>

Vrátí asynchronní iterátor, který zobrazí seznam všech popisovačů. pod zadaným účtem.

.byPage() vrátí asynchronní iterátor pro výpis popisovačů na stránkách.

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

Parametry

options: FileListHandlesOptions

Možnosti operací zpracování seznamu

AsyncIterableIterator, který podporuje stránkování.

Návraty

PagedAsyncIterableIterator<HandleItem, FileListHandlesResponse, PageSettings>

Přejmenuje soubor. Toto rozhraní API podporuje přejmenování souboru pouze ve stejné sdílené složce.

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

Parametry

destinationPath: string

Určuje cílovou cestu, na kterou se má přejmenovat. Cesta se zakóduje tak, aby se do adresy URL zadal cíl.

options: FileRenameOptions

Možnosti operace přejmenování

Návraty

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

Data odpovědi pro operaci přejmenování souboru.

Příklad použití:

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

Změňte velikost souboru.

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

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

Parametry

length: number

Změní velikost souboru na zadanou velikost v bajtech. Pokud je zadaná bajtová hodnota menší než aktuální velikost souboru, vymažou se všechny rozsahy nad zadanou hodnotou bajtů.

options: FileResizeOptions

Možnosti operace změny velikosti souboru

Návraty

Promise<FileSetHTTPHeadersResponse>

Data odpovědí pro operaci Hlavičky HTTP sady souborů

Nastaví hlavičky HTTP v souboru.

Pokud není k dispozici žádná možnost nebo žádná hodnota zadaná pro hlavičky HTTP souboru v možnostech, tyto hlavičky HTTP souboru bez hodnoty se vymažou.

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

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

Parametry

fileHttpHeaders: FileHttpHeaders

options: FileSetHttpHeadersOptions

Možnosti operace Nastavení hlaviček HTTP

Návraty

Promise<FileSetHTTPHeadersResponse>

Data odpovědí pro operaci Hlavičky HTTP sady souborů

Aktualizuje uživatelsky definovaná metadata pro zadaný soubor.

Pokud v parametru možnosti nejsou definována žádná metadata, odeberou se metadata souboru.

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

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

Parametry

metadata: Metadata

Pokud nejsou k dispozici žádná metadata, odeberou se všechna existující metadata adresáře.

options: FileSetMetadataOptions

Možnosti operace nastavení metadat souboru

Návraty

Promise<FileSetMetadataResponse>

Data odpovědí pro operaci metadat sady souborů.

Nastaví vlastnosti souboru.

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

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

Parametry

properties: FileProperties

Vlastnosti souboru. Pro hlavičky HTTP souboru (např. Content-Type), pokud nejsou zadány žádné hodnoty, stávající hlavičky HTTP budou odebrány. Pro jiné vlastnosti souboru (např. fileAttributes), pokud nejsou zadané žádné hodnoty, stávající hodnoty se zachovají.

Návraty

Promise<SetPropertiesResponse>

Zkopíruje objekt blob nebo soubor do cílového souboru v rámci účtu úložiště.

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

Parametry

copySource: string

Určuje adresu URL zdrojového souboru nebo objektu blob o délce až 2 kB. Pokud chcete zkopírovat soubor do jiného souboru ve stejném účtu úložiště, můžete k ověření zdrojového souboru použít sdílený klíč. Pokud kopírujete soubor z jiného účtu úložiště nebo pokud kopírujete objekt blob ze stejného účtu úložiště nebo jiného účtu úložiště, musíte zdrojový soubor nebo objekt blob ověřit pomocí sdíleného přístupového podpisu. Pokud je zdrojem veřejný objekt blob, k provedení operace kopírování se nevyžaduje žádné ověřování. Soubor ve snímku sdílené složky lze také zadat jako zdroj kopírování.

options: FileStartCopyOptions

Možnosti operace spuštění kopírování souboru

Návraty

Promise<FileStartCopyResponse>

Vytvoří nový soubor Azure nebo nahradí existující soubor Azure a pak do něj nahraje vyrovnávací paměť (uzel)/Blob/ArrayBuffer/ArrayBufferView.

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

Parametry

data: Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer(Node), Blob, ArrayBuffer nebo ArrayBufferView

options: FileParallelUploadOptions

Návraty

Promise<void>

K DISPOZICI POUZE V NODE.JS RUNTIME.

Vytvoří nový soubor Azure nebo nahradí existující soubor Azure a pak do něj nahraje místní soubor.

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

Parametry

filePath: string

Úplná cesta k místnímu souboru

options: FileParallelUploadOptions

Návraty

Promise<void>

Nahrajte do souboru rozsah bajtů. Tuto operaci lze volat pouze u existujícího souboru. Nezmění velikost, vlastnosti ani metadata souboru. Je nutné zadat počáteční i počet rozsahu. Rozsah může mít velikost až 4 MB.

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

Parametry

body: HttpRequestBody

Objekt blob, řetězec, ArrayBuffer, ArrayBufferView nebo funkce, která vrací nový čitelný datový proud, jehož posun je od začátku zdroje dat.

offset: number

Posun umístění cílového souboru Azure k nahrání

contentLength: number

Délka těla v bajtech. Pomocí Buffer.byteLength() můžete vypočítat délku textu řetězce včetně nekódovaných znaků bez kódování Base64/Hex.

options: FileUploadRangeOptions

Možnosti operace rozsahu nahrávání souborů

Návraty

Promise<FileUploadRangeResponse>

Data odpovědí pro operaci Rozsah nahrání souboru

Příklad použití:

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

Nahrajte rozsah bajtů do souboru, kde se obsah načítá z adresy URL jiného souboru. Rozsah může mít velikost až 4 MB.

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

Parametry

sourceURL: string

Zadejte adresu URL ke zdroji kopírování, sdílený přístupový podpis (SAS) možná pro ověření.

sourceOffset: number

Posun zdroje ke kopírování. Předejte 0 kopírování od začátku zdrojového souboru.

destOffset: number

Posun cílového souboru

count: number

Počet bajtů, které se mají nahrát ze zdrojového souboru

options: FileUploadRangeFromURLOptions

Možnosti konfigurace souboru – Rozsah nahrávání z operace adresy URL

Návraty

Promise<FileUploadRangeFromURLResponse>

K DISPOZICI POUZE V NODE.JS RUNTIME.

Přijímá Node.js objekt pro čtení streamu a nahrává se do souboru Azure v blocích. Objekt pro čtení streamu musí vrátit Node.js čitelný datový proud počínaje definovaným posunem. Posun je posun v souboru Azure, který se má nahrát.

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

Parametry

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

Vrátí Node.js čitelný datový proud počínaje definovaným posunem.

size: number

Velikost souboru Azure

options: FileParallelUploadOptions

Návraty

Promise<void>

K DISPOZICI POUZE V PROHLÍŽEČÍCH.

Nahraje objekt blob prohlížeče do souboru Azure. Vyžaduje objekt blobFactory jako zdroj dat, který musí vrátit objekt blob se zadaným posunem a velikostí.

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

Parametry

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

size: number

options: FileParallelUploadOptions

Návraty

Promise<void>

K DISPOZICI POUZE V NODE.JS RUNTIME.

Vytvoří nový soubor Azure nebo nahradí existující soubor Azure a pak do něj nahraje Node.js stream s možností čtení. Tato metoda se pokusí vytvořit soubor Azure a pak začne nahrávat blok dat podle bloků dat. Velikost bloku dat je definována parametrem bufferSize. Ujistěte se, že potenciální velikost streamu nepřekračuje velikost souboru.

TIPY KE ZLEPŠENÍ VÝKONU:

Vstupní datový proud highWaterMark je lepší nastavit stejnou hodnotu s parametrem bufferSize, což zabrání operacím Buffer.concat().

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

Parametry

stream: Readable

Node.js čitelný datový proud. Musí být menší nebo rovna velikosti souboru.

size: number

Velikost souboru, který se má vytvořit. Maximální povolená velikost je 4 TB. Pokud je tato hodnota větší než velikost datového proudu, budou prázdné bajty v chvostu souboru.

bufferSize: number

Velikost každé vyrovnávací paměti přidělené v bajtech, také velikost bloku/rozsahu během nahraného souboru. Velikost musí být větší než 0 a menší nebo rovna 4 × 1024 × 1024 (4 MB)

maxBuffers: number

Maximální počet vyrovnávacích pamětí se přidělí během nahrávání, pozitivní korelace s maximální souběžností nahrávání

options: FileUploadStreamOptions

Návraty

Promise<void>

Vytvoří nový objekt ShareFileClient shodný se zdrojem, ale se zadaným časovým razítkem snímku sdílené složky. Zadejte "" odebere snímek a vrátí adresu URL základního ShareFileClient.

function withShareSnapshot(shareSnapshot: string): ShareFileClient

Parametry

shareSnapshot: string

Časové razítko snímku sdílené složky.

Návraty

ShareFileClient

Nový objekt ShareFileClient shodný se zdrojem, ale se zadaným časovým razítkem snímku sdílené složky.

Sdílet prostřednictvím

ShareFileClient class

Konstruktory

Vlastnosti

Zděděné vlastnosti

Metody

Podrobnosti konstruktoru

ShareFileClient(string, Credential | TokenCredential, ShareClientOptions)

Parametry

ShareFileClient(string, Pipeline, ShareClientConfig)

Parametry

Podrobnosti vlastnosti

name

Hodnota vlastnosti

path

Hodnota vlastnosti

shareName

Hodnota vlastnosti

Podrobnosti zděděných vlastností

accountName

Hodnota vlastnosti

url

Hodnota vlastnosti

Podrobnosti metody

abortCopyFromURL(string, FileAbortCopyFromURLOptions)

Parametry

Návraty

clearRange(number, number, FileClearRangeOptions)

Parametry

Návraty

create(number, FileCreateOptions)

Parametry

Návraty

createHardLink(string, FileCreateHardLinkOptions)

Parametry

Návraty

createSymbolicLink(string, FileCreateSymbolicLinkOptions)

Parametry

Návraty

delete(FileDeleteOptions)

Parametry

Návraty

deleteIfExists(FileDeleteOptions)

Parametry

Návraty

download(number, number, FileDownloadOptions)

Parametry

Návraty

downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions)

Parametry

Návraty

downloadToBuffer(number, number, FileDownloadToBufferOptions)

Parametry

Návraty

downloadToFile(string, number, number, FileDownloadOptions)

Parametry

Návraty

exists(FileExistsOptions)

Parametry

Návraty

forceCloseAllHandles(FileForceCloseHandlesOptions)

Parametry

Návraty

forceCloseHandle(string, FileForceCloseHandlesOptions)

Parametry

Návraty

generateSasStringToSign(FileGenerateSasUrlOptions)

Parametry

Návraty

generateSasUrl(FileGenerateSasUrlOptions)

Parametry

Návraty

getProperties(FileGetPropertiesOptions)

Parametry

Návraty

getRangeList(FileGetRangeListOptions)

Parametry

Návraty

getRangeListDiff(string, FileGetRangeListOptions)

Parametry