ShareFileClient class

Référence

Paquet:: @azure/storage-file-share

Un ShareFileClient représente une URL vers un fichier de stockage Azure.

Extends: StorageClient

Constructeurs

ShareFileClient(string, Credential_2 \| TokenCredential, ShareClientOptions)	Crée une instance de ShareFileClient.
ShareFileClient(string, Pipeline, ShareClientConfig)	Crée une instance de ShareFileClient.

Propriétés

name	Nom du fichier
path	Chemin d’accès complet du fichier
shareName	Nom de partage correspondant à ce client de fichier

Propriétés héritées

accountName
url	Valeur de chaîne d’URL.

Méthodes

abortCopyFromURL(string, FileAbortCopyFromURLOptions)	Abandonne une opération copier un fichier en attente et laisse un fichier de destination avec aucune longueur et des métadonnées complètes. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-file
clearRange(number, number, FileClearRangeOptions)	Efface la plage spécifiée et libère l’espace utilisé dans le stockage pour cette plage.
create(number, FileCreateOptions)	Crée un fichier ou remplace un fichier. Notez qu’il initialise uniquement le fichier sans contenu. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/create-file
delete(FileDeleteOptions)	Supprime le fichier du compte de stockage. Quand un fichier est supprimé correctement, il est immédiatement retiré de l'index du compte de stockage et n'est plus accessible aux clients. Les données du fichier sont ensuite supprimées du service lors du nettoyage de la mémoire. 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 un 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://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2
deleteIfExists(FileDeleteOptions)	Supprime le fichier du compte de stockage s’il existe. Quand un fichier est supprimé correctement, il est immédiatement retiré de l'index du compte de stockage et n'est plus accessible aux clients. Les données du fichier sont ensuite supprimées du service lors du nettoyage de la mémoire. 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 un 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://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2
download(number, number, FileDownloadOptions)	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 sont retournées dans un flux lisible `readableStreamBody` Dans les navigateurs, les données retournent dans une promesse `contentAsBlob` Voir https://docs.microsoft.com/en-us/rest/api/storageservices/get-file
downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions)	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Télécharge un fichier Azure en parallèle à une mémoire tampon. Le décalage et le nombre sont facultatifs. Passez 0 pour les deux pour télécharger le fichier entier. Avertissement : Les mémoires tampons ne peuvent prendre en charge les fichiers que jusqu’à environ un gigaoctet sur les systèmes 32 bits ou environ deux gigaoctets sur les systèmes 64 bits en raison des limitations de Node.js/V8. Pour les fichiers supérieurs à cette taille, envisagez downloadToFile.
downloadToBuffer(number, number, FileDownloadToBufferOptions)	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME Télécharge un fichier Azure en parallèle à une mémoire tampon. Le décalage et le nombre sont facultatifs, passez 0 pour les deux pour télécharger l’intégralité du fichier Avertissement : Les mémoires tampons ne peuvent prendre en charge les fichiers que jusqu’à environ un gigaoctet sur les systèmes 32 bits ou environ deux gigaoctets sur les systèmes 64 bits en raison des limitations de Node.js/V8. Pour les fichiers supérieurs à cette taille, envisagez downloadToFile.
downloadToFile(string, number, number, FileDownloadOptions)	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, passez 0 et non défini respectivement pour télécharger l’intégralité de l’objet blob.
exists(FileExistsOptions)	Retourne true si le fichier spécifié existe ; false dans le cas contraire. REMARQUE : utilisez cette fonction avec précaution, 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.
forceCloseAllHandles(FileForceCloseHandlesOptions)	Forcer la fermeture de tous les handles d’un fichier. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/force-close-handles
forceCloseHandle(string, FileForceCloseHandlesOptions)	Forcer la fermeture d’un handle spécifique pour un fichier. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/force-close-handles
generateSasUrl(FileGenerateSasUrlOptions)	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é (SAS) 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://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getProperties(FileGetPropertiesOptions)	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. Elle ne retourne pas le contenu du fichier. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/get-file-properties
getRangeList(FileGetRangeListOptions)	Retourne la liste des plages valides pour un fichier.
getRangeListDiff(string, FileGetRangeListOptions)	Retourne la liste des plages qui diffèrent entre un instantané de partage précédent et ce fichier.
getShareLeaseClient(string)	Obtenez un ShareLeaseClient qui gère les baux sur le fichier.
listHandles(FileListHandlesOptions)	Retourne un itérateur asynchrone itérable pour répertorier tous les handles. sous le compte spécifié. .byPage() retourne un itérateur itérateur asynchrone pour répertorier les handles dans les pages.
rename(string, FileRenameOptions)	Renomme un fichier. Cette API prend uniquement en charge le renommage d’un fichier dans le même partage.
resize(number, FileResizeOptions)	Redimensionner le fichier. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-properties
setHttpHeaders(FileHttpHeaders, FileSetHttpHeadersOptions)	Définit les en-têtes HTTP sur le fichier. Si aucune option n’est fournie ou si aucune valeur n’est fournie pour les en-têtes HTTP de fichier dans les options, ces en-têtes HTTP de fichier sans valeur sont effacés. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-properties
setMetadata(Metadata, FileSetMetadataOptions)	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://docs.microsoft.com/en-us/rest/api/storageservices/set-file-metadata
setProperties(FileProperties)	Définit les propriétés du fichier. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-properties
startCopyFromURL(string, FileStartCopyOptions)	Copie un objet blob ou un fichier dans un fichier de destination dans le compte de stockage.
uploadData(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, FileParallelUploadOptions)	Crée un fichier Azure ou remplace un fichier Azure existant, puis y charge un buffer(Node)/Blob/ArrayBuffer/ArrayBuffer/ArrayBufferView.
uploadFile(string, FileParallelUploadOptions)	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Crée un fichier Azure ou remplace un fichier Azure existant, puis charge un fichier local dans celui-ci.
uploadRange(RequestBodyType, number, number, FileUploadRangeOptions)	Chargez une plage d’octets dans un fichier. Cette opération peut être appelée uniquement sur un fichier existant. Cela 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 4 Mo.
uploadRangeFromURL(string, number, number, number, FileUploadRangeFromURLOptions)	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 4 Mo.
uploadResetableStream((offset: number, count?: number) => ReadableStream, number, FileParallelUploadOptions)	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Accepte une fabrique de flux Node.js lecture et se charge en blocs dans un fichier Azure. La fabrique de flux lisible doit retourner un Node.js flux lisible à partir du décalage défini. Le décalage est le décalage dans le fichier Azure à charger.
uploadSeekableBlob((offset: number, size: number) => Blob, number, FileParallelUploadOptions)	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.
uploadStream(Readable, number, number, number, FileUploadStreamOptions)	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Crée un fichier Azure ou remplace un fichier Azure existant, puis y charge un flux Node.js accessible en lecture. Cette méthode tente de créer un fichier Azure, puis commence à charger segment par segment. La taille du bloc est définie par `bufferSize` le 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 de définir une même valeur avec le paramètre bufferSize, ce qui évitera les opérations Buffer.concat().
withShareSnapshot(string)	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 à l’objet ShareFileClient de base.

Détails du constructeur

Crée une instance de ShareFileClient.

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

Paramètres

url: string

Chaîne d’URL pointant vers le fichier Stockage Azure, telle que «https://myaccount.file.core.windows.net/myshare/mydirectory/file" ; ». Vous pouvez ajouter une signature d’accès partagé si vous utilisez AnonymousCredential, par exemple «https://myaccount.file.core.windows.net/myshare/mydirectory/file?sasString" ; ». Cette méthode accepte une URL encodée ou non encodée pointant vers un fichier. La chaîne d’URL encodée ne fera PAS l’objet d’une séquence d’échappement deux fois, seuls les caractères spéciaux dans le chemin d’accès de l’URL seront placés dans une séquence d’échappement. Toutefois, si un nom de fichier ou de répertoire inclut %, le nom du fichier ou du répertoire doit être encodé dans l’URL. Par exemple, un fichier nommé « myfile% », l’URL doit être «https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25" ; ».

credential: Credential | TokenCredential

Par exemple , StorageSharedKeyCredential ou TokenCredential, Si ce n’est pas spécifié, AnonymousCredential est utilisé.

options: ShareClientOptions

facultatif. Options de configuration du pipeline HTTP.

Crée une instance de ShareFileClient.

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

Paramètres

url: string

pipeline: Pipeline

Appelez newPipeline() pour créer un pipeline par défaut ou fournissez un pipeline personnalisé.

options: ShareClientConfig

Détails de la propriété

Nom du fichier

string name

Valeur de propriété

string

Chemin d’accès complet du fichier

string path

Valeur de propriété

string

Nom de partage correspondant à ce client de fichier

string shareName

Valeur de propriété

string

Détails de la propriété héritée

accountName: string

Valeur de propriété

string

Hérité de StorageClient.accountName

Valeur de chaîne d’URL.

url: string

Valeur de propriété

string

Hérité de StorageClient.url

Détails de la méthode

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

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

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

Paramètres

copyId: string

ID de l’opération Copier le fichier à abandonner.

options: FileAbortCopyFromURLOptions

Options de l’opération Annuler la copie à partir de l’URL.

Retours

Promise<FileAbortCopyResponse>

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

offset: number

contentLength: number

options: FileClearRangeOptions

Options de l’opération File Clear Range.

Retours

Promise<FileUploadRangeResponse>

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

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

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

Paramètres

size: number

Spécifie la taille maximale en octets du fichier, jusqu’à 4 To.

options: FileCreateOptions

Options de l’opération de création de fichier.

Retours

Promise<FileCreateResponse>

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

Exemple d’utilisation :

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

Supprime le fichier du compte de stockage. Quand un fichier est supprimé correctement, il est immédiatement retiré de l'index du compte de stockage et n'est plus accessible aux clients. Les données du fichier sont ensuite supprimées du service lors du nettoyage de la mémoire.

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 un 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://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2

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

Paramètres

options: FileDeleteOptions

Options de l’opération de suppression de fichier.

Retours

Promise<FileDeleteResponse>

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

Supprime le fichier du compte de stockage s’il existe. Quand un fichier est supprimé correctement, il est immédiatement retiré de l'index du compte de stockage et n'est plus accessible aux clients. Les données du fichier sont ensuite supprimées du service lors du nettoyage de la mémoire.

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.

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

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

Paramètres

options: FileDeleteOptions

Retours

Promise<FileDeleteIfExistsResponse>

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 sont retournées dans un flux lisible readableStreamBody
Dans les navigateurs, les données retournent dans une promesse contentAsBlob

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

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

Paramètres

offset: number

À partir de quelle position du fichier à télécharger, supérieur ou égal à 0

count: number

Quantité de données à télécharger, supérieure à 0. Téléchargement jusqu’à la fin lorsqu’il n’est pas défini

options: FileDownloadOptions

Options de l’opération de téléchargement de fichier.

Retours

Promise<FileDownloadResponseModel>

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

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

Exemple d’utilisation (navigateurs) :

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

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

Télécharge un fichier Azure en parallèle à une mémoire tampon. Le décalage et le nombre sont facultatifs. Passez 0 pour les deux pour télécharger le fichier entier.

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

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

Paramètres

buffer: Buffer

La mémoire tampon à remplir doit avoir une longueur supérieure au nombre

offset: number

À partir de quelle position du fichier Azure à télécharger

count: number

Quantité de données à télécharger. Téléchargement jusqu’à la fin lors de la transmission d’undefined

options: FileDownloadToBufferOptions

Retours

Promise<Buffer>

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME

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

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

Paramètres

offset: number

À partir de quelle position du fichier Azure à télécharger

count: number

Quantité de données à télécharger. Téléchargement jusqu’à la fin lors de la transmission d’undefined

options: FileDownloadToBufferOptions

Retours

Promise<Buffer>

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, passez 0 et non défini respectivement 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

filePath: string

offset: number

À partir de quelle position de l’objet blob de blocs à télécharger.

count: number

Quantité de données à télécharger. Téléchargement jusqu’à la fin lors du passage non défini.

options: FileDownloadOptions

Options pour les options de téléchargement d’objets blob.

Retours

Promise<FileDownloadResponseModel>

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

Retourne true si le fichier spécifié existe ; false dans le cas contraire.

REMARQUE : utilisez cette fonction avec précaution, 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

options: FileExistsOptions

options de l’opération Exists.

Retours

Promise<boolean>

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

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

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

Paramètres

options: FileForceCloseHandlesOptions

Options permettant de forcer l’opération de fermeture des handles.

Retours

Promise<CloseHandlesInfo>

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

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

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

Paramètres

handleId: string

ID de handle spécifique, ne peut pas être un astérisque « * ». Utilisez forceCloseAllHandles() pour fermer toutes les poignées.

options: FileForceCloseHandlesOptions

Retours

Promise<FileForceCloseHandlesResponse>

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é (SAS) 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://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: FileGenerateSasUrlOptions): string

Paramètres

options: FileGenerateSasUrlOptions

Paramètres facultatifs.

Retours

string

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. Elle ne retourne pas le contenu du fichier.

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

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

Paramètres

options: FileGetPropertiesOptions

Options de l’opération Obtenir les propriétés du fichier.

Retours

Promise<FileGetPropertiesResponse>

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

options: FileGetRangeListOptions

Options de l’opération File Get Range List.

Retours

Promise<FileGetRangeListResponse>

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

prevShareSnapshot: string

Le paramètre d’instantané précédent est une valeur DateTime opaque qui spécifie l’instantané de partage précédent à comparer.

options: FileGetRangeListOptions

Retours

Promise<FileGetRangeListDiffResponse>

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

function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient

Paramètres

proposeLeaseId: string

ID de bail initial proposé.

Retours

ShareLeaseClient

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

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

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

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

Paramètres

options: FileListHandlesOptions

Options pour répertorier l’opération de handles.

AsyncIterableIterator qui prend en charge la pagination.

Retours

PagedAsyncIterableIterator<HandleItem, FileListHandlesResponse, PageSettings>

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

destinationPath: string

Spécifie le chemin d’accès de destination à renommer. Le chemin d’accès sera encodé pour le placer dans une URL pour spécifier la destination.

options: FileRenameOptions

Options pour l’opération de renommage.

Retours

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

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

Exemple d’utilisation :


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

Redimensionner le fichier.

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

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

Paramètres

length: number

Redimensionne un fichier à la taille spécifiée en octets. Si la valeur d'octet spécifiée est inférieure à la taille actuelle du fichier, toutes les plages au-dessus de la valeur d'octet spécifiée sont effacées.

options: FileResizeOptions

Options de l’opération redimensionnement de fichier.

Retours

Promise<FileSetHTTPHeadersResponse>

Données de réponse pour l’opération 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 si aucune valeur n’est fournie pour les en-têtes HTTP de fichier dans les options, ces en-têtes HTTP de fichier sans valeur sont effacés.

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

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

Paramètres

fileHttpHeaders: FileHttpHeaders

options: FileSetHttpHeadersOptions

Options de l’opération Définir les en-têtes HTTP du jeu de fichiers.

Retours

Promise<FileSetHTTPHeadersResponse>

Données de réponse pour l’opération 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://docs.microsoft.com/en-us/rest/api/storageservices/set-file-metadata

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

Paramètres

metadata: Metadata

Si aucune métadonnées n’est fournie, toutes les métadonnées de répertoire existantes sont supprimées

options: FileSetMetadataOptions

Options de l’opération Définir les métadonnées de fichiers.

Retours

Promise<FileSetMetadataResponse>

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

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

Paramètres

properties: FileProperties

Propriétés de fichier. Pour les en-têtes HTTP de fichier (par exemple, Content-Type), si aucune valeur n’est fournie, les en-têtes HTTP existants sont supprimés. Pour d’autres propriétés de fichier (par exemple, fileAttributes), si aucune valeur n’est fournie, les valeurs existantes sont conservées.

Retours

Promise<SetPropertiesResponse>

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

copySource: string

Spécifie l’URL du fichier source ou de l’objet blob, d’une longueur maximale de 2 Ko. Pour copier un fichier dans un autre fichier dans le même compte de stockage, vous pouvez utiliser la clé partagée pour authentifier le fichier source. Si vous copiez un fichier à partir d’un autre compte de stockage ou si vous copiez un objet blob à partir du même compte de stockage ou d’un autre compte de stockage, vous devez authentifier le fichier source ou l’objet blob à l’aide d’une signature d’accès partagé. Si la source est un objet blob public, aucune authentification n’est requise pour effectuer l’opération de copie. Un fichier dans un instantané de partage peut également être spécifié en tant que source de copie.

options: FileStartCopyOptions

Options de l’opération De démarrage de fichier de copie.

Retours

Promise<FileStartCopyResponse>

Crée un fichier Azure ou remplace un fichier Azure existant, puis y charge un buffer(Node)/Blob/ArrayBuffer/ArrayBuffer/ArrayBufferView.

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

Paramètres

data: Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer(Node), Blob, ArrayBuffer ou ArrayBufferView

options: FileParallelUploadOptions

Retours

Promise<void>

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

Crée un fichier Azure ou remplace un fichier Azure existant, puis charge un fichier local dans celui-ci.

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

Paramètres

filePath: string

Chemin d’accès complet du fichier local

options: FileParallelUploadOptions

Retours

Promise<void>

Chargez une plage d’octets dans un fichier. Cette opération peut être appelée uniquement sur un fichier existant. Cela 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 4 Mo.

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

Paramètres

body: HttpRequestBody

Blob, string, ArrayBuffer, ArrayBufferView ou une fonction qui retourne un nouveau flux lisible dont le décalage provient du début de la source de données.

offset: number

Position de décalage du fichier Azure de destination à charger.

contentLength: number

Longueur du corps en octets. Utilisez Buffer.byteLength() pour calculer la longueur du corps d’une chaîne incluant des caractères non codés en Base64/Hexadécimal.

options: FileUploadRangeOptions

Options de l’opération Plage de téléchargement de fichiers.

Retours

Promise<FileUploadRangeResponse>

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

Exemple d’utilisation :

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

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 4 Mo.

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

Paramètres

sourceURL: string

Spécifiez une URL vers la source de copie, la signature d’accès partagé (SAS) peut être nécessaire pour l’authentification.

sourceOffset: number

Décalage source à partir duquel effectuer la copie. Passez 0 pour copier à partir du début du fichier source.

destOffset: number

Décalage du fichier de destination.

count: number

Nombre d’octets à charger à partir du fichier source.

options: FileUploadRangeFromURLOptions

Options permettant de configurer l’opération Fichier - Charger une plage à partir d’URL.

Retours

Promise<FileUploadRangeFromURLResponse>

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

Accepte une fabrique de flux Node.js lecture et se charge en blocs dans un fichier Azure. La fabrique de flux lisible doit retourner 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

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

Retourne un flux Node.js lisible à partir du décalage défini

size: number

Taille du fichier Azure

options: FileParallelUploadOptions

Retours

Promise<void>

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

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

size: number

options: FileParallelUploadOptions

Retours

Promise<void>

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

Crée un fichier Azure ou remplace un fichier Azure existant, puis y charge un flux Node.js accessible en lecture. Cette méthode tente de créer un fichier Azure, puis commence à charger segment par segment. La taille du bloc est définie par bufferSize le 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 de définir une même valeur avec le paramètre bufferSize, ce qui évitera les opérations Buffer.concat().

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

Paramètres

stream: Readable

Node.js flux lisible. Doit être inférieur ou égal à la taille du fichier.

size: number

Taille du fichier à créer. La taille maximale autorisée est de 4 To. Si cette valeur est supérieure à la taille du flux, la fin du fichier contient des octets vides.

bufferSize: number

Taille de chaque mémoire tampon allouée en octets, ainsi que la taille des blocs/plages pendant le fichier chargé. La taille doit être supérieure à 0 et inférieure ou égale à 4 * 1 024 * 1024 (4 Mo)

maxBuffers: number

Nombre maximal de mémoires tampons allouées pendant le chargement, corrélation positive avec concurrence de chargement maximale

options: FileUploadStreamOptions

Retours

Promise<void>

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 à l’objet ShareFileClient de base.

function withShareSnapshot(shareSnapshot: string): ShareFileClient

Paramètres

shareSnapshot: string

Horodatage de l’instantané de partage.

Retours

ShareFileClient

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

Partager via

ShareFileClient class

Constructeurs

Propriétés

Propriétés héritées

Méthodes

Détails du constructeur

ShareFileClient(string, Credential_2 | TokenCredential, ShareClientOptions)

Paramètres

ShareFileClient(string, Pipeline, ShareClientConfig)

Paramètres

Détails de la propriété

name

Valeur de propriété

path

Valeur de propriété

shareName

Valeur de propriété

Détails de la propriété héritée

accountName

Valeur de propriété

url

Valeur de propriété

Détails de la méthode

abortCopyFromURL(string, FileAbortCopyFromURLOptions)

Paramètres

Retours

clearRange(number, number, FileClearRangeOptions)

Paramètres

Retours

create(number, FileCreateOptions)

Paramètres

Retours

delete(FileDeleteOptions)

Paramètres

Retours

deleteIfExists(FileDeleteOptions)

Paramètres

Retours

download(number, number, FileDownloadOptions)

Paramètres

Retours

downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions)

Paramètres

Retours

downloadToBuffer(number, number, FileDownloadToBufferOptions)

Paramètres

Retours

downloadToFile(string, number, number, FileDownloadOptions)

Paramètres

Retours

exists(FileExistsOptions)

Paramètres

Retours

forceCloseAllHandles(FileForceCloseHandlesOptions)

Paramètres

Retours

forceCloseHandle(string, FileForceCloseHandlesOptions)

Paramètres

Retours

generateSasUrl(FileGenerateSasUrlOptions)

Paramètres

Retours

getProperties(FileGetPropertiesOptions)

Paramètres

Retours

getRangeList(FileGetRangeListOptions)

Paramètres

Retours

getRangeListDiff(string, FileGetRangeListOptions)

Paramètres

Retours

getShareLeaseClient(string)

Paramètres

Retours

listHandles(FileListHandlesOptions)

Paramètres

Retours

rename(string, FileRenameOptions)

Paramètres