ShareFileClient Klasa

Definicja

Umożliwia ShareFileClient manipulowanie plikami usługi Azure Storage.

public class ShareFileClient
type ShareFileClient = class
Public Class ShareFileClient
Dziedziczenie
ShareFileClient

Konstruktory

ShareFileClient()

Inicjuje ShareFileClient nowe wystąpienie klasy do szyderstwa.

ShareFileClient(String, String, String)

Inicjuje nowe wystąpienie klasy ShareFileClient.

ShareFileClient(String, String, String, ShareClientOptions)

Inicjuje nowe wystąpienie klasy ShareFileClient.

ShareFileClient(Uri, AzureSasCredential, ShareClientOptions)

Inicjuje nowe wystąpienie klasy ShareFileClient.

ShareFileClient(Uri, ShareClientOptions)

Inicjuje nowe wystąpienie klasy ShareFileClient.

ShareFileClient(Uri, StorageSharedKeyCredential, ShareClientOptions)

Inicjuje nowe wystąpienie klasy ShareFileClient.

ShareFileClient(Uri, TokenCredential, ShareClientOptions)

Inicjuje nowe wystąpienie klasy ShareFileClient.

Należy pamiętać, że ShareTokenIntent jest to obecnie wymagane do uwierzytelniania tokenu.

Właściwości

AccountName

Pobiera nazwę konta magazynu odpowiadającą klientowi plików.

CanGenerateSasUri

Określa, czy klient może wygenerować sygnaturę dostępu współdzielonego. Jeśli klient jest uwierzytelniany przy użyciu polecenia StorageSharedKeyCredential.

Name

Pobiera nazwę pliku.

Path

Pobiera ścieżkę pliku.

ShareName

Pobiera nazwę udziału odpowiadającą klientowi plików.

Uri

Pobiera podstawowy Uri punkt końcowy katalogu.

Metody

AbortCopy(String, ShareFileRequestConditions, CancellationToken)

Próbuje anulować oczekującą kopię, która została wcześniej uruchomiona i pozostawia plik docelowy o zerowej długości i pełnych metadanych.

Aby uzyskać więcej informacji, zobacz Przerwanie kopiowania pliku.

AbortCopyAsync(String, ShareFileRequestConditions, CancellationToken)

Próbuje anulować oczekującą kopię, która została wcześniej uruchomiona i pozostawia plik docelowy o zerowej długości i pełnych metadanych.

Aby uzyskać więcej informacji, zobacz Przerwanie kopiowania pliku.

ClearRange(HttpRange, ShareFileRequestConditions, CancellationToken)

Operacja ClearRange(HttpRange, ShareFileRequestConditions, CancellationToken) czyści range plik.

Aby uzyskać więcej informacji, zobacz Umieść zakres.

ClearRangeAsync(HttpRange, ShareFileRequestConditions, CancellationToken)

Operacja ClearRangeAsync(HttpRange, ShareFileRequestConditions, CancellationToken) czyści range plik.

Aby uzyskać więcej informacji, zobacz Umieść zakres.

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

Tworzy nowy plik lub zastępuje istniejący plik.

Aby uzyskać więcej informacji, zobacz Utwórz plik.

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

Tworzy nowy plik lub zastępuje istniejący plik.

Aby uzyskać więcej informacji, zobacz Utwórz plik.

Delete(ShareFileRequestConditions, CancellationToken)

Operacja Delete(ShareFileRequestConditions, CancellationToken) natychmiast usuwa plik z konta magazynu.

Aby uzyskać więcej informacji, zobacz Usuń plik.

DeleteAsync(ShareFileRequestConditions, CancellationToken)

Operacja DeleteAsync(ShareFileRequestConditions, CancellationToken) natychmiast usuwa plik z konta magazynu.

Aby uzyskać więcej informacji, zobacz Usuń plik.

DeleteIfExists(ShareFileRequestConditions, CancellationToken)

Operacja DeleteIfExists(ShareFileRequestConditions, CancellationToken) natychmiast usuwa plik z konta magazynu, jeśli istnieje.

Aby uzyskać więcej informacji, zobacz Usuń plik.

DeleteIfExistsAsync(ShareFileRequestConditions, CancellationToken)

Operacja DeleteIfExists(ShareFileRequestConditions, CancellationToken) natychmiast usuwa plik z konta magazynu, jeśli istnieje.

Aby uzyskać więcej informacji, zobacz Usuń plik.

Download(ShareFileDownloadOptions, CancellationToken)

Operacja Download(ShareFileDownloadOptions, CancellationToken) odczytuje lub pobiera plik z systemu, w tym jego metadane i właściwości.

Aby uzyskać więcej informacji, zobacz Pobierz plik.

DownloadAsync(ShareFileDownloadOptions, CancellationToken)

Operacja DownloadAsync(ShareFileDownloadOptions, CancellationToken) odczytuje lub pobiera plik z systemu, w tym jego metadane i właściwości.

Aby uzyskać więcej informacji, zobacz Pobierz plik.

Exists(CancellationToken)

Operację Exists(CancellationToken) można wywołać na obiekcie , ShareFileClient aby sprawdzić, czy skojarzony plik istnieje w udziale na koncie magazynu.

ExistsAsync(CancellationToken)

Operację Exists(CancellationToken) można wywołać na obiekcie , ShareFileClient aby sprawdzić, czy skojarzony plik istnieje w udziale na koncie magazynu.

ForceCloseAllHandles(CancellationToken)

Operacja ForceCloseAllHandles(CancellationToken) zamyka wszystkie uchwyty otwarte w pliku w usłudze.

Ten interfejs API ma być używany wraz z GetHandlesAsync(CancellationToken) wymusić zamknięcie uchwytów, które blokują operacje. Te uchwyty mogły wyciekć lub zostały utracone przez klientów SMB. Interfejs API ma wpływ po stronie klienta na zamknięcie uchwytu, w tym błędy widoczne dla użytkownika z powodu nieudanych prób odczytu lub zapisu plików. Ten interfejs API nie jest przeznaczony do użycia jako zamiennik lub alternatywa dla zamknięcia protokołu SMB.

Aby uzyskać więcej informacji, zobacz Wymuś zamknięcie uchwytów.

ForceCloseAllHandlesAsync(CancellationToken)

Operacja ForceCloseAllHandlesAsync(CancellationToken) zamyka wszystkie uchwyty otwarte w pliku w usłudze.

Ten interfejs API ma być używany wraz z GetHandlesAsync(CancellationToken) wymusić zamknięcie uchwytów, które blokują operacje. Te uchwyty mogły wyciekć lub zostały utracone przez klientów SMB. Interfejs API ma wpływ po stronie klienta na zamknięcie uchwytu, w tym błędy widoczne dla użytkownika z powodu nieudanych prób odczytu lub zapisu plików. Ten interfejs API nie jest przeznaczony do użycia jako zamiennik lub alternatywa dla zamknięcia protokołu SMB.

Aby uzyskać więcej informacji, zobacz Wymuś zamknięcie uchwytów.

ForceCloseHandle(String, CancellationToken)

Operacja ForceCloseHandle(String, CancellationToken) zamyka uchwyt otwarty w pliku w usłudze. Obsługuje zamykanie pojedynczego uchwytu określonego przez handleId.

Ten interfejs API ma być używany wraz z GetHandlesAsync(CancellationToken) wymusić zamknięcie uchwytów, które blokują operacje. Te uchwyty mogły wyciekć lub zostały utracone przez klientów SMB. Interfejs API ma wpływ po stronie klienta na zamknięcie uchwytu, w tym błędy widoczne dla użytkownika z powodu nieudanych prób odczytu lub zapisu plików. Ten interfejs API nie jest przeznaczony do użycia jako zamiennik lub alternatywa dla zamknięcia protokołu SMB.

Aby uzyskać więcej informacji, zobacz Wymuś zamknięcie uchwytów.

ForceCloseHandleAsync(String, CancellationToken)

Operacja ForceCloseHandleAsync(String, CancellationToken) zamyka uchwyt otwarty w pliku w usłudze. Obsługuje zamykanie pojedynczego uchwytu określonego przez handleId.

Ten interfejs API ma być używany wraz z GetHandlesAsync(CancellationToken) wymusić zamknięcie uchwytów, które blokują operacje. Te uchwyty mogły wyciekć lub zostały utracone przez klientów SMB. Interfejs API ma wpływ po stronie klienta na zamknięcie uchwytu, w tym błędy widoczne dla użytkownika z powodu nieudanych prób odczytu lub zapisu plików. Ten interfejs API nie jest przeznaczony do użycia jako zamiennik lub alternatywa dla zamknięcia protokołu SMB.

Aby uzyskać więcej informacji, zobacz Wymuś zamknięcie uchwytów.

GenerateSasUri(ShareFileSasPermissions, DateTimeOffset)

Zwraca GenerateSasUri(ShareFileSasPermissions, DateTimeOffset) wartość Uri , która generuje identyfikator URI sygnatury dostępu współdzielonego usługi plików udziału na podstawie przekazanych właściwości i parametrów klienta. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza współdzielonego klienta.

Aby sprawdzić, czy klient może podpisać sygnaturę dostępu współdzielonego usługi, zobacz CanGenerateSasUri.

Aby uzyskać więcej informacji, zobacz Konstruowanie sygnatury dostępu współdzielonego usługi.

GenerateSasUri(ShareSasBuilder)

Zwraca wartość GenerateSasUri(ShareSasBuilder)Uri , która generuje identyfikator URI sygnatury dostępu współdzielonego usługi plików udziałów (SAS) na podstawie właściwości klienta i konstruktora. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza współdzielonego klienta.

Aby sprawdzić, czy klient może podpisać sygnaturę dostępu współdzielonego usługi, zobacz CanGenerateSasUri.

Aby uzyskać więcej informacji, zobacz Konstruowanie sygnatury dostępu współdzielonego usługi.

GetHandles(CancellationToken)

Operacja GetHandles(CancellationToken) zwraca asynchronizową sekwencję otwartych dojść w katalogu lub pliku. Wyliczanie dojść może wysyłać wiele żądań do usługi podczas pobierania wszystkich wartości.

Aby uzyskać więcej informacji, zobacz Listy dojść.

GetHandlesAsync(CancellationToken)

Operacja GetHandlesAsync(CancellationToken) zwraca asynchronizową sekwencję otwartych dojść w katalogu lub pliku. Wyliczanie dojść może wysyłać wiele żądań do usługi podczas pobierania wszystkich wartości.

Aby uzyskać więcej informacji, zobacz Listy dojść.

GetParentShareClientCore()

Utwórz nową ShareClient , która wskazuje ten ShareFileClientkontener nadrzędny. ShareClient Nowy używa tego samego potoku zasad żądania co ShareFileClient.

GetParentShareDirectoryClientCore()

Utwórz nową ShareDirectoryClient , która wskazuje ten ShareFileClientkontener nadrzędny. ShareDirectoryClient Nowy używa tego samego potoku zasad żądania co ShareFileClient.

GetProperties(ShareFileRequestConditions, CancellationToken)

Operacja GetProperties(ShareFileRequestConditions, CancellationToken) zwraca wszystkie metadane zdefiniowane przez użytkownika, standardowe właściwości HTTP i właściwości systemu dla pliku. Nie zwraca zawartości pliku.

Aby uzyskać więcej informacji, zobacz Pobierz właściwości pliku.

GetPropertiesAsync(ShareFileRequestConditions, CancellationToken)

Operacja GetPropertiesAsync(ShareFileRequestConditions, CancellationToken) zwraca wszystkie metadane zdefiniowane przez użytkownika, standardowe właściwości HTTP i właściwości systemu dla pliku. Nie zwraca zawartości pliku.

Aby uzyskać więcej informacji, zobacz Pobierz właściwości pliku.

GetRangeList(ShareFileGetRangeListOptions, CancellationToken)

Zwraca listę prawidłowych zakresów dla pliku.

Aby uzyskać więcej informacji, zobacz Zakresy listy.

GetRangeListAsync(ShareFileGetRangeListOptions, CancellationToken)

Zwraca listę prawidłowych zakresów dla pliku.

Aby uzyskać więcej informacji, zobacz Zakresy listy.

GetRangeListDiff(ShareFileGetRangeListDiffOptions, CancellationToken)

Zwraca listę zakresów, które uległy zmianie w pliku od czasu wykonania poprzedniego poleceniaSnapshot.

Aby uzyskać więcej informacji, zobacz Zakresy listy.

GetRangeListDiffAsync(ShareFileGetRangeListDiffOptions, CancellationToken)

Zwraca listę zakresów, które uległy zmianie w pliku od czasu wykonania poprzedniego poleceniaSnapshot.

Aby uzyskać więcej informacji, zobacz Zakresy listy.

OpenRead(ShareFileOpenReadOptions, CancellationToken)

Otwiera strumień do odczytu z pliku. Strumień pobierze tylko plik, ponieważ strumień jest odczytywany.

OpenReadAsync(ShareFileOpenReadOptions, CancellationToken)

Otwiera strumień do odczytu z pliku. Strumień pobierze tylko plik, ponieważ strumień jest odczytywany.

OpenWrite(Boolean, Int64, ShareFileOpenWriteOptions, CancellationToken)

Otwiera strumień do zapisu w pliku.

OpenWriteAsync(Boolean, Int64, ShareFileOpenWriteOptions, CancellationToken)

Otwiera strumień do zapisu w pliku.

Rename(String, ShareFileRenameOptions, CancellationToken)

Zmienia nazwę pliku. Ten interfejs API nie obsługuje zmiany nazwy pliku z jednego udziału na inny lub między kontami magazynu.

RenameAsync(String, ShareFileRenameOptions, CancellationToken)

Zmienia nazwę pliku. Ten interfejs API nie obsługuje zmiany nazwy pliku z jednego udziału na inny lub między kontami magazynu.

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

Operacja SetHttpHeaders(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken) ustawia właściwości systemu w pliku.

Aby uzyskać więcej informacji, zobacz Ustaw właściwości pliku.

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

Operacja SetHttpHeadersAsync(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken) ustawia właściwości systemu w pliku.

Aby uzyskać więcej informacji, zobacz Ustaw właściwości pliku.

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

Operacja SetMetadata(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken) ustawia metadane zdefiniowane przez użytkownika dla określonego pliku jako jedną lub więcej par name-value.

Aby uzyskać więcej informacji, zobacz Ustaw metadane pliku.

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

Operacja SetMetadataAsync(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken) ustawia metadane zdefiniowane przez użytkownika dla określonego pliku jako jedną lub więcej par name-value.

Aby uzyskać więcej informacji, zobacz Ustaw metadane pliku.

StartCopy(Uri, ShareFileCopyOptions, CancellationToken)

Kopiuje obiekt blob lub plik do pliku docelowego na koncie magazynu.

Aby uzyskać więcej informacji, zobacz Skopiuj plik.

StartCopyAsync(Uri, ShareFileCopyOptions, CancellationToken)

Kopiuje obiekt blob lub plik do pliku docelowego na koncie magazynu.

Aby uzyskać więcej informacji, zobacz Skopiuj plik.

Upload(Stream, ShareFileUploadOptions, CancellationToken)

Operacja Upload(Stream, ShareFileUploadOptions, CancellationToken) zapisuje options.Stream.Stream w pliku.

Aby uzyskać więcej informacji, zobacz Umieść zakres.

UploadAsync(Stream, ShareFileUploadOptions, CancellationToken)

Operacja UploadAsync(Stream, ShareFileUploadOptions, CancellationToken) zapisuje options.Stream.Stream w pliku.

Aby uzyskać więcej informacji, zobacz Umieść zakres.

UploadRange(HttpRange, Stream, ShareFileUploadRangeOptions, CancellationToken)

Operacja 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) zapisuje content w range pliku.

Aby uzyskać więcej informacji, zobacz Umieść zakres.

UploadRangeAsync(HttpRange, Stream, ShareFileUploadRangeOptions, CancellationToken)

Operacja 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) zapisuje content w range pliku.

Aby uzyskać więcej informacji, zobacz Umieść zakres.

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

Operacja UploadRangeFromUri(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken) zapisuje zakres od pliku platformy Azure do innego pliku platformy Azure. Ten interfejs API jest obsługiwany tylko w wersji 2019-02-02 i nowszej.

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

Operacja Azure.Storage.Files.Shares.ShareFileClient.UploadRangeFromUriAsync(System.Uri,Azure.HttpRange,Azure.HttpRange,Azure.Storage.Files.Shares.Models.ShareFileRequestConditions,System.Threading.CancellationToken) zapisuje zakres od pliku platformy Azure do innego pliku platformy Azure. Ten interfejs API jest obsługiwany tylko w wersji 2019-02-02 i nowszej.

WithSnapshot(String)

Inicjuje ShareFileClient nowe wystąpienie klasy o identycznym Uri źródle, ale określony shareSnapshot znacznik czasu.

Aby uzyskać więcej informacji, zobacz Udział migawek.

Metody rozszerzania

GetShareLeaseClient(ShareFileClient, String)

Inicjuje nowe wystąpienie klasy ShareLeaseClient.

GetParentShareClient(ShareFileClient)

Utwórz nową ShareClient , która wskazuje ten ShareFileClientkontener nadrzędny. ShareClient Nowy używa tego samego potoku zasad żądania co ShareFileClient.

GetParentShareDirectoryClient(ShareFileClient)

Utwórz nową ShareDirectoryClient , która wskazuje ten ShareFileClientkontener nadrzędny. ShareDirectoryClient Nowy używa tego samego potoku zasad żądania co ShareFileClient.

Dotyczy