ShareFileClient Classe

Définition

vous ShareFileClient permet de manipuler des fichiers de stockage Azure.

public class ShareFileClient
type ShareFileClient = class
Public Class ShareFileClient
Héritage
ShareFileClient

Constructeurs

ShareFileClient()

Initialise une nouvelle instance de la classe pour la ShareFileClient simulation.

ShareFileClient(String, String, String)

Initialise une nouvelle instance de la classe ShareFileClient.

ShareFileClient(String, String, String, ShareClientOptions)

Initialise une nouvelle instance de la classe ShareFileClient.

ShareFileClient(Uri, AzureSasCredential, ShareClientOptions)

Initialise une nouvelle instance de la classe ShareFileClient.

ShareFileClient(Uri, ShareClientOptions)

Initialise une nouvelle instance de la classe ShareFileClient.

ShareFileClient(Uri, StorageSharedKeyCredential, ShareClientOptions)

Initialise une nouvelle instance de la classe ShareFileClient.

ShareFileClient(Uri, TokenCredential, ShareClientOptions)

Initialise une nouvelle instance de la classe ShareFileClient.

Notez que ShareTokenIntent est actuellement requis pour l’authentification par jeton.

Propriétés

AccountName

Obtient le nom du compte de stockage correspondant au client de fichiers.

CanGenerateSasUri

Détermine si le client est en mesure de générer une SAP. Si le client est authentifié avec un StorageSharedKeyCredential.

Name

Obtient le nom du fichier.

Path

Obtient le chemin du fichier.

ShareName

Obtient le nom de partage correspondant au client de fichier.

Uri

Obtient le point de terminaison principal Uri du répertoire.

Méthodes

AbortCopy(String, ShareFileRequestConditions, CancellationToken)

Tente d’annuler une copie en attente qui a été précédemment démarrée et laisse un fichier de destination avec aucune longueur et des métadonnées complètes.

Pour plus d'informations, consultez la rubrique Abandonner le fichier de copie.

AbortCopyAsync(String, ShareFileRequestConditions, CancellationToken)

Tente d’annuler une copie en attente qui a été précédemment démarrée et laisse un fichier de destination avec aucune longueur et des métadonnées complètes.

Pour plus d'informations, consultez la rubrique Abandonner le fichier de copie.

ClearRange(HttpRange, ShareFileRequestConditions, CancellationToken)

L’opération ClearRange(HttpRange, ShareFileRequestConditions, CancellationToken) efface le range d’un fichier.

Pour plus d'informations, consultez la rubrique Put Range.

ClearRangeAsync(HttpRange, ShareFileRequestConditions, CancellationToken)

L’opération ClearRangeAsync(HttpRange, ShareFileRequestConditions, CancellationToken) efface le range d’un fichier.

Pour plus d'informations, consultez la rubrique Put Range.

Create(Int64, ShareFileHttpHeaders, IDictionary<String,String>, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)

Crée un fichier ou remplace un fichier existant.

Pour plus d'informations, consultez la rubrique Créez un fichier.

CreateAsync(Int64, ShareFileHttpHeaders, IDictionary<String,String>, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)

Crée un fichier ou remplace un fichier existant.

Pour plus d'informations, consultez la rubrique Créez un fichier.

Delete(ShareFileRequestConditions, CancellationToken)

L'opération Delete(ShareFileRequestConditions, CancellationToken) supprime immédiatement le fichier du compte de stockage.

Pour plus d'informations, consultez la rubrique Supprimer le fichier.

DeleteAsync(ShareFileRequestConditions, CancellationToken)

L'opération DeleteAsync(ShareFileRequestConditions, CancellationToken) supprime immédiatement le fichier du compte de stockage.

Pour plus d'informations, consultez la rubrique Supprimer le fichier.

DeleteIfExists(ShareFileRequestConditions, CancellationToken)

L’opération DeleteIfExists(ShareFileRequestConditions, CancellationToken) supprime immédiatement le fichier du compte de stockage, s’il existe.

Pour plus d'informations, consultez la rubrique Supprimer le fichier.

DeleteIfExistsAsync(ShareFileRequestConditions, CancellationToken)

L’opération DeleteIfExists(ShareFileRequestConditions, CancellationToken) supprime immédiatement le fichier du compte de stockage, s’il existe.

Pour plus d'informations, consultez la rubrique Supprimer le fichier.

Download(ShareFileDownloadOptions, CancellationToken)

L'opération Download(ShareFileDownloadOptions, CancellationToken) lit ou télécharge un fichier à partir du système, avec ses métadonnées et propriétés.

Pour plus d'informations, consultez la rubrique Obtenir le fichier.

DownloadAsync(ShareFileDownloadOptions, CancellationToken)

L'opération DownloadAsync(ShareFileDownloadOptions, CancellationToken) lit ou télécharge un fichier à partir du système, avec ses métadonnées et propriétés.

Pour plus d'informations, consultez la rubrique Obtenir le fichier.

Exists(CancellationToken)

L’opération Exists(CancellationToken) peut être appelée sur un ShareFileClient pour voir si le fichier associé existe dans le partage sur le compte de stockage.

ExistsAsync(CancellationToken)

L’opération Exists(CancellationToken) peut être appelée sur un ShareFileClient pour voir si le fichier associé existe dans le partage sur le compte de stockage.

ForceCloseAllHandles(CancellationToken)

L’opération ForceCloseAllHandles(CancellationToken) ferme tous les handles ouverts sur un fichier au niveau du service.

Cette API est destinée à être utilisée en même temps GetHandlesAsync(CancellationToken) que pour forcer la fermeture des handles qui bloquent les opérations. Ces descripteurs ont peut-être fuyé ou ont été perdus de trace par les clients SMB. L’API a un impact côté client sur la fermeture du handle, y compris les erreurs visibles par l’utilisateur en raison d’échecs de tentatives de lecture ou d’écriture de fichiers. Cette API n’est pas destinée à être utilisée comme remplacement ou alternative à la fermeture SMB.

Pour plus d'informations, consultez la rubrique Forcer la fermeture des poignées.

ForceCloseAllHandlesAsync(CancellationToken)

L’opération ForceCloseAllHandlesAsync(CancellationToken) ferme tous les handles ouverts sur un fichier au niveau du service.

Cette API est destinée à être utilisée en même temps GetHandlesAsync(CancellationToken) que pour forcer la fermeture des handles qui bloquent les opérations. Ces descripteurs ont peut-être fuyé ou ont été perdus de trace par les clients SMB. L’API a un impact côté client sur la fermeture du handle, y compris les erreurs visibles par l’utilisateur en raison d’échecs de tentatives de lecture ou d’écriture de fichiers. Cette API n’est pas destinée à être utilisée comme remplacement ou alternative à la fermeture SMB.

Pour plus d'informations, consultez la rubrique Forcer la fermeture des poignées.

ForceCloseHandle(String, CancellationToken)

L’opération ForceCloseHandle(String, CancellationToken) ferme un handle ouvert sur un fichier au niveau du service. Il prend en charge la fermeture d’un handle unique spécifié par handleId.

Cette API est destinée à être utilisée en même temps GetHandlesAsync(CancellationToken) que pour forcer la fermeture des handles qui bloquent les opérations. Ces descripteurs ont peut-être fuyé ou ont été perdus de trace par les clients SMB. L’API a un impact côté client sur la fermeture du handle, y compris les erreurs visibles par l’utilisateur en raison d’échecs de tentatives de lecture ou d’écriture de fichiers. Cette API n’est pas destinée à être utilisée comme remplacement ou alternative à la fermeture SMB.

Pour plus d'informations, consultez la rubrique Forcer la fermeture des poignées.

ForceCloseHandleAsync(String, CancellationToken)

L’opération ForceCloseHandleAsync(String, CancellationToken) ferme un handle ouvert sur un fichier au niveau du service. Il prend en charge la fermeture d’un handle unique spécifié par handleId.

Cette API est destinée à être utilisée en même temps GetHandlesAsync(CancellationToken) que pour forcer la fermeture des handles qui bloquent les opérations. Ces descripteurs ont peut-être fuyé ou ont été perdus de trace par les clients SMB. L’API a un impact côté client sur la fermeture du handle, y compris les erreurs visibles par l’utilisateur en raison d’échecs de tentatives de lecture ou d’écriture de fichiers. Cette API n’est pas destinée à être utilisée comme remplacement ou alternative à la fermeture SMB.

Pour plus d'informations, consultez la rubrique Forcer la fermeture des poignées.

GenerateSasUri(ShareFileSasPermissions, DateTimeOffset)

Retourne GenerateSasUri(ShareFileSasPermissions, DateTimeOffset) un Uri qui génère un URI de signature d’accès partagé (SAS) du service de fichiers de partage en fonction des propriétés et paramètres du client passés. La signature d’accès partagé est signée par les informations d’identification de clé partagée du client.

Pour case activée si le client est en mesure de signer un sap de service, consultez CanGenerateSasUri.

Pour plus d'informations, consultez la rubrique Construction d’une SAP de service.

GenerateSasUri(ShareSasBuilder)

Retourne GenerateSasUri(ShareSasBuilder) un Uri qui génère un URI de signature d’accès partagé (SAS) du service de fichiers de partage en fonction des propriétés du client et du générateur et . La signature d’accès partagé est signée par les informations d’identification de clé partagée du client.

Pour case activée si le client est en mesure de signer un sap de service, consultez CanGenerateSasUri.

Pour plus d'informations, consultez la rubrique Construction d’une SAP de service.

GetCopyAuthorizationHeaderAsync(ShareFileClient, CancellationToken)

Obtenez un pour passer l’autorisation lors de HttpAuthorization l’exécution d’une ShareFileClientcopie de service à service où OAuth est nécessaire pour authentifier la source.

GetHandles(CancellationToken)

L’opération GetHandles(CancellationToken) retourne une séquence asynchrone des handles ouverts sur un répertoire ou un fichier. L’énumération des handles peut effectuer plusieurs requêtes au service lors de l’extraction de toutes les valeurs.

Pour plus d'informations, consultez la rubrique Descripteurs de liste.

GetHandlesAsync(CancellationToken)

L’opération GetHandlesAsync(CancellationToken) retourne une séquence asynchrone des handles ouverts sur un répertoire ou un fichier. L’énumération des handles peut effectuer plusieurs requêtes au service lors de l’extraction de toutes les valeurs.

Pour plus d'informations, consultez la rubrique Descripteurs de liste.

GetParentShareClientCore()

Créez un ShareClient qui pointe vers ce ShareFileClientconteneur parent. Le nouveau ShareClient utilise le même pipeline de stratégie de requête que le ShareFileClient.

GetParentShareDirectoryClientCore()

Créez un ShareDirectoryClient qui pointe vers ce ShareFileClientconteneur parent. Le nouveau ShareDirectoryClient utilise le même pipeline de stratégie de requête que le ShareFileClient.

GetProperties(ShareFileRequestConditions, CancellationToken)

L'opération GetProperties(ShareFileRequestConditions, CancellationToken) renvoie toutes les métadonnées définies par l'utilisateur, les propriétés HTTP standard et les propriétés système pour le fichier. Elle ne retourne pas le contenu du fichier.

Pour plus d'informations, consultez la rubrique Obtenir les propriétés du fichier.

GetPropertiesAsync(ShareFileRequestConditions, CancellationToken)

L'opération GetPropertiesAsync(ShareFileRequestConditions, CancellationToken) renvoie toutes les métadonnées définies par l'utilisateur, les propriétés HTTP standard et les propriétés système pour le fichier. Elle ne retourne pas le contenu du fichier.

Pour plus d'informations, consultez la rubrique Obtenir les propriétés du fichier.

GetRangeList(ShareFileGetRangeListOptions, CancellationToken)

Retourne la liste des plages valides pour un fichier.

Pour plus d'informations, consultez la rubrique Répertorier les plages.

GetRangeListAsync(ShareFileGetRangeListOptions, CancellationToken)

Retourne la liste des plages valides pour un fichier.

Pour plus d'informations, consultez la rubrique Répertorier les plages.

GetRangeListDiff(ShareFileGetRangeListDiffOptions, CancellationToken)

Retourne la liste des plages qui ont été modifiées dans le fichier depuis l’utilisation de previousSnapshot.

Pour plus d'informations, consultez la rubrique Répertorier les plages.

GetRangeListDiffAsync(ShareFileGetRangeListDiffOptions, CancellationToken)

Retourne la liste des plages qui ont été modifiées dans le fichier depuis l’utilisation de previousSnapshot.

Pour plus d'informations, consultez la rubrique Répertorier les plages.

OpenRead(ShareFileOpenReadOptions, CancellationToken)

Ouvre un flux de données pour lire à partir du fichier. Le flux télécharge uniquement le fichier à mesure que le flux est lu.

OpenReadAsync(ShareFileOpenReadOptions, CancellationToken)

Ouvre un flux de données pour lire à partir du fichier. Le flux télécharge uniquement le fichier à mesure que le flux est lu.

OpenWrite(Boolean, Int64, ShareFileOpenWriteOptions, CancellationToken)

Ouvre un flux de données pour écrire dans le fichier.

OpenWriteAsync(Boolean, Int64, ShareFileOpenWriteOptions, CancellationToken)

Ouvre un flux de données pour écrire dans le fichier.

Rename(String, ShareFileRenameOptions, CancellationToken)

Renomme un fichier. Cette API ne prend pas en charge le renommage d’un fichier d’un partage à un autre ou entre des comptes de stockage.

RenameAsync(String, ShareFileRenameOptions, CancellationToken)

Renomme un fichier. Cette API ne prend pas en charge le renommage d’un fichier d’un partage à un autre ou entre des comptes de stockage.

SetHttpHeaders(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)

L'opération SetHttpHeaders(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken) définit des propriétés système sur le fichier.

Pour plus d'informations, consultez la rubrique Définissez les propriétés du fichier.

SetHttpHeadersAsync(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)

L'opération SetHttpHeadersAsync(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken) définit des propriétés système sur le fichier.

Pour plus d'informations, consultez la rubrique Définissez les propriétés du fichier.

SetMetadata(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken)

L’opération SetMetadata(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken) définit les métadonnées définies par l’utilisateur pour le fichier spécifié sous la forme d’une ou plusieurs paires nom-valeur.

Pour plus d'informations, consultez la rubrique Définissez les métadonnées de fichier.

SetMetadataAsync(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken)

L’opération SetMetadataAsync(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken) définit les métadonnées définies par l’utilisateur pour le fichier spécifié sous la forme d’une ou plusieurs paires nom-valeur.

Pour plus d'informations, consultez la rubrique Définissez les métadonnées de fichier.

StartCopy(Uri, ShareFileCopyOptions, CancellationToken)

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

Pour plus d'informations, consultez la rubrique Copier le fichier.

StartCopyAsync(Uri, ShareFileCopyOptions, CancellationToken)

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

Pour plus d'informations, consultez la rubrique Copier le fichier.

Upload(Stream, ShareFileUploadOptions, CancellationToken)

L’opération Upload(Stream, ShareFileUploadOptions, CancellationToken) écrit options.Stream.Stream dans un fichier.

Pour plus d'informations, consultez la rubrique Put Range.

UploadAsync(Stream, ShareFileUploadOptions, CancellationToken)

L’opération UploadAsync(Stream, ShareFileUploadOptions, CancellationToken) écrit options.Stream.Stream dans un fichier.

Pour plus d'informations, consultez la rubrique Put Range.

UploadRange(HttpRange, Stream, ShareFileUploadRangeOptions, CancellationToken)

L’opération Azure.Storage.Files.Shares.ShareFileClient.UploadRange(Azure.HttpRange,System.IO.Stream,System.Byte[],System.IProgress{System.Int64},Azure.Storage.Files.Shares.Models.ShareFileRequestConditions,System.Threading.CancellationToken) écrit content dans un range d’un fichier.

Pour plus d'informations, consultez la rubrique Put Range.

UploadRangeAsync(HttpRange, Stream, ShareFileUploadRangeOptions, CancellationToken)

L’opération Azure.Storage.Files.Shares.ShareFileClient.UploadRangeAsync(Azure.HttpRange,System.IO.Stream,System.Byte[],System.IProgress{System.Int64},Azure.Storage.Files.Shares.Models.ShareFileRequestConditions,System.Threading.CancellationToken) écrit content dans un range d’un fichier.

Pour plus d'informations, consultez la rubrique Put Range.

UploadRangeFromUri(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken)

L’opération UploadRangeFromUri(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken) écrit une plage d’un fichier Azure dans un autre fichier Azure. Cette API est prise en charge uniquement pour la version 2019-02-02 et ultérieure.

UploadRangeFromUriAsync(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken)

L’opération Azure.Storage.Files.Shares.ShareFileClient.UploadRangeFromUriAsync(System.Uri,Azure.HttpRange,Azure.HttpRange,Azure.Storage.Files.Shares.Models.ShareFileRequestConditions,System.Threading.CancellationToken) écrit une plage d’un fichier Azure dans un autre fichier Azure. Cette API est prise en charge uniquement pour la version 2019-02-02 et ultérieure.

WithSnapshot(String)

Initialise une nouvelle instance de la ShareFileClient classe avec une source identiqueUri, mais l’horodatage spécifiéshareSnapshot.

Pour plus d'informations, consultez la rubrique Partage d’instantanés.

Méthodes d’extension

GetShareLeaseClient(ShareFileClient, String)

Initialise une nouvelle instance de la classe ShareLeaseClient.

GetParentShareClient(ShareFileClient)

Créez un ShareClient qui pointe vers ce ShareFileClientconteneur parent. Le nouveau ShareClient utilise le même pipeline de stratégie de requête que le ShareFileClient.

GetParentShareDirectoryClient(ShareFileClient)

Créez un ShareDirectoryClient qui pointe vers ce ShareFileClientconteneur parent. Le nouveau ShareDirectoryClient utilise le même pipeline de stratégie de requête que le ShareFileClient.

S’applique à