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

Propriedades

name	O nome do arquivo
path	O caminho completo do arquivo
shareName	O nome de 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 cópia de arquivo pendente e deixa um arquivo de destino com comprimento zero e metadados completos. Visualizar 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 apenas inicializa o arquivo sem conteúdo. Visualizar 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 é 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 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) Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2
deleteIfExists(FileDeleteOptions)	Remove o arquivo da conta de armazenamento, se existir. 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 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) Visualizar 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. No Node.js, os dados retornam em um fluxo legível `readableStreamBody` Nos navegadores, os dados retornam em uma promessa `contentAsBlob` Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/get-file
downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions)	DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Baixa um arquivo do Azure em paralelo a um buffer. Deslocamento e contagem são opcionais, passe 0 para ambos para baixar o arquivo inteiro. Aviso: Os buffers só podem suportar 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 EM TEMPO DE EXECUÇÃO NODE.JS Baixa um arquivo do Azure em paralelo a um buffer. Deslocamento e contagem são opcionais, passe 0 para ambos para baixar o arquivo inteiro Aviso: Os buffers só podem suportar 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 EM TEMPO DE EXECUÇÃO NODE.JS. Baixa um Blob do Azure para um arquivo local. Falhará se o caminho do arquivo fornecido já for encerrado. Deslocamento e contagem são opcionais, passe 0 e indefinido, respectivamente, para baixar todo o blob.
exists(FileExistsOptions)	Retorna true se o arquivo especificado existir; falso caso contrário. NOTA: utilize esta função com cuidado, uma vez que um ficheiro existente pode ser eliminado por outros clientes ou aplicações. Vice-versa, novos arquivos podem ser adicionados por outros clientes ou aplicativos após a conclusão dessa função.
forceCloseAllHandles(FileForceCloseHandlesOptions)	Força o fechamento de todas as alças de um arquivo. Visualizar 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. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/force-close-handles
generateSasStringToSign(FileGenerateSasUrlOptions)	Disponível apenas para clientes construídos 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(FileGenerateSasUrlOptions)	Disponível apenas para clientes construídos 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
getProperties(FileGetPropertiesOptions)	Retorna todos os metadados definidos pelo usuário, propriedades HTTP padrão e propriedades do sistema para o arquivo. Ele não retorna o conteúdo do arquivo. Visualizar 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. Esta API suporta apenas a mudança de nome de um ficheiro na mesma partilha.
resize(number, FileResizeOptions)	Redimensione o arquivo. Visualizar 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 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. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-properties
setMetadata(Metadata, FileSetMetadataOptions)	Atualiza os metadados definidos pelo usuário para o arquivo especificado. Se nenhum metadados for definido no parâmetro option, os metadados do arquivo serão removidos. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-metadata
setProperties(FileProperties)	Define propriedades no arquivo. Visualizar 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 APENAS EM TEMPO DE EXECUÇÃO NODE.JS. 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 para um arquivo. Esta 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 para um ficheiro onde o conteúdo é lido a partir do URL de outro ficheiro. O intervalo pode ter até 4 MB de tamanho.
uploadResetableStream((offset: number, count?: number) => ReadableStream, number, FileParallelUploadOptions)	DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Aceita uma fábrica de fluxo legível Node.js e carrega em blocos para um arquivo do Azure. A fábrica de fluxo legível deve retornar um fluxo Node.js 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 APENAS EM NAVEGADORES. Carrega um objeto Blob do navegador em um arquivo do Azure. Requer um blobFactory como fonte de dados, que precisa retornar um objeto Blob com o deslocamento e o tamanho fornecidos.
uploadStream(Readable, number, number, number, FileUploadStreamOptions)	DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Cria um novo Arquivo do Azure ou substitui um Arquivo do Azure existente e, em seguida, carrega um fluxo Node.js Legível nele. Esse método tentará criar um arquivo do Azure e, em seguida, começará a carregar bloco por bloco. O tamanho do bloco é definido por `bufferSize` parâmetro. Certifique-se de que o tamanho potencial do fluxo não exceda 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 de 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 será escapada duas vezes, apenas 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 deve ser codificado na URL. Como um arquivo chamado "myfile%", o 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 de 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 de Propriedade

O nome do arquivo

string name

Valor de Propriedade

string

O caminho completo do arquivo

string path

Valor de Propriedade

string

O nome de compartilhamento correspondente a este cliente de arquivo

string shareName

Valor de Propriedade

string

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

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

Visualizar 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 File Abort Copy From URL.

Devoluções

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 File Clear Range.

Devoluções

Promise<FileUploadRangeResponse>

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

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

Devoluções

Promise<FileCreateResponse>

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

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 é 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 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)

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

Devoluções

Promise<FileDeleteResponse>

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

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

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

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

Parâmetros

options: FileDeleteOptions

Devoluções

Promise<FileDeleteIfExistsResponse>

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

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

Visualizar 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 de qual posição do arquivo para download, maior ou igual a 0

count: number

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

options: FileDownloadOptions

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

Devoluções

Promise<FileDownloadResponseModel>

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

Exemplo de utilização (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);
  });
}

Exemplo de utilização (browsers):

// 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 EM TEMPO DE EXECUÇÃO NODE.JS.

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

Aviso: Os buffers só podem suportar 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

Buffer para ser preenchido, deve ter comprimento maior do que contagem

offset: number

A partir de qual posição do Arquivo do Azure para baixar

count: number

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

options: FileDownloadToBufferOptions

Devoluções

Promise<Buffer>

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS

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

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

Parâmetros

offset: number

A partir de qual posição do arquivo do Azure para baixar

count: number

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

options: FileDownloadToBufferOptions

Devoluções

Promise<Buffer>

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS.

Baixa um Blob do Azure para um arquivo local. Falhará se o caminho do arquivo fornecido já for encerrado. Deslocamento e contagem são opcionais, passe 0 e indefinido, 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 de qual posição do blob bloco para download.

count: number

Quantos dados serão baixados. Fará o download até o final ao passar indefinido.

options: FileDownloadOptions

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

Devoluções

Promise<FileDownloadResponseModel>

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

Retorna true se o arquivo especificado existir; falso caso contrário.

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

Devoluções

Promise<boolean>

Força o fechamento de todas as alças de um arquivo.

Visualizar 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 alças de fechamento.

Devoluções

Promise<CloseHandlesInfo>

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

Visualizar 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 todas as alças.

options: FileForceCloseHandlesOptions

Devoluções

Promise<FileForceCloseHandlesResponse>

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

Parâmetros

options: FileGenerateSasUrlOptions

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

Parâmetros

options: FileGenerateSasUrlOptions

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.

Retorna todos os metadados definidos pelo usuário, propriedades HTTP padrão e propriedades do sistema para o arquivo. Ele não retorna o conteúdo do arquivo.

Visualizar 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 File Get Properties.

Devoluções

Promise<FileGetPropertiesResponse>

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

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

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

Parâmetros

options: FileGetRangeListOptions

Opções para File Get range List operação.

Devoluções

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 snapshot anterior é um valor DateTime opaco que especifica o snapshot de compartilhamento anterior com o qual comparar.

options: FileGetRangeListOptions

Devoluções

Promise<FileGetRangeListDiffResponse>

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.

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 manipula a operação.

Um asyncIterableIterator que suporta paginação.

Devoluções

PagedAsyncIterableIterator<HandleItem, FileListHandlesResponse, PageSettings>

Renomeia um arquivo. Esta API suporta apenas a mudança de nome de um ficheiro na mesma partilha.

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.

Devoluções

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!");

Redimensione o arquivo.

Visualizar 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 for menor que o tamanho atual do arquivo, todos os intervalos acima do valor de byte especificado serão limpos.

options: FileResizeOptions

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

Devoluções

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

Visualizar 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 File set HTTP Headers.

Devoluções

Promise<FileSetHTTPHeadersResponse>

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

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

Se nenhum metadados for definido no parâmetro option, os metadados do arquivo serão removidos.

Visualizar 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 não forem fornecidos metadados, todos os metadados de diretório existentes serão removidos

options: FileSetMetadataOptions

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

Devoluções

Promise<FileSetMetadataResponse>

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

Define propriedades no arquivo.

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

Devoluções

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 dentro da 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 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 File Start Copy.

Devoluções

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(Nó), Blob, ArrayBuffer ou ArrayBufferView

options: FileParallelUploadOptions

Devoluções

Promise<void>

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS.

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

Devoluções

Promise<void>

Carregue um intervalo de bytes para um arquivo. Esta 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, string, ArrayBuffer, ArrayBufferView ou uma função que retorna um novo fluxo legível cujo deslocamento é do início da fonte de dados.

offset: number

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 para uma cadeia de caracteres incluindo caracteres não codificados em Base64/Hex.

options: FileUploadRangeOptions

Opções para a operação File Upload Range.

Devoluções

Promise<FileUploadRangeResponse>

Dados de resposta para a operação Intervalo de Carregamento de Ficheiros.

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 para um ficheiro onde o conteúdo é lido a partir do URL de outro ficheiro. 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 um URL para a fonte de cópia, Assinatura de Acesso Compartilhado (SAS) pode ser necessária para autenticação.

sourceOffset: number

O deslocamento de origem para copiar. Passe 0 para copiar a partir 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 Arquivo - Intervalo de upload da operação de URL.

Devoluções

Promise<FileUploadRangeFromURLResponse>

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS.

Aceita uma fábrica de fluxo legível Node.js e carrega em blocos para um arquivo do Azure. A fábrica de fluxo legível deve retornar um fluxo Node.js 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

Devolve um fluxo Node.js legível a partir do deslocamento definido

size: number

Tamanho do arquivo do Azure

options: FileParallelUploadOptions

Devoluções

Promise<void>

DISPONÍVEL APENAS EM NAVEGADORES.

Carrega um objeto Blob do navegador em um arquivo do Azure. Requer um blobFactory como 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

Devoluções

Promise<void>

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS.

Cria um novo Arquivo do Azure ou substitui um Arquivo do Azure existente e, em seguida, carrega um fluxo Node.js Legível nele. Esse método tentará criar um arquivo do Azure e, em seguida, começará a carregar bloco por bloco. O tamanho do bloco é definido por bufferSize parâmetro. Certifique-se de que o tamanho potencial do fluxo não exceda 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 do que o tamanho do fluxo, haverá bytes vazios na cauda do arquivo.

bufferSize: number

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

maxBuffers: number

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

options: FileUploadStreamOptions

Devoluções

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.

Devoluções

ShareFileClient

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

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

name

Valor de Propriedade

path

Valor de Propriedade

shareName

Valor de Propriedade

Detalhes da Propriedade Herdada

accountName

Valor de Propriedade

url

Valor de Propriedade

Detalhes de Método

abortCopyFromURL(string, FileAbortCopyFromURLOptions)

Parâmetros

Devoluções

clearRange(number, number, FileClearRangeOptions)

Parâmetros

Devoluções

create(number, FileCreateOptions)

Parâmetros

Devoluções

delete(FileDeleteOptions)

Parâmetros

Devoluções

deleteIfExists(FileDeleteOptions)

Parâmetros

Devoluções

download(number, number, FileDownloadOptions)

Parâmetros

Devoluções

downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions)

Parâmetros

Devoluções

downloadToBuffer(number, number, FileDownloadToBufferOptions)

Parâmetros

Devoluções

downloadToFile(string, number, number, FileDownloadOptions)

Parâmetros

Devoluções

exists(FileExistsOptions)

Parâmetros

Devoluções

forceCloseAllHandles(FileForceCloseHandlesOptions)

Parâmetros

Devoluções

forceCloseHandle(string, FileForceCloseHandlesOptions)

Parâmetros

Devoluções

generateSasStringToSign(FileGenerateSasUrlOptions)

Parâmetros

Devoluções

generateSasUrl(FileGenerateSasUrlOptions)

Parâmetros

Devoluções

getProperties(FileGetPropertiesOptions)

Parâmetros

Devoluções

getRangeList(FileGetRangeListOptions)

Parâmetros

Devoluções

getRangeListDiff(string, FileGetRangeListOptions)

Parâmetros

Devoluções

getShareLeaseClient(string)

Parâmetros

Devoluções

listHandles(FileListHandlesOptions)

Parâmetros