Compartilhar via


ShareClient class

Um ShareClient representa uma URL para o compartilhamento de Armazenamento do Azure, permitindo que você manipule seus diretórios e arquivos.

Extends

StorageClient

Construtores

ShareClient(string, Credential_2 | TokenCredential, ShareClientOptions)

Cria uma instância do ShareClient.

ShareClient(string, Pipeline, ShareClientConfig)

Cria uma instância do ShareClient.

ShareClient(string, string, ShareClientOptions)

Propriedades

name

O nome do compartilhamento

rootDirectoryClient

Obtém o cliente de diretório para o diretório raiz desse compartilhamento. Observe que o diretório raiz sempre existe e não pode ser excluído.

Um novo objeto ShareDirectoryClient para o diretório raiz.

Propriedades herdadas

accountName
url

Valor da cadeia de caracteres de URL.

Métodos

create(ShareCreateOptions)

Cria um novo compartilhamento na conta especificada. Se o compartilhamento com o mesmo nome já existir, a operação falhará.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/create-share

createDirectory(string, DirectoryCreateOptions)

Cria um novo subdiretório sob esse compartilhamento.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory

createFile(string, number, FileCreateOptions)

Cria um novo arquivo ou substitui um arquivo no diretório raiz desse compartilhamento. Observe que ele inicializa apenas o arquivo sem conteúdo.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/create-file

createIfNotExists(ShareCreateOptions)

Cria um novo compartilhamento na conta especificada. Se o compartilhamento com o mesmo nome já existir, ele não será alterado.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/create-share

createPermission(string, ShareCreatePermissionOptions)

Cria uma permissão de arquivo (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.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/create-permission

createSnapshot(ShareCreateSnapshotOptions)

Cria um instantâneo somente leitura de um compartilhamento.

delete(ShareDeleteMethodOptions)

Marca o compartilhamento especificado para exclusão. O compartilhamento e todos os diretórios ou arquivos contidos nele serão excluídos posteriormente durante a coleta de lixo.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share

deleteDirectory(string, DirectoryDeleteOptions)

Remove o subdiretório vazio especificado nesse compartilhamento. Observe que o diretório deve estar vazio antes que possa ser excluído.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-directory

deleteFile(string, FileDeleteOptions)

Remove um arquivo no diretório raiz desse compartilhamento da conta de armazenamento. Quando um arquivo é excluído com êxito, ele é removido imediatamente do índice da conta de armazenamento e se torna inacessível aos clientes. Os dados do arquivo são removidos posteriormente do serviço durante a coleta de lixo.

Excluir Arquivo falhará com o código de status 409 (Conflito) e o código SharingViolation de erro se o arquivo estiver aberto em um cliente SMB.

Não há suporte para Excluir Arquivo em um instantâneo de compartilhamento, que é uma cópia somente leitura de um compartilhamento. Uma tentativa de executar essa operação em um instantâneo de compartilhamento falhará com 400 (InvalidQueryParameterValue)

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2

deleteIfExists(ShareDeleteMethodOptions)

Marca o compartilhamento especificado para exclusão se ele existir. O compartilhamento e todos os diretórios ou arquivos contidos nele são posteriormente excluídos durante a coleta de lixo.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share

exists(ShareExistsOptions)

Retornará true se o recurso de compartilhamento do Azrue representado por esse cliente existir; false caso contrário.

OBSERVAÇÃO: use essa função com cuidado, pois um compartilhamento existente pode ser excluído por outros clientes ou aplicativos. Vice-versa, novos compartilhamentos podem ser adicionados por outros clientes ou aplicativos após a conclusão dessa função.

generateSasUrl(ShareGenerateSasUrlOptions)

Disponível apenas para ShareClient construído com uma credencial de chave compartilhada.

Gera um URI de SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela credencial de chave compartilhada do cliente.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

getAccessPolicy(ShareGetAccessPolicyOptions)

Obtém as permissões para o compartilhamento especificado. As permissões indicam se os dados de compartilhamento podem ser acessados publicamente.

AVISO: a Data do JavaScript potencialmente perderá a precisão ao analisar a cadeia de caracteres de início e expiração. Por exemplo, a nova Data("2018-12-31T03:44:23.8827891Z").toISOString() obterá "2018-12-31T03:44:23.882Z".

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-share-acl

getDirectoryClient(string)

Cria um objeto ShareDirectoryClient .

getPermission(string, ShareGetPermissionOptions)

Obtém o SDDL (Security Descriptor Definition Language) para uma determinada chave de permissão de arquivo que indica um descritor de segurança.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-permission

getProperties(ShareGetPropertiesOptions)

Retorna todos os metadados definidos pelo usuário e as propriedades do sistema para o compartilhamento especificado.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-share-properties

AVISO: o metadata objeto retornado na resposta terá suas chaves em letras minúsculas, mesmo que originalmente contivessem caracteres maiúsculos. Isso difere das chaves de metadados retornadas pelo listShares método do ShareServiceClient usando a opção includeMetadata , que manterá a maiúscula original.

getStatistics(ShareGetStatisticsOptions)

Recupera estatísticas relacionadas ao compartilhamento.

setAccessPolicy(SignedIdentifier[], ShareSetAccessPolicyOptions)

Define as permissões para o compartilhamento especificado. As permissões indicam se diretórios ou arquivos em um compartilhamento podem ser acessados publicamente.

Quando você define permissões para um compartilhamento, as permissões existentes são substituídas. Se nenhum shareAcl for fornecido, a ACL de compartilhamento existente será removida.

Quando você estabelece uma política de acesso armazenada em um compartilhamento, pode levar até 30 segundos para entrar em vigor. Durante esse intervalo, uma assinatura de acesso compartilhado que esteja associada à política de acesso armazenada falhará com o código de status 403 (Proibido) até que a política de acesso se torne ativa.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-share-acl

setMetadata(Metadata, ShareSetMetadataOptions)

Define um ou mais pares nome-valor definidos pelo usuário para o compartilhamento especificado.

Se nenhuma opção for fornecida ou nenhum metadado definido no parâmetro de opção, os metadados de compartilhamento serão removidos.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-share-metadata

setProperties(ShareSetPropertiesOptions)

Define as propriedades do compartilhamento.

setQuota(number, ShareSetQuotaOptions)

Define a cota para o compartilhamento especificado.

withSnapshot(string)

Cria um novo objeto ShareClient idêntico à origem, mas com o carimbo de data/hora do instantâneo especificado. Fornecer "" removerá o instantâneo e retornará uma URL para o compartilhamento base.

Detalhes do construtor

ShareClient(string, Credential_2 | TokenCredential, ShareClientOptions)

Cria uma instância do ShareClient.

new ShareClient(url: string, credential?: Credential_2 | TokenCredential, options?: ShareClientOptions)

Parâmetros

url

string

Uma cadeia de caracteres de URL apontando para o compartilhamento de arquivos do Armazenamento do Azure, como "https://myaccount.file.core.windows.net/share". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.file.core.windows.net/share?sasString".

credential

Credential | TokenCredential

Como AnonymousCredential ou StorageSharedKeyCredential. Se não for especificado, AnonymousCredential será usado.

options
ShareClientOptions

Opcional. Opções para configurar o pipeline HTTP.

ShareClient(string, Pipeline, ShareClientConfig)

Cria uma instância do ShareClient.

new ShareClient(url: string, pipeline: Pipeline, options?: ShareClientConfig)

Parâmetros

url

string

Uma cadeia de caracteres de URL apontando para o compartilhamento de arquivos do Armazenamento do Azure, como "https://myaccount.file.core.windows.net/share". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.file.core.windows.net/share?sasString".

pipeline
Pipeline

Chame newPipeline() para criar um pipeline padrão ou forneça um pipeline personalizado.

ShareClient(string, string, ShareClientOptions)

new ShareClient(connectionString: string, name: string, options?: ShareClientOptions)

Parâmetros

connectionString

string

Cadeia de conexão de conta ou uma cadeia de conexão SAS de uma conta de armazenamento do Azure. [ Observação - A cadeia de conexão da conta só pode ser usada em NODE.JS runtime. ] Exemplo de cadeia de conexão de conta –DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Exemplo de cadeia de conexão SAS – BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

name

string

Nome do compartilhamento.

options
ShareClientOptions

Opcional. Opções para configurar o pipeline HTTP.

Detalhes da propriedade

name

O nome do compartilhamento

string name

Valor da propriedade

string

rootDirectoryClient

Obtém o cliente de diretório para o diretório raiz desse compartilhamento. Observe que o diretório raiz sempre existe e não pode ser excluído.

Um novo objeto ShareDirectoryClient para o diretório raiz.

ShareDirectoryClient rootDirectoryClient

Valor da propriedade

Detalhes das propriedades herdadas

accountName

accountName: string

Valor da propriedade

string

Herdado de StorageClient.accountName

url

Valor da cadeia de caracteres de URL.

url: string

Valor da propriedade

string

Herdado de StorageClient.url

Detalhes do método

create(ShareCreateOptions)

Cria um novo compartilhamento na conta especificada. Se o compartilhamento com o mesmo nome já existir, a operação falhará.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/create-share

function create(options?: ShareCreateOptions): Promise<ShareCreateResponse>

Parâmetros

options
ShareCreateOptions

Opções para compartilhar a operação Criar.

Retornos

Dados de resposta para a operação Criar Compartilhamento.

createDirectory(string, DirectoryCreateOptions)

Cria um novo subdiretório sob esse compartilhamento.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory

function createDirectory(directoryName: string, options?: DirectoryCreateOptions): Promise<{ directoryClient: ShareDirectoryClient, directoryCreateResponse: DirectoryCreateResponse }>

Parâmetros

directoryName

string

options
DirectoryCreateOptions

Opções para a operação Criar diretório.

Retornos

Promise<{ directoryClient: ShareDirectoryClient, directoryCreateResponse: DirectoryCreateResponse }>

Dados de resposta de criação de diretório e o cliente de diretório correspondente.

createFile(string, number, FileCreateOptions)

Cria um novo arquivo ou substitui um arquivo no diretório raiz desse compartilhamento. Observe que ele inicializa apenas o arquivo sem conteúdo.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/create-file

function createFile(fileName: string, size: number, options?: FileCreateOptions): Promise<{ fileClient: ShareFileClient, fileCreateResponse: FileCreateResponse }>

Parâmetros

fileName

string

size

number

Especifica o tamanho máximo em bytes para o arquivo, até 4 TB.

options
FileCreateOptions

Opções para a operação Criação de Arquivo.

Retornos

Promise<{ fileClient: ShareFileClient, fileCreateResponse: FileCreateResponse }>

Dados de resposta de criação de arquivo e o cliente de arquivo correspondente.

createIfNotExists(ShareCreateOptions)

Cria um novo compartilhamento na conta especificada. Se o compartilhamento com o mesmo nome já existir, ele não será alterado.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/create-share

function createIfNotExists(options?: ShareCreateOptions): Promise<ShareCreateIfNotExistsResponse>

Parâmetros

Retornos

createPermission(string, ShareCreatePermissionOptions)

Cria uma permissão de arquivo (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.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/create-permission

function createPermission(filePermission: string, options?: ShareCreatePermissionOptions): Promise<ShareCreatePermissionResponse>

Parâmetros

filePermission

string

Permissão de arquivo descrita no SDDL

options
ShareCreatePermissionOptions

Opções para compartilhar a operação Criar Permissão.

Retornos

createSnapshot(ShareCreateSnapshotOptions)

Cria um instantâneo somente leitura de um compartilhamento.

function createSnapshot(options?: ShareCreateSnapshotOptions): Promise<ShareCreateSnapshotResponse>

Parâmetros

options
ShareCreateSnapshotOptions

Opções para compartilhar a operação Criar Instantâneo.

Retornos

Dados de resposta para a operação Criar Instantâneo de Compartilhamento.

delete(ShareDeleteMethodOptions)

Marca o compartilhamento especificado para exclusão. O compartilhamento e todos os diretórios ou arquivos contidos nele serão excluídos posteriormente durante a coleta de lixo.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share

function delete(options?: ShareDeleteMethodOptions): Promise<ShareDeleteResponse>

Parâmetros

options
ShareDeleteMethodOptions

Opções para a operação Compartilhar Exclusão.

Retornos

Dados de resposta para a operação Compartilhar Exclusão.

deleteDirectory(string, DirectoryDeleteOptions)

Remove o subdiretório vazio especificado nesse compartilhamento. Observe que o diretório deve estar vazio antes que possa ser excluído.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-directory

function deleteDirectory(directoryName: string, options?: DirectoryDeleteOptions): Promise<DirectoryDeleteResponse>

Parâmetros

directoryName

string

options
DirectoryDeleteOptions

Opções para a operação De exclusão de diretório.

Retornos

Dados de resposta de exclusão de diretório.

deleteFile(string, FileDeleteOptions)

Remove um arquivo no diretório raiz desse compartilhamento da conta de armazenamento. Quando um arquivo é excluído com êxito, ele é removido imediatamente do índice da conta de armazenamento e se torna inacessível aos clientes. Os dados do arquivo são removidos posteriormente do serviço durante a coleta de lixo.

Excluir Arquivo falhará com o código de status 409 (Conflito) e o código SharingViolation de erro se o arquivo estiver aberto em um cliente SMB.

Não há suporte para Excluir Arquivo em um instantâneo de compartilhamento, que é uma cópia somente leitura de um compartilhamento. Uma tentativa de executar essa operação em um instantâneo de compartilhamento falhará com 400 (InvalidQueryParameterValue)

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2

function deleteFile(fileName: string, options?: FileDeleteOptions): Promise<FileDeleteResponse>

Parâmetros

fileName

string

options
FileDeleteOptions

Opções para a operação De exclusão de arquivo.

Retornos

Dados de resposta de Exclusão de Arquivo de Promessa.

deleteIfExists(ShareDeleteMethodOptions)

Marca o compartilhamento especificado para exclusão se ele existir. O compartilhamento e todos os diretórios ou arquivos contidos nele são posteriormente excluídos durante a coleta de lixo.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share

function deleteIfExists(options?: ShareDeleteMethodOptions): Promise<ShareDeleteIfExistsResponse>

Parâmetros

Retornos

exists(ShareExistsOptions)

Retornará true se o recurso de compartilhamento do Azrue representado por esse cliente existir; false caso contrário.

OBSERVAÇÃO: use essa função com cuidado, pois um compartilhamento existente pode ser excluído por outros clientes ou aplicativos. Vice-versa, novos compartilhamentos podem ser adicionados por outros clientes ou aplicativos após a conclusão dessa função.

function exists(options?: ShareExistsOptions): Promise<boolean>

Parâmetros

options
ShareExistsOptions

opções para a operação Exists.

Retornos

Promise<boolean>

generateSasUrl(ShareGenerateSasUrlOptions)

Disponível apenas para ShareClient construído com uma credencial de chave compartilhada.

Gera um URI de SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela credencial de chave compartilhada do cliente.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: ShareGenerateSasUrlOptions): string

Parâmetros

options
ShareGenerateSasUrlOptions

Parâmetros opcionais.

Retornos

string

O URI de SAS que consiste no URI para o recurso representado por esse cliente, seguido pelo token SAS gerado.

getAccessPolicy(ShareGetAccessPolicyOptions)

Obtém as permissões para o compartilhamento especificado. As permissões indicam se os dados de compartilhamento podem ser acessados publicamente.

AVISO: a Data do JavaScript potencialmente perderá a precisão ao analisar a cadeia de caracteres de início e expiração. Por exemplo, a nova Data("2018-12-31T03:44:23.8827891Z").toISOString() obterá "2018-12-31T03:44:23.882Z".

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-share-acl

function getAccessPolicy(options?: ShareGetAccessPolicyOptions): Promise<ShareGetAccessPolicyResponse>

Parâmetros

Retornos

Dados de resposta para a operação Compartilhar Obter Política de Acesso.

getDirectoryClient(string)

Cria um objeto ShareDirectoryClient .

function getDirectoryClient(directoryName: string): ShareDirectoryClient

Parâmetros

directoryName

string

Um nome de diretório

Retornos

O objeto ShareDirectoryClient para o nome do diretório fornecido.

getPermission(string, ShareGetPermissionOptions)

Obtém o SDDL (Security Descriptor Definition Language) para uma determinada chave de permissão de arquivo que indica um descritor de segurança.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-permission

function getPermission(filePermissionKey: string, options?: ShareGetPermissionOptions): Promise<ShareGetPermissionResponse>

Parâmetros

filePermissionKey

string

Chave de permissão de arquivo que indica o descritor de segurança da permissão.

options
ShareGetPermissionOptions

Opções para compartilhar a operação Criar Permissão.

Retornos

getProperties(ShareGetPropertiesOptions)

Retorna todos os metadados definidos pelo usuário e as propriedades do sistema para o compartilhamento especificado.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-share-properties

AVISO: o metadata objeto retornado na resposta terá suas chaves em letras minúsculas, mesmo que originalmente contivessem caracteres maiúsculos. Isso difere das chaves de metadados retornadas pelo listShares método do ShareServiceClient usando a opção includeMetadata , que manterá a maiúscula original.

function getProperties(options?: ShareGetPropertiesOptions): Promise<ShareGetPropertiesResponse>

Parâmetros

Retornos

Dados de resposta para a operação Share Get Properties.

getStatistics(ShareGetStatisticsOptions)

Recupera estatísticas relacionadas ao compartilhamento.

function getStatistics(options?: ShareGetStatisticsOptions): Promise<ShareGetStatisticsResponse>

Parâmetros

Retornos

Dados de resposta para a operação Share Get Statistics.

setAccessPolicy(SignedIdentifier[], ShareSetAccessPolicyOptions)

Define as permissões para o compartilhamento especificado. As permissões indicam se diretórios ou arquivos em um compartilhamento podem ser acessados publicamente.

Quando você define permissões para um compartilhamento, as permissões existentes são substituídas. Se nenhum shareAcl for fornecido, a ACL de compartilhamento existente será removida.

Quando você estabelece uma política de acesso armazenada em um compartilhamento, pode levar até 30 segundos para entrar em vigor. Durante esse intervalo, uma assinatura de acesso compartilhado que esteja associada à política de acesso armazenada falhará com o código de status 403 (Proibido) até que a política de acesso se torne ativa.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-share-acl

function setAccessPolicy(shareAcl?: SignedIdentifier[], options?: ShareSetAccessPolicyOptions): Promise<ShareSetAccessPolicyResponse>

Parâmetros

shareAcl

SignedIdentifier[]

Matriz de identificadores assinados, cada um com uma ID exclusiva e detalhes da política de acesso.

Retornos

Dados de resposta para a operação Política de Acesso do Conjunto de Compartilhamentos.

setMetadata(Metadata, ShareSetMetadataOptions)

Define um ou mais pares nome-valor definidos pelo usuário para o compartilhamento especificado.

Se nenhuma opção for fornecida ou nenhum metadado definido no parâmetro de opção, os metadados de compartilhamento serão removidos.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-share-metadata

function setMetadata(metadata?: Metadata, options?: ShareSetMetadataOptions): Promise<ShareSetMetadataResponse>

Parâmetros

metadata
Metadata

Se nenhum metadado for fornecido, todos os metadados de diretório existentes serão removidos.

Retornos

Dados de resposta para a operação de Metadados do Conjunto de Compartilhamentos.

setProperties(ShareSetPropertiesOptions)

Define as propriedades do compartilhamento.

function setProperties(options?: ShareSetPropertiesOptions): Promise<ShareSetPropertiesResponse>

Parâmetros

Retornos

Dados de resposta para a operação Propriedades do Conjunto de Compartilhamentos.

setQuota(number, ShareSetQuotaOptions)

Aviso

Essa API foi preterida.

Use setProperties instead.

Define a cota para o compartilhamento especificado.

function setQuota(quotaInGB: number, options?: ShareSetQuotaOptions): Promise<ShareSetQuotaResponse>

Parâmetros

quotaInGB

number

Especifica o tamanho máximo do compartilhamento em gigabytes

Retornos

Dados de resposta para a operação Share Get Quota.

withSnapshot(string)

Cria um novo objeto ShareClient idêntico à origem, mas com o carimbo de data/hora do instantâneo especificado. Fornecer "" removerá o instantâneo e retornará uma URL para o compartilhamento base.

function withSnapshot(snapshot: string): ShareClient

Parâmetros

snapshot

string

O carimbo de data/hora do instantâneo.

Retornos

Um novo objeto ShareClient idêntico à origem, mas com o carimbo de data/hora do instantâneo especificado