ShareClient class

Cria uma instância do ShareClient.

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

Parâmetros

Cria uma instância do ShareClient.

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

Parâmetros

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

Parâmetros

O nome da partilha

string name

Valor de Propriedade

Obtém o cliente de diretório para o diretório de raiz desta partilha. Tenha em atenção que o diretório de raiz existe sempre e não pode ser eliminado.

Um novo objeto ShareDirectoryClient para o diretório de raiz.

ShareDirectoryClient rootDirectoryClient

Valor de Propriedade

accountName: string

Valor de Propriedade

Herdado de StorageClient.accountName

Valor da cadeia de URL.

url: string

Valor de Propriedade

Herdado de StorageClient.url

Cria uma nova partilha na conta especificada. Se a partilha 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

Devoluções

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

Cria um novo subdiretório nesta partilha.

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

Devoluções

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

Cria um novo ficheiro ou substitui um ficheiro no diretório de raiz desta partilha. Tenha em atenção que apenas inicializa o ficheiro 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

Devoluções

Dados de resposta de criação de ficheiros e o cliente de ficheiro correspondente.

Cria uma nova partilha na conta especificada. Se a partilha com o mesmo nome já existir, não será alterada.

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

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

Parâmetros

Devoluções

Cria uma permissão de ficheiro (um descritor de segurança) ao nível da partilha. O descritor de segurança criado pode ser utilizado para os ficheiros/diretórios na partilha.

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

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

Parâmetros

Devoluções

Cria um instantâneo só de leitura de uma partilha.

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

Parâmetros

Devoluções

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

Marca a partilha especificada para eliminação. A partilha e quaisquer diretórios ou ficheiros nele contidos são posteriormente eliminados durante a libertação da memória.

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

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

Parâmetros

Devoluções

Dados de resposta para a operação Partilhar Eliminação.

Remove o subdiretório vazio especificado nesta partilha. Tenha em atenção que o diretório tem de estar vazio antes de poder ser eliminado.

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

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

Parâmetros

Devoluções

Dados de resposta de eliminação de diretórios.

Remove um ficheiro no diretório raiz desta partilha da conta de armazenamento. Quando um ficheiro é eliminado com êxito, é imediatamente removido do índice da conta de armazenamento e já não está acessível aos clientes. Os dados do ficheiro são posteriormente removidos do serviço durante a recolha do lixo.

Eliminar Ficheiro falhará com o código de estado 409 (Conflito) e o código SharingViolation de erro se o ficheiro estiver aberto num cliente SMB.

Eliminar Ficheiro não é suportado num instantâneo de partilha, que é uma cópia só de leitura de uma partilha. Uma tentativa de executar esta operação num instantâneo de partilha 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

Devoluções

Prometer dados de resposta de Eliminação de Ficheiros.

Marca a partilha especificada para eliminação, se existir. A partilha e quaisquer diretórios ou ficheiros contidos na mesma são posteriormente eliminados durante a recolha de lixo.

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

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

Parâmetros

Devoluções

Devolve verdadeiro se o recurso de partilha do Azrue representado por este cliente existir; falso de outra forma.

NOTA: utilize esta função com cuidado, uma vez que uma partilha existente pode ser eliminada por outros clientes ou aplicações. As novas partilhas vice-versa podem ser adicionadas por outros clientes ou aplicações após a conclusão desta função.

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

Parâmetros

Devoluções

Apenas disponível para o ShareClient construído com uma credencial de chave partilhada.

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

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

function generateSasUrl(options: ShareGenerateSasUrlOptions): string

Parâmetros

Devoluções

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

Obtém as permissões para a partilha especificada. As permissões indicam se os dados de partilha podem ser acedidos publicamente.

AVISO: a Data javaScript poderá perder a precisão ao analisar a cadeia 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

Devoluções

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

Cria um objeto ShareDirectoryClient .

function getDirectoryClient(directoryName: string): ShareDirectoryClient

Parâmetros

Devoluções

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

Obtém a Linguagem de Definição do Descritor de Segurança (SDDL) para uma determinada chave de permissão de ficheiro 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

Devoluções

Devolve todos os metadados e propriedades do sistema definidos pelo utilizador para a partilha especificada.

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

AVISO: o metadata objeto devolvido na resposta terá as respetivas teclas em minúsculas, mesmo que tenham originalmente carateres em maiúsculas. Isto difere das chaves de metadados devolvidas pelo listShares método ShareServiceClient através da opção, que irá manter o includeMetadata seu invólucro original.

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

Parâmetros

Devoluções

Dados de resposta para a operação Partilhar Obter Propriedades.

Obtém estatísticas relacionadas com a partilha.

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

Parâmetros

Devoluções

Dados de resposta para a operação Partilhar Obter Estatísticas.

Define as permissões para a partilha especificada. As permissões indicam se os diretórios ou ficheiros numa partilha podem ser acedidos publicamente.

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

Quando estabelece uma política de acesso armazenado numa partilha, pode demorar até 30 segundos a entrar em vigor. Durante este intervalo, uma assinatura de acesso partilhado associada à política de acesso armazenado falhará com o código de estado 403 (Proibido), até que a política de acesso fique ativa.

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

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

Parâmetros

Devoluções

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

Define um ou mais pares nome-valor definidos pelo utilizador para a partilha especificada.

Se não for fornecida nenhuma opção ou nenhum metadados definidos no parâmetro de opção, os metadados de partilha 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

Devoluções

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

Define as propriedades da partilha.

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

Parâmetros

Devoluções

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

Define a quota para a partilha especificada.

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

Parâmetros

Devoluções

Dados de resposta para a operação Partilhar Obter Quota.

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 devolverá um URL à partilha base.

function withSnapshot(snapshot: string): ShareClient

Parâmetros

Devoluções

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