ShareFileClient class

Referenz

Paket:: @azure/storage-file-share

Ein ShareFileClient stellt eine URL zu einer Azure Storage-Datei dar.

Extends: StorageClient

Konstruktoren

ShareFileClient(string, Credential_2 \| TokenCredential, ShareClientOptions)	Erstellt eine Instanz von ShareFileClient.
ShareFileClient(string, Pipeline, ShareClientConfig)	Erstellt eine Instanz von ShareFileClient.

Eigenschaften

name	Der Name der Datei
path	Der vollständige Pfad der Datei
shareName	Der Freigabename, der diesem Dateiclient entspricht

Geerbte Eigenschaften

accountName
url	URL-Zeichenfolgenwert.

Methoden

abortCopyFromURL(string, FileAbortCopyFromURLOptions)	Bricht einen ausstehenden Dateikopiervorgang ab und belässt eine Zieldatei mit der Länge null und vollständigen Metadaten. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-file.
clearRange(number, number, FileClearRangeOptions)	Löscht den angegebenen Bereich und gibt den Speicherplatz frei, der im Speicher für diesen Bereich verwendet wird.
create(number, FileCreateOptions)	Erstellt eine neue Datei oder ersetzt eine Datei. Beachten Sie, dass die Datei nur ohne Inhalt initialisiert wird. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/create-file.
delete(FileDeleteOptions)	Entfernt die Datei aus dem Speicherkonto. Beim erfolgreichen Löschen einer Datei wird diese sofort aus dem Index des Speicherkontos entfernt, und Clients haben keinen Zugriff mehr darauf. Die Daten der Datei werden später während der automatischen Speicherbereinigung aus dem Dienst entfernt. Beim Löschen der Datei tritt der Statuscode 409 (Konflikt) und der Fehlercode SharingViolation auf, wenn die Datei auf einem SMB-Client geöffnet ist. Datei löschen wird für eine Freigabemomentaufnahme nicht unterstützt, bei der es sich um eine schreibgeschützte Kopie einer Freigabe handelt. Ein Versuch, diesen Vorgang für eine Freigabemomentaufnahme auszuführen, schlägt mit 400 (InvalidQueryParameterValue) fehl. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2.
deleteIfExists(FileDeleteOptions)	Entfernt die Datei aus dem Speicherkonto, sofern vorhanden. Beim erfolgreichen Löschen einer Datei wird diese sofort aus dem Index des Speicherkontos entfernt, und Clients haben keinen Zugriff mehr darauf. Die Daten der Datei werden später während der automatischen Speicherbereinigung aus dem Dienst entfernt. Beim Löschen der Datei tritt der Statuscode 409 (Konflikt) und der Fehlercode SharingViolation auf, wenn die Datei auf einem SMB-Client geöffnet ist. Datei löschen wird für eine Freigabemomentaufnahme nicht unterstützt, bei der es sich um eine schreibgeschützte Kopie einer Freigabe handelt. Ein Versuch, diesen Vorgang für eine Freigabemomentaufnahme auszuführen, schlägt mit 400 (InvalidQueryParameterValue) fehl. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2.
download(number, number, FileDownloadOptions)	Liest oder lädt eine Datei aus dem System herunter, einschließlich ihrer Metadaten und Eigenschaften. In Node.js werden Daten in einem lesbaren Datenstrom zurückgegeben. `readableStreamBody` In Browsern werden Daten in einer Zusage zurückgegeben. `contentAsBlob` Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/get-file.
downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions)	NUR IN NODE.JS RUNTIME VERFÜGBAR. Lädt eine Azure-Datei parallel in einen Puffer herunter. Offset und Count sind optional. Übergeben Sie 0 für beide, um die gesamte Datei herunterzuladen. Warnung: Puffer können aufgrund von Einschränkungen der Node.js/V8 nur Dateien bis zu etwa einem Gigabyte auf 32-Bit-Systemen oder etwa zwei Gigabyte auf 64-Bit-Systemen unterstützen. Für Dateien, die größer als diese Größe sind, sollten Sie downloadToFile in Betracht ziehen.
downloadToBuffer(number, number, FileDownloadToBufferOptions)	NUR IN NODE.JS RUNTIME VERFÜGBAR Lädt eine Azure-Datei parallel in einen Puffer herunter. Offset und Count sind optional. Übergeben Sie 0 für beide, um die gesamte Datei herunterzuladen. Warnung: Puffer können aufgrund von Einschränkungen der Node.js/V8 nur Dateien bis zu etwa einem Gigabyte auf 32-Bit-Systemen oder etwa zwei Gigabyte auf 64-Bit-Systemen unterstützen. Für Dateien, die größer als diese Größe sind, sollten Sie downloadToFile in Betracht ziehen.
downloadToFile(string, number, number, FileDownloadOptions)	NUR IN NODE.JS RUNTIME VERFÜGBAR. Lädt ein Azure-Blob in eine lokale Datei herunter. Tritt ein Fehler auf, wenn der angegebene Dateipfad bereits beendet wird. Offset und Count sind optional, übergeben 0 bzw. undefiniert, um das gesamte Blob herunterzuladen.
exists(FileExistsOptions)	Gibt true zurück, wenn die angegebene Datei vorhanden ist. Andernfalls false. HINWEIS: Verwenden Sie diese Funktion mit Bedacht, da eine vorhandene Datei möglicherweise von anderen Clients oder Anwendungen gelöscht wird. Umgekehrt können neue Dateien von anderen Clients oder Anwendungen hinzugefügt werden, nachdem diese Funktion abgeschlossen ist.
forceCloseAllHandles(FileForceCloseHandlesOptions)	Erzwingen des Schließens aller Handles für eine Datei. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/force-close-handles.
forceCloseHandle(string, FileForceCloseHandlesOptions)	Erzwingen Sie das Schließen eines bestimmten Handles für eine Datei. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/force-close-handles.
generateSasUrl(FileGenerateSasUrlOptions)	Nur für Clients verfügbar, die mit Anmeldeinformationen für gemeinsam genutzte Schlüssel erstellt wurden. Generiert einen SAS-URI (Service Shared Access Signature) basierend auf den übergebenen Clienteigenschaften und Parametern. Die SAS wird von den Anmeldeinformationen für gemeinsam genutzte Schlüssel des Clients signiert. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.
getProperties(FileGetPropertiesOptions)	Gibt alle benutzerdefinierten Metadaten, HTTP-Standardeigenschaften und Systemeigenschaften für die Datei zurück. Der Inhalt der Datei wird nicht zurückgegeben. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/get-file-properties.
getRangeList(FileGetRangeListOptions)	Gibt die Liste der gültigen Bereiche für eine Datei zurück.
getRangeListDiff(string, FileGetRangeListOptions)	Gibt die Liste der Bereiche zurück, die sich zwischen einer vorherigen Freigabemomentaufnahme und dieser Datei unterscheiden.
getShareLeaseClient(string)	Rufen Sie einen ShareLeaseClient ab, der Leases für die Datei verwaltet.
listHandles(FileListHandlesOptions)	Gibt einen asynchronen iterierbaren Iterator zurück, um alle Handles aufzulisten. unter dem angegebenen Konto. .byPage() gibt einen asynchronen iterierbaren Iterator zurück, um die Handles in Seiten aufzulisten.
rename(string, FileRenameOptions)	Benennt eine Datei um. Diese API unterstützt nur das Umbenennen einer Datei in derselben Freigabe.
resize(number, FileResizeOptions)	Ändern sie die Größe der Datei. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-properties.
setHttpHeaders(FileHttpHeaders, FileSetHttpHeadersOptions)	Legt HTTP-Header für die Datei fest. Wenn keine Option oder kein Wert für die HTTP-Header der Datei in den Optionen angegeben ist, werden diese Datei-HTTP-Header ohne Wert gelöscht. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-properties.
setMetadata(Metadata, FileSetMetadataOptions)	Aktualisiert benutzerdefinierte Metadaten für die angegebene Datei. Wenn im Optionsparameter keine Metadaten definiert sind, werden die Dateimetadaten entfernt. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-metadata.
setProperties(FileProperties)	Legt Eigenschaften für die Datei fest. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-properties.
startCopyFromURL(string, FileStartCopyOptions)	Kopiert ein Blob oder eine Datei in eine Zieldatei innerhalb des Speicherkontos.
uploadData(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, FileParallelUploadOptions)	Erstellt eine neue Azure-Datei oder ersetzt eine vorhandene Azure-Datei und lädt dann einen Buffer(Node)/Blob/ArrayBuffer/ArrayBufferView hoch.
uploadFile(string, FileParallelUploadOptions)	NUR IN NODE.JS RUNTIME VERFÜGBAR. Erstellt eine neue Azure-Datei oder ersetzt eine vorhandene Azure-Datei und lädt dann eine lokale Datei in sie hoch.
uploadRange(RequestBodyType, number, number, FileUploadRangeOptions)	Laden Sie einen Bytesbereich in eine Datei hoch. Dieser Vorgang kann nur für eine vorhandene Datei aufgerufen werden. Die Größe, Eigenschaften oder Metadaten der Datei werden nicht geändert. Sowohl der Start als auch die Anzahl des Bereichs müssen angegeben werden. Der Bereich kann bis zu 4 MB groß sein.
uploadRangeFromURL(string, number, number, number, FileUploadRangeFromURLOptions)	Laden Sie einen Bytesbereich in eine Datei hoch, in der der Inhalt aus der URL einer anderen Datei gelesen wird. Der Bereich kann bis zu 4 MB groß sein.
uploadResetableStream((offset: number, count?: number) => ReadableStream, number, FileParallelUploadOptions)	NUR IN NODE.JS RUNTIME VERFÜGBAR. Akzeptiert eine Node.js lesbare Stream factory und lädt in Blöcken in eine Azure-Datei hoch. Die Factory für lesbaren Datenstrom muss ab dem definierten Offset einen Node.js Lesbaren Stream zurückgeben. Der Offset ist der Offset in der azure-Datei, die hochgeladen werden soll.
uploadSeekableBlob((offset: number, size: number) => Blob, number, FileParallelUploadOptions)	NUR IN BROWSERN VERFÜGBAR. Lädt ein Browserblobobjekt in eine Azure-Datei hoch. Erfordert eine blobFactory als Datenquelle, die ein Blob-Objekt mit dem angegebenen Offset und der angegebenen Größe zurückgeben muss.
uploadStream(Readable, number, number, number, FileUploadStreamOptions)	NUR IN NODE.JS RUNTIME VERFÜGBAR. Erstellt eine neue Azure-Datei oder ersetzt eine vorhandene Azure-Datei und lädt dann einen Node.js lesbaren Stream in die Datei hoch. Diese Methode versucht, eine Azure-Datei zu erstellen, und beginnt dann mit dem Hochladen von Segmenten. Die Größe des Blocks wird durch den `bufferSize` Parameter definiert. Stellen Sie sicher, dass die potenzielle Größe des Streams die Dateigröße nicht überschreitet. TIPPS ZUR LEISTUNGSVERBESSERUNG: Der Eingabestream highWaterMark ist besser, einen gleichen Wert mit dem bufferSize-Parameter festzulegen, wodurch Buffer.concat()-Vorgänge vermieden werden.
withShareSnapshot(string)	Erstellt ein neues ShareFileClient-Objekt, das mit der Quelle identisch ist, aber mit dem angegebenen Freigabemomentaufnahmezeitstempel. Geben Sie "" an, um die Momentaufnahme zu entfernen und eine URL an die ShareFileClient-Basis zurückzugeben.

Details zum Konstruktor

Erstellt eine Instanz von ShareFileClient.

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

Parameter

url: string

Eine URL-Zeichenfolge, die auf die Azure Storage-Datei zeigt, z. B. "https://myaccount.file.core.windows.net/myshare/mydirectory/file"". Sie können eine SAS anfügen, wenn Sie AnonymousCredential verwenden, z. B. "https://myaccount.file.core.windows.net/myshare/mydirectory/file?sasString". Diese Methode akzeptiert eine codierte URL oder eine nicht codierte URL, die auf eine Datei verweist. Die codierte URL-Zeichenfolge wird NICHT zweimal mit Escapezeichen versehen, nur Sonderzeichen im URL-Pfad werden mit Escapezeichen versehen. Wenn jedoch ein Datei- oder Verzeichnisname %enthält, muss der Datei- oder Verzeichnisname in der URL codiert werden. z. B. eine Datei mit dem Namen "myfile%", sollte die URL "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25"" sein.

credential: Credential | TokenCredential

Beispielsweise , StorageSharedKeyCredential oder TokenCredential, Wenn nicht angegeben, wird AnonymousCredential verwendet.

options: ShareClientOptions

Optional. Optionen zum Konfigurieren der HTTP-Pipeline.

Erstellt eine Instanz von ShareFileClient.

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

Parameter

url: string

pipeline: Pipeline

Rufen Sie newPipeline() auf, um eine Standardpipeline zu erstellen, oder stellen Sie eine benutzerdefinierte Pipeline bereit.

options: ShareClientConfig

Details zur Eigenschaft

Der Name der Datei

string name

Eigenschaftswert

string

Der vollständige Pfad der Datei

string path

Eigenschaftswert

string

Der Freigabename, der diesem Dateiclient entspricht

string shareName

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

accountName: string

Eigenschaftswert

string

Geerbt von StorageClient.accountName

URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

string

Geerbt von StorageClient.url

Details zur Methode

Bricht einen ausstehenden Dateikopiervorgang ab und belässt eine Zieldatei mit der Länge null und vollständigen Metadaten.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-file.

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

Parameter

copyId: string

ID des abzubrechenden Vorgangs Datei kopieren.

options: FileAbortCopyFromURLOptions

Optionen zum Abbruch des Vorgangs "Kopieren von URL".

Gibt zurück

Promise<FileAbortCopyResponse>

Löscht den angegebenen Bereich und gibt den Speicherplatz frei, der im Speicher für diesen Bereich verwendet wird.

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

Parameter

offset: number

contentLength: number

options: FileClearRangeOptions

Optionen für den Vorgang "Dateilöschbereich".

Gibt zurück

Promise<FileUploadRangeResponse>

Erstellt eine neue Datei oder ersetzt eine Datei. Beachten Sie, dass die Datei nur ohne Inhalt initialisiert wird.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/create-file.

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

Parameter

size: number

Gibt die maximale Größe in Bytes für die Datei an, bis zu 4 TB.

options: FileCreateOptions

Optionen zum Dateierstellungsvorgang.

Gibt zurück

Promise<FileCreateResponse>

Antwortdaten für den Dateierstellungsvorgang.

Beispielverwendung:

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!")

Entfernt die Datei aus dem Speicherkonto. Beim erfolgreichen Löschen einer Datei wird diese sofort aus dem Index des Speicherkontos entfernt, und Clients haben keinen Zugriff mehr darauf. Die Daten der Datei werden später während der automatischen Speicherbereinigung aus dem Dienst entfernt.

Beim Löschen der Datei tritt der Statuscode 409 (Konflikt) und der Fehlercode SharingViolation auf, wenn die Datei auf einem SMB-Client geöffnet ist.

Datei löschen wird für eine Freigabemomentaufnahme nicht unterstützt, bei der es sich um eine schreibgeschützte Kopie einer Freigabe handelt. Ein Versuch, diesen Vorgang für eine Freigabemomentaufnahme auszuführen, schlägt mit 400 (InvalidQueryParameterValue) fehl.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2.

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

Parameter

options: FileDeleteOptions

Optionen zum Dateilöschvorgang.

Gibt zurück

Promise<FileDeleteResponse>

Antwortdaten für den Dateilöschvorgang.

Entfernt die Datei aus dem Speicherkonto, sofern vorhanden. Beim erfolgreichen Löschen einer Datei wird diese sofort aus dem Index des Speicherkontos entfernt, und Clients haben keinen Zugriff mehr darauf. Die Daten der Datei werden später während der automatischen Speicherbereinigung aus dem Dienst entfernt.

Beim Löschen der Datei tritt der Statuscode 409 (Konflikt) und der Fehlercode SharingViolation auf, wenn die Datei auf einem SMB-Client geöffnet ist.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2.

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

Parameter

options: FileDeleteOptions

Gibt zurück

Promise<FileDeleteIfExistsResponse>

Liest oder lädt eine Datei aus dem System herunter, einschließlich ihrer Metadaten und Eigenschaften.

In Node.js werden Daten in einem lesbaren Datenstrom zurückgegeben. readableStreamBody
In Browsern werden Daten in einer Zusage zurückgegeben. contentAsBlob

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

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

Parameter

offset: number

Von welcher Position der datei heruntergeladen werden soll, größer oder gleich 0

count: number

Wie viele Daten heruntergeladen werden sollen, größer als 0. Wird bis zum Ende heruntergeladen, wenn nicht definiert

options: FileDownloadOptions

Optionen zum Dateidownloadvorgang.

Gibt zurück

Promise<FileDownloadResponseModel>

Antwortdaten für den Dateidownloadvorgang.

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

Beispielverwendung (Browser):

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

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Lädt eine Azure-Datei parallel in einen Puffer herunter. Offset und Count sind optional. Übergeben Sie 0 für beide, um die gesamte Datei herunterzuladen.

Warnung: Puffer können aufgrund von Einschränkungen der Node.js/V8 nur Dateien bis zu etwa einem Gigabyte auf 32-Bit-Systemen oder etwa zwei Gigabyte auf 64-Bit-Systemen unterstützen. Für Dateien, die größer als diese Größe sind, sollten Sie downloadToFile in Betracht ziehen.

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

Parameter

buffer: Buffer

Puffer, der gefüllt werden soll, muss eine Länge haben, die größer als die Anzahl ist

offset: number

Von welcher Position der Azure-Datei heruntergeladen werden soll

count: number

Wie viele Daten heruntergeladen werden sollen. Wird bis zum Ende heruntergeladen, wenn undefined übergeben wird

options: FileDownloadToBufferOptions

Gibt zurück

Promise<Buffer>

NUR IN NODE.JS RUNTIME VERFÜGBAR

Lädt eine Azure-Datei parallel in einen Puffer herunter. Offset und Count sind optional. Übergeben Sie 0 für beide, um die gesamte Datei herunterzuladen.

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

Parameter

offset: number

Von welcher Position der Azure-Datei heruntergeladen werden soll

count: number

Wie viele Daten heruntergeladen werden sollen. Wird bis zum Ende heruntergeladen, wenn undefined übergeben wird

options: FileDownloadToBufferOptions

Gibt zurück

Promise<Buffer>

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Lädt ein Azure-Blob in eine lokale Datei herunter. Tritt ein Fehler auf, wenn der angegebene Dateipfad bereits beendet wird. Offset und Count sind optional, übergeben 0 bzw. undefiniert, um das gesamte Blob herunterzuladen.

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

Parameter

filePath: string

offset: number

Von welcher Position des Blockblobs heruntergeladen werden soll.

count: number

Wie viele Daten heruntergeladen werden sollen. Wird bis zum Ende heruntergeladen, wenn undefined übergeben wird.

options: FileDownloadOptions

Optionen für Blobdownloadoptionen.

Gibt zurück

Promise<FileDownloadResponseModel>

Die Antwortdaten für den Blobdownloadvorgang, jedoch mit readableStreamBody auf undefiniert festgelegt, da der Inhalt bereits am angegebenen Pfad gelesen und in eine lokale Datei geschrieben wird.

Gibt true zurück, wenn die angegebene Datei vorhanden ist. Andernfalls false.

HINWEIS: Verwenden Sie diese Funktion mit Bedacht, da eine vorhandene Datei möglicherweise von anderen Clients oder Anwendungen gelöscht wird. Umgekehrt können neue Dateien von anderen Clients oder Anwendungen hinzugefügt werden, nachdem diese Funktion abgeschlossen ist.

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

Parameter

options: FileExistsOptions

Optionen zum Exists-Vorgang.

Gibt zurück

Promise<boolean>

Erzwingen des Schließens aller Handles für eine Datei.

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

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

Parameter

options: FileForceCloseHandlesOptions

Optionen zum Erzwingen des Vorgangs zum Schließen von Handles.

Gibt zurück

Promise<CloseHandlesInfo>

Erzwingen Sie das Schließen eines bestimmten Handles für eine Datei.

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

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

Parameter

handleId: string

Die spezifische Handle-ID darf kein Sternchen "*" sein. Verwenden Sie forceCloseAllHandles(), um alle Handles zu schließen.

options: FileForceCloseHandlesOptions

Gibt zurück

Promise<FileForceCloseHandlesResponse>

Nur für Clients verfügbar, die mit Anmeldeinformationen für gemeinsam genutzte Schlüssel erstellt wurden.

Generiert einen SAS-URI (Service Shared Access Signature) basierend auf den übergebenen Clienteigenschaften und Parametern. Die SAS wird von den Anmeldeinformationen für gemeinsam genutzte Schlüssel des Clients signiert.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.

function generateSasUrl(options: FileGenerateSasUrlOptions): string

Parameter

options: FileGenerateSasUrlOptions

Optionale Parameter.

Gibt zurück

string

Der SAS-URI, der aus dem URI für die von diesem Client dargestellte Ressource besteht, gefolgt vom generierten SAS-Token.

Gibt alle benutzerdefinierten Metadaten, HTTP-Standardeigenschaften und Systemeigenschaften für die Datei zurück. Der Inhalt der Datei wird nicht zurückgegeben.

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

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

Parameter

options: FileGetPropertiesOptions

Optionen zum Vorgang Datei abrufen von Eigenschaften.

Gibt zurück

Promise<FileGetPropertiesResponse>

Antwortdaten für den Vorgang Dateieigenschaften abrufen.

Gibt die Liste der gültigen Bereiche für eine Datei zurück.

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

Parameter

options: FileGetRangeListOptions

Optionen zum Vorgang "Dateibereichsliste abrufen".

Gibt zurück

Promise<FileGetRangeListResponse>

Gibt die Liste der Bereiche zurück, die sich zwischen einer vorherigen Freigabemomentaufnahme und dieser Datei unterscheiden.

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

Parameter

prevShareSnapshot: string

Der vorherige Momentaufnahmeparameter ist ein undurchsichtiger DateTime-Wert, der die vorherige Freigabemomentaufnahme angibt, mit der verglichen werden soll.

options: FileGetRangeListOptions

Gibt zurück

Promise<FileGetRangeListDiffResponse>

Rufen Sie einen ShareLeaseClient ab, der Leases für die Datei verwaltet.

function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient

Parameter

proposeLeaseId: string

Anfänglich vorgeschlagene Lease-ID.

Gibt zurück

ShareLeaseClient

Ein neues ShareLeaseClient-Objekt zum Verwalten von Leases für die Datei.

Gibt einen asynchronen iterierbaren Iterator zurück, um alle Handles aufzulisten. unter dem angegebenen Konto.

.byPage() gibt einen asynchronen iterierbaren Iterator zurück, um die Handles in Seiten aufzulisten.

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

Parameter

options: FileListHandlesOptions

Optionen zum Auflisten des Handles-Vorgangs.

Ein asyncIterableIterator, der Paging unterstützt.

Gibt zurück

PagedAsyncIterableIterator<HandleItem, FileListHandlesResponse, PageSettings>

Benennt eine Datei um. Diese API unterstützt nur das Umbenennen einer Datei in derselben Freigabe.

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

Parameter

destinationPath: string

Gibt den Zielpfad an, in den umbenannt werden soll. Der Pfad wird so codiert, dass er in eine URL eingefügt wird, um das Ziel anzugeben.

options: FileRenameOptions

Optionen für den Umbenennungsvorgang.

Gibt zurück

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

Antwortdaten für den Dateiumbenennungsvorgang.

Beispielverwendung:


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

Ändern sie die Größe der Datei.

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

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

Parameter

length: number

Ändert die Größe einer Datei auf die angegebene Größe in Bytes. Wenn der angegebene Byte-Wert kleiner als die aktuelle Größe der Datei ist, werden alle Bereiche über dem angegebenen Byte-Wert gelöscht.

options: FileResizeOptions

Optionen zum Dateiänderungsvorgang.

Gibt zurück

Promise<FileSetHTTPHeadersResponse>

Antwortdaten für den Vorgang "Dateisatz-HTTP-Headers".

Legt HTTP-Header für die Datei fest.

Wenn keine Option oder kein Wert für die HTTP-Header der Datei in den Optionen angegeben ist, werden diese Datei-HTTP-Header ohne Wert gelöscht.

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

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

Parameter

fileHttpHeaders: FileHttpHeaders

options: FileSetHttpHeadersOptions

Optionen zum Dateisatz-HTTP-Headervorgang.

Gibt zurück

Promise<FileSetHTTPHeadersResponse>

Antwortdaten für den Vorgang "Dateisatz-HTTP-Headers".

Aktualisiert benutzerdefinierte Metadaten für die angegebene Datei.

Wenn im Optionsparameter keine Metadaten definiert sind, werden die Dateimetadaten entfernt.

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

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

Parameter

metadata: Metadata

Wenn keine Metadaten angegeben werden, werden alle vorhandenen Verzeichnismetadaten entfernt.

options: FileSetMetadataOptions

Optionen zum Dateisatzmetadatenvorgang.

Gibt zurück

Promise<FileSetMetadataResponse>

Antwortdaten für den Dateisatzmetadatenvorgang.

Legt Eigenschaften für die Datei fest.

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

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

Parameter

properties: FileProperties

Dateieigenschaften. Bei Datei-HTTP-Headern (z. B. Content-Type) werden vorhandene HTTP-Header entfernt, wenn keine Werte angegeben werden. Bei anderen Dateieigenschaften (z. B. fileAttributes) werden vorhandene Werte beibehalten, wenn keine Werte angegeben werden.

Gibt zurück

Promise<SetPropertiesResponse>

Kopiert ein Blob oder eine Datei in eine Zieldatei innerhalb des Speicherkontos.

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

Parameter

copySource: string

Gibt die URL der Quelldatei oder des Blobs mit einer Länge von bis zu 2 KB an. Um eine Datei in eine andere Datei innerhalb desselben Speicherkontos zu kopieren, können Sie den freigegebenen Schlüssel verwenden, um die Quelldatei zu authentifizieren. Wenn Sie eine Datei aus einem anderen Speicherkonto kopieren oder ein Blob aus demselben Speicherkonto oder einem anderen Speicherkonto kopieren, müssen Sie die Quelldatei oder das Blob mithilfe einer Freigegebenen Zugriffssignatur authentifizieren. Wenn es sich bei der Quelle um ein öffentliches Blob handelt, ist keine Authentifizierung erforderlich, um den Kopiervorgang auszuführen. Eine Datei in einer Freigabemomentaufnahme kann auch als Kopierquelle angegeben werden.

options: FileStartCopyOptions

Optionen zum Dateistart kopiervorgang.

Gibt zurück

Promise<FileStartCopyResponse>

Erstellt eine neue Azure-Datei oder ersetzt eine vorhandene Azure-Datei und lädt dann einen Buffer(Node)/Blob/ArrayBuffer/ArrayBufferView hoch.

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

Parameter

data: Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer(Node), Blob, ArrayBuffer oder ArrayBufferView

options: FileParallelUploadOptions

Gibt zurück

Promise<void>

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Erstellt eine neue Azure-Datei oder ersetzt eine vorhandene Azure-Datei und lädt dann eine lokale Datei in sie hoch.

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

Parameter

filePath: string

Vollständiger Pfad der lokalen Datei

options: FileParallelUploadOptions

Gibt zurück

Promise<void>

Laden Sie einen Bytesbereich in eine Datei hoch. Dieser Vorgang kann nur für eine vorhandene Datei aufgerufen werden. Die Größe, Eigenschaften oder Metadaten der Datei werden nicht geändert. Sowohl der Start als auch die Anzahl des Bereichs müssen angegeben werden. Der Bereich kann bis zu 4 MB groß sein.

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

Parameter

body: HttpRequestBody

Blob, String, ArrayBuffer, ArrayBufferView oder eine Funktion, die einen neuen lesbaren Stream zurückgibt, dessen Offset vom Anfang der Datenquelle stammt.

offset: number

Offsetposition der azure-Zieldatei, die hochgeladen werden soll.

contentLength: number

Länge des Textkörpers in Bytes. Verwenden Sie Buffer.byteLength(), um die Textlänge für eine Zeichenfolge zu berechnen, die nicht Base64/Hex-codierte Zeichen enthält.

options: FileUploadRangeOptions

Optionen zum Dateiuploadbereich- Vorgang.

Gibt zurück

Promise<FileUploadRangeResponse>

Antwortdaten für den Vorgang Dateiuploadbereich.

Beispielverwendung:

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!")

Laden Sie einen Bytesbereich in eine Datei hoch, in der der Inhalt aus der URL einer anderen Datei gelesen wird. Der Bereich kann bis zu 4 MB groß sein.

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

Parameter

sourceURL: string

Geben Sie eine URL für die Kopierquelle an. Shared Access Signature (SAS), die möglicherweise für die Authentifizierung erforderlich ist.

sourceOffset: number

Der Quelloffset, aus dem kopiert werden soll. Übergeben Sie 0, um vom Anfang der Quelldatei zu kopieren.

destOffset: number

Offset der Zieldatei.

count: number

Anzahl der Bytes, die aus der Quelldatei hochgeladen werden sollen.

options: FileUploadRangeFromURLOptions

Optionen zum Konfigurieren von Datei – Upload Range from URL-Vorgang.

Gibt zurück

Promise<FileUploadRangeFromURLResponse>

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Akzeptiert eine Node.js lesbare Stream factory und lädt in Blöcken in eine Azure-Datei hoch. Die Factory für lesbaren Datenstrom muss ab dem definierten Offset einen Node.js Lesbaren Stream zurückgeben. Der Offset ist der Offset in der azure-Datei, die hochgeladen werden soll.

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

Parameter

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

Gibt einen Node.js lesbaren Stream ab dem definierten Offset zurück.

size: number

Größe der Azure-Datei

options: FileParallelUploadOptions

Gibt zurück

Promise<void>

NUR IN BROWSERN VERFÜGBAR.

Lädt ein Browserblobobjekt in eine Azure-Datei hoch. Erfordert eine blobFactory als Datenquelle, die ein Blob-Objekt mit dem angegebenen Offset und der angegebenen Größe zurückgeben muss.

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

Parameter

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

size: number

options: FileParallelUploadOptions

Gibt zurück

Promise<void>

NUR IN NODE.JS RUNTIME VERFÜGBAR.

Erstellt eine neue Azure-Datei oder ersetzt eine vorhandene Azure-Datei und lädt dann einen Node.js lesbaren Stream in die Datei hoch. Diese Methode versucht, eine Azure-Datei zu erstellen, und beginnt dann mit dem Hochladen von Segmenten. Die Größe des Blocks wird durch den bufferSize Parameter definiert. Stellen Sie sicher, dass die potenzielle Größe des Streams die Dateigröße nicht überschreitet.

TIPPS ZUR LEISTUNGSVERBESSERUNG:

Der Eingabestream highWaterMark ist besser, einen gleichen Wert mit dem bufferSize-Parameter festzulegen, wodurch Buffer.concat()-Vorgänge vermieden werden.

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

Parameter

stream: Readable

Node.js lesbarer Stream. Muss kleiner oder gleich der Dateigröße sein.

size: number

Größe der zu erstellenden Datei. Die maximal zulässige Größe beträgt 4 TB. Wenn dieser Wert größer als die Streamgröße ist, befinden sich leere Bytes im Dateifragment.

bufferSize: number

Größe jedes Puffers, der in Bytes zugeordnet ist, auch die Block-/Bereichsgröße während der hochgeladenen Datei. Größe muss größer als 0 und kleiner als oder gleich 4 * 1024 * 1024 (4 MB) sein.

maxBuffers: number

Max. Puffer werden während des Uploads zugeordnet, positive Korrelation mit maximaler Parallelität des Uploads

options: FileUploadStreamOptions

Gibt zurück

Promise<void>

Erstellt ein neues ShareFileClient-Objekt, das mit der Quelle identisch ist, aber mit dem angegebenen Freigabemomentaufnahmezeitstempel. Geben Sie "" an, um die Momentaufnahme zu entfernen und eine URL an die ShareFileClient-Basis zurückzugeben.

function withShareSnapshot(shareSnapshot: string): ShareFileClient

Parameter

shareSnapshot: string

Der Zeitstempel der Freigabemomentaufnahme.

Gibt zurück

ShareFileClient

Ein neues ShareFileClient-Objekt, das mit der Quelle identisch ist, aber mit dem angegebenen Freigabemomentaufnahmezeitstempel.

Freigeben über

ShareFileClient class

Konstruktoren

Eigenschaften

Geerbte Eigenschaften

Methoden

Details zum Konstruktor

ShareFileClient(string, Credential_2 | TokenCredential, ShareClientOptions)

Parameter

ShareFileClient(string, Pipeline, ShareClientConfig)

Parameter

Details zur Eigenschaft

name

Eigenschaftswert

path

Eigenschaftswert

shareName

Eigenschaftswert

Geerbte Eigenschaftsdetails

accountName

Eigenschaftswert

url

Eigenschaftswert

Details zur Methode

abortCopyFromURL(string, FileAbortCopyFromURLOptions)

Parameter

Gibt zurück

clearRange(number, number, FileClearRangeOptions)

Parameter

Gibt zurück

create(number, FileCreateOptions)

Parameter

Gibt zurück

delete(FileDeleteOptions)

Parameter

Gibt zurück

deleteIfExists(FileDeleteOptions)

Parameter

Gibt zurück

download(number, number, FileDownloadOptions)

Parameter

Gibt zurück

downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions)

Parameter

Gibt zurück

downloadToBuffer(number, number, FileDownloadToBufferOptions)

Parameter

Gibt zurück

downloadToFile(string, number, number, FileDownloadOptions)

Parameter

Gibt zurück

exists(FileExistsOptions)

Parameter

Gibt zurück

forceCloseAllHandles(FileForceCloseHandlesOptions)

Parameter

Gibt zurück

forceCloseHandle(string, FileForceCloseHandlesOptions)

Parameter

Gibt zurück

generateSasUrl(FileGenerateSasUrlOptions)

Parameter

Gibt zurück

getProperties(FileGetPropertiesOptions)

Parameter

Gibt zurück

getRangeList(FileGetRangeListOptions)

Parameter

Gibt zurück

getRangeListDiff(string, FileGetRangeListOptions)

Parameter

Gibt zurück

getShareLeaseClient(string)

Parameter

Gibt zurück

listHandles(FileListHandlesOptions)

Parameter

Gibt zurück

rename(string, FileRenameOptions)

Parameter