ShareFileClient Klass

Referens

Definition

Namnområde:: Azure.Storage.Files.Shares

Sammansättning:: Azure.Storage.Files.Shares.dll

Paket:: Azure.Storage.Files.Shares v12.16.0

Viktigt

En del information gäller för förhandsversionen av en produkt och kan komma att ändras avsevärt innan produkten blir allmänt tillgänglig. Microsoft lämnar inga garantier, uttryckliga eller underförstådda, avseende informationen som visas här.

ShareFileClient Gör att du kan ändra Azure Storage-filer.

public class ShareFileClient

type ShareFileClient = class

Public Class ShareFileClient

Arv: Object
ShareFileClient

Konstruktorer

ShareFileClient()	Initierar en ny instans av ShareFileClient klassen för att simulera.
ShareFileClient(String, String, String)	Initierar en ny instans av ShareFileClient klassen.
ShareFileClient(String, String, String, ShareClientOptions)	Initierar en ny instans av ShareFileClient klassen.
ShareFileClient(Uri, AzureSasCredential, ShareClientOptions)	Initierar en ny instans av ShareFileClient klassen.
ShareFileClient(Uri, ShareClientOptions)	Initierar en ny instans av ShareFileClient klassen.
ShareFileClient(Uri, StorageSharedKeyCredential, ShareClientOptions)	Initierar en ny instans av ShareFileClient klassen.
ShareFileClient(Uri, TokenCredential, ShareClientOptions)	Initierar en ny instans av ShareFileClient klassen. Observera att ShareTokenIntent för närvarande krävs för tokenautentisering.

Egenskaper

AccountName	Hämtar lagringskontonamnet som motsvarar filklienten.
CanGenerateSasUri	Avgör om klienten kan generera en SAS. Om klienten autentiseras med en StorageSharedKeyCredential.
Name	Hämtar namnet på filen.
Path	Hämtar sökvägen till filen.
ShareName	Hämtar resursnamnet som motsvarar filklienten.
Uri	Hämtar katalogens primära Uri slutpunkt.

Metoder

AbortCopy(String, ShareFileRequestConditions, CancellationToken)	Försök att avbryta en väntande kopia som startades tidigare och lämnar en målfil med noll längd och fullständiga metadata. Mer information finns i Avbryt kopieringsfilen.
AbortCopyAsync(String, ShareFileRequestConditions, CancellationToken)	Försök att avbryta en väntande kopia som startades tidigare och lämnar en målfil med noll längd och fullständiga metadata. Mer information finns i Avbryt kopieringsfilen.
ClearRange(HttpRange, ShareFileRequestConditions, CancellationToken)	Åtgärden ClearRange(HttpRange, ShareFileRequestConditions, CancellationToken) rensar `range` från en fil. Mer information finns i Placera Område.
ClearRangeAsync(HttpRange, ShareFileRequestConditions, CancellationToken)	Åtgärden ClearRangeAsync(HttpRange, ShareFileRequestConditions, CancellationToken) rensar `range` från en fil. Mer information finns i Placera Område.
Create(Int64, ShareFileHttpHeaders, IDictionary<String,String>, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)	Skapar en ny fil eller ersätter en befintlig fil. Mer information finns i Skapa fil.
CreateAsync(Int64, ShareFileHttpHeaders, IDictionary<String,String>, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)	Skapar en ny fil eller ersätter en befintlig fil. Mer information finns i Skapa fil.
Delete(ShareFileRequestConditions, CancellationToken)	Åtgärden Delete(ShareFileRequestConditions, CancellationToken) tar omedelbart bort filen från lagringskontot. Mer information finns i Ta bort fil.
DeleteAsync(ShareFileRequestConditions, CancellationToken)	Åtgärden DeleteAsync(ShareFileRequestConditions, CancellationToken) tar omedelbart bort filen från lagringskontot. Mer information finns i Ta bort fil.
DeleteIfExists(ShareFileRequestConditions, CancellationToken)	Åtgärden DeleteIfExists(ShareFileRequestConditions, CancellationToken) tar omedelbart bort filen från lagringskontot, om den finns. Mer information finns i Ta bort fil.
DeleteIfExistsAsync(ShareFileRequestConditions, CancellationToken)	Åtgärden DeleteIfExists(ShareFileRequestConditions, CancellationToken) tar omedelbart bort filen från lagringskontot, om den finns. Mer information finns i Ta bort fil.
Download(ShareFileDownloadOptions, CancellationToken)	Åtgärden Download(ShareFileDownloadOptions, CancellationToken) läser eller laddar ned en fil från systemet, inklusive dess metadata och egenskaper. Mer information finns i Hämta fil.
DownloadAsync(ShareFileDownloadOptions, CancellationToken)	Åtgärden DownloadAsync(ShareFileDownloadOptions, CancellationToken) läser eller laddar ned en fil från systemet, inklusive dess metadata och egenskaper. Mer information finns i Hämta fil.
Exists(CancellationToken)	Åtgärden Exists(CancellationToken) kan anropas på en ShareFileClient för att se om den associerade filen finns i resursen på lagringskontot.
ExistsAsync(CancellationToken)	Åtgärden Exists(CancellationToken) kan anropas på en ShareFileClient för att se om den associerade filen finns i resursen på lagringskontot.
ForceCloseAllHandles(CancellationToken)	Åtgärden ForceCloseAllHandles(CancellationToken) stänger alla referenser som öppnats på en fil i tjänsten. Det här API:et är avsett att användas tillsammans GetHandlesAsync(CancellationToken) med för att tvinga fram stängningshandtag som blockerar åtgärder. Dessa referenser kan ha läckt eller tappats bort från SMB-klienter. API:et har påverkan på referensen på klientsidan som stängs, inklusive användar synliga fel på grund av misslyckade försök att läsa eller skriva filer. Det här API:et är inte avsett att användas som ersättning eller alternativ för SMB-stängning. Mer information finns i Framtvinga stängningshandtag.
ForceCloseAllHandlesAsync(CancellationToken)	Åtgärden ForceCloseAllHandlesAsync(CancellationToken) stänger alla referenser som öppnats på en fil i tjänsten. Det här API:et är avsett att användas tillsammans GetHandlesAsync(CancellationToken) med för att tvinga fram stängningshandtag som blockerar åtgärder. Dessa referenser kan ha läckt eller tappats bort från SMB-klienter. API:et har påverkan på referensen på klientsidan som stängs, inklusive användar synliga fel på grund av misslyckade försök att läsa eller skriva filer. Det här API:et är inte avsett att användas som ersättning eller alternativ för SMB-stängning. Mer information finns i Framtvinga stängningshandtag.
ForceCloseHandle(String, CancellationToken)	Åtgärden ForceCloseHandle(String, CancellationToken) stänger ett handtag som öppnats på en fil i tjänsten. Det stöder stängning av ett enda handtag som anges av `handleId`. Det här API:et är avsett att användas tillsammans GetHandlesAsync(CancellationToken) med för att tvinga fram stängningshandtag som blockerar åtgärder. Dessa referenser kan ha läckt eller tappats bort från SMB-klienter. API:et har påverkan på referensen på klientsidan som stängs, inklusive användar synliga fel på grund av misslyckade försök att läsa eller skriva filer. Det här API:et är inte avsett att användas som ersättning eller alternativ för SMB-stängning. Mer information finns i Framtvinga stängningshandtag.
ForceCloseHandleAsync(String, CancellationToken)	Åtgärden ForceCloseHandleAsync(String, CancellationToken) stänger ett handtag som öppnats på en fil i tjänsten. Det stöder stängning av ett enda handtag som anges av `handleId`. Det här API:et är avsett att användas tillsammans GetHandlesAsync(CancellationToken) med för att tvinga fram stängningshandtag som blockerar åtgärder. Dessa referenser kan ha läckt eller tappats bort från SMB-klienter. API:et har påverkan på referensen på klientsidan som stängs, inklusive användar synliga fel på grund av misslyckade försök att läsa eller skriva filer. Det här API:et är inte avsett att användas som ersättning eller alternativ för SMB-stängning. Mer information finns i Framtvinga stängningshandtag.
GenerateSasUri(ShareFileSasPermissions, DateTimeOffset)	GenerateSasUri(ShareFileSasPermissions, DateTimeOffset) returnerar en Uri som genererar en SAS-URI (Share File Service Shared Access Signature) baserat på de klientegenskaper och parametrar som skickas. SAS signeras av klientens autentiseringsuppgifter för delad nyckel. Om du vill kontrollera om klienten kan signera en Tjänst-Sas kan du se CanGenerateSasUri. Mer information finns i Skapa en tjänst-SAS.
GenerateSasUri(ShareSasBuilder)	GenerateSasUri(ShareSasBuilder) returnerar en Uri som genererar en SAS-URI (Share File Service Shared Access Signature) baserat på klientegenskaperna och och byggaren. SAS signeras av klientens autentiseringsuppgifter för delad nyckel. Om du vill kontrollera om klienten kan signera en Tjänst-Sas kan du se CanGenerateSasUri. Mer information finns i Skapa en tjänst-SAS.
GetHandles(CancellationToken)	Åtgärden GetHandles(CancellationToken) returnerar en asynkron sekvens av de öppna referenserna i en katalog eller en fil. Uppräkning av handtagen kan göra flera begäranden till tjänsten när alla värden hämtas. Mer information finns i Listreferenser.
GetHandlesAsync(CancellationToken)	Åtgärden GetHandlesAsync(CancellationToken) returnerar en asynkron sekvens av de öppna referenserna i en katalog eller en fil. Uppräkning av handtagen kan göra flera begäranden till tjänsten när alla värden hämtas. Mer information finns i Listreferenser.
GetParentShareClientCore()	Skapa en ny ShareClient som pekar på den överordnade ShareFileClientcontainern. Den nya ShareClient använder samma pipeline för begärandeprincip som ShareFileClient.
GetParentShareDirectoryClientCore()	Skapa en ny ShareDirectoryClient som pekar på den överordnade ShareFileClientcontainern. Den nya ShareDirectoryClient använder samma pipeline för begärandeprincip som ShareFileClient.
GetProperties(ShareFileRequestConditions, CancellationToken)	Åtgärden GetProperties(ShareFileRequestConditions, CancellationToken) returnerar alla användardefinierade metadata, HTTP-standardegenskaper och systemegenskaper för filen. Den returnerar inte innehållet i filen. Mer information finns i Hämta filegenskaper.
GetPropertiesAsync(ShareFileRequestConditions, CancellationToken)	Åtgärden GetPropertiesAsync(ShareFileRequestConditions, CancellationToken) returnerar alla användardefinierade metadata, HTTP-standardegenskaper och systemegenskaper för filen. Den returnerar inte innehållet i filen. Mer information finns i Hämta filegenskaper.
GetRangeList(ShareFileGetRangeListOptions, CancellationToken)	Returnerar listan över giltiga intervall för en fil. Mer information finns i Listintervall.
GetRangeListAsync(ShareFileGetRangeListOptions, CancellationToken)	Returnerar listan över giltiga intervall för en fil. Mer information finns i Listintervall.
GetRangeListDiff(ShareFileGetRangeListDiffOptions, CancellationToken)	Returnerar listan över intervall som har ändrats i filen sedan föregåendeSnapshot togs. Mer information finns i Listintervall.
GetRangeListDiffAsync(ShareFileGetRangeListDiffOptions, CancellationToken)	Returnerar listan över intervall som har ändrats i filen sedan föregåendeSnapshot togs. Mer information finns i Listintervall.
OpenRead(ShareFileOpenReadOptions, CancellationToken)	Öppnar en dataström för läsning från filen. Strömmen laddar bara ned filen när dataströmmen läss från.
OpenReadAsync(ShareFileOpenReadOptions, CancellationToken)	Öppnar en dataström för läsning från filen. Strömmen laddar bara ned filen när dataströmmen läss från.
OpenWrite(Boolean, Int64, ShareFileOpenWriteOptions, CancellationToken)	Öppnar en dataström för att skriva till filen.
OpenWriteAsync(Boolean, Int64, ShareFileOpenWriteOptions, CancellationToken)	Öppnar en dataström för att skriva till filen.
Rename(String, ShareFileRenameOptions, CancellationToken)	Byter namn på en fil. Det här API:et har inte stöd för att byta namn på en fil från en resurs till en annan eller mellan lagringskonton.
RenameAsync(String, ShareFileRenameOptions, CancellationToken)	Byter namn på en fil. Det här API:et har inte stöd för att byta namn på en fil från en resurs till en annan eller mellan lagringskonton.
SetHttpHeaders(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)	Åtgärden SetHttpHeaders(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken) anger systemegenskaper för filen. Mer information finns i Ange filegenskaper.
SetHttpHeadersAsync(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)	Åtgärden SetHttpHeadersAsync(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken) anger systemegenskaper för filen. Mer information finns i Ange filegenskaper.
SetMetadata(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken)	Åtgärden SetMetadata(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken) anger användardefinierade metadata för den angivna filen som ett eller flera namn/värde-par. Mer information finns i Ange filmetadata.
SetMetadataAsync(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken)	Åtgärden SetMetadataAsync(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken) anger användardefinierade metadata för den angivna filen som ett eller flera namn/värde-par. Mer information finns i Ange filmetadata.
StartCopy(Uri, ShareFileCopyOptions, CancellationToken)	Kopierar en blob eller fil till en målfil i lagringskontot. Mer information finns i Kopiera fil.
StartCopyAsync(Uri, ShareFileCopyOptions, CancellationToken)	Kopierar en blob eller fil till en målfil i lagringskontot. Mer information finns i Kopiera fil.
Upload(Stream, ShareFileUploadOptions, CancellationToken)	Åtgärden Upload(Stream, ShareFileUploadOptions, CancellationToken) skriver `options.Stream.Stream` till en fil. Mer information finns i Placera Område.
UploadAsync(Stream, ShareFileUploadOptions, CancellationToken)	Åtgärden UploadAsync(Stream, ShareFileUploadOptions, CancellationToken) skriver `options.Stream.Stream` till en fil. Mer information finns i Placera Område.
UploadRange(HttpRange, Stream, ShareFileUploadRangeOptions, CancellationToken)	Åtgärden 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) skriver `content` till en `range` fil. Mer information finns i Placera Område.
UploadRangeAsync(HttpRange, Stream, ShareFileUploadRangeOptions, CancellationToken)	Åtgärden 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) skriver `content` till en `range` fil. Mer information finns i Placera Område.
UploadRangeFromUri(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken)	Åtgärden UploadRangeFromUri(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken) skriver ett intervall från en Azure-fil till en annan Azure-fil. Det här API:et stöds endast för version 2019-02-02 och senare.
UploadRangeFromUriAsync(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken)	Åtgärden Azure.Storage.Files.Shares.ShareFileClient.UploadRangeFromUriAsync(System.Uri,Azure.HttpRange,Azure.HttpRange,Azure.Storage.Files.Shares.Models.ShareFileRequestConditions,System.Threading.CancellationToken) skriver ett intervall från en Azure-fil till en annan Azure-fil. Det här API:et stöds endast för version 2019-02-02 och senare.
WithSnapshot(String)	Initierar en ny instans av ShareFileClient klassen med en identisk Uri källa men den angivna `shareSnapshot` tidsstämpeln. Mer information finns i Ögonblicksbildsresurs.

Tilläggsmetoder

GetShareLeaseClient(ShareFileClient, String)	Initierar en ny instans av ShareLeaseClient klassen.
GetParentShareClient(ShareFileClient)	Skapa en ny ShareClient som pekar på den överordnade ShareFileClientcontainern. Den nya ShareClient använder samma pipeline för begärandeprincip som ShareFileClient.
GetParentShareDirectoryClient(ShareFileClient)	Skapa en ny ShareDirectoryClient som pekar på den överordnade ShareFileClientcontainern. Den nya ShareDirectoryClient använder samma pipeline för begärandeprincip som ShareFileClient.

Gäller för

Dela via