ShareFileClient Klasse

Definition

Namespace:

Azure.Storage.Files.Shares

Assembly:

Azure.Storage.Files.Shares.dll

Paket:

Azure.Storage.Files.Shares v12.17.1

Quelle:

ShareFileClient.cs

Mit ShareFileClient können Sie Azure Storage-Dateien bearbeiten.

public class ShareFileClient

type ShareFileClient = class

Public Class ShareFileClient

Vererbung

Object

ShareFileClient

Konstruktoren

ShareFileClient()	Initialisiert eine neue instance der -Klasse für die ShareFileClient Simulation.
ShareFileClient(String, String, String)	Initialisiert eine neue Instanz der ShareFileClient-Klasse.
ShareFileClient(String, String, String, ShareClientOptions)	Initialisiert eine neue Instanz der ShareFileClient-Klasse.
ShareFileClient(Uri, AzureSasCredential, ShareClientOptions)	Initialisiert eine neue Instanz der ShareFileClient-Klasse.
ShareFileClient(Uri, ShareClientOptions)	Initialisiert eine neue Instanz der ShareFileClient-Klasse.
ShareFileClient(Uri, StorageSharedKeyCredential, ShareClientOptions)	Initialisiert eine neue Instanz der ShareFileClient-Klasse.
ShareFileClient(Uri, TokenCredential, ShareClientOptions)	Initialisiert eine neue Instanz der ShareFileClient-Klasse. Beachten Sie, dass ShareTokenIntent derzeit für die Tokenauthentifizierung erforderlich ist.

Eigenschaften

AccountName	Ruft den Speicherkontonamen ab, der dem Dateiclient entspricht.
CanGenerateSasUri	Bestimmt, ob der Client eine SAS generieren kann. Wenn der Client mit einem StorageSharedKeyCredentialauthentifiziert wird.
Name	Ruft den Namen der Datei ab.
Path	Ruft den Pfad der Datei ab.
ShareName	Ruft den Freigabenamen ab, der dem Dateiclient entspricht.
Uri	Ruft den primären Uri Endpunkt des Verzeichnisses ab.

Methoden

AbortCopy(String, ShareFileRequestConditions, CancellationToken)	Versucht, eine ausstehende Kopie abzubrechen, die zuvor gestartet wurde, und belässt eine Zieldatei mit der Länge Null und vollständigen Metadaten. Weitere Informationen finden Sie unter Abbrechen des Kopierens der Datei.
AbortCopyAsync(String, ShareFileRequestConditions, CancellationToken)	Versucht, eine ausstehende Kopie abzubrechen, die zuvor gestartet wurde, und belässt eine Zieldatei mit der Länge Null und vollständigen Metadaten. Weitere Informationen finden Sie unter Abbrechen des Kopierens der Datei.
ClearRange(HttpRange, ShareFileRequestConditions, CancellationToken)	Der ClearRange(HttpRange, ShareFileRequestConditions, CancellationToken) Vorgang löscht die range einer Datei. Weitere Informationen finden Sie unter Legen Sie Den Bereich fest.
ClearRangeAsync(HttpRange, ShareFileRequestConditions, CancellationToken)	Der ClearRangeAsync(HttpRange, ShareFileRequestConditions, CancellationToken) Vorgang löscht die range einer Datei. Weitere Informationen finden Sie unter Legen Sie Den Bereich fest.
Create(Int64, ShareFileHttpHeaders, IDictionary<String,String>, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)	Erstellt eine neue Datei oder ersetzt eine vorhandene Datei. Weitere Informationen finden Sie unter Datei erstellen.
CreateAsync(Int64, ShareFileHttpHeaders, IDictionary<String,String>, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)	Erstellt eine neue Datei oder ersetzt eine vorhandene Datei. Weitere Informationen finden Sie unter Datei erstellen.
Delete(ShareFileRequestConditions, CancellationToken)	Durch den Delete(ShareFileRequestConditions, CancellationToken)-Vorgang wird die Datei sofort aus dem Speicherkonto entfernt. Weitere Informationen finden Sie unter Datei löschen.
DeleteAsync(ShareFileRequestConditions, CancellationToken)	Durch den DeleteAsync(ShareFileRequestConditions, CancellationToken)-Vorgang wird die Datei sofort aus dem Speicherkonto entfernt. Weitere Informationen finden Sie unter Datei löschen.
DeleteIfExists(ShareFileRequestConditions, CancellationToken)	Der DeleteIfExists(ShareFileRequestConditions, CancellationToken) Vorgang entfernt die Datei sofort aus dem Speicherkonto, sofern vorhanden. Weitere Informationen finden Sie unter Datei löschen.
DeleteIfExistsAsync(ShareFileRequestConditions, CancellationToken)	Der DeleteIfExists(ShareFileRequestConditions, CancellationToken) Vorgang entfernt die Datei sofort aus dem Speicherkonto, sofern vorhanden. Weitere Informationen finden Sie unter Datei löschen.
Download(ShareFileDownloadOptions, CancellationToken)	Mit dem Download(ShareFileDownloadOptions, CancellationToken)-Vorgang wird eine Datei einschließlich der zugehörigen Metadaten und Eigenschaften aus dem System gelesen oder heruntergeladen. Weitere Informationen finden Sie unter Datei abrufen.
DownloadAsync(ShareFileDownloadOptions, CancellationToken)	Mit dem DownloadAsync(ShareFileDownloadOptions, CancellationToken)-Vorgang wird eine Datei einschließlich der zugehörigen Metadaten und Eigenschaften aus dem System gelesen oder heruntergeladen. Weitere Informationen finden Sie unter Datei abrufen.
Exists(CancellationToken)	Der Exists(CancellationToken) Vorgang kann für ein ShareFileClient aufgerufen werden, um festzustellen, ob die zugeordnete Datei in der Freigabe für das Speicherkonto vorhanden ist.
ExistsAsync(CancellationToken)	Der Exists(CancellationToken) Vorgang kann für ein ShareFileClient aufgerufen werden, um festzustellen, ob die zugeordnete Datei in der Freigabe für das Speicherkonto vorhanden ist.
ForceCloseAllHandles(CancellationToken)	Der ForceCloseAllHandles(CancellationToken) Vorgang schließt alle Handles, die für eine Datei im Dienst geöffnet wurden. Diese API soll zusammen GetHandlesAsync(CancellationToken) verwendet werden, um schließende Handles zu erzwingen, die Vorgänge blockieren. Diese Handles sind möglicherweise durch SMB-Clients kompromittiert oder verloren gegangen. Die API hat clientseitige Auswirkungen auf das zu schließende Handle, einschließlich sichtbarer Benutzerfehler aufgrund fehlgeschlagener Versuche, Dateien zu lesen oder zu schreiben. Diese API ist nicht für die Verwendung als Ersatz oder Alternative für den SMB-Schließen vorgesehen. Weitere Informationen finden Sie unter Schließen von Handles erzwingen.
ForceCloseAllHandlesAsync(CancellationToken)	Der ForceCloseAllHandlesAsync(CancellationToken) Vorgang schließt alle Handles, die für eine Datei im Dienst geöffnet wurden. Diese API soll zusammen GetHandlesAsync(CancellationToken) verwendet werden, um schließende Handles zu erzwingen, die Vorgänge blockieren. Diese Handles sind möglicherweise durch SMB-Clients kompromittiert oder verloren gegangen. Die API hat clientseitige Auswirkungen auf das zu schließende Handle, einschließlich sichtbarer Benutzerfehler aufgrund fehlgeschlagener Versuche, Dateien zu lesen oder zu schreiben. Diese API ist nicht für die Verwendung als Ersatz oder Alternative für den SMB-Schließen vorgesehen. Weitere Informationen finden Sie unter Schließen von Handles erzwingen.
ForceCloseHandle(String, CancellationToken)	Der ForceCloseHandle(String, CancellationToken) Vorgang schließt ein Handle, das für eine Datei im Dienst geöffnet wurde. Es unterstützt das Schließen eines einzelnen Handles, das von angegeben wird handleId. Diese API soll zusammen GetHandlesAsync(CancellationToken) verwendet werden, um schließende Handles zu erzwingen, die Vorgänge blockieren. Diese Handles sind möglicherweise durch SMB-Clients kompromittiert oder verloren gegangen. Die API hat clientseitige Auswirkungen auf das zu schließende Handle, einschließlich sichtbarer Benutzerfehler aufgrund fehlgeschlagener Versuche, Dateien zu lesen oder zu schreiben. Diese API ist nicht für die Verwendung als Ersatz oder Alternative für den SMB-Schließen vorgesehen. Weitere Informationen finden Sie unter Schließen von Handles erzwingen.
ForceCloseHandleAsync(String, CancellationToken)	Der ForceCloseHandleAsync(String, CancellationToken) Vorgang schließt ein Handle, das für eine Datei im Dienst geöffnet wurde. Es unterstützt das Schließen eines einzelnen Handles, das von angegeben wird handleId. Diese API soll zusammen GetHandlesAsync(CancellationToken) verwendet werden, um schließende Handles zu erzwingen, die Vorgänge blockieren. Diese Handles sind möglicherweise durch SMB-Clients kompromittiert oder verloren gegangen. Die API hat clientseitige Auswirkungen auf das zu schließende Handle, einschließlich sichtbarer Benutzerfehler aufgrund fehlgeschlagener Versuche, Dateien zu lesen oder zu schreiben. Diese API ist nicht für die Verwendung als Ersatz oder Alternative für den SMB-Schließen vorgesehen. Weitere Informationen finden Sie unter Schließen von Handles erzwingen.
GenerateSasUri(ShareFileSasPermissions, DateTimeOffset)	Gibt GenerateSasUri(ShareFileSasPermissions, DateTimeOffset) einen Uri zurück, der basierend auf den übergebenen Clienteigenschaften und Parametern einen SAS-URI (Shared Access Signature) generiert. Die SAS wird von den Anmeldeinformationen für gemeinsam genutzte Schlüssel des Clients signiert. Informationen zum Überprüfen, ob der Client eine Dienst-Sas signieren kann, finden Sie unter CanGenerateSasUri. Weitere Informationen finden Sie unter Erstellen einer Dienst-SAS.
GenerateSasUri(ShareSasBuilder)	Gibt GenerateSasUri(ShareSasBuilder) einen Uri zurück, der basierend auf den Clienteigenschaften und dem Generator einen SAS-URI (Shared Access Signature) des Freigabedateidiensts generiert. Die SAS wird von den Anmeldeinformationen für gemeinsam genutzte Schlüssel des Clients signiert. Informationen zum Überprüfen, ob der Client eine Dienst-Sas signieren kann, finden Sie unter CanGenerateSasUri. Weitere Informationen finden Sie unter Erstellen einer Dienst-SAS.
GetCopyAuthorizationHeaderAsync(ShareFileClient, CancellationToken)	Ruft ein ShareFileClient-Element HttpAuthorization ab, um die Autorisierung beim Ausführen von Dienst-zu-Dienst-Kopiervorgängen zu übergeben, wobei OAuth erforderlich ist, um die Quelle zu authentifizieren.
GetHandles(CancellationToken)	Der GetHandles(CancellationToken) Vorgang gibt eine asynchrone Sequenz der geöffneten Handles für ein Verzeichnis oder eine Datei zurück. Das Aufzählen der Handles kann mehrere Anforderungen an den Dienst senden, während alle Werte abgerufen werden. Weitere Informationen finden Sie unter Listenhandles.
GetHandlesAsync(CancellationToken)	Der GetHandlesAsync(CancellationToken) Vorgang gibt eine asynchrone Sequenz der geöffneten Handles für ein Verzeichnis oder eine Datei zurück. Das Aufzählen der Handles kann mehrere Anforderungen an den Dienst senden, während alle Werte abgerufen werden. Weitere Informationen finden Sie unter Listenhandles.
GetParentShareClientCore()	Erstellen Sie einen neuen ShareClient , der auf diesen ShareFileClientübergeordneten Container verweist. Das neue ShareClient verwendet dieselbe Anforderungsrichtlinienpipeline wie die ShareFileClient.
GetParentShareDirectoryClientCore()	Erstellen Sie einen neuen ShareDirectoryClient , der auf diesen ShareFileClientübergeordneten Container verweist. Das neue ShareDirectoryClient verwendet dieselbe Anforderungsrichtlinienpipeline wie die ShareFileClient.
GetProperties(ShareFileRequestConditions, CancellationToken)	Der GetProperties(ShareFileRequestConditions, CancellationToken) Vorgang gibt alle benutzerdefinierten Metadaten, HTTP-Standardeigenschaften und Systemeigenschaften für die Datei zurück. Der Inhalt der Datei wird nicht zurückgegeben. Weitere Informationen finden Sie unter Dateieigenschaften abrufen.
GetPropertiesAsync(ShareFileRequestConditions, CancellationToken)	Der GetPropertiesAsync(ShareFileRequestConditions, CancellationToken) Vorgang gibt alle benutzerdefinierten Metadaten, HTTP-Standardeigenschaften und Systemeigenschaften für die Datei zurück. Der Inhalt der Datei wird nicht zurückgegeben. Weitere Informationen finden Sie unter Dateieigenschaften abrufen.
GetRangeList(ShareFileGetRangeListOptions, CancellationToken)	Gibt die Liste der gültigen Bereiche für eine Datei zurück. Weitere Informationen finden Sie unter Listenbereiche.
GetRangeListAsync(ShareFileGetRangeListOptions, CancellationToken)	Gibt die Liste der gültigen Bereiche für eine Datei zurück. Weitere Informationen finden Sie unter Listenbereiche.
GetRangeListDiff(ShareFileGetRangeListDiffOptions, CancellationToken)	Gibt die Liste der Bereiche zurück, die sich in der Datei seit der vorherigen Aufnahme von Snapshot geändert haben. Weitere Informationen finden Sie unter Listenbereiche.
GetRangeListDiffAsync(ShareFileGetRangeListDiffOptions, CancellationToken)	Gibt die Liste der Bereiche zurück, die sich in der Datei seit der vorherigen Aufnahme von Snapshot geändert haben. Weitere Informationen finden Sie unter Listenbereiche.
OpenRead(ShareFileOpenReadOptions, CancellationToken)	Öffnet einen Stream, um Daten aus der Datei zu lesen. Der Stream lädt die Datei nur herunter, wenn der Stream gelesen wird.
OpenReadAsync(ShareFileOpenReadOptions, CancellationToken)	Öffnet einen Stream, um Daten aus der Datei zu lesen. Der Stream lädt die Datei nur herunter, wenn der Stream gelesen wird.
OpenWrite(Boolean, Int64, ShareFileOpenWriteOptions, CancellationToken)	Öffnet einen Stream, um in die Datei zu schreiben.
OpenWriteAsync(Boolean, Int64, ShareFileOpenWriteOptions, CancellationToken)	Öffnet einen Stream, um in die Datei zu schreiben.
Rename(String, ShareFileRenameOptions, CancellationToken)	Benennt eine Datei um. Diese API unterstützt das Umbenennen einer Datei von einer Freigabe in eine andere oder zwischen Speicherkonten nicht.
RenameAsync(String, ShareFileRenameOptions, CancellationToken)	Benennt eine Datei um. Diese API unterstützt das Umbenennen einer Datei von einer Freigabe in eine andere oder zwischen Speicherkonten nicht.
SetHttpHeaders(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)	Mit dem Vorgang SetHttpHeaders(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken) werden Systemeigenschaften für die Datei festgelegt. Weitere Informationen finden Sie unter Legen Sie Dateieigenschaften fest.
SetHttpHeadersAsync(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)	Mit dem Vorgang SetHttpHeadersAsync(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken) werden Systemeigenschaften für die Datei festgelegt. Weitere Informationen finden Sie unter Legen Sie Dateieigenschaften fest.
SetMetadata(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken)	Der SetMetadata(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken) Vorgang legt benutzerdefinierte Metadaten für die angegebene Datei als mindestens ein Name-Wert-Paar fest. Weitere Informationen finden Sie unter Legen Sie Dateimetadaten fest.
SetMetadataAsync(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken)	Der SetMetadataAsync(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken) Vorgang legt benutzerdefinierte Metadaten für die angegebene Datei als mindestens ein Name-Wert-Paar fest. Weitere Informationen finden Sie unter Legen Sie Dateimetadaten fest.
StartCopy(Uri, ShareFileCopyOptions, CancellationToken)	Kopiert ein Blob oder eine Datei in eine Zieldatei innerhalb des Speicherkontos. Weitere Informationen finden Sie unter Datei kopieren.
StartCopyAsync(Uri, ShareFileCopyOptions, CancellationToken)	Kopiert ein Blob oder eine Datei in eine Zieldatei innerhalb des Speicherkontos. Weitere Informationen finden Sie unter Datei kopieren.
Upload(Stream, ShareFileUploadOptions, CancellationToken)	Der Upload(Stream, ShareFileUploadOptions, CancellationToken) Vorgang schreibt options.Stream.Stream in eine Datei. Weitere Informationen finden Sie unter Bereich platzieren.
UploadAsync(Stream, ShareFileUploadOptions, CancellationToken)	Der UploadAsync(Stream, ShareFileUploadOptions, CancellationToken) Vorgang schreibt options.Stream.Stream in eine Datei. Weitere Informationen finden Sie unter Bereich platzieren.
UploadRange(HttpRange, Stream, ShareFileUploadRangeOptions, CancellationToken)	Der 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) Vorgang schreibt content in eine range datei. Weitere Informationen finden Sie unter Bereich platzieren.
UploadRangeAsync(HttpRange, Stream, ShareFileUploadRangeOptions, CancellationToken)	Der 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) Vorgang schreibt content in eine range datei. Weitere Informationen finden Sie unter Bereich platzieren.
UploadRangeFromUri(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken)	Der UploadRangeFromUri(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken) Vorgang schreibt einen Bereich von einer Azure-Datei in eine andere Azure-Datei. Diese API wird nur ab Version 2019-02-02 unterstützt.
UploadRangeFromUriAsync(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken)	Der Azure.Storage.Files.Shares.ShareFileClient.UploadRangeFromUriAsync(System.Uri,Azure.HttpRange,Azure.HttpRange,Azure.Storage.Files.Shares.Models.ShareFileRequestConditions,System.Threading.CancellationToken) Vorgang schreibt einen Bereich von einer Azure-Datei in eine andere Azure-Datei. Diese API wird nur ab Version 2019-02-02 unterstützt.
WithSnapshot(String)	Initialisiert einen neuen instance der ShareFileClient -Klasse mit einer identischen Uri Quelle, aber dem angegebenen shareSnapshot Zeitstempel. Weitere Informationen finden Sie unter Momentaufnahmefreigabe.

Erweiterungsmethoden

GetShareLeaseClient(ShareFileClient, String)	Initialisiert eine neue Instanz der ShareLeaseClient-Klasse.
GetParentShareClient(ShareFileClient)	Erstellen Sie einen neuen ShareClient , der auf diesen ShareFileClientübergeordneten Container verweist. Das neue ShareClient verwendet dieselbe Anforderungsrichtlinienpipeline wie die ShareFileClient.
GetParentShareDirectoryClient(ShareFileClient)	Erstellen Sie einen neuen ShareDirectoryClient , der auf diesen ShareFileClientübergeordneten Container verweist. Das neue ShareDirectoryClient verwendet dieselbe Anforderungsrichtlinienpipeline wie die ShareFileClient.