ShareClient Classe

Definição

O ShareClient permite manipular os compartilhamentos do Armazenamento do Azure e seus diretórios e arquivos.

public class ShareClient
type ShareClient = class
Public Class ShareClient
Herança
ShareClient

Construtores

ShareClient()

Inicializa uma nova instância da ShareClient classe para simulação.

ShareClient(String, String)

Inicializa uma nova instância da classe ShareClient.

ShareClient(String, String, ShareClientOptions)

Inicializa uma nova instância da classe ShareClient.

ShareClient(Uri, AzureSasCredential, ShareClientOptions)

Inicializa uma nova instância da classe ShareClient.

Observe que a autenticação de credencial de token só é compatível com as GetPermission(String, CancellationToken)operações de nível de compartilhamento , GetPermissionAsync(String, CancellationToken)CreatePermission(String, CancellationToken), e CreatePermissionAsync(String, CancellationToken) .

ShareClient(Uri, ShareClientOptions)

Inicializa uma nova instância da classe ShareClient.

ShareClient(Uri, StorageSharedKeyCredential, ShareClientOptions)

Inicializa uma nova instância da classe ShareClient.

ShareClient(Uri, TokenCredential, ShareClientOptions)

Inicializa uma nova instância da classe ShareClient.

Observe que as únicas operações de nível de compartilhamento que dão suporte à autenticação de credencial de token são CreatePermission(String, CancellationToken), CreatePermissionAsync(String, CancellationToken), GetPermission(String, CancellationToken)e GetPermissionAsync(String, CancellationToken).

Esse construtor também permite a construção de um ShareServiceClient que pode ser usado para derivar um ShareClient que tem autenticação de credencial de token.

Observe também que ShareTokenIntent atualmente é necessário para autenticação de token.

Propriedades

AccountName

Obtém o nome da conta de armazenamento correspondente ao cliente de compartilhamento.

CanGenerateSasUri

Determina se o cliente é capaz de gerar uma SAS. Se o cliente for autenticado com um StorageSharedKeyCredential.

Name

Obtém o nome do compartilhamento.

Uri

Obtém o ponto de extremidade primário Uri do compartilhamento.

Métodos

Create(ShareCreateOptions, CancellationToken)

A operação Create(ShareCreateOptions, CancellationToken) cria um compartilhamento sob a conta especificada. Se já existir um compartilhamento com o mesmo nome, a operação falhará.

Para obter mais informações, consulte Criar Compartilhamento.

CreateAsync(ShareCreateOptions, CancellationToken)

A operação CreateAsync(ShareCreateOptions, CancellationToken) cria um compartilhamento sob a conta especificada. Se já existir um compartilhamento com o mesmo nome, a operação falhará.

Para obter mais informações, consulte Criar Compartilhamento.

CreateDirectory(String, IDictionary<String,String>, FileSmbProperties, String, CancellationToken)

A CreateDirectory(String, IDictionary<String,String>, FileSmbProperties, String, CancellationToken) operação cria um novo diretório nesse compartilhamento.

Para obter mais informações, consulte Criar Diretório.

CreateDirectoryAsync(String, IDictionary<String,String>, FileSmbProperties, String, CancellationToken)

A CreateDirectoryAsync(String, IDictionary<String,String>, FileSmbProperties, String, CancellationToken) operação cria um novo diretório nesse compartilhamento.

Para obter mais informações, consulte Criar Diretório.

CreateIfNotExists(ShareCreateOptions, CancellationToken)

A operação CreateIfNotExists(ShareCreateOptions, CancellationToken) cria um compartilhamento sob a conta especificada. Se um compartilhamento com o mesmo nome já existir, ele não será alterado.

Para obter mais informações, consulte Criar Compartilhamento.

CreateIfNotExistsAsync(IDictionary<String,String>, Nullable<Int32>, CancellationToken)

A operação CreateIfNotExistsAsync(IDictionary<String,String>, Nullable<Int32>, CancellationToken) cria um compartilhamento sob a conta especificada. Se um compartilhamento com o mesmo nome já existir, ele não será alterado.

Para obter mais informações, consulte Criar Compartilhamento.

CreateIfNotExistsAsync(ShareCreateOptions, CancellationToken)

A operação CreateIfNotExistsAsync(IDictionary<String,String>, Nullable<Int32>, CancellationToken) cria um compartilhamento sob a conta especificada. Se um compartilhamento com o mesmo nome já existir, ele não será alterado.

Para obter mais informações, consulte Criar Compartilhamento.

CreatePermission(String, CancellationToken)

Cria uma permissão (um descritor de segurança) no nível do compartilhamento. O descritor de segurança criado pode ser usado para os arquivos/diretórios no compartilhamento.

CreatePermissionAsync(String, CancellationToken)

Cria uma permissão (um descritor de segurança) no nível do compartilhamento. O descritor de segurança criado pode ser usado para os arquivos/diretórios no compartilhamento.

CreateSnapshot(IDictionary<String,String>, CancellationToken)

Cria uma instantâneo somente leitura de um compartilhamento.

Para obter mais informações, consulte Compartilhamento de instantâneos.

CreateSnapshotAsync(IDictionary<String,String>, CancellationToken)

Cria uma instantâneo somente leitura de um compartilhamento.

Para obter mais informações, consulte Compartilhamento de instantâneos.

Delete(ShareDeleteOptions, CancellationToken)

Marca o instantâneo de compartilhamento ou compartilhamento especificado para exclusão. O compartilhamento ou o compartilhamento instantâneo e todos os arquivos contidos nele serão excluídos posteriormente durante a coleta de lixo, o que pode levar vários minutos.

Para obter mais informações, consulte Excluir Compartilhamento.

DeleteAsync(ShareDeleteOptions, CancellationToken)

Marca o instantâneo de compartilhamento ou compartilhamento especificado para exclusão. O compartilhamento ou o compartilhamento instantâneo e todos os arquivos contidos nele serão excluídos posteriormente durante a coleta de lixo, o que pode levar vários minutos.

Para obter mais informações, consulte Excluir Compartilhamento.

DeleteDirectory(String, CancellationToken)

A operação DeleteDirectory(String, CancellationToken) remove o diretório vazio especificado.

Para obter mais informações, consulte Excluir Diretório.

DeleteDirectoryAsync(String, CancellationToken)

A operação DeleteDirectoryAsync(String, CancellationToken) remove o diretório vazio especificado.

Para obter mais informações, consulte Excluir Diretório.

DeleteIfExists(ShareDeleteOptions, CancellationToken)

Marca o instantâneo de compartilhamento ou compartilhamento especificado para exclusão, se existir.

Para obter mais informações, consulte Excluir Compartilhamento.

DeleteIfExistsAsync(ShareDeleteOptions, CancellationToken)

Marca o instantâneo de compartilhamento ou compartilhamento especificado para exclusão, se existir.

Para obter mais informações, consulte Excluir Compartilhamento.

Exists(CancellationToken)

A Exists(CancellationToken) operação pode ser chamada em um ShareClient para ver se o compartilhamento associado existe na conta de armazenamento no serviço de armazenamento.

ExistsAsync(CancellationToken)

A ExistsAsync(CancellationToken) operação pode ser chamada em um ShareClient para ver se o compartilhamento associado existe na conta de armazenamento no serviço de armazenamento.

GenerateSasUri(ShareSasBuilder)

O GenerateSasUri(ShareSasBuilder) retorna um Uri que gera um Uri de SAS (Assinatura de Acesso Compartilhado) do Serviço de Contêiner de Blob com base nas propriedades do cliente e no construtor passados. A SAS é assinada pela credencial de chave compartilhada do cliente.

Para marcar se o cliente for capaz de assinar uma Sas de Serviço, consulte CanGenerateSasUri.

Para obter mais informações, consulte Construindo uma SAS de serviço.

GenerateSasUri(ShareSasPermissions, DateTimeOffset)

O GenerateSasUri(ShareSasPermissions, DateTimeOffset) retorna um Uri que gera um URI de SAS (Assinatura de Acesso Compartilhado) do Serviço 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 for capaz de assinar uma Sas de Serviço, consulte CanGenerateSasUri.

Para obter mais informações, consulte Construindo uma SAS de serviço.

GetAccessPolicy(ShareFileRequestConditions, CancellationToken)

A GetAccessPolicy(ShareFileRequestConditions, CancellationToken) operação obtém as permissões para esse compartilhamento. As permissões indicam se os dados de compartilhamento podem ser acessados publicamente.

Para obter mais informações, consulte Obter ACL de compartilhamento.

GetAccessPolicyAsync(ShareFileRequestConditions, CancellationToken)

A GetAccessPolicyAsync(ShareFileRequestConditions, CancellationToken) operação obtém as permissões para esse compartilhamento. As permissões indicam se os dados de compartilhamento podem ser acessados publicamente.

Para obter mais informações, consulte Obter ACL de compartilhamento.

GetDirectoryClient(String)

Crie um novo ShareDirectoryClient objeto acrescentando directoryName ao final de Uri. O novo ShareDirectoryClient usa o mesmo pipeline de política de solicitação que o ShareClient.

GetParentServiceClientCore()

Crie um novo ShareServiceClient que aponte para o contêiner pai desse ShareClient. O novo ShareServiceClient usa o mesmo pipeline de política de solicitação que o ShareClient.

GetPermission(String, CancellationToken)

Obtém a permissão de arquivo na SDDL (Linguagem de Definição do Descritor de Segurança).

GetPermissionAsync(String, CancellationToken)

Obtém a permissão de arquivo na SDDL (Linguagem de Definição do Descritor de Segurança).

GetProperties(ShareFileRequestConditions, CancellationToken)

A GetProperties(ShareFileRequestConditions, CancellationToken) operação retorna todos os metadados definidos pelo usuário, propriedades HTTP padrão e propriedades do sistema para o compartilhamento.

Para obter mais informações, consulte Obter propriedades de compartilhamento.

GetPropertiesAsync(ShareFileRequestConditions, CancellationToken)

A GetPropertiesAsync(ShareFileRequestConditions, CancellationToken) operação retorna todos os metadados definidos pelo usuário, as propriedades HTTP padrão e as propriedades do sistema para o compartilhamento.

Para obter mais informações, consulte Obter propriedades de compartilhamento.

GetRootDirectoryClient()

Crie um ShareDirectoryClient objeto para a raiz do compartilhamento. O novo ShareDirectoryClient usa o mesmo pipeline de política de solicitação que o ShareClient.

GetStatistics(ShareFileRequestConditions, CancellationToken)

Recupera estatísticas relacionadas ao compartilhamento.

Para obter mais informações, consulte Obter estatísticas de compartilhamento.

GetStatisticsAsync(ShareFileRequestConditions, CancellationToken)

Recupera estatísticas relacionadas ao compartilhamento.

Para obter mais informações, consulte Obter estatísticas de compartilhamento.

SetAccessPolicy(IEnumerable<ShareSignedIdentifier>, ShareFileRequestConditions, CancellationToken)

A SetAccessPolicy(IEnumerable<ShareSignedIdentifier>, ShareFileRequestConditions, CancellationToken) operação define as permissões para o compartilhamento especificado. As permissões indicam se os dados de compartilhamento podem ser acessados publicamente.

Para obter mais informações, consulte Defina Compartilhar ACL.

SetAccessPolicyAsync(IEnumerable<ShareSignedIdentifier>, ShareFileRequestConditions, CancellationToken)

A SetAccessPolicyAsync(IEnumerable<ShareSignedIdentifier>, ShareFileRequestConditions, CancellationToken) operação define as permissões para o compartilhamento especificado. As permissões indicam se os dados de compartilhamento podem ser acessados publicamente.

Para obter mais informações, consulte Defina Compartilhar ACL.

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

A SetMetadata(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken) operação define metadados definidos pelo usuário para o compartilhamento especificado como um ou mais pares nome-valor.

Para obter mais informações, consulte Definir Metadados de Compartilhamento.

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

A SetMetadataAsync(IDictionary<String,String>, ShareFileRequestConditions, CancellationToken) operação define metadados definidos pelo usuário para o compartilhamento especificado como um ou mais pares nome-valor.

Para obter mais informações, consulte Definir Metadados de Compartilhamento.

SetProperties(ShareSetPropertiesOptions, CancellationToken)

Define as propriedades do compartilhamento.

Para obter mais informações, consulte Defina Propriedades de Compartilhamento.

SetPropertiesAsync(ShareSetPropertiesOptions, CancellationToken)

Define as propriedades do compartilhamento.

Para obter mais informações, consulte Defina Propriedades de Compartilhamento.

WithSnapshot(String)

Inicializa uma nova instância da ShareClient classe com uma origem idêntica Uri , mas o carimbo de data/hora especificado snapshot .

Para obter mais informações, consulte Compartilhamento de instantâneo.

Métodos de Extensão

GetShareLeaseClient(ShareClient, String)

Inicializa uma nova instância da classe ShareLeaseClient.

GetParentServiceClient(ShareClient)

Crie um novo ShareServiceClient que aponte para o contêiner pai deste ShareClient. O novo ShareServiceClient usa o mesmo pipeline de política de solicitação que o ShareClient.

Aplica-se a