ShareFileClient Classe

Definição

Namespace:

Azure.Storage.Files.Shares

Assembly:

Azure.Storage.Files.Shares.dll

Pacote:

Azure.Storage.Files.Shares v12.17.1

Origem:

ShareFileClient.cs

O ShareFileClient permite manipular arquivos do Armazenamento do Azure.

public class ShareFileClient

type ShareFileClient = class

Public Class ShareFileClient

Herança

Object

ShareFileClient

Construtores

ShareFileClient()	Inicializa uma nova instância da ShareFileClient classe para zombar.
ShareFileClient(String, String, String)	Inicializa uma nova instância da classe ShareFileClient.
ShareFileClient(String, String, String, ShareClientOptions)	Inicializa uma nova instância da classe ShareFileClient.
ShareFileClient(Uri, AzureSasCredential, ShareClientOptions)	Inicializa uma nova instância da classe ShareFileClient.
ShareFileClient(Uri, ShareClientOptions)	Inicializa uma nova instância da classe ShareFileClient.
ShareFileClient(Uri, StorageSharedKeyCredential, ShareClientOptions)	Inicializa uma nova instância da classe ShareFileClient.
ShareFileClient(Uri, TokenCredential, ShareClientOptions)	Inicializa uma nova instância da classe ShareFileClient. Observe que ShareTokenIntent atualmente é necessário para autenticação de token.

Propriedades

AccountName	Obtém o nome da conta de armazenamento correspondente ao cliente de arquivo.
CanGenerateSasUri	Determina se o cliente é capaz de gerar uma SAS. Se o cliente for autenticado com um StorageSharedKeyCredential.
Name	Obtém o nome do arquivo.
Path	Obtém o caminho do arquivo.
ShareName	Obtém o nome do compartilhamento correspondente ao cliente de arquivo.
Uri	Obtém o ponto de extremidade primário Uri do diretório.

Métodos

AbortCopy(String, ShareFileRequestConditions, CancellationToken)	Tenta cancelar uma cópia pendente que foi iniciada anteriormente e deixa um arquivo de destino com comprimento zero e metadados completos. Para obter mais informações, consulte Anular Arquivo de Cópia.
AbortCopyAsync(String, ShareFileRequestConditions, CancellationToken)	Tenta cancelar uma cópia pendente que foi iniciada anteriormente e deixa um arquivo de destino com comprimento zero e metadados completos. Para obter mais informações, consulte Anular Arquivo de Cópia.
ClearRange(HttpRange, ShareFileRequestConditions, CancellationToken)	A ClearRange(HttpRange, ShareFileRequestConditions, CancellationToken) operação limpa o range de um arquivo. Para obter mais informações, consulte Colocar Intervalo.
ClearRangeAsync(HttpRange, ShareFileRequestConditions, CancellationToken)	A ClearRangeAsync(HttpRange, ShareFileRequestConditions, CancellationToken) operação limpa o range de um arquivo. Para obter mais informações, consulte Colocar Intervalo.
Create(Int64, ShareFileHttpHeaders, IDictionary<String,String>, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)	Cria um novo arquivo ou substitui um arquivo existente. Para obter mais informações, consulte Criar Arquivo.
CreateAsync(Int64, ShareFileHttpHeaders, IDictionary<String,String>, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)	Cria um novo arquivo ou substitui um arquivo existente. Para obter mais informações, consulte Criar Arquivo.
Delete(ShareFileRequestConditions, CancellationToken)	A operação Delete(ShareFileRequestConditions, CancellationToken) remove imediatamente o arquivo da conta de armazenamento. Para obter mais informações, consulte Excluir Arquivo.
DeleteAsync(ShareFileRequestConditions, CancellationToken)	A operação DeleteAsync(ShareFileRequestConditions, CancellationToken) remove imediatamente o arquivo da conta de armazenamento. Para obter mais informações, consulte Excluir Arquivo.
DeleteIfExists(ShareFileRequestConditions, CancellationToken)	A DeleteIfExists(ShareFileRequestConditions, CancellationToken) operação remove imediatamente o arquivo da conta de armazenamento, se ele existir. Para obter mais informações, consulte Excluir Arquivo.
DeleteIfExistsAsync(ShareFileRequestConditions, CancellationToken)	A DeleteIfExists(ShareFileRequestConditions, CancellationToken) operação remove imediatamente o arquivo da conta de armazenamento, se ele existir. Para obter mais informações, consulte Excluir Arquivo.
Download(ShareFileDownloadOptions, CancellationToken)	A Download(ShareFileDownloadOptions, CancellationToken) operação lê ou baixa um arquivo do sistema, incluindo seus metadados e propriedades. Para obter mais informações, consulte Obter Arquivo.
DownloadAsync(ShareFileDownloadOptions, CancellationToken)	A DownloadAsync(ShareFileDownloadOptions, CancellationToken) operação lê ou baixa um arquivo do sistema, incluindo seus metadados e propriedades. Para obter mais informações, consulte Obter Arquivo.
Exists(CancellationToken)	A Exists(CancellationToken) operação pode ser chamada em um ShareFileClient para ver se o arquivo associado existe no compartilhamento na conta de armazenamento.
ExistsAsync(CancellationToken)	A Exists(CancellationToken) operação pode ser chamada em um ShareFileClient para ver se o arquivo associado existe no compartilhamento na conta de armazenamento.
ForceCloseAllHandles(CancellationToken)	A ForceCloseAllHandles(CancellationToken) operação fecha todos os identificadores abertos em um arquivo no serviço. Essa API destina-se a ser usada junto com GetHandlesAsync(CancellationToken) para forçar alças próximas que bloqueiam operações. Esses identificadores podem ter vazado ou perdido o controle de por clientes SMB. A API tem impacto no lado do cliente no identificador que está sendo fechado, incluindo erros visíveis do usuário devido a tentativas de leitura ou gravação de arquivos com falha. Essa API não se destina a ser usada como uma substituição ou alternativa para fechamento de SMB. Para obter mais informações, consulte Force Close Handles.
ForceCloseAllHandlesAsync(CancellationToken)	A ForceCloseAllHandlesAsync(CancellationToken) operação fecha todos os identificadores abertos em um arquivo no serviço. Essa API destina-se a ser usada junto com GetHandlesAsync(CancellationToken) para forçar alças próximas que bloqueiam operações. Esses identificadores podem ter vazado ou perdido o controle de por clientes SMB. A API tem impacto no lado do cliente no identificador que está sendo fechado, incluindo erros visíveis do usuário devido a tentativas de leitura ou gravação de arquivos com falha. Essa API não se destina a ser usada como uma substituição ou alternativa para fechamento de SMB. Para obter mais informações, consulte Force Close Handles.
ForceCloseHandle(String, CancellationToken)	A ForceCloseHandle(String, CancellationToken) operação fecha um identificador aberto em um arquivo no serviço. Ele dá suporte ao fechamento de um único identificador especificado por handleId. Essa API destina-se a ser usada junto com GetHandlesAsync(CancellationToken) para forçar alças próximas que bloqueiam operações. Esses identificadores podem ter vazado ou perdido o controle de por clientes SMB. A API tem impacto no lado do cliente no identificador que está sendo fechado, incluindo erros visíveis do usuário devido a tentativas de leitura ou gravação de arquivos com falha. Essa API não se destina a ser usada como uma substituição ou alternativa para fechamento de SMB. Para obter mais informações, consulte Force Close Handles.
ForceCloseHandleAsync(String, CancellationToken)	A ForceCloseHandleAsync(String, CancellationToken) operação fecha um identificador aberto em um arquivo no serviço. Ele dá suporte ao fechamento de um único identificador especificado por handleId. Essa API destina-se a ser usada junto com GetHandlesAsync(CancellationToken) para forçar alças próximas que bloqueiam operações. Esses identificadores podem ter vazado ou perdido o controle de por clientes SMB. A API tem impacto no lado do cliente no identificador que está sendo fechado, incluindo erros visíveis do usuário devido a tentativas de leitura ou gravação de arquivos com falha. Essa API não se destina a ser usada como uma substituição ou alternativa para fechamento de SMB. Para obter mais informações, consulte Force Close Handles.
GenerateSasUri(ShareFileSasPermissions, DateTimeOffset)	O GenerateSasUri(ShareFileSasPermissions, DateTimeOffset) retorna um Uri que gera um Uri de SAS (Assinatura de Acesso Compartilhado) do Serviço de Arquivo de Compartilhamento com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela credencial de chave compartilhada do cliente. Para marcar se o cliente puder assinar uma Sas de Serviço, consulte CanGenerateSasUri. Para obter mais informações, consulte Construindo uma SAS de serviço.
GenerateSasUri(ShareSasBuilder)	O GenerateSasUri(ShareSasBuilder) retorna um Uri que gera um Uri de SAS (Assinatura de Acesso Compartilhado) do Serviço de Arquivo de Compartilhamento com base nas propriedades do cliente e no construtor. A SAS é assinada pela credencial de chave compartilhada do cliente. Para marcar se o cliente puder assinar uma Sas de Serviço, consulte CanGenerateSasUri. Para obter mais informações, consulte Construindo uma SAS de serviço.
GetCopyAuthorizationHeaderAsync(ShareFileClient, CancellationToken)	Obtenha um ShareFileClientpara HttpAuthorization passar a autorização ao executar o serviço para a cópia de serviço em que o OAuth é necessário para autenticar a origem.
GetHandles(CancellationToken)	A GetHandles(CancellationToken) operação retorna uma sequência assíncrona dos identificadores abertos em um diretório ou arquivo. Enumerar os identificadores pode fazer várias solicitações para o serviço ao buscar todos os valores. Para obter mais informações, consulte Listar identificadores.
GetHandlesAsync(CancellationToken)	A GetHandlesAsync(CancellationToken) operação retorna uma sequência assíncrona dos identificadores abertos em um diretório ou arquivo. Enumerar os identificadores pode fazer várias solicitações para o serviço ao buscar todos os valores. Para obter mais informações, consulte Listar identificadores.
GetParentShareClientCore()	Crie um novo ShareClient que aponte para o contêiner pai deste ShareFileClient. O novo ShareClient usa o mesmo pipeline de política de solicitação que o ShareFileClient.
GetParentShareDirectoryClientCore()	Crie um novo ShareDirectoryClient que aponte para o contêiner pai deste ShareFileClient. O novo ShareDirectoryClient usa o mesmo pipeline de política de solicitação que o ShareFileClient.
GetProperties(ShareFileRequestConditions, CancellationToken)	A operação GetProperties(ShareFileRequestConditions, CancellationToken) retorna todos os metadados definidos pelo usuário, propriedades HTTP padrão e propriedades do sistema para o arquivo. Ela não retorna o conteúdo do arquivo. Para obter mais informações, consulte Obter propriedades do arquivo.
GetPropertiesAsync(ShareFileRequestConditions, CancellationToken)	A operação GetPropertiesAsync(ShareFileRequestConditions, CancellationToken) retorna todos os metadados definidos pelo usuário, propriedades HTTP padrão e propriedades do sistema para o arquivo. Ela não retorna o conteúdo do arquivo. Para obter mais informações, consulte Obter propriedades do arquivo.
GetRangeList(ShareFileGetRangeListOptions, CancellationToken)	Retorna a lista de intervalos válidos para um arquivo. Para obter mais informações, consulte Listar Intervalos.
GetRangeListAsync(ShareFileGetRangeListOptions, CancellationToken)	Retorna a lista de intervalos válidos para um arquivo. Para obter mais informações, consulte Listar Intervalos.
GetRangeListDiff(ShareFileGetRangeListDiffOptions, CancellationToken)	Retorna a lista de intervalos que foram alterados no arquivo desde que previousSnapshot foi obtido. Para obter mais informações, consulte Listar Intervalos.
GetRangeListDiffAsync(ShareFileGetRangeListDiffOptions, CancellationToken)	Retorna a lista de intervalos que foram alterados no arquivo desde que previousSnapshot foi obtido. Para obter mais informações, consulte Listar Intervalos.
OpenRead(ShareFileOpenReadOptions, CancellationToken)	Abre um fluxo para ler do arquivo. O fluxo só baixará o arquivo conforme o fluxo for lido.
OpenReadAsync(ShareFileOpenReadOptions, CancellationToken)	Abre um fluxo para ler do arquivo. O fluxo só baixará o arquivo conforme o fluxo for lido.
OpenWrite(Boolean, Int64, ShareFileOpenWriteOptions, CancellationToken)	Abre um fluxo para gravação no arquivo.
OpenWriteAsync(Boolean, Int64, ShareFileOpenWriteOptions, CancellationToken)	Abre um fluxo para gravação no arquivo.
Rename(String, ShareFileRenameOptions, CancellationToken)	Renomeia um arquivo. Essa API não dá suporte à renomeação de um arquivo de um compartilhamento para outro ou entre contas de armazenamento.
RenameAsync(String, ShareFileRenameOptions, CancellationToken)	Renomeia um arquivo. Essa API não dá suporte à renomeação de um arquivo de um compartilhamento para outro ou entre contas de armazenamento.
SetHttpHeaders(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)	A operação SetHttpHeaders(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken) define as propriedades do sistema no arquivo. Para obter mais informações, consulte Definir Propriedades do Arquivo.
SetHttpHeadersAsync(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken)	A operação SetHttpHeadersAsync(Nullable<Int64>, ShareFileHttpHeaders, FileSmbProperties, String, ShareFileRequestConditions, CancellationToken) define as propriedades do sistema no arquivo. Para obter mais informações, consulte Definir Propriedades do Arquivo.
SetMetadata(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken)	A SetMetadata(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken) operação define metadados definidos pelo usuário para o arquivo especificado como um ou mais pares nome-valor. Para obter mais informações, consulte Definir metadados de arquivo.
SetMetadataAsync(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken)	A SetMetadataAsync(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken) operação define metadados definidos pelo usuário para o arquivo especificado como um ou mais pares nome-valor. Para obter mais informações, consulte Definir metadados de arquivo.
StartCopy(Uri, ShareFileCopyOptions, CancellationToken)	Copia um blob ou arquivo para um arquivo de destino dentro da conta de armazenamento. Para obter mais informações, consulte Copiar Arquivo.
StartCopyAsync(Uri, ShareFileCopyOptions, CancellationToken)	Copia um blob ou arquivo para um arquivo de destino dentro da conta de armazenamento. Para obter mais informações, consulte Copiar Arquivo.
Upload(Stream, ShareFileUploadOptions, CancellationToken)	A Upload(Stream, ShareFileUploadOptions, CancellationToken) operação grava options.Stream.Stream em um arquivo. Para obter mais informações, consulte Colocar Intervalo.
UploadAsync(Stream, ShareFileUploadOptions, CancellationToken)	A UploadAsync(Stream, ShareFileUploadOptions, CancellationToken) operação grava options.Stream.Stream em um arquivo. Para obter mais informações, consulte Colocar Intervalo.
UploadRange(HttpRange, Stream, ShareFileUploadRangeOptions, CancellationToken)	A 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) operação grava content em um range de um arquivo. Para obter mais informações, consulte Colocar Intervalo.
UploadRangeAsync(HttpRange, Stream, ShareFileUploadRangeOptions, CancellationToken)	A 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) operação grava content em um range de um arquivo. Para obter mais informações, consulte Colocar Intervalo.
UploadRangeFromUri(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken)	A UploadRangeFromUri(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken) operação grava um intervalo de um Arquivo do Azure em outro arquivo do Azure. Essa API tem suporte apenas para a versão 2019-02-02 e superior.
UploadRangeFromUriAsync(Uri, HttpRange, HttpRange, ShareFileUploadRangeFromUriOptions, CancellationToken)	A Azure.Storage.Files.Shares.ShareFileClient.UploadRangeFromUriAsync(System.Uri,Azure.HttpRange,Azure.HttpRange,Azure.Storage.Files.Shares.Models.ShareFileRequestConditions,System.Threading.CancellationToken) operação grava um intervalo de um Arquivo do Azure em outro arquivo do Azure. Essa API tem suporte apenas para a versão 2019-02-02 e superior.
WithSnapshot(String)	Inicializa uma nova instância da ShareFileClient classe com uma origem idêntica Uri , mas o carimbo de data/hora especificado shareSnapshot . Para obter mais informações, consulte Compartilhamento de instantâneo.

Métodos de Extensão

GetShareLeaseClient(ShareFileClient, String)	Inicializa uma nova instância da classe ShareLeaseClient.
GetParentShareClient(ShareFileClient)	Crie um novo ShareClient que aponte para o contêiner pai deste ShareFileClient. O novo ShareClient usa o mesmo pipeline de política de solicitação que o ShareFileClient.
GetParentShareDirectoryClient(ShareFileClient)	Crie um novo ShareDirectoryClient que aponte para o contêiner pai deste ShareFileClient. O novo ShareDirectoryClient usa o mesmo pipeline de política de solicitação que o ShareFileClient.