ShareFileClient class

Crée une instance de ShareFileClient.

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

Paramètres

Crée une instance de ShareFileClient.

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

Paramètres

Nom du fichier

string name

Valeur de propriété

Chemin d’accès complet du fichier

string path

Valeur de propriété

Nom du partage correspondant à ce client de fichiers

string shareName

Valeur de propriété

accountName: string

Valeur de propriété

héritée de StorageClient.accountName

Valeur de chaîne d’URL.

url: string

Valeur de propriété

héritée de StorageClient.url

Abandonne une opération de copie de fichier en attente et laisse un fichier de destination avec une longueur nulle et des métadonnées complètes.

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

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

Paramètres

Retours

Efface la plage spécifiée et libère l’espace utilisé dans le stockage pour cette plage.

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

Paramètres

Retours

Crée un fichier ou remplace un fichier. Notez qu’il initialise uniquement le fichier sans contenu.

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

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

Paramètres

Retours

Données de réponse pour l’opération Création de fichiers.

Exemple d’utilisation :

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

NFS uniquement. Crée un lien dur vers le fichier spécifié par chemin d’accès.

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

Paramètres

Retours

NFS uniquement. Crée un lien symbolique.

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

Paramètres

Retours

Supprime le fichier du compte de stockage. Lorsqu’un fichier est supprimé avec succès, il est immédiatement supprimé de l’index du compte de stockage et n’est plus accessible aux clients. Les données du fichier sont supprimées ultérieurement du service pendant le garbage collection.

La suppression du fichier échoue avec le code d’état 409 (conflit) et le code d’erreur SharingViolation si le fichier est ouvert sur un client SMB.

Supprimer le fichier n’est pas pris en charge sur un instantané de partage, qui est une copie en lecture seule d’un partage. Une tentative d’exécution de cette opération sur un instantané de partage échoue avec 400 (InvalidQueryParameterValue)

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

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

Paramètres

Retours

Données de réponse pour l’opération suppression de fichier.

Supprime le fichier du compte de stockage s’il existe. Lorsqu’un fichier est supprimé avec succès, il est immédiatement supprimé de l’index du compte de stockage et n’est plus accessible aux clients. Les données du fichier sont supprimées ultérieurement du service pendant le garbage collection.

La suppression du fichier échoue avec le code d’état 409 (conflit) et le code d’erreur SharingViolation si le fichier est ouvert sur un client SMB.

Supprimer le fichier n’est pas pris en charge sur un instantané de partage, qui est une copie en lecture seule d’un partage. Une tentative d’exécution de cette opération sur un instantané de partage échoue avec 400 (InvalidQueryParameterValue)

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

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

Paramètres

Retours

Lit ou télécharge un fichier à partir du système, y compris ses métadonnées et ses propriétés.

• Dans Node.js, les données retournent dans un flux lisible readableStreamBody
• Dans les navigateurs, les données retournent dans une promesse contentAsBlob

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

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

Paramètres

Retours

Données de réponse pour l’opération de téléchargement de fichiers.

Exemple d’utilisation (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);
  });
}

Exemple d’utilisation (navigateurs) :

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

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

Télécharge un fichier Azure en parallèle vers une mémoire tampon. Le décalage et le nombre sont facultatifs, transmettez 0 pour les deux pour télécharger l’intégralité du fichier.

Avertissement : les mémoires tampons peuvent uniquement prendre en charge les fichiers pouvant atteindre environ un gigaoctet sur des systèmes 32 bits ou environ deux gigaoctets sur des systèmes 64 bits en raison des limitations de Node.js/V8. Pour les fichiers supérieurs à cette taille, envisagez de downloadToFile.

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

Paramètres

Retours

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME

Télécharge un fichier Azure en parallèle vers une mémoire tampon. Offset et count sont facultatifs, passez 0 pour les deux pour télécharger l’intégralité du fichier

Avertissement : les mémoires tampons peuvent uniquement prendre en charge les fichiers pouvant atteindre environ un gigaoctet sur des systèmes 32 bits ou environ deux gigaoctets sur des systèmes 64 bits en raison des limitations de Node.js/V8. Pour les fichiers supérieurs à cette taille, envisagez de downloadToFile.

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

Paramètres

Retours

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

Télécharge un objet blob Azure dans un fichier local. Échoue si le chemin d’accès du fichier donné se ferme déjà. Le décalage et le nombre sont facultatifs, passent respectivement 0 et non définis pour télécharger l’intégralité de l’objet blob.

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

Paramètres

Retours

Données de réponse pour l’opération de téléchargement d’objets blob, mais avec readableStreamBody défini sur non défini, car son contenu est déjà lu et écrit dans un fichier local au chemin spécifié.

Retourne true si le fichier spécifié existe ; false sinon.

REMARQUE : utilisez cette fonction avec soin, car un fichier existant peut être supprimé par d’autres clients ou applications. Inversement, de nouveaux fichiers peuvent être ajoutés par d’autres clients ou applications une fois cette fonction terminée.

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

Paramètres

Retours

Forcez la fermeture de tous les handles d’un fichier.

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

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

Paramètres

Retours

Forcer la fermeture d’un handle spécifique pour un fichier.

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

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

Paramètres

Retours

Disponible uniquement pour les clients construits avec des informations d’identification de clé partagée.

Génère une chaîne à signer pour un URI de signature d’accès partagé de service (SAP) en fonction des propriétés et paramètres du client transmis. La SAP est signée par les informations d’identification de clé partagée du client.

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

function generateSasStringToSign(options: FileGenerateSasUrlOptions): string

Paramètres

Retours

URI SAP constitué de l’URI de la ressource représentée par ce client, suivi du jeton SAP généré.

Disponible uniquement pour les clients construits avec des informations d’identification de clé partagée.

Génère un URI de signature d’accès partagé (SAP) de service en fonction des propriétés et paramètres du client transmis. La SAP est signée par les informations d’identification de clé partagée du client.

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

function generateSasUrl(options: FileGenerateSasUrlOptions): string

Paramètres

Retours

URI SAP constitué de l’URI de la ressource représentée par ce client, suivi du jeton SAP généré.

Retourne toutes les métadonnées définies par l’utilisateur, les propriétés HTTP standard et les propriétés système du fichier. Il ne retourne pas le contenu du fichier.

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

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

Paramètres

Retours

Données de réponse pour l’opération Propriétés d’obtention de fichier.

Retourne la liste des plages valides pour un fichier.

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

Paramètres

Retours

Retourne la liste des plages qui diffèrent entre un instantané de partage précédent et ce fichier.

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

Paramètres

Retours

Obtenez un ShareLeaseClient qui gère les baux sur le fichier.

function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient

Paramètres

Retours

Nouvel objet ShareLeaseClient pour la gestion des baux sur le fichier.

NFS uniquement. Obtient le contenu d’un lien symbolique.

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

Paramètres

Retours

Retourne un itérateur itérable asynchrone pour répertorier tous les handles. sous le compte spécifié.

.byPage() retourne un itérateur itérable asynchrone pour répertorier les handles dans les pages.

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

Paramètres

Retours

Renomme un fichier. Cette API prend uniquement en charge le renommage d’un fichier dans le même partage.

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

Paramètres

Retours

Données de réponse pour l’opération de changement de nom de fichier.

Exemple d’utilisation :

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

Redimensionnez le fichier.

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

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

Paramètres

Retours

Données de réponse pour l’opération d’en-têtes HTTP du jeu de fichiers.

Définit les en-têtes HTTP sur le fichier.

Si aucune option n’est fournie ou aucune valeur fournie pour les en-têtes HTTP de fichier dans les options, ces en-têtes HTTP de fichier sans valeur seront effacés.

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

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

Paramètres

Retours

Données de réponse pour l’opération d’en-têtes HTTP du jeu de fichiers.

Met à jour les métadonnées définies par l’utilisateur pour le fichier spécifié.

Si aucune métadonnées n’est définie dans le paramètre d’option, les métadonnées du fichier sont supprimées.

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

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

Paramètres

Retours

Données de réponse pour l’opération de métadonnées du jeu de fichiers.

Définit les propriétés du fichier.

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

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

Paramètres

Retours

Copie un objet blob ou un fichier dans un fichier de destination dans le compte de stockage.

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

Paramètres

Retours

Crée un fichier Azure ou remplace un fichier Azure existant, puis charge une mémoire tampon(node)/Blob/ArrayBuffer/ArrayBufferView.

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

Paramètres

Retours

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

Crée un fichier Azure ou remplace un fichier Azure existant, puis charge un fichier local.

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

Paramètres

Retours

Chargez une plage d’octets dans un fichier. Cette opération ne peut être appelée que sur un fichier existant. Elle ne modifie pas la taille, les propriétés ou les métadonnées du fichier. Le début et le nombre de la plage doivent être spécifiés. La plage peut atteindre jusqu’à 4 Mo de taille.

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

Paramètres

Retours

Données de réponse pour l’opération de plage de chargement de fichiers.

Exemple d’utilisation :

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

Chargez une plage d’octets dans un fichier où le contenu est lu à partir de l’URL d’un autre fichier. La plage peut atteindre jusqu’à 4 Mo de taille.

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

Paramètres

Retours

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

Accepte une fabrique de flux lisible Node.js et charge dans des blocs dans un fichier Azure. La fabrique de flux lisible doit renvoyer un Node.js flux lisible à partir du décalage défini. Le décalage est le décalage dans le fichier Azure à charger.

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

Paramètres

Retours

DISPONIBLE UNIQUEMENT DANS LES NAVIGATEURS.

Charge un objet Blob de navigateur dans un fichier Azure. Nécessite un blobFactory comme source de données, qui doit retourner un objet Blob avec le décalage et la taille fournis.

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

Paramètres

Retours

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

Crée un fichier Azure ou remplace un fichier Azure existant, puis charge un flux Node.js lisible dans celui-ci. Cette méthode tente de créer un fichier Azure, puis commence à charger un bloc par segment. La taille du bloc est définie par bufferSize paramètre. Assurez-vous que la taille potentielle du flux ne dépasse pas la taille du fichier.

CONSEILS D’AMÉLIORATION DES PERFORMANCES :

• Le flux d’entrée highWaterMark est préférable à définir une même valeur avec le paramètre bufferSize, ce qui évite les opérations Buffer.concat().

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

Paramètres

Retours

Crée un objet ShareFileClient identique à la source, mais avec l’horodatage d’instantané de partage spécifié. Indiquez « » supprime l’instantané et retourne une URL vers shareFileClient de base.

function withShareSnapshot(shareSnapshot: string): ShareFileClient

Paramètres

Retours

Nouvel objet ShareFileClient identique à la source, mais avec l’horodatage d’instantané de partage spécifié.