ShareFileClient class

Referência

Pacote:: @azure/storage-file-share

Um ShareFileClient representa uma URL para um arquivo de Armazenamento do Azure.

Extends: StorageClient

Construtores

ShareFileClient(string, Credential_2 \| TokenCredential, ShareClientOptions)	Cria uma instância do ShareFileClient.
ShareFileClient(string, Pipeline, ShareClientConfig)	Cria uma instância do ShareFileClient.

Propriedades

name	O nome do arquivo
path	O caminho completo do arquivo
shareName	O nome do compartilhamento correspondente a este cliente de arquivo

Propriedades herdadas

accountName
url	Valor da cadeia de caracteres de URL.

Métodos

abortCopyFromURL(string, FileAbortCopyFromURLOptions)	Anula uma operação de Arquivo de Cópia pendente e deixa um arquivo de destino com comprimento zero e metadados completos. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-file
clearRange(number, number, FileClearRangeOptions)	Limpa o intervalo especificado e libera o espaço usado no armazenamento para esse intervalo.
create(number, FileCreateOptions)	Cria um novo arquivo ou substitui um arquivo. Observe que ele inicializa apenas o arquivo sem conteúdo. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/create-file
delete(FileDeleteOptions)	Remove o arquivo 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 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) Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2
deleteIfExists(FileDeleteOptions)	Remove o arquivo da conta de armazenamento se ele existir. 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 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) Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2
download(number, number, FileDownloadOptions)	Lê ou baixa um arquivo do sistema, incluindo seus metadados e propriedades. Em Node.js, os dados retornam em um fluxo legível `readableStreamBody` Em navegadores, os dados retornam em uma promessa `contentAsBlob` Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-file
downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions)	DISPONÍVEL APENAS NO RUNTIME NODE.JS. Baixa um arquivo do Azure em paralelo a um buffer. Deslocamento e contagem são opcionais, passe 0 para que ambos baixem o arquivo inteiro. Aviso: os buffers só podem dar suporte a arquivos de até cerca de um gigabyte em sistemas de 32 bits ou cerca de dois gigabytes em sistemas de 64 bits devido a limitações de Node.js/V8. Para arquivos maiores que esse tamanho, considere downloadToFile.
downloadToBuffer(number, number, FileDownloadToBufferOptions)	DISPONÍVEL APENAS NO RUNTIME NODE.JS Baixa um arquivo do Azure em paralelo a um buffer. Deslocamento e contagem são opcionais, passe 0 para que ambos baixem o arquivo inteiro Aviso: os buffers só podem dar suporte a arquivos de até cerca de um gigabyte em sistemas de 32 bits ou cerca de dois gigabytes em sistemas de 64 bits devido a limitações de Node.js/V8. Para arquivos maiores que esse tamanho, considere downloadToFile.
downloadToFile(string, number, number, FileDownloadOptions)	DISPONÍVEL APENAS NO RUNTIME NODE.JS. Baixa um Blob do Azure em um arquivo local. Falhará se o caminho de arquivo fornecido já for encerrado. Deslocamento e contagem são opcionais, passe 0 e indefinidos, respectivamente, para baixar todo o blob.
exists(FileExistsOptions)	Retornará true se o arquivo especificado existir; false caso contrário. OBSERVAÇÃO: use essa função com cuidado, pois um arquivo existente pode ser excluído por outros clientes ou aplicativos. Vice-versa, novos arquivos podem ser adicionados por outros clientes ou aplicativos após a conclusão dessa função.
forceCloseAllHandles(FileForceCloseHandlesOptions)	Force fechar todos os identificadores de um arquivo. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/force-close-handles
forceCloseHandle(string, FileForceCloseHandlesOptions)	Forçar o fechamento de um identificador específico para um arquivo. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/force-close-handles
generateSasUrl(FileGenerateSasUrlOptions)	Disponível somente para clientes construídos 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
getProperties(FileGetPropertiesOptions)	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. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-file-properties
getRangeList(FileGetRangeListOptions)	Retorna a lista de intervalos válidos para um arquivo.
getRangeListDiff(string, FileGetRangeListOptions)	Retorna a lista de intervalos que diferem entre um instantâneo de compartilhamento anterior e esse arquivo.
getShareLeaseClient(string)	Obtenha um ShareLeaseClient que gerencia concessões no arquivo.
listHandles(FileListHandlesOptions)	Retorna um iterador iterável assíncrono para listar todos os identificadores. na conta especificada. .byPage() retorna um iterador iterável assíncrono para listar os identificadores nas páginas.
rename(string, FileRenameOptions)	Renomeia um arquivo. Essa API dá suporte apenas à renomeação de um arquivo no mesmo compartilhamento.
resize(number, FileResizeOptions)	Redimensionar arquivo. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-properties
setHttpHeaders(FileHttpHeaders, FileSetHttpHeadersOptions)	Define cabeçalhos HTTP no arquivo. Se nenhuma opção for fornecida ou nenhum valor fornecido para os cabeçalhos HTTP do arquivo nas opções, esses cabeçalhos HTTP de arquivo sem um valor serão limpos. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-properties
setMetadata(Metadata, FileSetMetadataOptions)	Atualiza metadados definidos pelo usuário para o arquivo especificado. Se nenhum metadado definido no parâmetro de opção, os metadados do arquivo serão removidos. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-metadata
setProperties(FileProperties)	Define as propriedades no arquivo. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-properties
startCopyFromURL(string, FileStartCopyOptions)	Copia um blob ou arquivo para um arquivo de destino dentro da conta de armazenamento.
uploadData(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, FileParallelUploadOptions)	Cria um novo Arquivo do Azure ou substitui um Arquivo do Azure existente e carrega um Buffer(Node)/Blob/ArrayBuffer/ArrayBufferView nele.
uploadFile(string, FileParallelUploadOptions)	DISPONÍVEL SOMENTE EM NODE.JS RUNTIME. Cria um novo Arquivo do Azure ou substitui um Arquivo do Azure existente e carrega um arquivo local nele.
uploadRange(RequestBodyType, number, number, FileUploadRangeOptions)	Carregue um intervalo de bytes em um arquivo. Essa operação só pode ser chamada em um arquivo existente. Ele não alterará o tamanho, as propriedades ou os metadados do arquivo. O início e a contagem do intervalo devem ser especificados. O intervalo pode ter até 4 MB de tamanho.
uploadRangeFromURL(string, number, number, number, FileUploadRangeFromURLOptions)	Carregue um intervalo de bytes em um arquivo em que o conteúdo é lido da URL de outro arquivo. O intervalo pode ter até 4 MB de tamanho.
uploadResetableStream((offset: number, count?: number) => ReadableStream, number, FileParallelUploadOptions)	DISPONÍVEL SOMENTE EM NODE.JS RUNTIME. Aceita um Node.js fábrica de fluxo legível e carrega em blocos em um Arquivo do Azure. A fábrica de fluxo legível deve retornar uma Node.js fluxo legível a partir do deslocamento definido. O deslocamento é o deslocamento no arquivo do Azure a ser carregado.
uploadSeekableBlob((offset: number, size: number) => Blob, number, FileParallelUploadOptions)	DISPONÍVEL SOMENTE EM NAVEGADORES. Carrega um objeto Blob do navegador em um arquivo do Azure. Requer um blobFactory como a fonte de dados, que precisa retornar um objeto Blob com o deslocamento e o tamanho fornecidos.
uploadStream(Readable, number, number, number, FileUploadStreamOptions)	DISPONÍVEL SOMENTE EM NODE.JS RUNTIME. Cria um novo Arquivo do Azure ou substitui um Arquivo do Azure existente e, em seguida, carrega uma Node.js fluxo legível nele. Esse método tentará criar um Arquivo do Azure e, em seguida, começará a carregar parte por parte. O tamanho da parte é definido pelo `bufferSize` parâmetro . Verifique se o tamanho potencial do fluxo não excede o tamanho do arquivo. DICAS DE MELHORIA DE DESEMPENHO: O fluxo de entrada highWaterMark é melhor definir um mesmo valor com o parâmetro bufferSize, o que evitará operações buffer.concat().
withShareSnapshot(string)	Cria um novo objeto ShareFileClient idêntico à origem, mas com o carimbo de data/hora do instantâneo de compartilhamento especificado. Fornecer "" removerá o instantâneo e retornará uma URL para o ShareFileClient base.

Detalhes do construtor

Cria uma instância do ShareFileClient.

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

Parâmetros

url: string

Uma cadeia de caracteres de URL apontando para o arquivo de Armazenamento do Azure, como "https://myaccount.file.core.windows.net/myshare/mydirectory/file". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.file.core.windows.net/myshare/mydirectory/file?sasString". Esse método aceita uma URL codificada ou uma URL não codificada apontando para um arquivo. A cadeia de caracteres de URL codificada NÃO terá escape duas vezes, somente caracteres especiais no caminho da URL serão escapados. No entanto, se um nome de arquivo ou diretório incluir %, o nome do arquivo ou diretório deverá ser codificado na URL. Como um arquivo chamado "myfile%", a URL deve ser "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25".

credential: Credential | TokenCredential

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

options: ShareClientOptions

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

Cria uma instância do ShareFileClient.

new ShareFileClient(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

Detalhes da propriedade

O nome do arquivo

string name

Valor da propriedade

string

O caminho completo do arquivo

string path

Valor da propriedade

string

O nome do compartilhamento correspondente a este cliente de arquivo

string shareName

Valor da propriedade

string

Detalhes das propriedades herdadas

accountName: string

Valor da propriedade

string

Herdado de StorageClient.accountName

Valor da cadeia de caracteres de URL.

url: string

Valor da propriedade

string

Herdado de StorageClient.url

Detalhes do método

Anula uma operação de Arquivo de Cópia pendente e deixa um arquivo de destino com comprimento zero e metadados completos.

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

function abortCopyFromURL(copyId: string, options?: FileAbortCopyFromURLOptions): Promise<FileAbortCopyResponse>

Parâmetros

copyId: string

Id da operação Copiar Arquivo a ser anulada.

options: FileAbortCopyFromURLOptions

Opções para a operação anular cópia de arquivo da URL.

Retornos

Promise<FileAbortCopyResponse>

Limpa o intervalo especificado e libera o espaço usado no armazenamento para esse intervalo.

function clearRange(offset: number, contentLength: number, options?: FileClearRangeOptions): Promise<FileUploadRangeResponse>

Parâmetros

offset: number

contentLength: number

options: FileClearRangeOptions

Opções para a operação Limpar Intervalo de Arquivos.

Retornos

Promise<FileUploadRangeResponse>

Cria um novo arquivo ou substitui um arquivo. Observe que ele inicializa apenas o arquivo sem conteúdo.

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

function create(size: number, options?: FileCreateOptions): Promise<FileCreateResponse>

Parâmetros

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

Retornos

Promise<FileCreateResponse>

Dados de resposta para a operação Criação de Arquivos.

Exemplo de uso:

const content = "Hello world!";

// Create the file
await fileClient.create(content.length);
console.log("Created file successfully!");

// Then upload data to the file
await fileClient.uploadRange(content, 0, content.length);
console.log("Updated file successfully!")

Remove o arquivo 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 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)

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

function delete(options?: FileDeleteOptions): Promise<FileDeleteResponse>

Parâmetros

options: FileDeleteOptions

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

Retornos

Promise<FileDeleteResponse>

Dados de resposta para a operação De exclusão de arquivo.

Remove o arquivo da conta de armazenamento se ele existir. 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 de erro SharingViolation se o arquivo estiver aberto em um cliente SMB.

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

function deleteIfExists(options?: FileDeleteOptions): Promise<FileDeleteIfExistsResponse>

Parâmetros

options: FileDeleteOptions

Retornos

Promise<FileDeleteIfExistsResponse>

Lê ou baixa um arquivo do sistema, incluindo seus metadados e propriedades.

Em Node.js, os dados retornam em um fluxo legível readableStreamBody
Em navegadores, os dados retornam em uma promessa contentAsBlob

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

function download(offset?: number, count?: number, options?: FileDownloadOptions): Promise<FileDownloadResponseModel>

Parâmetros

offset: number

A partir da qual a posição do arquivo será baixado, maior ou igual a 0

count: number

Quantos dados devem ser baixados, maior que 0. Será baixado até o final quando indefinido

options: FileDownloadOptions

Opções para a operação de Download de Arquivos.

Retornos

Promise<FileDownloadResponseModel>

Dados de resposta para a operação de Download de Arquivos.

Uso de exemplo (Node.js):

// Download a file to a string
const downloadFileResponse = await fileClient.download();
console.log(
  "Downloaded file content:",
  (await streamToBuffer(downloadFileResponse.readableStreamBody)).toString()}
);

// A helper method used to read a Node.js readable stream into string
async function streamToBuffer(readableStream) {
  return new Promise((resolve, reject) => {
    const chunks = [];
    readableStream.on("data", (data) => {
      chunks.push(data instanceof Buffer ? data : Buffer.from(data));
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}

Uso de exemplo (navegadores):

// Download a file to a string
const downloadFileResponse = await fileClient.download(0);
console.log(
  "Downloaded file content:",
  await blobToString(await downloadFileResponse.blobBody)}
);

// A helper method used to convert a browser Blob into string.
export async function blobToString(blob: Blob): Promise<string> {
  const fileReader = new FileReader();
  return new Promise<string>((resolve, reject) => {
    fileReader.onloadend = (ev: any) => {
      resolve(ev.target!.result);
    };
    fileReader.onerror = reject;
    fileReader.readAsText(blob);
  });
}

DISPONÍVEL APENAS NO RUNTIME NODE.JS.

Baixa um arquivo do Azure em paralelo a um buffer. Deslocamento e contagem são opcionais, passe 0 para que ambos baixem o arquivo inteiro.

Aviso: os buffers só podem dar suporte a arquivos de até cerca de um gigabyte em sistemas de 32 bits ou cerca de dois gigabytes em sistemas de 64 bits devido a limitações de Node.js/V8. Para arquivos maiores que esse tamanho, considere downloadToFile.

function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: FileDownloadToBufferOptions): Promise<Buffer>

Parâmetros

buffer: Buffer

O buffer a ser preenchido deve ter um comprimento maior que a contagem

offset: number

De qual posição do Arquivo do Azure baixar

count: number

Quantos dados devem ser baixados. Será baixado até o final ao passar indefinido

options: FileDownloadToBufferOptions

Retornos

Promise<Buffer>

DISPONÍVEL APENAS NO RUNTIME NODE.JS

Baixa um arquivo do Azure em paralelo a um buffer. Deslocamento e contagem são opcionais, passe 0 para que ambos baixem o arquivo inteiro

function downloadToBuffer(offset?: number, count?: number, options?: FileDownloadToBufferOptions): Promise<Buffer>

Parâmetros

offset: number

De qual posição do arquivo do Azure baixar

count: number

Quantos dados devem ser baixados. Será baixado até o final ao passar indefinido

options: FileDownloadToBufferOptions

Retornos

Promise<Buffer>

DISPONÍVEL APENAS NO RUNTIME NODE.JS.

Baixa um Blob do Azure em um arquivo local. Falhará se o caminho de arquivo fornecido já for encerrado. Deslocamento e contagem são opcionais, passe 0 e indefinidos, respectivamente, para baixar todo o blob.

function downloadToFile(filePath: string, offset?: number, count?: number, options?: FileDownloadOptions): Promise<FileDownloadResponseModel>

Parâmetros

filePath: string

offset: number

A partir da qual a posição do blob de blocos será baixada.

count: number

Quantos dados devem ser baixados. Baixará até o final ao passar indefinido.

options: FileDownloadOptions

Opções para opções de download de Blob.

Retornos

Promise<FileDownloadResponseModel>

Os dados de resposta para a operação de download de blob, mas com readableStreamBody definido como indefinido, pois seu conteúdo já é lido e gravado em um arquivo local no caminho especificado.

Retornará true se o arquivo especificado existir; false caso contrário.

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

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

Parâmetros

options: FileExistsOptions

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

Retornos

Promise<boolean>

Force fechar todos os identificadores de um arquivo.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/force-close-handles

function forceCloseAllHandles(options?: FileForceCloseHandlesOptions): Promise<CloseHandlesInfo>

Parâmetros

options: FileForceCloseHandlesOptions

Opções para forçar a operação de fechamento de identificadores.

Retornos

Promise<CloseHandlesInfo>

Forçar o fechamento de um identificador específico para um arquivo.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/force-close-handles

function forceCloseHandle(handleId: string, options?: FileForceCloseHandlesOptions): Promise<FileForceCloseHandlesResponse>

Parâmetros

handleId: string

ID do identificador específico, não pode ser asterisco "*". Use forceCloseAllHandles() para fechar todos os identificadores.

options: FileForceCloseHandlesOptions

Retornos

Promise<FileForceCloseHandlesResponse>

Disponível somente para clientes construídos 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: FileGenerateSasUrlOptions): string

Parâmetros

options: FileGenerateSasUrlOptions

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.

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.

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

function getProperties(options?: FileGetPropertiesOptions): Promise<FileGetPropertiesResponse>

Parâmetros

options: FileGetPropertiesOptions

Opções para a operação Obter Propriedades do Arquivo.

Retornos

Promise<FileGetPropertiesResponse>

Dados de resposta para a operação Propriedades de Obtenção de Arquivo.

Retorna a lista de intervalos válidos para um arquivo.

function getRangeList(options?: FileGetRangeListOptions): Promise<FileGetRangeListResponse>

Parâmetros

options: FileGetRangeListOptions

Opções para a operação Lista de Intervalos de Obtenção de Arquivos.

Retornos

Promise<FileGetRangeListResponse>

Retorna a lista de intervalos que diferem entre um instantâneo de compartilhamento anterior e esse arquivo.

function getRangeListDiff(prevShareSnapshot: string, options?: FileGetRangeListOptions): Promise<FileGetRangeListDiffResponse>

Parâmetros

prevShareSnapshot: string

O parâmetro de instantâneo anterior é um valor datetime opaco que especifica o instantâneo de compartilhamento anterior com o qual comparar.

options: FileGetRangeListOptions

Retornos

Promise<FileGetRangeListDiffResponse>

Obtenha um ShareLeaseClient que gerencia concessões no arquivo.

function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient

Parâmetros

proposeLeaseId: string

ID de concessão proposta inicial.

Retornos

ShareLeaseClient

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

Retorna um iterador iterável assíncrono para listar todos os identificadores. na conta especificada.

.byPage() retorna um iterador iterável assíncrono para listar os identificadores nas páginas.

function listHandles(options?: FileListHandlesOptions): PagedAsyncIterableIterator<HandleItem, FileListHandlesResponse, PageSettings>

Parâmetros

options: FileListHandlesOptions

Opções para listar a operação de identificadores.

Um asyncIterableIterator que dá suporte à paginação.

Retornos

PagedAsyncIterableIterator<HandleItem, FileListHandlesResponse, PageSettings>

Renomeia um arquivo. Essa API dá suporte apenas à renomeação de um arquivo no mesmo compartilhamento.

function rename(destinationPath: string, options?: FileRenameOptions): Promise<{ destinationFileClient: ShareFileClient, fileRenameResponse: FileRenameResponse }>

Parâmetros

destinationPath: string

Especifica o caminho de destino para o qual renomear. O caminho será codificado para colocar em uma URL para especificar o destino.

options: FileRenameOptions

Opções para a operação de renomeação.

Retornos

Promise<{ destinationFileClient: ShareFileClient, fileRenameResponse: FileRenameResponse }>

Dados de resposta para a operação de renomeação de arquivo.

Exemplo de uso:


// Rename the file
await fileClient.rename(destinationPath);
console.log("Renamed file successfully!");

Redimensionar arquivo.

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

function resize(length: number, options?: FileResizeOptions): Promise<FileSetHTTPHeadersResponse>

Parâmetros

length: number

Redimensiona um arquivo para o tamanho especificado em bytes. Se o valor de byte especificado é menor do que o tamanho atual do arquivo, então todos os intervalos acima do valor de byte especificado são limpos.

options: FileResizeOptions

Opções para a operação de Redimensionamento de Arquivos.

Retornos

Promise<FileSetHTTPHeadersResponse>

Dados de resposta para a operação Cabeçalhos HTTP do Conjunto de Arquivos.

Define cabeçalhos HTTP no arquivo.

Se nenhuma opção for fornecida ou nenhum valor fornecido para os cabeçalhos HTTP do arquivo nas opções, esses cabeçalhos HTTP de arquivo sem um valor serão limpos.

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

function setHttpHeaders(fileHttpHeaders?: FileHttpHeaders, options?: FileSetHttpHeadersOptions): Promise<FileSetHTTPHeadersResponse>

Parâmetros

fileHttpHeaders: FileHttpHeaders

options: FileSetHttpHeadersOptions

Opções para a operação Defina Cabeçalhos HTTP de Conjunto de Arquivos.

Retornos

Promise<FileSetHTTPHeadersResponse>

Dados de resposta para a operação Cabeçalhos HTTP do Conjunto de Arquivos.

Atualiza metadados definidos pelo usuário para o arquivo especificado.

Se nenhum metadado definido no parâmetro de opção, os metadados do arquivo serão removidos.

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

function setMetadata(metadata?: Metadata, options?: FileSetMetadataOptions): Promise<FileSetMetadataResponse>

Parâmetros

metadata: Metadata

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

options: FileSetMetadataOptions

Opções para a operação de metadados de conjunto de arquivos.

Retornos

Promise<FileSetMetadataResponse>

Dados de resposta para a operação de metadados de conjunto de arquivos.

Define as propriedades no arquivo.

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

function setProperties(properties?: FileProperties): Promise<SetPropertiesResponse>

Parâmetros

properties: FileProperties

Propriedades do arquivo. Para cabeçalhos HTTP de arquivo (por exemplo, Content-Type), se nenhum valor for fornecido, os cabeçalhos HTTP existentes serão removidos. Para outras propriedades de arquivo (por exemplo, fileAttributes), se nenhum valor for fornecido, os valores existentes serão preservados.

Retornos

Promise<SetPropertiesResponse>

Copia um blob ou arquivo para um arquivo de destino dentro da conta de armazenamento.

function startCopyFromURL(copySource: string, options?: FileStartCopyOptions): Promise<FileStartCopyResponse>

Parâmetros

copySource: string

Especifica a URL do arquivo de origem ou blob, com até 2 KB de comprimento. Para copiar um arquivo para outro arquivo na mesma conta de armazenamento, você pode usar a Chave Compartilhada para autenticar o arquivo de origem. Se você estiver copiando um arquivo de outra conta de armazenamento ou se estiver copiando um blob da mesma conta de armazenamento ou de outra conta de armazenamento, deverá autenticar o arquivo de origem ou o blob usando uma assinatura de acesso compartilhado. Se a origem for um blob público, nenhuma autenticação será necessária para executar a operação de cópia. Um arquivo em um instantâneo de compartilhamento também pode ser especificado como uma fonte de cópia.

options: FileStartCopyOptions

Opções para a operação De início da cópia de arquivo.

Retornos

Promise<FileStartCopyResponse>

Cria um novo Arquivo do Azure ou substitui um Arquivo do Azure existente e carrega um Buffer(Node)/Blob/ArrayBuffer/ArrayBufferView nele.

function uploadData(data: Blob | ArrayBuffer | ArrayBufferView | Buffer, options?: FileParallelUploadOptions): Promise<void>

Parâmetros

data: Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer(Node), Blob, ArrayBuffer ou ArrayBufferView

options: FileParallelUploadOptions

Retornos

Promise<void>

DISPONÍVEL SOMENTE EM NODE.JS RUNTIME.

Cria um novo Arquivo do Azure ou substitui um Arquivo do Azure existente e carrega um arquivo local nele.

function uploadFile(filePath: string, options?: FileParallelUploadOptions): Promise<void>

Parâmetros

filePath: string

Caminho completo do arquivo local

options: FileParallelUploadOptions

Retornos

Promise<void>

Carregue um intervalo de bytes em um arquivo. Essa operação só pode ser chamada em um arquivo existente. Ele não alterará o tamanho, as propriedades ou os metadados do arquivo. O início e a contagem do intervalo devem ser especificados. O intervalo pode ter até 4 MB de tamanho.

function uploadRange(body: RequestBodyType, offset: number, contentLength: number, options?: FileUploadRangeOptions): Promise<FileUploadRangeResponse>

Parâmetros

body: HttpRequestBody

Blob, cadeia de caracteres, ArrayBuffer, ArrayBufferView ou uma função que retorna um novo fluxo legível cujo deslocamento é do início da fonte de dados.

offset: number

Deslocamento da posição de deslocamento do Arquivo do Azure de destino a ser carregado.

contentLength: number

Comprimento do corpo em bytes. Use Buffer.byteLength() para calcular o comprimento do corpo de uma cadeia de caracteres, incluindo caracteres não codificados em Base64/Hex.

options: FileUploadRangeOptions

Opções para a operação intervalo de upload de arquivos.

Retornos

Promise<FileUploadRangeResponse>

Dados de resposta para a operação Intervalo de Upload de Arquivos.

Exemplo de uso:

const content = "Hello world!";

// Create the file
await fileClient.create(content.length);
console.log("Created file successfully!");

// Then upload data to the file
await fileClient.uploadRange(content, 0, content.length);
console.log("Updated file successfully!")

Carregue um intervalo de bytes em um arquivo em que o conteúdo é lido da URL de outro arquivo. O intervalo pode ter até 4 MB de tamanho.

function uploadRangeFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: FileUploadRangeFromURLOptions): Promise<FileUploadRangeFromURLResponse>

Parâmetros

sourceURL: string

Especifique uma URL para a fonte de cópia, SAS (Assinatura de Acesso Compartilhado) talvez seja necessária para autenticação.

sourceOffset: number

O deslocamento de origem do qual copiar. Passe 0 para copiar do início do arquivo de origem.

destOffset: number

Deslocamento do arquivo de destino.

count: number

Número de bytes a serem carregados do arquivo de origem.

options: FileUploadRangeFromURLOptions

Opções para configurar a operação Arquivo – Carregar Intervalo da URL.

Retornos

Promise<FileUploadRangeFromURLResponse>

DISPONÍVEL SOMENTE EM NODE.JS RUNTIME.

Aceita um Node.js fábrica de fluxo legível e carrega em blocos em um Arquivo do Azure. A fábrica de fluxo legível deve retornar uma Node.js fluxo legível a partir do deslocamento definido. O deslocamento é o deslocamento no arquivo do Azure a ser carregado.

function uploadResetableStream(streamFactory: (offset: number, count?: number) => ReadableStream, size: number, options?: FileParallelUploadOptions): Promise<void>

Parâmetros

streamFactory: (offset: number, count?: number) => ReadableStream

Retorna uma Node.js fluxo legível a partir do deslocamento definido

size: number

Tamanho do arquivo do Azure

options: FileParallelUploadOptions

Retornos

Promise<void>

DISPONÍVEL SOMENTE EM NAVEGADORES.

Carrega um objeto Blob do navegador em um arquivo do Azure. Requer um blobFactory como a fonte de dados, que precisa retornar um objeto Blob com o deslocamento e o tamanho fornecidos.

function uploadSeekableBlob(blobFactory: (offset: number, size: number) => Blob, size: number, options?: FileParallelUploadOptions): Promise<void>

Parâmetros

blobFactory: (offset: number, size: number) => Blob

size: number

options: FileParallelUploadOptions

Retornos

Promise<void>

DISPONÍVEL SOMENTE EM NODE.JS RUNTIME.

Cria um novo Arquivo do Azure ou substitui um Arquivo do Azure existente e, em seguida, carrega uma Node.js fluxo legível nele. Esse método tentará criar um Arquivo do Azure e, em seguida, começará a carregar parte por parte. O tamanho da parte é definido pelo bufferSize parâmetro . Verifique se o tamanho potencial do fluxo não excede o tamanho do arquivo.

DICAS DE MELHORIA DE DESEMPENHO:

O fluxo de entrada highWaterMark é melhor definir um mesmo valor com o parâmetro bufferSize, o que evitará operações buffer.concat().

function uploadStream(stream: Readable, size: number, bufferSize: number, maxBuffers: number, options?: FileUploadStreamOptions): Promise<void>

Parâmetros

stream: Readable

Node.js fluxo legível. Deve ser menor ou igual ao tamanho do arquivo.

size: number

Tamanho do arquivo a ser criado. O tamanho máximo permitido é de 4 TB. Se esse valor for maior que o tamanho do fluxo, haverá bytes vazios na parte final do arquivo.

bufferSize: number

Tamanho de cada buffer alocado em bytes, também o tamanho da parte/intervalo durante o arquivo carregado. O tamanho deve ser maior que 0 e menor ou igual a 4 * 1024 * 1024 (4 MB)

maxBuffers: number

Buffers máximos serão alocados durante o carregamento, correlação positiva com simultaneidade máxima de carregamento

options: FileUploadStreamOptions

Retornos

Promise<void>

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

function withShareSnapshot(shareSnapshot: string): ShareFileClient

Parâmetros

shareSnapshot: string

O carimbo de data/hora do instantâneo de compartilhamento.

Retornos

ShareFileClient

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

Compartilhar via

ShareFileClient class

Construtores

Propriedades

Propriedades herdadas

Métodos

Detalhes do construtor

ShareFileClient(string, Credential_2 | TokenCredential, ShareClientOptions)

Parâmetros

ShareFileClient(string, Pipeline, ShareClientConfig)

Parâmetros

Detalhes da propriedade

name

Valor da propriedade

path

Valor da propriedade

shareName

Valor da propriedade

Detalhes das propriedades herdadas

accountName

Valor da propriedade

url

Valor da propriedade

Detalhes do método

abortCopyFromURL(string, FileAbortCopyFromURLOptions)

Parâmetros

Retornos

clearRange(number, number, FileClearRangeOptions)

Parâmetros

Retornos

create(number, FileCreateOptions)

Parâmetros

Retornos

delete(FileDeleteOptions)

Parâmetros

Retornos

deleteIfExists(FileDeleteOptions)

Parâmetros

Retornos

download(number, number, FileDownloadOptions)

Parâmetros

Retornos

downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions)

Parâmetros

Retornos

downloadToBuffer(number, number, FileDownloadToBufferOptions)

Parâmetros

Retornos

downloadToFile(string, number, number, FileDownloadOptions)

Parâmetros

Retornos

exists(FileExistsOptions)

Parâmetros

Retornos

forceCloseAllHandles(FileForceCloseHandlesOptions)

Parâmetros

Retornos

forceCloseHandle(string, FileForceCloseHandlesOptions)

Parâmetros

Retornos

generateSasUrl(FileGenerateSasUrlOptions)

Parâmetros

Retornos

getProperties(FileGetPropertiesOptions)

Parâmetros

Retornos

getRangeList(FileGetRangeListOptions)

Parâmetros

Retornos

getRangeListDiff(string, FileGetRangeListOptions)

Parâmetros

Retornos

getShareLeaseClient(string)

Parâmetros

Retornos

listHandles(FileListHandlesOptions)

Parâmetros

Retornos

rename(string, FileRenameOptions)

Parâmetros