ShareClient class

Referência

Pacote:: @azure/storage-file-share

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 de ShareClient.
ShareClient(string, Pipeline, ShareClientConfig)	Cria uma instância de ShareClient.
ShareClient(string, string, ShareClientOptions)

Propriedades

name

O nome da partilha

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á. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/create-share
createDirectory(string, DirectoryCreateOptions)	Cria um novo subdiretório sob esse compartilhamento. Visualizar 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 apenas inicializa o arquivo sem conteúdo. Visualizar 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. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/create-share
createPermission(string \| SharePermission, ShareCreatePermissionOptions)	Cria uma permissão de arquivo (um descritor de segurança) no nível de compartilhamento. O descritor de segurança criado pode ser usado para os arquivos/diretórios no compartilhamento. Visualizar 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 quaisquer diretórios ou arquivos contidos nele são excluídos posteriormente durante a coleta de lixo. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share
deleteDirectory(string, DirectoryDeleteOptions)	Remove o subdiretório vazio especificado sob este compartilhamento. Observe que o diretório deve estar vazio antes de poder ser excluído. Visualizar 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 é imediatamente removido do índice da conta de armazenamento e não está mais acessível aos clientes. Os dados do arquivo são posteriormente removidos do serviço durante a coleta de lixo. Excluir arquivo falhará com o código de status 409 (Conflito) e código de erro `SharingViolation` 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`) Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2
deleteIfExists(ShareDeleteMethodOptions)	Marca o compartilhamento especificado para exclusão, se existir. O compartilhamento e quaisquer diretórios ou arquivos contidos nele são excluídos posteriormente durante a coleta de lixo. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share
exists(ShareExistsOptions)	Retorna true se o recurso de compartilhamento Azrue representado por este cliente existir; falso caso contrário. NOTA: utilize esta função com cuidado, uma vez que uma partilha existente pode ser eliminada por outros clientes ou aplicações. Vice-versa, novos compartilhamentos podem ser adicionados por outros clientes ou aplicativos após a conclusão dessa função.
generateSasStringToSign(ShareGenerateSasUrlOptions)	Disponível apenas para ShareClient construído com uma credencial de chave compartilhada. Gera cadeia de caracteres para assinar um URI SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente transmitidos. O SAS é assinado pela credencial de chave compartilhada do cliente. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(ShareGenerateSasUrlOptions)	Disponível apenas para ShareClient construído com uma credencial de chave compartilhada. Gera um URI SAS (Service Shared Access Signature) com base nas propriedades do cliente e nos parâmetros passados. O SAS é assinado pela credencial de chave compartilhada do cliente. Visualizar 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: JavaScript Date 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". Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/get-share-acl
getDirectoryClient(string)	Cria um objeto ShareDirectoryClient.
getPermission(string, ShareGetPermissionOptions)	Obtém a linguagem SDDL (Security Descriptor Definition Language) para uma determinada chave de permissão de arquivo que indica um descritor de segurança. Visualizar 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. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/get-share-properties AVISO: O objeto `metadata` retornado na resposta terá suas teclas em minúsculas, mesmo que originalmente contivessem caracteres maiúsculos. Isso difere das chaves de metadados retornadas pelo método `listShares` de ShareServiceClient usando a opção `includeMetadata`, que manterá seu invólucro original.
getShareLeaseClient(string)	Obtenha um ShareLeaseClient que gerencia concessões no arquivo.
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 fornecido, a ACL de compartilhamento existente será removida. Quando você estabelece uma política de acesso armazenado em um compartilhamento, pode levar até 30 segundos para entrar em vigor. Durante esse intervalo, uma assinatura de acesso compartilhado associada à política de acesso armazenado falhará com o código de status 403 (Proibido), até que a política de acesso fique ativa. Visualizar 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 metadados definido no parâmetro option, os metadados de compartilhamento serão removidos. Visualizar 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

Cria uma instância de 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.

Cria uma instância de ShareClient.

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

Parâmetros

url: string

pipeline: Pipeline

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

options: ShareClientConfig

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 tempo de execução. ] 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 da partilha.

options: ShareClientOptions

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

Detalhes de Propriedade

O nome da partilha

string name

Valor de Propriedade

string

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 de Propriedade

ShareDirectoryClient

Detalhes da Propriedade Herdada

accountName: string

Valor de Propriedade

string

herdado de StorageClient.accountName

Valor da cadeia de caracteres de URL.

url: string

Valor de Propriedade

string

herdado de StorageClient.url

Detalhes de Método

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

Visualizar 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.

Devoluções

Promise<ShareCreateResponse>

Dados de resposta para a operação Share Create.

Cria um novo subdiretório sob esse compartilhamento.

Visualizar 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 de criação de diretório.

Devoluções

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

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

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

Visualizar 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 de criação de arquivo.

Devoluções

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

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

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

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

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

Parâmetros

options: ShareCreateOptions

Devoluções

Promise<ShareCreateIfNotExistsResponse>

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

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

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

Parâmetros

filePermission: string | SharePermission

Permissão de arquivo descrita no SDDL

options: ShareCreatePermissionOptions

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

Devoluções

Promise<ShareCreatePermissionResponse>

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.

Devoluções

Promise<ShareCreateSnapshotResponse>

Dados de resposta para a operação Share Create Snapshot.

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

Visualizar 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 Share Delete.

Devoluções

Promise<ShareDeleteResponse>

Dados de resposta para a operação Share Delete.

Remove o subdiretório vazio especificado sob este compartilhamento. Observe que o diretório deve estar vazio antes de poder ser excluído.

Visualizar 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 Directory Delete.

Devoluções

Promise<DirectoryDeleteResponse>

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

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

Excluir arquivo falhará com o código de status 409 (Conflito) e código de erro SharingViolation 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)

Visualizar 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 File Delete.

Devoluções

Promise<FileDeleteResponse>

Prometer dados de resposta de exclusão de arquivo.

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

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

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

Parâmetros

options: ShareDeleteMethodOptions

Devoluções

Promise<ShareDeleteIfExistsResponse>

Retorna true se o recurso de compartilhamento Azrue representado por este cliente existir; falso caso contrário.

NOTA: utilize esta função com cuidado, uma vez que uma partilha existente pode ser eliminada por outros clientes ou aplicações. 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 Existe.

Devoluções

Promise<boolean>

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

Gera cadeia de caracteres para assinar um URI SAS (Assinatura de Acesso Compartilhado de Serviço) com base nas propriedades e parâmetros do cliente transmitidos. O SAS é assinado pela credencial de chave compartilhada do cliente.

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

function generateSasStringToSign(options: ShareGenerateSasUrlOptions): string

Parâmetros

options: ShareGenerateSasUrlOptions

Parâmetros opcionais.

Devoluções

string

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

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

Gera um URI SAS (Service Shared Access Signature) com base nas propriedades do cliente e nos parâmetros passados. O SAS é assinado pela credencial de chave compartilhada do cliente.

Visualizar 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.

Devoluções

string

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

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

AVISO: JavaScript Date 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".

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

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

Parâmetros

options: ShareGetAccessPolicyOptions

Devoluções

Promise<ShareGetAccessPolicyResponse>

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

Cria um objeto ShareDirectoryClient.

function getDirectoryClient(directoryName: string): ShareDirectoryClient

Parâmetros

directoryName: string

Um nome de diretório

Devoluções

ShareDirectoryClient

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

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

Visualizar 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.

Devoluções

Promise<ShareGetPermissionResponse>

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

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

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

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

Parâmetros

options: ShareGetPropertiesOptions

Devoluções

Promise<ShareGetPropertiesResponse>

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

Obtenha um ShareLeaseClient que gerencia concessões no arquivo.

function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient

Parâmetros

proposeLeaseId: string

Proposta inicial de arrendamento Id.

Devoluções

ShareLeaseClient

Um novo objeto ShareLeaseClient para gerenciar concessões no arquivo.

Recupera estatísticas relacionadas ao compartilhamento.

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

Parâmetros

options: ShareGetStatisticsOptions

Devoluções

Promise<ShareGetStatisticsResponse>

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

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 fornecido, a ACL de compartilhamento existente será removida.

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

Visualizar 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 um ID exclusivo e detalhes da política de acesso.

options: ShareSetAccessPolicyOptions

Devoluções

Promise<ShareSetAccessPolicyResponse>

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

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

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

Visualizar 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 metadados for fornecido, todos os metadados de diretório existentes serão removidos.

options: ShareSetMetadataOptions

Devoluções

Promise<ShareSetMetadataResponse>

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

Define as propriedades do compartilhamento.

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

Parâmetros

options: ShareSetPropertiesOptions

Devoluções

Promise<ShareSetPropertiesResponse>

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

Aviso

Esta 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

options: ShareSetQuotaOptions

Devoluções

Promise<ShareSetQuotaResponse>

Dados de resposta para a operação Share Get 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 retornará uma URL para o compartilhamento base.

function withSnapshot(snapshot: string): ShareClient

Parâmetros

snapshot: string

O carimbo de data/hora do instantâneo.

Devoluções

ShareClient

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

Partilhar via

ShareClient class

Construtores

Propriedades

Propriedades Herdadas

Métodos

Detalhes do Construtor

ShareClient(string, Credential_2 | TokenCredential, ShareClientOptions)

Parâmetros

ShareClient(string, Pipeline, ShareClientConfig)

Parâmetros

ShareClient(string, string, ShareClientOptions)

Parâmetros

Detalhes de Propriedade

name

Valor de Propriedade

rootDirectoryClient

Valor de Propriedade

Detalhes da Propriedade Herdada

accountName

Valor de Propriedade

url

Valor de Propriedade

Detalhes de Método

create(ShareCreateOptions)

Parâmetros

Devoluções

createDirectory(string, DirectoryCreateOptions)

Parâmetros

Devoluções

createFile(string, number, FileCreateOptions)

Parâmetros

Devoluções

createIfNotExists(ShareCreateOptions)

Parâmetros

Devoluções

createPermission(string | SharePermission, ShareCreatePermissionOptions)

Parâmetros

Devoluções

createSnapshot(ShareCreateSnapshotOptions)

Parâmetros

Devoluções

delete(ShareDeleteMethodOptions)

Parâmetros

Devoluções

deleteDirectory(string, DirectoryDeleteOptions)

Parâmetros

Devoluções

deleteFile(string, FileDeleteOptions)

Parâmetros

Devoluções

deleteIfExists(ShareDeleteMethodOptions)

Parâmetros

Devoluções

exists(ShareExistsOptions)

Parâmetros

Devoluções

generateSasStringToSign(ShareGenerateSasUrlOptions)

Parâmetros

Devoluções

generateSasUrl(ShareGenerateSasUrlOptions)

Parâmetros

Devoluções

getAccessPolicy(ShareGetAccessPolicyOptions)

Parâmetros

Devoluções

getDirectoryClient(string)

Parâmetros

Devoluções

getPermission(string, ShareGetPermissionOptions)

Parâmetros

Devoluções

getProperties(ShareGetPropertiesOptions)

Parâmetros

Devoluções

getShareLeaseClient(string)

Parâmetros

Devoluções

getStatistics(ShareGetStatisticsOptions)

Parâmetros