ShareFileClient class

Cria uma instância do ShareFileClient.

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

Parâmetros

Cria uma instância do ShareFileClient.

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

Parâmetros

O nome do ficheiro

string name

Valor de Propriedade

O caminho completo do ficheiro

string path

Valor de Propriedade

O nome da partilha correspondente a este cliente de ficheiro

string shareName

Valor de Propriedade

accountName: string

Valor de Propriedade

Herdado de StorageClient.accountName

Valor da cadeia de URL.

url: string

Valor de Propriedade

Herdado de StorageClient.url

Aborta uma operação de Ficheiro de Cópia pendente e deixa um ficheiro 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

Devoluções

Limpa o intervalo especificado e liberta o espaço utilizado no armazenamento para esse intervalo.

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

Parâmetros

Devoluções

Cria um novo ficheiro ou substitui um ficheiro. Tenha em atenção que apenas inicializa o ficheiro sem conteúdo.

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

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

Parâmetros

Devoluções

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

Utilização de exemplo:

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 ficheiro da conta de armazenamento. Quando um ficheiro é eliminado com êxito, é imediatamente removido do índice da conta de armazenamento e já não está acessível aos clientes. Os dados do ficheiro são posteriormente removidos do serviço durante a recolha do lixo.

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

A opção Eliminar Ficheiro não é suportada num instantâneo de partilha, que é uma cópia só de leitura de uma partilha. Uma tentativa de executar esta operação num instantâneo de partilha falhará com 400 (InvalidQueryParameterValue)

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

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

Parâmetros

Devoluções

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

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

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

A opção Eliminar Ficheiro não é suportada num instantâneo de partilha, que é uma cópia só de leitura de uma partilha. Uma tentativa de executar esta operação num instantâneo de partilha falhará com 400 (InvalidQueryParameterValue)

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

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

Parâmetros

Devoluções

Lê ou transfere um ficheiro do sistema, incluindo os respetivos metadados e propriedades.

• No Node.js, os dados são devolvidos num fluxo Legível readableStreamBody
• Nos browsers, os dados são devolvidos numa 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

Devoluções

Dados de resposta para a operação transferência de ficheiros.

Utilização 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);
  });
}

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

APENAS DISPONÍVEL NO NODE.JS RUNTIME.

Transfere um ficheiro do Azure em paralelo para uma memória intermédia. O deslocamento e a contagem são opcionais, passe 0 para ambos transferirem o ficheiro inteiro.

Aviso: as memórias intermédias só podem suportar ficheiros 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 ficheiros maiores do que este tamanho, considere downloadToFile.

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

Parâmetros

Devoluções

APENAS DISPONÍVEL NO NODE.JS RUNTIME

Transfere um ficheiro do Azure em paralelo para uma memória intermédia. Desvio e contagem são opcionais, passe 0 para ambos transferirem todo o ficheiro

Aviso: as memórias intermédias só podem suportar ficheiros 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 ficheiros maiores do que este tamanho, considere downloadToFile.

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

Parâmetros

Devoluções

APENAS DISPONÍVEL NO NODE.JS RUNTIME.

Transfere um Blob do Azure para um ficheiro local. Falha se o caminho de ficheiro especificado já sair. O deslocamento e a contagem são opcionais, passam 0 e não são definidos, respetivamente, para transferir todo o blob.

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

Parâmetros

Devoluções

Os dados de resposta para a operação de transferência de blobs, mas com readableStreamBody definidos como indefinidos, uma vez que o respetivo conteúdo já é lido e escrito num ficheiro local no caminho especificado.

Devolve verdadeiro se o ficheiro especificado existir; falso de outra forma.

NOTA: utilize esta função com cuidado, uma vez que um ficheiro existente pode ser eliminado por outros clientes ou aplicações. Os novos ficheiros vice-versa podem ser adicionados por outros clientes ou aplicações após a conclusão desta função.

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

Parâmetros

Devoluções

Forçar fechar todas as alças de um ficheiro.

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

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

Parâmetros

Devoluções

Forçar a fecho de uma alça específica para um ficheiro.

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

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

Parâmetros

Devoluções

Disponível apenas para clientes criados com uma credencial de chave partilhada.

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

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

function generateSasUrl(options: FileGenerateSasUrlOptions): string

Parâmetros

Devoluções

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

Devolve todos os metadados definidos pelo utilizador, propriedades HTTP padrão e propriedades do sistema para o ficheiro. Não devolve o conteúdo do ficheiro.

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

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

Parâmetros

Devoluções

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

Devolve a lista de intervalos válidos para um ficheiro.

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

Parâmetros

Devoluções

Devolve a lista de intervalos que diferem entre um instantâneo de partilha anterior e este ficheiro.

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

Parâmetros

Devoluções

Obtenha um ShareLeaseClient que gere as concessões no ficheiro.

function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient

Parâmetros

Devoluções

Um novo objeto ShareLeaseClient para gerir concessões no ficheiro.

Devolve um iterador iterável assíncrono para listar todas as alças. na conta especificada.

.byPage() devolve um iterador iterável assíncrono para listar as alças nas páginas.

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

Parâmetros

Devoluções

Muda o nome de um ficheiro. Esta API só suporta mudar o nome de um ficheiro na mesma partilha.

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

Parâmetros

Devoluções

Dados de resposta para a operação de mudança de nome do ficheiro.

Utilização de exemplo:

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

Redimensionar ficheiro.

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

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

Parâmetros

Devoluções

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

Define cabeçalhos HTTP no ficheiro.

Se não for fornecida nenhuma opção ou nenhum valor fornecido para os cabeçalhos HTTP do ficheiro nas opções, estes cabeçalhos HTTP de ficheiro 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

Devoluções

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

Atualiza os metadados definidos pelo utilizador para o ficheiro especificado.

Se não forem definidos metadados no parâmetro de opção, os metadados de ficheiro 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

Devoluções

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

Define as propriedades no ficheiro.

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

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

Parâmetros

Devoluções

Copia um blob ou ficheiro para um ficheiro de destino na conta de armazenamento.

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

Parâmetros

Devoluções

Cria um novo Ficheiro do Azure ou substitui um Ficheiro do Azure existente e, em seguida, carrega um Buffer(Node)/Blob/ArrayBuffer/ArrayBufferView para o mesmo.

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

Parâmetros

Devoluções

APENAS DISPONÍVEL NO NODE.JS RUNTIME.

Cria um novo Ficheiro do Azure ou substitui um Ficheiro do Azure existente e, em seguida, carrega um ficheiro local para o mesmo.

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

Parâmetros

Devoluções

Carregue um intervalo de bytes para um ficheiro. Esta operação só pode ser chamada num ficheiro existente. Não altera o tamanho, propriedades ou metadados do ficheiro. O início e a contagem do intervalo têm de 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

Devoluções

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

Utilização de exemplo:

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 os conteúdos são lidos 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

Devoluções

APENAS DISPONÍVEL NO NODE.JS RUNTIME.

Aceita um Node.js fábrica de fluxo legível e carrega em blocos para um Ficheiro do Azure. A fábrica de fluxo legível tem de devolver uma Node.js Fluxo legível a partir do desvio definido. O desvio é o desvio no ficheiro do Azure a carregar.

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

Parâmetros

Devoluções

APENAS DISPONÍVEL EM BROWSERS.

Carrega um objeto blob do browser para um ficheiro do Azure. Requer um blobFactory como a origem de dados, que precisa de devolver um objeto Blob com o desvio e o tamanho fornecidos.

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

Parâmetros

Devoluções

APENAS DISPONÍVEL NO NODE.JS RUNTIME.

Cria um novo Ficheiro do Azure ou substitui um Ficheiro do Azure existente e, em seguida, carrega uma Node.js fluxo Legível para o mesmo. Este método tentará criar um Ficheiro do Azure e, em seguida, iniciará o carregamento segmento a segmento. O tamanho do segmento é definido pelo bufferSize parâmetro . Certifique-se de que o tamanho potencial do fluxo não excede o tamanho do ficheiro.

SUGESTÕES 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

Devoluções

Cria um novo objeto ShareFileClient idêntico à origem, mas com o carimbo de data/hora do instantâneo de partilha especificado. Indique "" irá remover o instantâneo e devolver um URL ao ShareFileClient base.

function withShareSnapshot(shareSnapshot: string): ShareFileClient

Parâmetros

Devoluções

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