ShareFileClient class

Referentie

Pakket:: @azure/storage-file-share

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

Uitbreiding: StorageClient

Constructors

ShareFileClient(string, Credential_2 \| 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://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-file
clearRange(number, number, FileClearRangeOptions)	Wist het opgegeven bereik en maakt de ruimte vrij die in de opslag voor dat bereik wordt gebruikt.
create(number, FileCreateOptions)	Hiermee maakt u een nieuw bestand of vervangt u een bestand. Het bestand wordt alleen geïnitialiseerd zonder inhoud. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/create-file
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 verwijderd uit de service 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://docs.microsoft.com/en-us/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 verwijderd uit de service 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://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2
download(number, number, FileDownloadOptions)	Leest of downloadt een bestand van het systeem, inclusief de metagegevens en eigenschappen. In Node.js worden gegevens geretourneerd in een leesbare stroom `readableStreamBody` In browsers worden gegevens geretourneerd in een promise `contentAsBlob` Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-file
downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions)	ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME. Downloadt een Azure-bestand parallel met een buffer. Verschuiving en aantal zijn optioneel. Geef 0 door voor beide om het hele bestand te downloaden. Waarschuwing: Buffers kunnen alleen bestanden ondersteunen tot ongeveer één gigabyte 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 downloadToFile overwegen.
downloadToBuffer(number, number, FileDownloadToBufferOptions)	ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME Downloadt een Azure-bestand parallel met een buffer. Verschuiving en aantal zijn optioneel, geef 0 door voor beide om het hele bestand te downloaden Waarschuwing: Buffers kunnen alleen bestanden ondersteunen tot ongeveer één gigabyte 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 downloadToFile overwegen.
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. Offset en aantal zijn optioneel, geef respectievelijk 0 en undefined door om de hele blob te downloaden.
exists(FileExistsOptions)	Retourneert true als het opgegeven bestand bestaat; anders onwaar. OPMERKING: gebruik deze functie zorgvuldig, omdat een bestaand bestand mogelijk door andere clients of toepassingen wordt verwijderd. Omgekeerd kunnen nieuwe bestanden worden toegevoegd door andere clients of toepassingen nadat deze functie is voltooid.
forceCloseAllHandles(FileForceCloseHandlesOptions)	Alle ingangen voor een bestand geforceerd sluiten. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/force-close-handles
forceCloseHandle(string, FileForceCloseHandlesOptions)	Forceer het sluiten van een specifieke ingang voor een bestand. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/force-close-handles
generateSasUrl(FileGenerateSasUrlOptions)	Alleen beschikbaar voor clients die zijn gemaakt met een gedeelde sleutelreferentie. Genereert 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://docs.microsoft.com/en-us/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://docs.microsoft.com/en-us/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 eerdere momentopname van een share en dit bestand.
getShareLeaseClient(string)	Haal een ShareLeaseClient op waarmee leases voor het bestand worden beheerd.
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://docs.microsoft.com/en-us/rest/api/storageservices/set-file-properties
setHttpHeaders(FileHttpHeaders, FileSetHttpHeadersOptions)	Hiermee stelt u HTTP-headers in voor 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 BESTANDS-HTTP-headers zonder waarde gewist. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-properties
setMetadata(Metadata, FileSetMetadataOptions)	Werkt door de gebruiker gedefinieerde metagegevens bij voor het opgegeven bestand. Als er geen metagegevens zijn gedefinieerd in de optieparameter, worden de metagegevens van het bestand verwijderd. Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-metadata
setProperties(FileProperties)	Hiermee stelt u eigenschappen voor het bestand in. Zie https://docs.microsoft.com/en-us/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 er vervolgens een Buffer(Node)/Blob/ArrayBuffer/ArrayBufferView naar.
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 voor een bestaand bestand. De grootte, eigenschappen of metagegevens van het bestand worden niet gewijzigd. Zowel het begin als het aantal van het bereik moeten 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 vanuit 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 readable stream factory en uploadt in blokken naar een Azure-bestand. De factory voor leesbare stroom 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 blobobject in de browser naar een Azure-bestand. Vereist een blobFactory als 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 naar het bestand. Met deze methode wordt geprobeerd een Azure-bestand te maken en wordt vervolgens chunk voor segment geüpload. De grootte van het segment wordt gedefinieerd door de `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 voorkomen.
withShareSnapshot(string)	Hiermee maakt u een nieuw ShareFileClient-object dat identiek is aan de bron, maar met het opgegeven tijdstempel van de momentopname van de share. Geef '' op om de momentopname te verwijderen en een URL te retourneren naar de basis ShareFileClient.

Constructordetails

Hiermee maakt u een exemplaar van ShareFileClient.

new ShareFileClient(url: string, credential?: Credential_2 | 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 naar een bestand verwijst. Gecodeerde URL-tekenreeks wordt NIET tweemaal ge escaped, alleen speciale tekens in het URL-pad worden escaped. Als een bestands- of mapnaam echter %bevat, moet de naam van het bestand of de map worden gecodeerd in de URL. Zoals een bestand met de naam 'myfile%', moet de URL 'https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25"' zijn.

credential: Credential | TokenCredential

Zoals , StorageSharedKeyCredential of TokenCredential, als dit niet is opgegeven, wordt AnonymousCredential gebruikt.

options: ShareClientOptions

Optioneel. 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 een aangepaste pijplijn op te geven.

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://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-file

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

Parameters

copyId: string

Id van de bewerking Bestand kopiëren die moet worden afgebroken.

options: FileAbortCopyFromURLOptions

Opties voor de bewerking Bestand Kopiëren van URL afbreken.

Retouren

Promise<FileAbortCopyResponse>

Wist het opgegeven bereik en maakt de ruimte vrij 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 de bewerking Bereik wissen bestand.

Retouren

Promise<FileUploadRangeResponse>

Hiermee maakt u een nieuw bestand of vervangt u een bestand. Het bestand wordt alleen geïnitialiseerd zonder inhoud.

Zie https://docs.microsoft.com/en-us/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 op, maximaal 4 TB.

options: FileCreateOptions

Opties voor de bewerking Bestand maken.

Retouren

Promise<FileCreateResponse>

Antwoordgegevens voor de bewerking Bestand maken.

Gebruiksvoorbeeld:

const content = "Hello world!";

// Create the file
await fileClient.create(content.length);
console.log("Created file successfully!");

// Then upload data to the file
await fileClient.uploadRange(content, 0, content.length);
console.log("Updated file successfully!")

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 verwijderd uit de service 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://docs.microsoft.com/en-us/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 verwijderd uit de service tijdens de garbagecollection.

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

Zie https://docs.microsoft.com/en-us/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.js worden gegevens geretourneerd in een leesbare stroom readableStreamBody
In browsers worden gegevens geretourneerd in een promise contentAsBlob

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/get-file

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

Parameters

offset: number

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

count: number

Hoeveel gegevens er moeten worden gedownload, groter dan 0. Wordt gedownload tot het einde wanneer dit niet is gedefinieerd

options: FileDownloadOptions

Opties voor bestandsdownloadbewerking.

Retouren

Promise<FileDownloadResponseModel>

Antwoordgegevens voor de bewerking Bestand downloaden.

Voorbeeld van gebruik (Node.js):

// Download a file to a string
const downloadFileResponse = await fileClient.download();
console.log(
  "Downloaded file content:",
  (await streamToBuffer(downloadFileResponse.readableStreamBody)).toString()}
);

// A helper method used to read a Node.js readable stream into string
async function streamToBuffer(readableStream) {
  return new Promise((resolve, reject) => {
    const chunks = [];
    readableStream.on("data", (data) => {
      chunks.push(data instanceof Buffer ? data : Buffer.from(data));
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}

Voorbeeld van gebruik (browsers):

// Download a file to a string
const downloadFileResponse = await fileClient.download(0);
console.log(
  "Downloaded file content:",
  await blobToString(await downloadFileResponse.blobBody)}
);

// A helper method used to convert a browser Blob into string.
export async function blobToString(blob: Blob): Promise<string> {
  const fileReader = new FileReader();
  return new Promise<string>((resolve, reject) => {
    fileReader.onloadend = (ev: any) => {
      resolve(ev.target!.result);
    };
    fileReader.onerror = reject;
    fileReader.readAsText(blob);
  });
}

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Downloadt een Azure-bestand parallel met een buffer. Verschuiving en aantal zijn optioneel. Geef 0 door voor beide om het hele bestand te downloaden.

Waarschuwing: Buffers kunnen alleen bestanden ondersteunen tot ongeveer één gigabyte 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 downloadToFile overwegen.

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 moet worden gedownload

count: number

Hoeveel gegevens er moeten worden gedownload. Wordt gedownload tot het einde wanneer undefined wordt doorgegeven

options: FileDownloadToBufferOptions

Retouren

Promise<Buffer>

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME

Downloadt een Azure-bestand parallel met 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 er moeten worden gedownload. Wordt gedownload tot het einde wanneer undefined 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. Offset en aantal zijn optioneel, geef respectievelijk 0 en undefined 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 er moeten worden gedownload. Wordt gedownload tot het einde wanneer undefined wordt doorgegeven.

options: FileDownloadOptions

Opties voor blobdownloadopties.

Retouren

Promise<FileDownloadResponseModel>

De antwoordgegevens voor de blobdownloadbewerking, maar met readableStreamBody ingesteld op undefined, omdat de inhoud al is gelezen en geschreven in een lokaal bestand op het opgegeven pad.

Retourneert true als het opgegeven bestand bestaat; anders onwaar.

OPMERKING: gebruik deze functie zorgvuldig, omdat een bestaand bestand mogelijk door andere clients of toepassingen wordt verwijderd. 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 de bewerking Exists.

Retouren

Promise<boolean>

Alle ingangen voor een bestand geforceerd sluiten.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/force-close-handles

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

Parameters

options: FileForceCloseHandlesOptions

Opties voor het geforceerd sluiten van grepen.

Retouren

Promise<CloseHandlesInfo>

Forceer het sluiten van een specifieke ingang voor een bestand.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/force-close-handles

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

Parameters

handleId: string

Specifieke ingangs-id, mag geen sterretje '*' zijn. Gebruik forceCloseAllHandles() om alle grepen te sluiten.

options: FileForceCloseHandlesOptions

Retouren

Promise<FileForceCloseHandlesResponse>

Alleen beschikbaar voor clients die zijn gemaakt met een gedeelde sleutelreferentie.

Genereert 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://docs.microsoft.com/en-us/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 naar 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://docs.microsoft.com/en-us/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 ophalen van bestand.

Retourneert de lijst met geldige bereiken voor een bestand.

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

Parameters

options: FileGetRangeListOptions

Opties voor bestand ophalen bereik lijst bewerking.

Retouren

Promise<FileGetRangeListResponse>

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

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

Parameters

prevShareSnapshot: string

De vorige momentopnameparameter is een ondoorzichtige Datum/tijd-waarde die de vorige momentopname van de share aangeeft waarmee moet worden vergeleken.

options: FileGetRangeListOptions

Retouren

Promise<FileGetRangeListDiffResponse>

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

function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient

Parameters

proposeLeaseId: string

Initiële voorgestelde lease-id.

Retouren

ShareLeaseClient

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

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 de bewerking handles.

Een asynchroneIterableIterator die ondersteuning biedt voor paging.

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 bewerking voor het wijzigen van de naam.

Retouren

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

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

Gebruiksvoorbeeld:


// Rename the file
await fileClient.rename(destinationPath);
console.log("Renamed file successfully!");

Formaat van bestand wijzigen.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-properties

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

Parameters

length: number

Hiermee wijzigt u de grootte 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 de bewerking Formaat van bestand wijzigen.

Retouren

Promise<FileSetHTTPHeadersResponse>

Antwoordgegevens voor de bewerking HTTP-headers voor bestandsset.

Hiermee stelt u HTTP-headers in voor 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 BESTANDS-HTTP-headers zonder waarde gewist.

Zie https://docs.microsoft.com/en-us/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.

Werkt door de gebruiker gedefinieerde metagegevens bij voor het opgegeven bestand.

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

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-metadata

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

Parameters

metadata: Metadata

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

options: FileSetMetadataOptions

Opties voor de bewerking Metagegevens van bestandsset.

Retouren

Promise<FileSetMetadataResponse>

Antwoordgegevens voor de bewerking Metagegevens van bestandsset.

Hiermee stelt u eigenschappen voor het bestand in.

Zie https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-properties

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

Parameters

properties: FileProperties

Bestandseigenschappen. Voor HTTP-bestandsheaders (bijvoorbeeld inhoudstype) worden bestaande HTTP-headers verwijderd als er geen waarden worden opgegeven. Voor andere bestandseigenschappen (bijvoorbeeld fileAttributes) blijven bestaande waarden behouden als er geen waarden worden opgegeven.

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 op, met een lengte van maximaal 2 KB. Als u een bestand wilt kopiëren naar een ander bestand in hetzelfde opslagaccount, 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 shared access signature. 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 de bewerking Bestand Kopiëren starten.

Retouren

Promise<FileStartCopyResponse>

Hiermee maakt u een nieuw Azure-bestand of vervangt u een bestaand Azure-bestand en uploadt u er vervolgens een Buffer(Node)/Blob/ArrayBuffer/ArrayBufferView naar.

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

Parameters

data: Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer(Node), 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 lokaal bestand

options: FileParallelUploadOptions

Retouren

Promise<void>

Upload een bereik van bytes naar een bestand. Deze bewerking kan alleen worden aangeroepen voor een bestaand bestand. De grootte, eigenschappen of metagegevens van het bestand worden niet gewijzigd. Zowel het begin als het aantal van het bereik moeten 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, string, 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 moet worden geüpload.

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 de bewerking Bestandsuploadbereik.

Retouren

Promise<FileUploadRangeResponse>

Antwoordgegevens voor de bewerking Bereik voor het uploaden van bestanden.

Gebruiksvoorbeeld:

const content = "Hello world!";

// Create the file
await fileClient.create(content.length);
console.log("Created file successfully!");

// Then upload data to the file
await fileClient.uploadRange(content, 0, content.length);
console.log("Updated file successfully!")

Upload een bereik van bytes naar een bestand waarin de inhoud wordt gelezen vanuit 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, shared access signature (SAS) die mogelijk nodig is voor verificatie.

sourceOffset: number

De bronverschuiving waaruit u wilt kopiëren. 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 - uploadbereik van URL-bewerking.

Retouren

Promise<FileUploadRangeFromURLResponse>

ALLEEN BESCHIKBAAR IN NODE.JS RUNTIME.

Accepteert een Node.js readable stream factory en uploadt in blokken naar een Azure-bestand. De factory voor leesbare stroom 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 blobobject in de browser naar een Azure-bestand. Vereist een blobFactory als 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 naar het bestand. Met deze methode wordt geprobeerd een Azure-bestand te maken en wordt vervolgens chunk voor segment geüpload. De grootte van het segment wordt gedefinieerd door de 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 voorkomen.

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

Parameters

stream: Readable

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

size: number

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

bufferSize: number

Grootte van elke buffer die in bytes is toegewezen, ook de grootte van het segment/bereik tijdens het geüploade bestand. De grootte moet groter zijn dan 0 en kleiner dan of gelijk zijn 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 het opgegeven tijdstempel van de momentopname van de share. Geef '' op om de momentopname te verwijderen en een URL te retourneren naar de basis ShareFileClient.

function withShareSnapshot(shareSnapshot: string): ShareFileClient

Parameters

shareSnapshot: string

Het tijdstempel van de momentopname van de share.

Retouren

ShareFileClient

Een nieuw ShareFileClient-object dat identiek is aan de bron, maar met de opgegeven tijdstempel van de momentopname van de share.

Delen via

ShareFileClient class

Constructors

Eigenschappen

Overgenomen eigenschappen

Methoden

Constructordetails

ShareFileClient(string, Credential_2 | 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

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

generateSasUrl(FileGenerateSasUrlOptions)

Parameters

Retouren

getProperties(FileGetPropertiesOptions)

Parameters

Retouren

getRangeList(FileGetRangeListOptions)

Parameters

Retouren

getRangeListDiff(string, FileGetRangeListOptions)

Parameters

Retouren

getShareLeaseClient(string)

Parameters

Retouren

listHandles(FileListHandlesOptions)

Parameters

Retouren

rename(string, FileRenameOptions)

Parameters