ShareFileClient Класс

Ссылка

Определение

Пространство имен:: Azure.Storage.Files.Shares

Сборка:: Azure.Storage.Files.Shares.dll

Пакет:: Azure.Storage.Files.Shares v12.16.0

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

позволяет ShareFileClient управлять файлами службы хранилища Azure.

public class ShareFileClient

type ShareFileClient = class

Public Class ShareFileClient

Наследование: Object
ShareFileClient

Конструкторы

ShareFileClient()	Инициализирует новый экземпляр ShareFileClient класса для макетирования.
ShareFileClient(String, String, String)	Инициализирует новый экземпляр класса ShareFileClient.
ShareFileClient(String, String, String, ShareClientOptions)	Инициализирует новый экземпляр класса ShareFileClient.
ShareFileClient(Uri, AzureSasCredential, ShareClientOptions)	Инициализирует новый экземпляр класса ShareFileClient.
ShareFileClient(Uri, ShareClientOptions)	Инициализирует новый экземпляр класса ShareFileClient.
ShareFileClient(Uri, StorageSharedKeyCredential, ShareClientOptions)	Инициализирует новый экземпляр класса ShareFileClient.
ShareFileClient(Uri, TokenCredential, ShareClientOptions)	Инициализирует новый экземпляр класса ShareFileClient. Обратите внимание, что ShareTokenIntent в настоящее время требуется для проверки подлинности на основе маркеров.

Свойства

AccountName	Возвращает имя учетной записи хранения, соответствующее файлу клиента.
CanGenerateSasUri	Определяет, может ли клиент создать SAS. Если клиент проходит проверку подлинности с помощью StorageSharedKeyCredential.
Name	Получает имя файла.
Path	Возвращает путь к файлу.
ShareName	Возвращает имя общей папки, соответствующее файлового клиента.
Uri	Возвращает основную конечную точку Uri каталога.

Методы

AbortCopy(String, ShareFileRequestConditions, CancellationToken)	Пытается отменить ожидающую копию, которая была запущена ранее, и оставляет целевой файл с нулевой длиной и полными метаданными. Дополнительные сведения см. в разделе Прервать копирование файла.
AbortCopyAsync(String, ShareFileRequestConditions, CancellationToken)	Пытается отменить ожидающую копию, которая была запущена ранее, и оставляет целевой файл с нулевой длиной и полными метаданными. Дополнительные сведения см. в разделе Прервать копирование файла.
ClearRange(HttpRange, ShareFileRequestConditions, CancellationToken)	Операция ClearRange(HttpRange, ShareFileRequestConditions, CancellationToken) очищает `range` из файла. Дополнительные сведения см. в разделе Поместите диапазон.
ClearRangeAsync(HttpRange, ShareFileRequestConditions, CancellationToken)	Операция ClearRangeAsync(HttpRange, ShareFileRequestConditions, CancellationToken) очищает `range` из файла. Дополнительные сведения см. в разделе Поместите диапазон.
Create(Int64, ShareFileHttpHeaders, IDictionary<String,String>, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)	Создает новый файл или заменяет существующий. Дополнительные сведения см. в разделе Создайте файл.
CreateAsync(Int64, ShareFileHttpHeaders, IDictionary<String,String>, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)	Создает новый файл или заменяет существующий. Дополнительные сведения см. в разделе Создайте файл.
Delete(ShareFileRequestConditions, CancellationToken)	Операция Delete(ShareFileRequestConditions, CancellationToken) немедленно удаляет файл из учетной записи хранения. Дополнительные сведения см. в разделе Удалить файл.
DeleteAsync(ShareFileRequestConditions, CancellationToken)	Операция DeleteAsync(ShareFileRequestConditions, CancellationToken) немедленно удаляет файл из учетной записи хранения. Дополнительные сведения см. в разделе Удалить файл.
DeleteIfExists(ShareFileRequestConditions, CancellationToken)	Операция DeleteIfExists(ShareFileRequestConditions, CancellationToken) немедленно удаляет файл из учетной записи хранения, если он существует. Дополнительные сведения см. в разделе Удалить файл.
DeleteIfExistsAsync(ShareFileRequestConditions, CancellationToken)	Операция DeleteIfExists(ShareFileRequestConditions, CancellationToken) немедленно удаляет файл из учетной записи хранения, если он существует. Дополнительные сведения см. в разделе Удалить файл.
Download(ShareFileDownloadOptions, CancellationToken)	Операция Download(ShareFileDownloadOptions, CancellationToken) считывает или загружает файл из системы, включая метаданные и свойства. Дополнительные сведения см. в разделе Получение файла.
DownloadAsync(ShareFileDownloadOptions, CancellationToken)	Операция DownloadAsync(ShareFileDownloadOptions, CancellationToken) считывает или загружает файл из системы, включая метаданные и свойства. Дополнительные сведения см. в разделе Получение файла.
Exists(CancellationToken)	Операцию Exists(CancellationToken) можно вызвать в , ShareFileClient чтобы узнать, существует ли связанный файл в общей папке в учетной записи хранения.
ExistsAsync(CancellationToken)	Операцию Exists(CancellationToken) можно вызвать в , ShareFileClient чтобы узнать, существует ли связанный файл в общей папке в учетной записи хранения.
ForceCloseAllHandles(CancellationToken)	Операция ForceCloseAllHandles(CancellationToken) закрывает все дескрипторы, открытые в файле службы. Этот API предназначен для принудительного GetHandlesAsync(CancellationToken) закрытия дескрипторов, которые блокируют операции. Возможно, эти дескрипторы произошли или были потеряны клиентами SMB. API влияет на закрытие дескриптора на стороне клиента, включая ошибки, видимые пользователем из-за неудачных попыток чтения или записи файлов. Этот API не предназначен для использования в качестве замены или альтернативы для закрытия SMB. Дополнительные сведения см. в разделе Принудительное закрытие дескрипторов.
ForceCloseAllHandlesAsync(CancellationToken)	Операция ForceCloseAllHandlesAsync(CancellationToken) закрывает все дескрипторы, открытые в файле службы. Этот API предназначен для принудительного GetHandlesAsync(CancellationToken) закрытия дескрипторов, которые блокируют операции. Возможно, эти дескрипторы произошли или были потеряны клиентами SMB. API влияет на закрытие дескриптора на стороне клиента, включая ошибки, видимые пользователем из-за неудачных попыток чтения или записи файлов. Этот API не предназначен для использования в качестве замены или альтернативы для закрытия SMB. Дополнительные сведения см. в разделе Принудительное закрытие дескрипторов.
ForceCloseHandle(String, CancellationToken)	Операция ForceCloseHandle(String, CancellationToken) закрывает дескриптор, открытый в файле службы. Он поддерживает закрытие одного дескриптора, указанного параметром `handleId`. Этот API предназначен для принудительного GetHandlesAsync(CancellationToken) закрытия дескрипторов, которые блокируют операции. Возможно, эти дескрипторы произошли или были потеряны клиентами SMB. API влияет на закрытие дескриптора на стороне клиента, включая ошибки, видимые пользователем из-за неудачных попыток чтения или записи файлов. Этот API не предназначен для использования в качестве замены или альтернативы для закрытия SMB. Дополнительные сведения см. в разделе Принудительное закрытие дескрипторов.
ForceCloseHandleAsync(String, CancellationToken)	Операция ForceCloseHandleAsync(String, CancellationToken) закрывает дескриптор, открытый в файле службы. Он поддерживает закрытие одного дескриптора, указанного параметром `handleId`. Этот API предназначен для принудительного GetHandlesAsync(CancellationToken) закрытия дескрипторов, которые блокируют операции. Возможно, эти дескрипторы произошли или были потеряны клиентами SMB. API влияет на закрытие дескриптора на стороне клиента, включая ошибки, видимые пользователем из-за неудачных попыток чтения или записи файлов. Этот API не предназначен для использования в качестве замены или альтернативы для закрытия SMB. Дополнительные сведения см. в разделе Принудительное закрытие дескрипторов.
GenerateSasUri(ShareFileSasPermissions, DateTimeOffset)	Возвращает GenerateSasUri(ShareFileSasPermissions, DateTimeOffset) объект Uri , который создает URI подписанного URL-адреса (SAS) файловой службы на основе переданных свойств и параметров клиента. SAS подписывается учетными данными общего ключа клиента. Чтобы проверка, может ли клиент подписать sas службы, см. раздел CanGenerateSasUri. Дополнительные сведения см. в разделе Создание SAS службы.
GenerateSasUri(ShareSasBuilder)	Возвращает GenerateSasUri(ShareSasBuilder) объект Uri , который создает универсальный код ресурса (SAS) подписанного URL-адреса на основе свойств клиента и построителя и . SAS подписывается учетными данными общего ключа клиента. Чтобы проверка, может ли клиент подписать sas службы, см. раздел CanGenerateSasUri. Дополнительные сведения см. в разделе Создание SAS службы.
GetHandles(CancellationToken)	Операция GetHandles(CancellationToken) возвращает асинхронную последовательность открытых дескрипторов в каталоге или файле. Перечисление дескрипторов может выполнять несколько запросов к службе при получении всех значений. Дополнительные сведения см. в разделе Дескрипторы списка.
GetHandlesAsync(CancellationToken)	Операция GetHandlesAsync(CancellationToken) возвращает асинхронную последовательность открытых дескрипторов в каталоге или файле. Перечисление дескрипторов может выполнять несколько запросов к службе при получении всех значений. Дополнительные сведения см. в разделе Дескрипторы списка.
GetParentShareClientCore()	Создайте новый ShareClient объект , указывающий на родительский контейнер этого ShareFileClientобъекта. ShareClient Новый использует тот же конвейер политики запросов, что и ShareFileClient.
GetParentShareDirectoryClientCore()	Создайте новый ShareDirectoryClient объект , указывающий на родительский контейнер этого ShareFileClientобъекта. ShareDirectoryClient Новый использует тот же конвейер политики запросов, что и ShareFileClient.
GetProperties(ShareFileRequestConditions, CancellationToken)	Операция GetProperties(ShareFileRequestConditions, CancellationToken) возвращает все пользовательские метаданные, стандартные свойства HTTP и системные свойства файла. Операция не возвращает содержимое файла. Дополнительные сведения см. в разделе Получение свойств файла.
GetPropertiesAsync(ShareFileRequestConditions, CancellationToken)	Операция GetPropertiesAsync(ShareFileRequestConditions, CancellationToken) возвращает все пользовательские метаданные, стандартные свойства HTTP и системные свойства файла. Операция не возвращает содержимое файла. Дополнительные сведения см. в разделе Получение свойств файла.
GetRangeList(ShareFileGetRangeListOptions, CancellationToken)	Возвращает список допустимых диапазонов для файла. Дополнительные сведения см. в разделе Список диапазонов.
GetRangeListAsync(ShareFileGetRangeListOptions, CancellationToken)	Возвращает список допустимых диапазонов для файла. Дополнительные сведения см. в разделе Список диапазонов.
GetRangeListDiff(ShareFileGetRangeListDiffOptions, CancellationToken)	Возвращает список диапазонов, которые были изменены в файле с момента предыдущей записиSnapshot. Дополнительные сведения см. в разделе Список диапазонов.
GetRangeListDiffAsync(ShareFileGetRangeListDiffOptions, CancellationToken)	Возвращает список диапазонов, которые были изменены в файле с момента предыдущей записиSnapshot. Дополнительные сведения см. в разделе Список диапазонов.
OpenRead(ShareFileOpenReadOptions, CancellationToken)	Открывает поток для чтения из файла. Поток скачивает файл только по мере считывания потока.
OpenReadAsync(ShareFileOpenReadOptions, CancellationToken)	Открывает поток для чтения из файла. Поток скачивает файл только по мере считывания потока.
OpenWrite(Boolean, Int64, ShareFileOpenWriteOptions, CancellationToken)	Открывает поток для записи в файл.
OpenWriteAsync(Boolean, Int64, ShareFileOpenWriteOptions, CancellationToken)	Открывает поток для записи в файл.
Rename(String, ShareFileRenameOptions, CancellationToken)	Переименование файла. Этот API не поддерживает переименование файла из одной общей папки в другую или между учетными записями хранения.
RenameAsync(String, ShareFileRenameOptions, CancellationToken)	Переименование файла. Этот API не поддерживает переименование файла из одной общей папки в другую или между учетными записями хранения.
SetHttpHeaders(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)	Операция SetHttpHeaders(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken) задает системные свойства для файла. Дополнительные сведения см. в разделе Задайте свойства файла.
SetHttpHeadersAsync(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)	Операция SetHttpHeadersAsync(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken) задает системные свойства для файла. Дополнительные сведения см. в разделе Задайте свойства файла.
SetMetadata(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken)	Операция SetMetadata(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken) задает пользовательские метаданные для указанного файла в виде одной или нескольких пар "имя-значение". Дополнительные сведения см. в разделе Задайте метаданные файла.
SetMetadataAsync(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken)	Операция SetMetadataAsync(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken) задает пользовательские метаданные для указанного файла в виде одной или нескольких пар "имя-значение". Дополнительные сведения см. в разделе Задайте метаданные файла.
StartCopy(Uri, ShareFileCopyOptions, CancellationToken)	Копирует большой двоичный объект или файл в целевой файл в учетной записи хранения. Дополнительные сведения см. в разделе Копирование файла.
StartCopyAsync(Uri, ShareFileCopyOptions, CancellationToken)	Копирует большой двоичный объект или файл в целевой файл в учетной записи хранения. Дополнительные сведения см. в разделе Копирование файла.
Upload(Stream, ShareFileUploadOptions, CancellationToken)	Операция Upload(Stream, ShareFileUploadOptions, CancellationToken) выполняет запись `options.Stream.Stream` в файл. Дополнительные сведения см. в разделе Поместите диапазон.
UploadAsync(Stream, ShareFileUploadOptions, CancellationToken)	Операция UploadAsync(Stream, ShareFileUploadOptions, CancellationToken) выполняет запись `options.Stream.Stream` в файл. Дополнительные сведения см. в разделе Поместите диапазон.
UploadRange(HttpRange, Stream, ShareFileUploadRangeOptions, CancellationToken)	Операция 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) выполняет запись `content` в `range` файл . Дополнительные сведения см. в разделе Поместите диапазон.
UploadRangeAsync(HttpRange, Stream, ShareFileUploadRangeOptions, CancellationToken)	Операция 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) выполняет запись `content` в `range` файл . Дополнительные сведения см. в разделе Поместите диапазон.
UploadRangeFromUri(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken)	Операция UploadRangeFromUri(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken) записывает диапазон из файла Azure в другой файл Azure. Этот API поддерживается только для версии 2019-02-02 и более поздних версий.
UploadRangeFromUriAsync(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken)	Операция Azure.Storage.Files.Shares.ShareFileClient.UploadRangeFromUriAsync(System.Uri,Azure.HttpRange,Azure.HttpRange,Azure.Storage.Files.Shares.Models.ShareFileRequestConditions,System.Threading.CancellationToken) записывает диапазон из файла Azure в другой файл Azure. Этот API поддерживается только для версии 2019-02-02 и более поздних версий.
WithSnapshot(String)	Инициализирует новый экземпляр класса с идентичным ShareFileClient Uri источником, но указанной `shareSnapshot` меткой времени. Дополнительные сведения см. в разделе Общий ресурс моментальных снимков.

Методы расширения

GetShareLeaseClient(ShareFileClient, String)	Инициализирует новый экземпляр класса ShareLeaseClient.
GetParentShareClient(ShareFileClient)	Создайте новый ShareClient объект , указывающий на родительский контейнер этого ShareFileClientобъекта. ShareClient Новый использует тот же конвейер политики запросов, что и ShareFileClient.
GetParentShareDirectoryClient(ShareFileClient)	Создайте новый ShareDirectoryClient объект , указывающий на родительский контейнер этого ShareFileClientобъекта. ShareDirectoryClient Новый использует тот же конвейер политики запросов, что и ShareFileClient.

Применяется к

Поделиться через