ShareFileClient class

Pakket:: @azure/storage-file-share

Een ShareFileClient vertegenwoordigt een URL naar een Azure Storage-bestand.

Uitbreiding: StorageClient

Constructors

ShareFileClient(string, Credential \| TokenCredential, ShareClientOptions)	Hiermee maakt u een exemplaar van ShareFileClient.
ShareFileClient(string, Pipeline, ShareClientConfig)	Hiermee maakt u een exemplaar van ShareFileClient.

Eigenschappen

name	De naam van het bestand
path	Het volledige pad van het bestand
shareName	De naam van de share die overeenkomt met deze bestandsclient

Overgenomen eigenschappen

accountName
url	URL-tekenreekswaarde.

Methoden

abortCopyFromURL(string, FileAbortCopyFromURLOptions)	Hiermee wordt een in behandeling zijnde kopieerbestandsbewerking afgebroken en blijft een doelbestand met de lengte nul en volledige metagegevens achter. Zie https://learn.microsoft.com/rest/api/storageservices/abort-copy-file
clearRange(number, number, FileClearRangeOptions)	Hiermee wordt het opgegeven bereik gewist en wordt de ruimte vrijgemaakt die in de opslag voor dat bereik wordt gebruikt.
create(number, FileCreateOptions)	Hiermee maakt u een nieuw bestand of vervangt u een bestand. Houd er rekening mee dat het bestand alleen wordt geïnitialiseerd zonder inhoud. Zie https://learn.microsoft.com/rest/api/storageservices/create-file
createHardLink(string, FileCreateHardLinkOptions)	Alleen NFS. Hiermee maakt u een harde koppeling naar het bestand dat is opgegeven via het pad.
createSymbolicLink(string, FileCreateSymbolicLinkOptions)	Alleen NFS. Hiermee maakt u een symbolische koppeling.
delete(FileDeleteOptions)	Hiermee verwijdert u het bestand uit het opslagaccount. Wanneer een bestand is verwijderd, wordt het onmiddellijk verwijderd uit de index van het opslagaccount en is het niet meer toegankelijk voor clients. De gegevens van het bestand worden later uit de service verwijderd tijdens de garbagecollection. Bestand verwijderen mislukt met statuscode 409 (Conflict) en foutcode SharingViolation als het bestand is geopend op een SMB-client. Bestand verwijderen wordt niet ondersteund op een momentopname van een share. Dit is een alleen-lezen kopie van een share. Een poging om deze bewerking uit te voeren op een momentopname van een share mislukt met 400 (InvalidQueryParameterValue) Zie https://learn.microsoft.com/rest/api/storageservices/delete-file2
deleteIfExists(FileDeleteOptions)	Hiermee verwijdert u het bestand uit het opslagaccount als het bestaat. Wanneer een bestand is verwijderd, wordt het onmiddellijk verwijderd uit de index van het opslagaccount en is het niet meer toegankelijk voor clients. De gegevens van het bestand worden later uit de service verwijderd tijdens de garbagecollection. Bestand verwijderen mislukt met statuscode 409 (Conflict) en foutcode SharingViolation als het bestand is geopend op een SMB-client. Bestand verwijderen wordt niet ondersteund op een momentopname van een share. Dit is een alleen-lezen kopie van een share. Een poging om deze bewerking uit te voeren op een momentopname van een share mislukt met 400 (InvalidQueryParameterValue) Zie https://learn.microsoft.com/rest/api/storageservices/delete-file2
download(number, number, FileDownloadOptions)	Leest of downloadt een bestand van het systeem, inclusief de metagegevens en eigenschappen. In Node.jsworden gegevens geretourneerd in een leesbare stroom `readableStreamBody` In browsers worden gegevens geretourneerd in een belofte `contentAsBlob` Zie https://learn.microsoft.com/rest/api/storageservices/get-file
downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions)	ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee downloadt u een Azure-bestand parallel aan een buffer. Verschuiving en aantal zijn optioneel, geef 0 door voor beide om het hele bestand te downloaden. Waarschuwing: buffers kunnen bestanden maximaal één gigabyte ondersteunen op 32-bits systemen of ongeveer twee gigabytes op 64-bits systemen vanwege beperkingen van Node.js/V8. Voor bestanden die groter zijn dan deze grootte, kunt u overwegen downloadToFile.
downloadToBuffer(number, number, FileDownloadToBufferOptions)	ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME Hiermee downloadt u een Azure-bestand parallel aan een buffer. Verschuiving en aantal zijn optioneel, geef 0 door voor beide om het hele bestand te downloaden Waarschuwing: buffers kunnen bestanden maximaal één gigabyte ondersteunen op 32-bits systemen of ongeveer twee gigabytes op 64-bits systemen vanwege beperkingen van Node.js/V8. Voor bestanden die groter zijn dan deze grootte, kunt u overwegen downloadToFile.
downloadToFile(string, number, number, FileDownloadOptions)	ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee downloadt u een Azure Blob naar een lokaal bestand. Mislukt als het opgegeven bestandspad al wordt afgesloten. Verschuiving en aantal zijn optioneel, geef respectievelijk 0 en niet-gedefinieerd door om de hele blob te downloaden.
exists(FileExistsOptions)	Retourneert waar als het opgegeven bestand bestaat; anders onwaar. OPMERKING: gebruik deze functie met zorg omdat een bestaand bestand kan worden verwijderd door andere clients of toepassingen. Omgekeerd kunnen nieuwe bestanden worden toegevoegd door andere clients of toepassingen nadat deze functie is voltooid.
forceCloseAllHandles(FileForceCloseHandlesOptions)	Sluit alle ingangen voor een bestand af. Zie https://learn.microsoft.com/rest/api/storageservices/force-close-handles
forceCloseHandle(string, FileForceCloseHandlesOptions)	Sluit een specifieke ingang voor een bestand af. Zie https://learn.microsoft.com/rest/api/storageservices/force-close-handles
generateSasStringToSign(FileGenerateSasUrlOptions)	Alleen beschikbaar voor clients die zijn samengesteld met een referenties voor een gedeelde sleutel. Hiermee wordt een tekenreeks gegenereerd die moet worden ondertekend voor een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client. Zie https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(FileGenerateSasUrlOptions)	Alleen beschikbaar voor clients die zijn samengesteld met een referenties voor een gedeelde sleutel. Hiermee genereert u een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client. Zie https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
getProperties(FileGetPropertiesOptions)	Retourneert alle door de gebruiker gedefinieerde metagegevens, standaard HTTP-eigenschappen en systeemeigenschappen voor het bestand. De inhoud van het bestand wordt niet geretourneerd. Zie https://learn.microsoft.com/rest/api/storageservices/get-file-properties
getRangeList(FileGetRangeListOptions)	Retourneert de lijst met geldige bereiken voor een bestand.
getRangeListDiff(string, FileGetRangeListOptions)	Retourneert de lijst met bereiken die verschillen tussen een vorige momentopname van een share en dit bestand.
getShareLeaseClient(string)	Haal een ShareLeaseClient- op waarmee leases op het bestand worden beheerd.
getSymbolicLink(FileGetSymbolicLinkOptions)	Alleen NFS. Haalt de inhoud van een symbolische link op.
listHandles(FileListHandlesOptions)	Retourneert een asynchrone iterator om alle ingangen weer te geven. onder het opgegeven account. .byPage() retourneert een asynchrone iterator om de ingangen in pagina's weer te geven.
rename(string, FileRenameOptions)	Hiermee wijzigt u de naam van een bestand. Deze API biedt alleen ondersteuning voor het wijzigen van de naam van een bestand in dezelfde share.
resize(number, FileResizeOptions)	Formaat van bestand wijzigen. Zie https://learn.microsoft.com/rest/api/storageservices/set-file-properties
setHttpHeaders(FileHttpHeaders, FileSetHttpHeadersOptions)	Hiermee stelt u HTTP-headers in op het bestand. Als er geen optie is opgegeven of als er geen waarde is opgegeven voor de HTTP-headers van het bestand in de opties, worden deze HTTP-headers zonder waarde gewist. Zie https://learn.microsoft.com/rest/api/storageservices/set-file-properties
setMetadata(Metadata, FileSetMetadataOptions)	Hiermee worden door de gebruiker gedefinieerde metagegevens voor het opgegeven bestand bijgewerkt. Als er geen metagegevens zijn gedefinieerd in de optieparameter, worden de metagegevens van het bestand verwijderd. Zie https://learn.microsoft.com/rest/api/storageservices/set-file-metadata
setProperties(FileProperties)	Hiermee stelt u eigenschappen in voor het bestand. Zie https://learn.microsoft.com/rest/api/storageservices/set-file-properties
startCopyFromURL(string, FileStartCopyOptions)	Kopieert een blob of bestand naar een doelbestand in het opslagaccount.
uploadData(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, FileParallelUploadOptions)	Hiermee maakt u een nieuw Azure-bestand of vervangt u een bestaand Azure-bestand en uploadt u vervolgens een buffer(knooppunt)/Blob/ArrayBuffer/ArrayBufferView.
uploadFile(string, FileParallelUploadOptions)	ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee maakt u een nieuw Azure-bestand of vervangt u een bestaand Azure-bestand en uploadt u vervolgens een lokaal bestand naar het bestand.
uploadRange(RequestBodyType, number, number, FileUploadRangeOptions)	Upload een bereik van bytes naar een bestand. Deze bewerking kan alleen worden aangeroepen op een bestaand bestand. De grootte, eigenschappen of metagegevens van het bestand worden niet gewijzigd. Zowel het begin als het aantal van het bereik moet worden opgegeven. Het bereik kan maximaal 4 MB groot zijn.
uploadRangeFromURL(string, number, number, number, FileUploadRangeFromURLOptions)	Upload een bereik van bytes naar een bestand waarin de inhoud wordt gelezen uit de URL van een ander bestand. Het bereik kan maximaal 4 MB groot zijn.
uploadResetableStream((offset: number, count?: number) => ReadableStream, number, FileParallelUploadOptions)	ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Accepteert een Node.js leesbare streamfactory en uploadt in blokken naar een Azure-bestand. De fabriek voor leesbare stromen moet een Node.js leesbare stroom retourneren vanaf de gedefinieerde offset. De offset is de offset in het Azure-bestand dat moet worden geüpload.
uploadSeekableBlob((offset: number, size: number) => Blob, number, FileParallelUploadOptions)	ALLEEN BESCHIKBAAR IN BROWSERS. Uploadt een browserblobobject naar een Azure-bestand. Vereist een blobFactory als de gegevensbron, die een Blob-object moet retourneren met de opgegeven offset en grootte.
uploadStream(Readable, number, number, number, FileUploadStreamOptions)	ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Hiermee maakt u een nieuw Azure-bestand of vervangt u een bestaand Azure-bestand en uploadt u vervolgens een Node.js leesbare stroom erin. Met deze methode wordt geprobeerd een Azure-bestand te maken en vervolgens segment per segment te uploaden. De grootte van het segment wordt gedefinieerd door `bufferSize` parameter. Zorg ervoor dat de potentiële grootte van de stream niet groter is dan de bestandsgrootte. TIPS VOOR PRESTATIEVERBETERING: Invoerstroom highWaterMark is beter om dezelfde waarde in te stellen met de parameter bufferSize, waardoor buffer.concat() bewerkingen worden vermeden.
withShareSnapshot(string)	Hiermee maakt u een nieuw ShareFileClient-object dat identiek is aan de bron, maar met de opgegeven tijdstempel voor momentopnamen van shares. Geef '' op, verwijdert de momentopname en retourneert een URL naar de basisShareFileClient.

Constructordetails

Hiermee maakt u een exemplaar van ShareFileClient.

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

Parameters

url: string

Een URL-tekenreeks die verwijst naar het Azure Storage-bestand, zoals 'https://myaccount.file.core.windows.net/myshare/mydirectory/file". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals 'https://myaccount.file.core.windows.net/myshare/mydirectory/file?sasString". Deze methode accepteert een gecodeerde URL of niet-gecodeerde URL die verwijst naar een bestand. Gecodeerde URL-tekenreeks wordt NIET tweemaal escaped, alleen speciale tekens in HET URL-pad worden escaped. Als een bestand of mapnaam echter %bevat, moet de naam van een bestand of map in de URL worden gecodeerd. Zoals een bestand met de naam 'myfile%', moet de URL zijn 'https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25".

credential: Credential | TokenCredential

Zoals StorageSharedKeyCredential of TokenCredential, indien niet opgegeven, wordt AnonymousCredential gebruikt.

options: ShareClientOptions

Optional. Opties voor het configureren van de HTTP-pijplijn.

Hiermee maakt u een exemplaar van ShareFileClient.

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

Parameters

url: string

pipeline: Pipeline

Roep newPipeline() aan om een standaardpijplijn te maken of geef een aangepaste pijplijn op.

options: ShareClientConfig

Eigenschapdetails

De naam van het bestand

string name

Waarde van eigenschap

string

Het volledige pad van het bestand

string path

Waarde van eigenschap

string

De naam van de share die overeenkomt met deze bestandsclient

string shareName

Waarde van eigenschap

string

Details van overgenomen eigenschap

accountName: string

Waarde van eigenschap

string

overgenomen van StorageClient.accountName

URL-tekenreekswaarde.

url: string

Waarde van eigenschap

string

overgenomen van StorageClient.url

Methodedetails

Hiermee wordt een in behandeling zijnde kopieerbestandsbewerking afgebroken en blijft een doelbestand met de lengte nul en volledige metagegevens achter.

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

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

Parameters

copyId: string

Id van de bewerking Bestand kopiëren om af te breken.

options: FileAbortCopyFromURLOptions

Opties voor Het afbreken van het bestand kopiëren van URL-bewerking.

Retouren

Promise<FileAbortCopyResponse>

Hiermee wordt het opgegeven bereik gewist en wordt de ruimte vrijgemaakt die in de opslag voor dat bereik wordt gebruikt.

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

Parameters

offset: number

contentLength: number

options: FileClearRangeOptions

Opties voor het wissen van het bereik van bestand.

Retouren

Promise<FileUploadRangeResponse>

Hiermee maakt u een nieuw bestand of vervangt u een bestand. Houd er rekening mee dat het bestand alleen wordt geïnitialiseerd zonder inhoud.

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

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

Parameters

size: number

Hiermee geeft u de maximale grootte in bytes voor het bestand, maximaal 4 TB.

options: FileCreateOptions

Opties voor het maken van bestanden.

Retouren

Promise<FileCreateResponse>

Antwoordgegevens voor de bewerking Bestand maken.

Voorbeeldgebruik:

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

Alleen NFS. Hiermee maakt u een harde koppeling naar het bestand dat is opgegeven via het pad.

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

Parameters

targetFile: string

Pad van het bestand om de harde koppeling naar te maken, niet inclusief de share. Bijvoorbeeld: "targetDirectory/targetSubDirectory/.../targetFile"

options: FileCreateHardLinkOptions

Opties voor het maken van een harde koppelingsbewerking.

Retouren

Promise<FileCreateHardLinkResponse>

Alleen NFS. Hiermee maakt u een symbolische koppeling.

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

Parameters

linkText: string

Het pad naar het originele bestand, de symbolische link verwijst naar. Het pad is van het type string dat niet is opgelost en wordt opgeslagen zoals het is. Het pad kan een absoluut pad of het relatieve pad zijn, afhankelijk van de inhoud die is opgeslagen in het symbolische koppelingsbestand.

options: FileCreateSymbolicLinkOptions

Opties voor het maken van een harde koppelingsbewerking.

Retouren

Promise<FileCreateSymbolicLinkResponse>

Hiermee verwijdert u het bestand uit het opslagaccount. Wanneer een bestand is verwijderd, wordt het onmiddellijk verwijderd uit de index van het opslagaccount en is het niet meer toegankelijk voor clients. De gegevens van het bestand worden later uit de service verwijderd tijdens de garbagecollection.

Bestand verwijderen mislukt met statuscode 409 (Conflict) en foutcode SharingViolation als het bestand is geopend op een SMB-client.

Bestand verwijderen wordt niet ondersteund op een momentopname van een share. Dit is een alleen-lezen kopie van een share. Een poging om deze bewerking uit te voeren op een momentopname van een share mislukt met 400 (InvalidQueryParameterValue)

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

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

Parameters

options: FileDeleteOptions

Opties voor de bewerking Bestand verwijderen.

Retouren

Promise<FileDeleteResponse>

Antwoordgegevens voor de bewerking Bestand verwijderen.

Hiermee verwijdert u het bestand uit het opslagaccount als het bestaat. Wanneer een bestand is verwijderd, wordt het onmiddellijk verwijderd uit de index van het opslagaccount en is het niet meer toegankelijk voor clients. De gegevens van het bestand worden later uit de service verwijderd tijdens de garbagecollection.

Bestand verwijderen mislukt met statuscode 409 (Conflict) en foutcode SharingViolation als het bestand is geopend op een SMB-client.

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

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

Parameters

options: FileDeleteOptions

Retouren

Promise<FileDeleteIfExistsResponse>

Leest of downloadt een bestand van het systeem, inclusief de metagegevens en eigenschappen.

In Node.jsworden gegevens geretourneerd in een leesbare stroom readableStreamBody
In browsers worden gegevens geretourneerd in een belofte contentAsBlob

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

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

Parameters

offset: number

Vanaf welke positie van het bestand moet worden gedownload, groter dan of gelijk aan 0

count: number

Hoeveel gegevens moeten worden gedownload, groter dan 0. Wordt naar het einde gedownload wanneer deze niet is gedefinieerd

options: FileDownloadOptions

Opties voor de bewerking Bestand downloaden.

Retouren

Promise<FileDownloadResponseModel>

Antwoordgegevens voor de bewerking Bestand downloaden.

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

Voorbeeldgebruik (browsers):

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

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Hiermee downloadt u een Azure-bestand parallel aan een buffer. Verschuiving en aantal zijn optioneel, geef 0 door voor beide om het hele bestand te downloaden.

Waarschuwing: buffers kunnen bestanden maximaal één gigabyte ondersteunen op 32-bits systemen of ongeveer twee gigabytes op 64-bits systemen vanwege beperkingen van Node.js/V8. Voor bestanden die groter zijn dan deze grootte, kunt u overwegen downloadToFile.

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

Parameters

buffer: Buffer

Buffer die moet worden gevuld, moet een lengte hebben die groter is dan het aantal

offset: number

Vanaf welke positie van het Azure-bestand u wilt downloaden

count: number

Hoeveel gegevens moeten worden gedownload. Wordt naar het einde gedownload wanneer niet-gedefinieerd wordt doorgegeven

options: FileDownloadToBufferOptions

Retouren

Promise<Buffer>

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME

Hiermee downloadt u een Azure-bestand parallel aan een buffer. Verschuiving en aantal zijn optioneel, geef 0 door voor beide om het hele bestand te downloaden

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

Parameters

offset: number

Vanaf welke positie van het Azure-bestand moet worden gedownload

count: number

Hoeveel gegevens moeten worden gedownload. Wordt naar het einde gedownload wanneer niet-gedefinieerd wordt doorgegeven

options: FileDownloadToBufferOptions

Retouren

Promise<Buffer>

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Hiermee downloadt u een Azure Blob naar een lokaal bestand. Mislukt als het opgegeven bestandspad al wordt afgesloten. Verschuiving en aantal zijn optioneel, geef respectievelijk 0 en niet-gedefinieerd door om de hele blob te downloaden.

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

Parameters

filePath: string

offset: number

Vanaf welke positie van de blok-blob moet worden gedownload.

count: number

Hoeveel gegevens moeten worden gedownload. Wordt naar het einde gedownload wanneer niet-gedefinieerd wordt doorgegeven.

options: FileDownloadOptions

Opties voor blobdownloadopties.

Retouren

Promise<FileDownloadResponseModel>

De antwoordgegevens voor de blob-downloadbewerking, maar met readableStreamBody is ingesteld op niet-gedefinieerd omdat de inhoud al is gelezen en naar een lokaal bestand is geschreven op het opgegeven pad.

Retourneert waar als het opgegeven bestand bestaat; anders onwaar.

OPMERKING: gebruik deze functie met zorg omdat een bestaand bestand kan worden verwijderd door andere clients of toepassingen. Omgekeerd kunnen nieuwe bestanden worden toegevoegd door andere clients of toepassingen nadat deze functie is voltooid.

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

Parameters

options: FileExistsOptions

opties voor bestaat bewerking.

Retouren

Promise<boolean>

Sluit alle ingangen voor een bestand af.

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

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

Parameters

options: FileForceCloseHandlesOptions

Opties voor het afdwingen van bewerkingen voor het sluiten van ingangen.

Retouren

Promise<CloseHandlesInfo>

Sluit een specifieke ingang voor een bestand af.

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

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

Parameters

handleId: string

Specifieke handle-id, mag geen sterretje *zijn. Gebruik forceCloseAllHandles() om alle ingangen te sluiten.

options: FileForceCloseHandlesOptions

Retouren

Promise<FileForceCloseHandlesResponse>

Alleen beschikbaar voor clients die zijn samengesteld met een referenties voor een gedeelde sleutel.

Hiermee wordt een tekenreeks gegenereerd die moet worden ondertekend voor een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client.

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

function generateSasStringToSign(options: FileGenerateSasUrlOptions): string

Parameters

options: FileGenerateSasUrlOptions

Optionele parameters.

Retouren

string

De SAS-URI die bestaat uit de URI voor de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.

Alleen beschikbaar voor clients die zijn samengesteld met een referenties voor een gedeelde sleutel.

Hiermee genereert u een SAS-URI (Service Shared Access Signature) op basis van de clienteigenschappen en parameters die zijn doorgegeven. De SAS wordt ondertekend door de gedeelde sleutelreferentie van de client.

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

function generateSasUrl(options: FileGenerateSasUrlOptions): string

Parameters

options: FileGenerateSasUrlOptions

Optionele parameters.

Retouren

string

De SAS-URI die bestaat uit de URI voor de resource die wordt vertegenwoordigd door deze client, gevolgd door het gegenereerde SAS-token.

Retourneert alle door de gebruiker gedefinieerde metagegevens, standaard HTTP-eigenschappen en systeemeigenschappen voor het bestand. De inhoud van het bestand wordt niet geretourneerd.

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

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

Parameters

options: FileGetPropertiesOptions

Opties voor de bewerking Eigenschappen ophalen van bestand.

Retouren

Promise<FileGetPropertiesResponse>

Antwoordgegevens voor de bewerking Eigenschappen van bestand ophalen.

Retourneert de lijst met geldige bereiken voor een bestand.

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

Parameters

options: FileGetRangeListOptions

Opties voor de bewerking Bereiklijst ophalen van bestand.

Retouren

Promise<FileGetRangeListResponse>

Retourneert de lijst met bereiken die verschillen tussen een vorige momentopname van een share en dit bestand.

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

Parameters

prevShareSnapshot: string

De vorige parameter voor momentopnamen is een ondoorzichtige Datum/tijd-waarde waarmee de vorige momentopname van de share wordt opgegeven om mee te vergelijken.

options: FileGetRangeListOptions

Retouren

Promise<FileGetRangeListDiffResponse>

Haal een ShareLeaseClient- op waarmee leases op het bestand worden beheerd.

function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient

Parameters

proposeLeaseId: string

Oorspronkelijke voorgestelde lease-id.

Retouren

ShareLeaseClient

Een nieuw ShareLeaseClient-object voor het beheren van leases op het bestand.

Alleen NFS. Haalt de inhoud van een symbolische link op.

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

Parameters

options: FileGetSymbolicLinkOptions

Opties om symbolische linkbediening te krijgen.

Retouren

Promise<FileGetSymbolicLinkResponse>

Retourneert een asynchrone iterator om alle ingangen weer te geven. onder het opgegeven account.

.byPage() retourneert een asynchrone iterator om de ingangen in pagina's weer te geven.

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

Parameters

options: FileListHandlesOptions

Opties voor het weergeven van handlesbewerkingen.

Een asyncIterableIterator die paging ondersteunt.

Retouren

PagedAsyncIterableIterator<HandleItem, FileListHandlesResponse, PageSettings>

Hiermee wijzigt u de naam van een bestand. Deze API biedt alleen ondersteuning voor het wijzigen van de naam van een bestand in dezelfde share.

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

Parameters

destinationPath: string

Hiermee geeft u het doelpad om de naam te wijzigen in. Het pad wordt gecodeerd om in een URL te plaatsen om de bestemming op te geven.

options: FileRenameOptions

Opties voor de naamgevingsbewerking.

Retouren

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

Antwoordgegevens voor de bewerking voor het wijzigen van de naam van het bestand.

Voorbeeldgebruik:

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

Formaat van bestand wijzigen.

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

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

Parameters

length: number

Hiermee wijzigt u het formaat van een bestand in de opgegeven grootte in bytes. Als de opgegeven bytewaarde kleiner is dan de huidige grootte van het bestand, worden alle bereiken boven de opgegeven bytewaarde gewist.

options: FileResizeOptions

Opties voor het wijzigen van het formaat van het bestand.

Retouren

Promise<FileSetHTTPHeadersResponse>

Antwoordgegevens voor de bewerking HTTP-headers voor bestandsset.

Hiermee stelt u HTTP-headers in op het bestand.

Als er geen optie is opgegeven of als er geen waarde is opgegeven voor de HTTP-headers van het bestand in de opties, worden deze HTTP-headers zonder waarde gewist.

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

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

Parameters

fileHttpHeaders: FileHttpHeaders

options: FileSetHttpHeadersOptions

Opties voor de bewerking HTTP-headers instellen.

Retouren

Promise<FileSetHTTPHeadersResponse>

Antwoordgegevens voor de bewerking HTTP-headers voor bestandsset.

Hiermee worden door de gebruiker gedefinieerde metagegevens voor het opgegeven bestand bijgewerkt.

Als er geen metagegevens zijn gedefinieerd in de optieparameter, worden de metagegevens van het bestand verwijderd.

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

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

Parameters

metadata: Metadata

Als er geen metagegevens worden opgegeven, worden alle bestaande mapmetagegevens verwijderd

options: FileSetMetadataOptions

Opties voor bestandssetmetagegevensbewerking.

Retouren

Promise<FileSetMetadataResponse>

Antwoordgegevens voor de bewerking Metagegevens van bestandsset.

Hiermee stelt u eigenschappen in voor het bestand.

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

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

Parameters

properties: FileProperties

Eigenschappen van het bestand. Als er geen waarden worden opgegeven, worden bestaande HTTP-headers verwijderd voor BESTANDS-HTTP-headers (bijvoorbeeld Inhoudstype). Voor andere bestandseigenschappen (bijvoorbeeld fileAttributes), als er geen waarden worden opgegeven, blijven bestaande waarden behouden.

Retouren

Promise<SetPropertiesResponse>

Kopieert een blob of bestand naar een doelbestand in het opslagaccount.

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

Parameters

copySource: string

Hiermee geeft u de URL van het bronbestand of de blob, maximaal 2 kB lang. Als u een bestand naar een ander bestand in hetzelfde opslagaccount wilt kopiëren, kunt u gedeelde sleutel gebruiken om het bronbestand te verifiëren. Als u een bestand kopieert vanuit een ander opslagaccount of als u een blob kopieert vanuit hetzelfde opslagaccount of een ander opslagaccount, moet u het bronbestand of de blob verifiëren met behulp van een handtekening voor gedeelde toegang. Als de bron een openbare blob is, is er geen verificatie vereist om de kopieerbewerking uit te voeren. Een bestand in een momentopname van een share kan ook worden opgegeven als een kopieerbron.

options: FileStartCopyOptions

Opties voor het kopiëren van bestand starten.

Retouren

Promise<FileStartCopyResponse>

Hiermee maakt u een nieuw Azure-bestand of vervangt u een bestaand Azure-bestand en uploadt u vervolgens een buffer(knooppunt)/Blob/ArrayBuffer/ArrayBufferView.

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

Parameters

data: Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer(knooppunt), Blob, ArrayBuffer of ArrayBufferView

options: FileParallelUploadOptions

Retouren

Promise<void>

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Hiermee maakt u een nieuw Azure-bestand of vervangt u een bestaand Azure-bestand en uploadt u vervolgens een lokaal bestand naar het bestand.

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

Parameters

filePath: string

Volledig pad naar het lokale bestand

options: FileParallelUploadOptions

Retouren

Promise<void>

Upload een bereik van bytes naar een bestand. Deze bewerking kan alleen worden aangeroepen op een bestaand bestand. De grootte, eigenschappen of metagegevens van het bestand worden niet gewijzigd. Zowel het begin als het aantal van het bereik moet worden opgegeven. Het bereik kan maximaal 4 MB groot zijn.

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

Parameters

body: HttpRequestBody

Blob, tekenreeks, ArrayBuffer, ArrayBufferView of een functie die een nieuwe leesbare stroom retourneert waarvan de offset afkomstig is van het begin van de gegevensbron.

offset: number

Verschuivingspositie van het Azure-doelbestand dat u wilt uploaden.

contentLength: number

Lengte van hoofdtekst in bytes. Gebruik Buffer.byteLength() om de lengte van de hoofdtekst te berekenen voor een tekenreeks, inclusief niet-Base64/Hex-gecodeerde tekens.

options: FileUploadRangeOptions

Opties voor bestandsuploadbereikbewerking.

Retouren

Promise<FileUploadRangeResponse>

Antwoordgegevens voor de bewerking Bestandsuploadbereik.

Voorbeeldgebruik:

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

Upload een bereik van bytes naar een bestand waarin de inhoud wordt gelezen uit de URL van een ander bestand. Het bereik kan maximaal 4 MB groot zijn.

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

Parameters

sourceURL: string

Geef een URL op naar de kopieerbron, sas (Shared Access Signature) die mogelijk nodig is voor verificatie.

sourceOffset: number

De bronverschil waaruit moet worden gekopieerd. Geef 0 door om te kopiëren vanaf het begin van het bronbestand.

destOffset: number

Verschuiving van doelbestand.

count: number

Het aantal bytes dat moet worden geüpload vanuit het bronbestand.

options: FileUploadRangeFromURLOptions

Opties voor het configureren van bestand - Bereik uploaden van URL-bewerking.

Retouren

Promise<FileUploadRangeFromURLResponse>

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Accepteert een Node.js leesbare streamfactory en uploadt in blokken naar een Azure-bestand. De fabriek voor leesbare stromen moet een Node.js leesbare stroom retourneren vanaf de gedefinieerde offset. De offset is de offset in het Azure-bestand dat moet worden geüpload.

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

Parameters

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

Retourneert een Node.js leesbare stroom vanaf de gedefinieerde offset

size: number

Grootte van het Azure-bestand

options: FileParallelUploadOptions

Retouren

Promise<void>

ALLEEN BESCHIKBAAR IN BROWSERS.

Uploadt een browserblobobject naar een Azure-bestand. Vereist een blobFactory als de gegevensbron, die een Blob-object moet retourneren met de opgegeven offset en grootte.

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

Parameters

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

size: number

options: FileParallelUploadOptions

Retouren

Promise<void>

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Hiermee maakt u een nieuw Azure-bestand of vervangt u een bestaand Azure-bestand en uploadt u vervolgens een Node.js leesbare stroom erin. Met deze methode wordt geprobeerd een Azure-bestand te maken en vervolgens segment per segment te uploaden. De grootte van het segment wordt gedefinieerd door bufferSize parameter. Zorg ervoor dat de potentiële grootte van de stream niet groter is dan de bestandsgrootte.

TIPS VOOR PRESTATIEVERBETERING:

Invoerstroom highWaterMark is beter om dezelfde waarde in te stellen met de parameter bufferSize, waardoor buffer.concat() bewerkingen worden vermeden.

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

Parameters

stream: Readable

Node.js leesbare stroom. Moet kleiner of gelijk zijn aan de bestandsgrootte.

size: number

De grootte van het bestand dat moet worden gemaakt. De toegestane maximale grootte is 4 TB. Als deze waarde groter is dan de stroomgrootte, zijn er lege bytes in de bestandsstaart.

bufferSize: number

De grootte van elke buffer die is toegewezen in bytes, ook de grootte van het segment/bereik tijdens het geüploade bestand. De grootte moet groter zijn dan 0 en kleiner dan of gelijk aan 4 * 1024 * 1024 (4 MB)

maxBuffers: number

Maximale buffers worden toegewezen tijdens het uploaden, positieve correlatie met maximale gelijktijdigheid van uploaden

options: FileUploadStreamOptions

Retouren

Promise<void>

Hiermee maakt u een nieuw ShareFileClient-object dat identiek is aan de bron, maar met de opgegeven tijdstempel voor momentopnamen van shares. Geef '' op, verwijdert de momentopname en retourneert een URL naar de basisShareFileClient.

function withShareSnapshot(shareSnapshot: string): ShareFileClient

Parameters

shareSnapshot: string

De tijdstempel van de momentopname van de share.

Retouren

ShareFileClient

Een nieuw ShareFileClient-object dat identiek is aan de bron, maar met de opgegeven tijdstempel voor momentopnamen van shares.

Delen via

ShareFileClient class

Constructors

Eigenschappen

Overgenomen eigenschappen

Methoden

Constructordetails

ShareFileClient(string, Credential | TokenCredential, ShareClientOptions)

Parameters

ShareFileClient(string, Pipeline, ShareClientConfig)

Parameters

Eigenschapdetails

name

Waarde van eigenschap

path

Waarde van eigenschap

shareName

Waarde van eigenschap

Details van overgenomen eigenschap

accountName

Waarde van eigenschap

url

Waarde van eigenschap

Methodedetails

abortCopyFromURL(string, FileAbortCopyFromURLOptions)

Parameters

Retouren

clearRange(number, number, FileClearRangeOptions)

Parameters

Retouren

create(number, FileCreateOptions)

Parameters

Retouren

createHardLink(string, FileCreateHardLinkOptions)

Parameters

Retouren

createSymbolicLink(string, FileCreateSymbolicLinkOptions)

Parameters

Retouren

delete(FileDeleteOptions)

Parameters

Retouren

deleteIfExists(FileDeleteOptions)

Parameters

Retouren

download(number, number, FileDownloadOptions)

Parameters

Retouren

downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions)

Parameters

Retouren

downloadToBuffer(number, number, FileDownloadToBufferOptions)

Parameters

Retouren

downloadToFile(string, number, number, FileDownloadOptions)

Parameters

Retouren

exists(FileExistsOptions)

Parameters

Retouren

forceCloseAllHandles(FileForceCloseHandlesOptions)

Parameters

Retouren

forceCloseHandle(string, FileForceCloseHandlesOptions)

Parameters

Retouren

generateSasStringToSign(FileGenerateSasUrlOptions)

Parameters

Retouren

generateSasUrl(FileGenerateSasUrlOptions)

Parameters

Retouren

getProperties(FileGetPropertiesOptions)

Parameters

Retouren

getRangeList(FileGetRangeListOptions)

Parameters

Retouren

getRangeListDiff(string, FileGetRangeListOptions)

Parameters