ShareFileClient Třída

Definice

Umožňuje ShareFileClient manipulovat se soubory Azure Storage.

public class ShareFileClient
type ShareFileClient = class
Public Class ShareFileClient
Dědičnost
ShareFileClient

Konstruktory

ShareFileClient()

Inicializuje novou instanci ShareFileClient třídy pro napodobení.

ShareFileClient(String, String, String)

Inicializuje novou instanci ShareFileClient třídy.

ShareFileClient(String, String, String, ShareClientOptions)

Inicializuje novou instanci ShareFileClient třídy.

ShareFileClient(Uri, AzureSasCredential, ShareClientOptions)

Inicializuje novou instanci ShareFileClient třídy.

ShareFileClient(Uri, ShareClientOptions)

Inicializuje novou instanci ShareFileClient třídy.

ShareFileClient(Uri, StorageSharedKeyCredential, ShareClientOptions)

Inicializuje novou instanci ShareFileClient třídy.

ShareFileClient(Uri, TokenCredential, ShareClientOptions)

Inicializuje novou instanci ShareFileClient třídy.

Všimněte si, že ShareTokenIntent se aktuálně vyžaduje pro ověřování pomocí tokenů.

Vlastnosti

AccountName

Získá název účtu úložiště odpovídající klientovi souboru.

CanGenerateSasUri

Určuje, jestli klient může vygenerovat SAS. Pokud je klient ověřený pomocí StorageSharedKeyCredential.

Name

Získá název souboru.

Path

Získá cestu k souboru.

ShareName

Získá název sdílené složky odpovídající souboru klienta.

Uri

Získá primární Uri koncový bod adresáře.

Metody

AbortCopy(String, ShareFileRequestConditions, CancellationToken)

Pokusí se zrušit čekající kopii, která byla dříve spuštěna, a ponechá cílový soubor s nulovou délkou a úplnými metadaty.

Další informace najdete v tématu Přerušit kopírování souboru.

AbortCopyAsync(String, ShareFileRequestConditions, CancellationToken)

Pokusí se zrušit čekající kopii, která byla dříve spuštěna, a ponechá cílový soubor s nulovou délkou a úplnými metadaty.

Další informace najdete v tématu Přerušit kopírování souboru.

ClearRange(HttpRange, ShareFileRequestConditions, CancellationToken)

Operace ClearRange(HttpRange, ShareFileRequestConditions, CancellationToken) vymaže range soubor.

Další informace najdete v tématu Vložit rozsah.

ClearRangeAsync(HttpRange, ShareFileRequestConditions, CancellationToken)

Operace ClearRangeAsync(HttpRange, ShareFileRequestConditions, CancellationToken) vymaže range soubor.

Další informace najdete v tématu Vložit rozsah.

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

Vytvoří nový soubor nebo nahradí existující soubor.

Další informace najdete v tématu Vytvořit soubor.

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

Vytvoří nový soubor nebo nahradí existující soubor.

Další informace najdete v tématu Vytvořit soubor.

Delete(ShareFileRequestConditions, CancellationToken)

Operace Delete(ShareFileRequestConditions, CancellationToken) okamžitě odebere soubor z účtu úložiště.

Další informace najdete v tématu Odstranit soubor.

DeleteAsync(ShareFileRequestConditions, CancellationToken)

Operace DeleteAsync(ShareFileRequestConditions, CancellationToken) okamžitě odebere soubor z účtu úložiště.

Další informace najdete v tématu Odstranit soubor.

DeleteIfExists(ShareFileRequestConditions, CancellationToken)

Operace DeleteIfExists(ShareFileRequestConditions, CancellationToken) okamžitě odebere soubor z účtu úložiště, pokud existuje.

Další informace najdete v tématu Odstranit soubor.

DeleteIfExistsAsync(ShareFileRequestConditions, CancellationToken)

Operace DeleteIfExists(ShareFileRequestConditions, CancellationToken) okamžitě odebere soubor z účtu úložiště, pokud existuje.

Další informace najdete v tématu Odstranit soubor.

Download(ShareFileDownloadOptions, CancellationToken)

Operace Download(ShareFileDownloadOptions, CancellationToken) přečte nebo stáhne soubor ze systému, včetně jeho metadat a vlastností.

Další informace najdete v tématu Získat soubor.

DownloadAsync(ShareFileDownloadOptions, CancellationToken)

Operace DownloadAsync(ShareFileDownloadOptions, CancellationToken) přečte nebo stáhne soubor ze systému, včetně jeho metadat a vlastností.

Další informace najdete v tématu Získat soubor.

Exists(CancellationToken)

Operaci Exists(CancellationToken) je možné volat na objektu a ShareFileClient zjistit, jestli přidružený soubor existuje ve sdílené složce v účtu úložiště.

ExistsAsync(CancellationToken)

Operaci Exists(CancellationToken) je možné volat na objektu a ShareFileClient zjistit, jestli přidružený soubor existuje ve sdílené složce v účtu úložiště.

ForceCloseAllHandles(CancellationToken)

Operace ForceCloseAllHandles(CancellationToken) zavře všechny popisovače otevřené v souboru ve službě.

Toto rozhraní API je určeno k vynucení GetHandlesAsync(CancellationToken) popisovačů uzavření, které blokují operace. Klienti SMB můžou tyto popisovače prozradit nebo je ztratit. Rozhraní API má na straně klienta vliv na zavření popisovače, včetně chyb viditelných uživatelem kvůli neúspěšným pokusům o čtení nebo zápis souborů. Toto rozhraní API není určené k použití jako náhrada nebo alternativa pro uzavření protokolu SMB.

Další informace najdete v tématu Vynutit zavření úchytů.

ForceCloseAllHandlesAsync(CancellationToken)

Operace ForceCloseAllHandlesAsync(CancellationToken) zavře všechny popisovače otevřené v souboru ve službě.

Toto rozhraní API je určeno k vynucení GetHandlesAsync(CancellationToken) popisovačů uzavření, které blokují operace. Klienti SMB můžou tyto popisovače prozradit nebo je ztratit. Rozhraní API má na straně klienta vliv na zavření popisovače, včetně chyb viditelných uživatelem kvůli neúspěšným pokusům o čtení nebo zápis souborů. Toto rozhraní API není určené k použití jako náhrada nebo alternativa pro uzavření protokolu SMB.

Další informace najdete v tématu Vynutit zavření úchytů.

ForceCloseHandle(String, CancellationToken)

Operace ForceCloseHandle(String, CancellationToken) zavře popisovač otevřený v souboru ve službě. Podporuje zavření jednoho popisovače určeného nástrojem handleId.

Toto rozhraní API je určeno k vynucení GetHandlesAsync(CancellationToken) popisovačů uzavření, které blokují operace. Klienti SMB můžou tyto popisovače prozradit nebo je ztratit. Rozhraní API má na straně klienta vliv na zavření popisovače, včetně chyb viditelných uživatelem kvůli neúspěšným pokusům o čtení nebo zápis souborů. Toto rozhraní API není určené k použití jako náhrada nebo alternativa pro uzavření protokolu SMB.

Další informace najdete v tématu Vynutit zavření úchytů.

ForceCloseHandleAsync(String, CancellationToken)

Operace ForceCloseHandleAsync(String, CancellationToken) zavře popisovač otevřený v souboru ve službě. Podporuje zavření jednoho popisovače určeného nástrojem handleId.

Toto rozhraní API je určeno k vynucení GetHandlesAsync(CancellationToken) popisovačů uzavření, které blokují operace. Klienti SMB můžou tyto popisovače prozradit nebo je ztratit. Rozhraní API má na straně klienta vliv na zavření popisovače, včetně chyb viditelných uživatelem kvůli neúspěšným pokusům o čtení nebo zápis souborů. Toto rozhraní API není určené k použití jako náhrada nebo alternativa pro uzavření protokolu SMB.

Další informace najdete v tématu Vynutit zavření úchytů.

GenerateSasUri(ShareFileSasPermissions, DateTimeOffset)

Vrátí GenerateSasUri(ShareFileSasPermissions, DateTimeOffset) identifikátor Uri , který vygeneruje identifikátor URI sdíleného přístupového podpisu (SAS) sdílené souborové služby na základě předaných vlastností a parametrů klienta. Sas je podepsaný přihlašovacími údaji sdíleného klíče klienta.

Pokud chcete zkontrolovat, jestli je klient schopen podepsat sas služby, přečtěte si téma CanGenerateSasUri.

Další informace najdete v tématu Vytvoření sdíleného přístupového podpisu služby

GenerateSasUri(ShareSasBuilder)

Vrátí GenerateSasUri(ShareSasBuilder) identifikátor Uri , který vygeneruje identifikátor URI sdíleného přístupového podpisu (SAS) sdílené souborové služby na základě vlastností klienta a tvůrce. Sas je podepsaný přihlašovacími údaji sdíleného klíče klienta.

Pokud chcete zkontrolovat, jestli je klient schopen podepsat sas služby, přečtěte si téma CanGenerateSasUri.

Další informace najdete v tématu Vytvoření sdíleného přístupového podpisu služby

GetHandles(CancellationToken)

Operace GetHandles(CancellationToken) vrátí asynchronní sekvenci otevřených popisovačů v adresáři nebo souboru. Výčet popisovačů může při načítání všech hodnot provést více požadavků na službu.

Další informace najdete v tématu Popisovače seznamu.

GetHandlesAsync(CancellationToken)

Operace GetHandlesAsync(CancellationToken) vrátí asynchronní sekvenci otevřených popisovačů v adresáři nebo souboru. Výčet popisovačů může při načítání všech hodnot provést více požadavků na službu.

Další informace najdete v tématu Popisovače seznamu.

GetParentShareClientCore()

Vytvořte nový ShareClient odkazující na tento ShareFileClientnadřazený kontejner. Nový ShareClient používá stejný kanál zásad požadavků jako ShareFileClient.

GetParentShareDirectoryClientCore()

Vytvořte nový ShareDirectoryClient odkazující na tento ShareFileClientnadřazený kontejner. Nový ShareDirectoryClient používá stejný kanál zásad požadavků jako ShareFileClient.

GetProperties(ShareFileRequestConditions, CancellationToken)

Operace GetProperties(ShareFileRequestConditions, CancellationToken) vrátí všechna uživatelem definovaná metadata, standardní vlastnosti HTTP a systémové vlastnosti souboru. Nevrací obsah souboru.

Další informace najdete v tématu Načíst vlastnosti souboru.

GetPropertiesAsync(ShareFileRequestConditions, CancellationToken)

Operace GetPropertiesAsync(ShareFileRequestConditions, CancellationToken) vrátí všechna uživatelem definovaná metadata, standardní vlastnosti HTTP a systémové vlastnosti souboru. Nevrací obsah souboru.

Další informace najdete v tématu Načíst vlastnosti souboru.

GetRangeList(ShareFileGetRangeListOptions, CancellationToken)

Vrátí seznam platných oblastí pro soubor.

Další informace najdete v tématu Vypsat oblasti.

GetRangeListAsync(ShareFileGetRangeListOptions, CancellationToken)

Vrátí seznam platných oblastí pro soubor.

Další informace najdete v tématu Vypsat oblasti.

GetRangeListDiff(ShareFileGetRangeListDiffOptions, CancellationToken)

Vrátí seznam rozsahů, které se změnily v souboru od doby, kdy byla přijata funkce previousSnapshot.

Další informace najdete v tématu Vypsat oblasti.

GetRangeListDiffAsync(ShareFileGetRangeListDiffOptions, CancellationToken)

Vrátí seznam rozsahů, které se změnily v souboru od doby, kdy byla přijata funkce previousSnapshot.

Další informace najdete v tématu Vypsat oblasti.

OpenRead(ShareFileOpenReadOptions, CancellationToken)

Otevře datový proud pro čtení ze souboru. Datový proud stáhne soubor jenom tak, jak se datový proud načítá.

OpenReadAsync(ShareFileOpenReadOptions, CancellationToken)

Otevře datový proud pro čtení ze souboru. Datový proud stáhne soubor jenom tak, jak se datový proud načítá.

OpenWrite(Boolean, Int64, ShareFileOpenWriteOptions, CancellationToken)

Otevře datový proud pro zápis do souboru.

OpenWriteAsync(Boolean, Int64, ShareFileOpenWriteOptions, CancellationToken)

Otevře datový proud pro zápis do souboru.

Rename(String, ShareFileRenameOptions, CancellationToken)

Přejmenuje soubor. Toto rozhraní API nepodporuje přejmenování souboru z jedné sdílené složky do jiné nebo mezi účty úložiště.

RenameAsync(String, ShareFileRenameOptions, CancellationToken)

Přejmenuje soubor. Toto rozhraní API nepodporuje přejmenování souboru z jedné sdílené složky do jiné nebo mezi účty úložiště.

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

Operace SetHttpHeaders(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken) nastaví systémové vlastnosti souboru.

Další informace najdete v tématu Nastavte vlastnosti souboru.

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

Operace SetHttpHeadersAsync(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken) nastaví systémové vlastnosti souboru.

Další informace najdete v tématu Nastavte vlastnosti souboru.

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

Operace SetMetadata(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken) nastaví uživatelem definovaná metadata pro zadaný soubor jako jeden nebo více dvojic název-hodnota.

Další informace najdete v tématu Nastavte metadata souboru.

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

Operace SetMetadataAsync(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken) nastaví uživatelem definovaná metadata pro zadaný soubor jako jeden nebo více dvojic název-hodnota.

Další informace najdete v tématu Nastavte metadata souboru.

StartCopy(Uri, ShareFileCopyOptions, CancellationToken)

Zkopíruje objekt blob nebo soubor do cílového souboru v rámci účtu úložiště.

Další informace najdete v tématu Kopírovat soubor.

StartCopyAsync(Uri, ShareFileCopyOptions, CancellationToken)

Zkopíruje objekt blob nebo soubor do cílového souboru v rámci účtu úložiště.

Další informace najdete v tématu Kopírovat soubor.

Upload(Stream, ShareFileUploadOptions, CancellationToken)

Operace Upload(Stream, ShareFileUploadOptions, CancellationToken) zapíše options.Stream.Stream do souboru.

Další informace najdete v tématu Vložit rozsah.

UploadAsync(Stream, ShareFileUploadOptions, CancellationToken)

Operace UploadAsync(Stream, ShareFileUploadOptions, CancellationToken) zapíše options.Stream.Stream do souboru.

Další informace najdete v tématu Vložit rozsah.

UploadRange(HttpRange, Stream, ShareFileUploadRangeOptions, CancellationToken)

Operace 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) zapíše content do range souboru.

Další informace najdete v tématu Vložit rozsah.

UploadRangeAsync(HttpRange, Stream, ShareFileUploadRangeOptions, CancellationToken)

Operace 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) zapíše content do range souboru.

Další informace najdete v tématu Vložit rozsah.

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

Operace UploadRangeFromUri(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken) zapíše rozsah ze souboru Azure do jiného souboru Azure. Toto rozhraní API se podporuje jenom pro verzi 2019-02-02 a vyšší.

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

Operace Azure.Storage.Files.Shares.ShareFileClient.UploadRangeFromUriAsync(System.Uri,Azure.HttpRange,Azure.HttpRange,Azure.Storage.Files.Shares.Models.ShareFileRequestConditions,System.Threading.CancellationToken) zapíše rozsah ze souboru Azure do jiného souboru Azure. Toto rozhraní API se podporuje jenom pro verzi 2019-02-02 a vyšší.

WithSnapshot(String)

Inicializuje novou instanci ShareFileClient třídy se identickým Uri zdrojem, ale zadaným shareSnapshot časovým razítkem.

Další informace najdete v tématu Sdílená složka snímků.

Metody rozšíření

GetShareLeaseClient(ShareFileClient, String)

Inicializuje novou instanci ShareLeaseClient třídy.

GetParentShareClient(ShareFileClient)

Vytvořte nový ShareClient odkazující na tento ShareFileClientnadřazený kontejner. Nový ShareClient používá stejný kanál zásad požadavků jako ShareFileClient.

GetParentShareDirectoryClient(ShareFileClient)

Vytvořte nový ShareDirectoryClient odkazující na tento ShareFileClientnadřazený kontejner. Nový ShareDirectoryClient používá stejný kanál zásad požadavků jako ShareFileClient.

Platí pro