ShareFileClient class

Paket:: @azure/storage-file-share

ShareFileClient mewakili URL ke file Azure Storage.

Memperluas: StorageClient

Konstruktor

ShareFileClient(string, Credential \| TokenCredential, ShareClientOptions)	Membuat instans ShareFileClient.
ShareFileClient(string, Pipeline, ShareClientConfig)	Membuat instans ShareFileClient.

Properti

name	Nama file
path	Jalur lengkap file
shareName	Nama berbagi yang sesuai dengan klien file ini

Properti yang Diwariskan

accountName
url	Nilai string URL.

Metode

abortCopyFromURL(string, FileAbortCopyFromURLOptions)	Membatalkan operasi Salin File yang tertunda, dan meninggalkan file tujuan dengan panjang nol dan metadata penuh. Lihat https://learn.microsoft.com/rest/api/storageservices/abort-copy-file
clearRange(number, number, FileClearRangeOptions)	Menghapus rentang yang ditentukan dan melepaskan ruang yang digunakan dalam penyimpanan untuk rentang tersebut.
create(number, FileCreateOptions)	Membuat file baru atau mengganti file. Perhatikan bahwa file hanya menginisialisasi file tanpa konten. Lihat https://learn.microsoft.com/rest/api/storageservices/create-file
createHardLink(string, FileCreateHardLinkOptions)	Hanya NFS. Membuat tautan keras ke file file yang ditentukan oleh jalur.
createSymbolicLink(string, FileCreateSymbolicLinkOptions)	Hanya NFS. Membuat tautan simbolis.
delete(FileDeleteOptions)	Menghapus file dari akun penyimpanan. Ketika file berhasil dihapus, file segera dihapus dari indeks akun penyimpanan dan tidak lagi dapat diakses oleh klien. Data file kemudian dihapus dari layanan selama pengumpulan sampah. Hapus File akan gagal dengan kode status 409 (Konflik) dan kode kesalahan SharingViolation jika file terbuka pada klien SMB. Hapus File tidak didukung pada salinan bayangan berbagi, yang merupakan salinan berbagi baca-saja. Upaya untuk melakukan operasi ini pada rekam jepret berbagi akan gagal dengan 400 (InvalidQueryParameterValue) Lihat https://learn.microsoft.com/rest/api/storageservices/delete-file2
deleteIfExists(FileDeleteOptions)	Menghapus file dari akun penyimpanan jika ada. Ketika file berhasil dihapus, file segera dihapus dari indeks akun penyimpanan dan tidak lagi dapat diakses oleh klien. Data file kemudian dihapus dari layanan selama pengumpulan sampah. Hapus File akan gagal dengan kode status 409 (Konflik) dan kode kesalahan SharingViolation jika file terbuka pada klien SMB. Hapus File tidak didukung pada salinan bayangan berbagi, yang merupakan salinan berbagi baca-saja. Upaya untuk melakukan operasi ini pada rekam jepret berbagi akan gagal dengan 400 (InvalidQueryParameterValue) Lihat https://learn.microsoft.com/rest/api/storageservices/delete-file2
download(number, number, FileDownloadOptions)	Membaca atau mengunduh file dari sistem, termasuk metadata dan propertinya. Di Node.js, data kembali dalam aliran yang dapat dibaca `readableStreamBody` Di browser, data kembali dalam `contentAsBlob` janji Lihat https://learn.microsoft.com/rest/api/storageservices/get-file
downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions)	HANYA TERSEDIA DALAM RUNTIME NODE.JS. Mengunduh file Azure secara paralel dengan buffer. Offset dan hitungan bersifat opsional, teruskan 0 untuk mengunduh seluruh file. Peringatan: Buffer hanya dapat mendukung file hingga sekitar satu gigabyte pada sistem 32-bit atau sekitar dua gigabyte pada sistem 64-bit karena keterbatasan Node.js/V8. Untuk file yang lebih besar dari ukuran ini, pertimbangkan downloadToFile.
downloadToBuffer(number, number, FileDownloadToBufferOptions)	HANYA TERSEDIA DALAM RUNTIME NODE.JS Mengunduh file Azure secara paralel dengan buffer. Offset dan hitungan bersifat opsional, teruskan 0 untuk mengunduh seluruh file Peringatan: Buffer hanya dapat mendukung file hingga sekitar satu gigabyte pada sistem 32-bit atau sekitar dua gigabyte pada sistem 64-bit karena keterbatasan Node.js/V8. Untuk file yang lebih besar dari ukuran ini, pertimbangkan downloadToFile.
downloadToFile(string, number, number, FileDownloadOptions)	HANYA TERSEDIA DALAM RUNTIME NODE.JS. Mengunduh Azure Blob ke file lokal. Gagal jika jalur file yang diberikan sudah keluar. Offset dan hitungan bersifat opsional, pass 0 dan undefined masing-masing untuk mengunduh seluruh blob.
exists(FileExistsOptions)	Mengembalikan true jika file yang ditentukan ada; false jika tidak. CATATAN: gunakan fungsi ini dengan hati-hati karena file yang ada mungkin dihapus oleh klien atau aplikasi lain. Sebaliknya, file baru mungkin ditambahkan oleh klien atau aplikasi lain setelah fungsi ini selesai.
forceCloseAllHandles(FileForceCloseHandlesOptions)	Tutup semua handel untuk file. Lihat https://learn.microsoft.com/rest/api/storageservices/force-close-handles
forceCloseHandle(string, FileForceCloseHandlesOptions)	Tutup paksa handel tertentu untuk file. Lihat https://learn.microsoft.com/rest/api/storageservices/force-close-handles
generateSasStringToSign(FileGenerateSasUrlOptions)	Hanya tersedia untuk klien yang dibangun dengan kredensial kunci bersama. Menghasilkan string untuk masuk ke URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh kredensial kunci bersama klien. Lihat https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(FileGenerateSasUrlOptions)	Hanya tersedia untuk klien yang dibangun dengan kredensial kunci bersama. Menghasilkan URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh kredensial kunci bersama klien. Lihat https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
getProperties(FileGetPropertiesOptions)	Mengembalikan semua metadata yang ditentukan pengguna, properti HTTP standar, dan properti sistem untuk file tersebut. Ini tidak mengembalikan konten file. Lihat https://learn.microsoft.com/rest/api/storageservices/get-file-properties
getRangeList(FileGetRangeListOptions)	Mengembalikan daftar rentang yang valid untuk file.
getRangeListDiff(string, FileGetRangeListOptions)	Mengembalikan daftar rentang yang berbeda antara salinan bayangan berbagi sebelumnya dan file ini.
getShareLeaseClient(string)	Dapatkan ShareLeaseClient yang mengelola sewa pada file.
getSymbolicLink(FileGetSymbolicLinkOptions)	Hanya NFS. Mendapatkan konten tautan simbolis.
listHandles(FileListHandlesOptions)	Mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan semua handel. di bawah akun yang ditentukan. .byPage() mengembalikan iterator yang dapat di-iterator asinkron untuk mencantumkan handel di halaman.
rename(string, FileRenameOptions)	Mengganti nama file. API ini hanya mendukung penggantian nama file dalam berbagi yang sama.
resize(number, FileResizeOptions)	Ubah ukuran file. Lihat https://learn.microsoft.com/rest/api/storageservices/set-file-properties
setHttpHeaders(FileHttpHeaders, FileSetHttpHeadersOptions)	Mengatur header HTTP pada file. Jika tidak ada opsi yang disediakan, atau tidak ada nilai yang disediakan untuk header HTTP file dalam opsi, header HTTP file ini tanpa nilai akan dihapus. Lihat https://learn.microsoft.com/rest/api/storageservices/set-file-properties
setMetadata(Metadata, FileSetMetadataOptions)	Memperbarui metadata yang ditentukan pengguna untuk file yang ditentukan. Jika tidak ada metadata yang ditentukan dalam parameter opsi, metadata file akan dihapus. Lihat https://learn.microsoft.com/rest/api/storageservices/set-file-metadata
setProperties(FileProperties)	Mengatur properti pada file. Lihat https://learn.microsoft.com/rest/api/storageservices/set-file-properties
startCopyFromURL(string, FileStartCopyOptions)	Menyalin blob atau file ke file tujuan dalam akun penyimpanan.
uploadData(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, FileParallelUploadOptions)	Membuat File Azure baru atau mengganti File Azure yang sudah ada, lalu mengunggah Buffer(Node)/Blob/ArrayBuffer/ArrayBufferView ke dalamnya.
uploadFile(string, FileParallelUploadOptions)	HANYA TERSEDIA DALAM RUNTIME NODE.JS. Membuat File Azure baru atau mengganti File Azure yang sudah ada, lalu mengunggah file lokal ke file tersebut.
uploadRange(RequestBodyType, number, number, FileUploadRangeOptions)	Unggah rentang byte ke file. Operasi ini hanya dapat dipanggil pada file yang ada. Ini tidak akan mengubah ukuran, properti, atau metadata file. Mulai dan hitungan rentang harus ditentukan. Rentangnya bisa berukuran hingga 4 MB.
uploadRangeFromURL(string, number, number, number, FileUploadRangeFromURLOptions)	Unggah rentang byte ke file tempat konten dibaca dari URL file lain. Rentangnya bisa berukuran hingga 4 MB.
uploadResetableStream((offset: number, count?: number) => ReadableStream, number, FileParallelUploadOptions)	HANYA TERSEDIA DALAM RUNTIME NODE.JS. Menerima Node.js pabrik aliran yang dapat dibaca, dan mengunggah dalam blok ke File Azure. Pabrik aliran yang dapat dibaca harus mengembalikan aliran Node.js Dapat Dibaca mulai dari offset yang ditentukan. Offset adalah offset dalam file Azure yang akan diunggah.
uploadSeekableBlob((offset: number, size: number) => Blob, number, FileParallelUploadOptions)	HANYA TERSEDIA DI BROWSER. Mengunggah objek Blob browser ke file Azure. Memerlukan blobFactory sebagai sumber data, yang perlu mengembalikan objek Blob dengan offset dan ukuran yang disediakan.
uploadStream(Readable, number, number, number, FileUploadStreamOptions)	HANYA TERSEDIA DALAM RUNTIME NODE.JS. Membuat File Azure baru atau mengganti File Azure yang sudah ada, lalu mengunggah aliran Node.js Dapat Dibaca ke dalamnya. Metode ini akan mencoba membuat File Azure, lalu mulai mengunggah gugus menurut gugus. Ukuran gugus didefinisikan oleh parameter `bufferSize`. Pastikan ukuran potensi aliran tidak melebihi ukuran file. TIPS PENINGKATAN PERFORMA: Input stream highWaterMark lebih baik mengatur nilai yang sama dengan parameter bufferSize, yang akan menghindari operasi Buffer.concat().
withShareSnapshot(string)	Membuat objek ShareFileClient baru yang identik dengan sumber tetapi dengan tanda waktu rekam jepret berbagi yang ditentukan. Berikan "" akan menghapus rekam jepret dan mengembalikan URL ke ShareFileClient dasar.

Detail Konstruktor

Membuat instans ShareFileClient.

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

Parameter

url: string

String URL yang menunjuk ke file Azure Storage, seperti "https://myaccount.file.core.windows.net/myshare/mydirectory/file". Anda dapat menambahkan SAS jika menggunakan AnonymousCredential, seperti "https://myaccount.file.core.windows.net/myshare/mydirectory/file?sasString". Metode ini menerima URL yang dikodekan atau URL yang tidak dikodekan yang menunjuk ke file. String URL yang dikodekan TIDAK akan diloloskan dua kali, hanya karakter khusus di jalur URL yang akan lolos. Namun, jika nama file atau direktori menyertakan %, nama file atau direktori harus dikodekan dalam URL. Seperti file bernama "myfile%", URL harus "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25".

credential: Credential | TokenCredential

Seperti , StorageSharedKeyCredential atau TokenCredential, Jika tidak ditentukan, AnonymousCredential digunakan.

options: ShareClientOptions

Optional. Opsi untuk mengonfigurasi alur HTTP.

Membuat instans ShareFileClient.

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

Parameter

url: string

pipeline: Pipeline

Panggil newPipeline() untuk membuat alur default, atau sediakan alur yang disesuaikan.

options: ShareClientConfig

Detail Properti

Nama file

string name

Nilai Properti

string

Jalur lengkap file

string path

Nilai Properti

string

Nama berbagi yang sesuai dengan klien file ini

string shareName

Nilai Properti

string

Detail Properti yang Diwariskan

accountName: string

Nilai Properti

string

Diwarisi Dari StorageClient.accountName

Nilai string URL.

url: string

Nilai Properti

string

Diwariskan Dari StorageClient.url

Detail Metode

Membatalkan operasi Salin File yang tertunda, dan meninggalkan file tujuan dengan panjang nol dan metadata penuh.

Lihat https://learn.microsoft.com/rest/api/storageservices/abort-copy-file

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

Parameter

copyId: string

Id operasi Salin File untuk dibatalkan.

options: FileAbortCopyFromURLOptions

Opsi untuk operasi Batalkan Salin Dari URL File.

Mengembalikan

Promise<FileAbortCopyResponse>

Menghapus rentang yang ditentukan dan melepaskan ruang yang digunakan dalam penyimpanan untuk rentang tersebut.

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

Parameter

offset: number

contentLength: number

options: FileClearRangeOptions

Opsi untuk operasi Rentang Hapus File.

Mengembalikan

Promise<FileUploadRangeResponse>

Membuat file baru atau mengganti file. Perhatikan bahwa file hanya menginisialisasi file tanpa konten.

Lihat https://learn.microsoft.com/rest/api/storageservices/create-file

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

Parameter

size: number

Menentukan ukuran maksimum dalam byte untuk file, hingga 4 TB.

options: FileCreateOptions

Opsi untuk operasi Buat File.

Mengembalikan

Promise<FileCreateResponse>

Data respons untuk operasi Buat File.

Contoh penggunaan:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

const shareName = "<share name>";
const directoryName = "<directory name>";
const directoryClient = serviceClient.getShareClient(shareName).getDirectoryClient(directoryName);

const content = "Hello World!";
const fileName = `newdirectory${+new Date()}`;
const fileClient = directoryClient.getFileClient(fileName);
await fileClient.create(content.length);
console.log(`Create file ${fileName} successfully`);

// Upload file range
await fileClient.uploadRange(content, 0, content.length);
console.log(`Upload file range "${content}" to ${fileName} successfully`);

Hanya NFS. Membuat tautan keras ke file file yang ditentukan oleh jalur.

function createHardLink(targetFile: string, options?: FileCreateHardLinkOptions): Promise<FileCreateHardLinkResponse>

Parameter

targetFile: string

Jalur file untuk membuat tautan keras ke, tidak termasuk berbagi. Misalnya: "targetDirectory/targetSubDirectory/.../targetFile"

options: FileCreateHardLinkOptions

Opsi untuk membuat operasi tautan keras.

Mengembalikan

Promise<FileCreateHardLinkResponse>

Hanya NFS. Membuat tautan simbolis.

function createSymbolicLink(linkText: string, options?: FileCreateSymbolicLinkOptions): Promise<FileCreateSymbolicLinkResponse>

Parameter

linkText: string

Jalur ke file asli, tautan simbolis menunjuk. Jalur adalah jenis string yang tidak diselesaikan dan disimpan apa adanya. Jalur dapat berupa jalur absolut atau jalur relatif tergantung pada konten yang disimpan dalam file tautan simbolis.

options: FileCreateSymbolicLinkOptions

Opsi untuk membuat operasi tautan keras.

Mengembalikan

Promise<FileCreateSymbolicLinkResponse>

Menghapus file dari akun penyimpanan. Ketika file berhasil dihapus, file segera dihapus dari indeks akun penyimpanan dan tidak lagi dapat diakses oleh klien. Data file kemudian dihapus dari layanan selama pengumpulan sampah.

Hapus File akan gagal dengan kode status 409 (Konflik) dan kode kesalahan SharingViolation jika file terbuka pada klien SMB.

Hapus File tidak didukung pada salinan bayangan berbagi, yang merupakan salinan berbagi baca-saja. Upaya untuk melakukan operasi ini pada rekam jepret berbagi akan gagal dengan 400 (InvalidQueryParameterValue)

Lihat https://learn.microsoft.com/rest/api/storageservices/delete-file2

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

Parameter

options: FileDeleteOptions

Opsi untuk operasi Penghapusan File.

Mengembalikan

Promise<FileDeleteResponse>

Data respons untuk operasi Penghapusan File.

Menghapus file dari akun penyimpanan jika ada. Ketika file berhasil dihapus, file segera dihapus dari indeks akun penyimpanan dan tidak lagi dapat diakses oleh klien. Data file kemudian dihapus dari layanan selama pengumpulan sampah.

Hapus File akan gagal dengan kode status 409 (Konflik) dan kode kesalahan SharingViolation jika file terbuka pada klien SMB.

Lihat https://learn.microsoft.com/rest/api/storageservices/delete-file2

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

Parameter

options: FileDeleteOptions

Mengembalikan

Promise<FileDeleteIfExistsResponse>

Membaca atau mengunduh file dari sistem, termasuk metadata dan propertinya.

Di Node.js, data kembali dalam aliran yang dapat dibaca readableStreamBody
Di browser, data kembali dalam contentAsBlob janji

Lihat https://learn.microsoft.com/rest/api/storageservices/get-file

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

Parameter

offset: number

Dari posisi file mana yang akan diunduh, lebih besar dari atau sama dengan 0

count: number

Berapa banyak data yang akan diunduh, lebih besar dari 0. Akan mengunduh ke akhir ketika tidak ditentukan

options: FileDownloadOptions

Opsi untuk operasi Pengunduhan File.

Mengembalikan

Promise<FileDownloadResponseModel>

Data respons untuk operasi Unduhan File.

Contoh penggunaan (Node.js):

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

const shareName = "<share name>";
const fileName = "<file name>";
const fileClient = serviceClient
  .getShareClient(shareName)
  .rootDirectoryClient.getFileClient(fileName);

// Get file content from position 0 to the end
// In Node.js, get downloaded data by accessing downloadFileResponse.readableStreamBody
const downloadFileResponse = await fileClient.download();
if (downloadFileResponse.readableStreamBody) {
  const buffer = await streamToBuffer(downloadFileResponse.readableStreamBody);
  console.log(`Downloaded file content: ${buffer.toString()}`);
}

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

Contoh penggunaan (browser):

import { ShareServiceClient } from "@azure/storage-file-share";

const account = "<account name>";
const sas = "<service Shared Access Signature Token>";

const serviceClient = new ShareServiceClient(`https://${account}.file.core.windows.net?${sas}`);

const shareName = "<share name>";
const fileName = "<file name>";
const fileClient = serviceClient
  .getShareClient(shareName)
  .rootDirectoryClient.getFileClient(fileName);

// Get file content from position 0 to the end
// In browsers, get downloaded data by accessing downloadFileResponse.blobBody
const downloadFileResponse = await fileClient.download(0);
if (downloadFileResponse.blobBody) {
  console.log(`Downloaded file content: ${(await downloadFileResponse.blobBody).text()}`);
}

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

Mengunduh file Azure secara paralel dengan buffer. Offset dan hitungan bersifat opsional, teruskan 0 untuk mengunduh seluruh file.

Peringatan: Buffer hanya dapat mendukung file hingga sekitar satu gigabyte pada sistem 32-bit atau sekitar dua gigabyte pada sistem 64-bit karena keterbatasan Node.js/V8. Untuk file yang lebih besar dari ukuran ini, pertimbangkan downloadToFile.

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

Parameter

buffer: Buffer

Buffer yang akan diisi, harus memiliki panjang yang lebih besar dari hitungan

offset: number

Dari posisi File Azure mana yang akan diunduh

count: number

Berapa banyak data yang akan diunduh. Akan mengunduh ke akhir saat melewati tidak terdefinis

options: FileDownloadToBufferOptions

Mengembalikan

Promise<Buffer>

HANYA TERSEDIA DALAM RUNTIME NODE.JS

Mengunduh file Azure secara paralel dengan buffer. Offset dan hitungan bersifat opsional, teruskan 0 untuk mengunduh seluruh file

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

Parameter

offset: number

Dari posisi file Azure mana yang akan diunduh

count: number

Berapa banyak data yang akan diunduh. Akan mengunduh ke akhir saat melewati tidak terdefinis

options: FileDownloadToBufferOptions

Mengembalikan

Promise<Buffer>

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

Mengunduh Azure Blob ke file lokal. Gagal jika jalur file yang diberikan sudah keluar. Offset dan hitungan bersifat opsional, pass 0 dan undefined masing-masing untuk mengunduh seluruh blob.

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

Parameter

filePath: string

offset: number

Dari posisi blob blok mana yang akan diunduh.

count: number

Berapa banyak data yang akan diunduh. Akan mengunduh ke akhir saat melewati tidak ditentukan.

options: FileDownloadOptions

Opsi untuk opsi pengunduhan Blob.

Mengembalikan

Promise<FileDownloadResponseModel>

Data respons untuk operasi pengunduhan blob, tetapi dengan ReadableStreamBody diatur ke tidak terdefinisi karena kontennya sudah dibaca dan ditulis ke dalam file lokal di jalur yang ditentukan.

Mengembalikan true jika file yang ditentukan ada; false jika tidak.

CATATAN: gunakan fungsi ini dengan hati-hati karena file yang ada mungkin dihapus oleh klien atau aplikasi lain. Sebaliknya, file baru mungkin ditambahkan oleh klien atau aplikasi lain setelah fungsi ini selesai.

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

Parameter

options: FileExistsOptions

opsi untuk operasi Ada.

Mengembalikan

Promise<boolean>

Tutup semua handel untuk file.

Lihat https://learn.microsoft.com/rest/api/storageservices/force-close-handles

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

Parameter

options: FileForceCloseHandlesOptions

Opsi untuk menutup paksa operasi handel.

Mengembalikan

Promise<CloseHandlesInfo>

Tutup paksa handel tertentu untuk file.

Lihat https://learn.microsoft.com/rest/api/storageservices/force-close-handles

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

Parameter

handleId: string

ID handel tertentu, tidak dapat berupa tanda bintang "*". Gunakan forceCloseAllHandles() untuk menutup semua handel.

options: FileForceCloseHandlesOptions

Mengembalikan

Promise<FileForceCloseHandlesResponse>

Hanya tersedia untuk klien yang dibangun dengan kredensial kunci bersama.

Menghasilkan string untuk masuk ke URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh kredensial kunci bersama klien.

Lihat https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: FileGenerateSasUrlOptions): string

Parameter

options: FileGenerateSasUrlOptions

Parameter opsional.

Mengembalikan

string

URI SAS yang terdiri dari URI ke sumber daya yang diwakili oleh klien ini, diikuti dengan token SAS yang dihasilkan.

Hanya tersedia untuk klien yang dibangun dengan kredensial kunci bersama.

Menghasilkan URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh kredensial kunci bersama klien.

Lihat https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: FileGenerateSasUrlOptions): string

Parameter

options: FileGenerateSasUrlOptions

Parameter opsional.

Mengembalikan

string

URI SAS yang terdiri dari URI ke sumber daya yang diwakili oleh klien ini, diikuti dengan token SAS yang dihasilkan.

Mengembalikan semua metadata yang ditentukan pengguna, properti HTTP standar, dan properti sistem untuk file tersebut. Ini tidak mengembalikan konten file.

Lihat https://learn.microsoft.com/rest/api/storageservices/get-file-properties

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

Parameter

options: FileGetPropertiesOptions

Opsi untuk operasi File Dapatkan Properti.

Mengembalikan

Promise<FileGetPropertiesResponse>

Data respons untuk operasi Properti Dapatkan File.

Mengembalikan daftar rentang yang valid untuk file.

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

Parameter

options: FileGetRangeListOptions

Opsi untuk operasi Daftar rentang Get File.

Mengembalikan

Promise<FileGetRangeListResponse>

Mengembalikan daftar rentang yang berbeda antara salinan bayangan berbagi sebelumnya dan file ini.

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

Parameter

prevShareSnapshot: string

Parameter rekam jepret sebelumnya adalah nilai DateTime buram yang menentukan rekam jepret berbagi sebelumnya untuk dibandingkan.

options: FileGetRangeListOptions

Mengembalikan

Promise<FileGetRangeListDiffResponse>

Dapatkan ShareLeaseClient yang mengelola sewa pada file.

function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient

Parameter

proposeLeaseId: string

Id sewa awal yang diusulkan.

Mengembalikan

ShareLeaseClient

Objek ShareLeaseClient baru untuk mengelola sewa pada file.

Hanya NFS. Mendapatkan konten tautan simbolis.

function getSymbolicLink(options?: FileGetSymbolicLinkOptions): Promise<FileGetSymbolicLinkResponse>

Parameter

options: FileGetSymbolicLinkOptions

Opsi untuk mendapatkan operasi tautan simbolis.

Mengembalikan

Promise<FileGetSymbolicLinkResponse>

Mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan semua handel. di bawah akun yang ditentukan.

.byPage() mengembalikan iterator yang dapat di-iterator asinkron untuk mencantumkan handel di halaman.

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

Parameter

options: FileListHandlesOptions

Opsi untuk mencantumkan operasi handel.

AsyncIterableIterator yang mendukung halaman.

Mengembalikan

PagedAsyncIterableIterator<HandleItem, FileListHandlesResponse, PageSettings>

Mengganti nama file. API ini hanya mendukung penggantian nama file dalam berbagi yang sama.

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

Parameter

destinationPath: string

Menentukan jalur tujuan yang akan diganti namanya. Jalur akan dikodekan untuk dimasukkan ke dalam URL untuk menentukan tujuan.

options: FileRenameOptions

Opsi untuk operasi penggantian nama.

Mengembalikan

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

Data respons untuk operasi penggantian nama file.

Contoh penggunaan:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

const shareName = "<share name>";
const directoryName = "<directory name>";
const fileName = "<file name>";
const destinationPath = "<destination path>";
const fileClient = serviceClient
  .getShareClient(shareName)
  .getDirectoryClient(directoryName)
  .getFileClient(fileName);

await fileClient.rename(destinationPath);

Ubah ukuran file.

Lihat https://learn.microsoft.com/rest/api/storageservices/set-file-properties

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

Parameter

length: number

Mengubah ukuran file ke ukuran yang ditentukan dalam byte. Jika nilai byte yang ditentukan kurang dari ukuran file saat ini, maka semua rentang di atas nilai byte yang ditentukan dihapus.

options: FileResizeOptions

Opsi untuk operasi Mengubah Ukuran File.

Mengembalikan

Promise<FileSetHTTPHeadersResponse>

Data respons untuk operasi Header HTTP Set File.

Mengatur header HTTP pada file.

Jika tidak ada opsi yang disediakan, atau tidak ada nilai yang disediakan untuk header HTTP file dalam opsi, header HTTP file ini tanpa nilai akan dihapus.

Lihat https://learn.microsoft.com/rest/api/storageservices/set-file-properties

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

Parameter

fileHttpHeaders: FileHttpHeaders

options: FileSetHttpHeadersOptions

Opsi untuk operasi Header HTTP Set File.

Mengembalikan

Promise<FileSetHTTPHeadersResponse>

Data respons untuk operasi Header HTTP Set File.

Memperbarui metadata yang ditentukan pengguna untuk file yang ditentukan.

Jika tidak ada metadata yang ditentukan dalam parameter opsi, metadata file akan dihapus.

Lihat https://learn.microsoft.com/rest/api/storageservices/set-file-metadata

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

Parameter

metadata: Metadata

Jika tidak ada metadata yang disediakan, semua metadata direktori yang ada akan dihapus

options: FileSetMetadataOptions

Opsi untuk operasi Set File Metadata.

Mengembalikan

Promise<FileSetMetadataResponse>

Data respons untuk operasi Metadata Set File.

Mengatur properti pada file.

Lihat https://learn.microsoft.com/rest/api/storageservices/set-file-properties

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

Parameter

properties: FileProperties

Properti file. Untuk header HTTP file(misalnya Content-Type), jika tidak ada nilai yang disediakan, header HTTP yang ada akan dihapus. Untuk properti file lainnya (misalnya fileAttributes), jika tidak ada nilai yang disediakan, nilai yang ada akan dipertahankan.

Mengembalikan

Promise<SetPropertiesResponse>

Menyalin blob atau file ke file tujuan dalam akun penyimpanan.

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

Parameter

copySource: string

Menentukan URL file sumber atau blob, panjangnya hingga 2 KB. Untuk menyalin file ke file lain dalam akun penyimpanan yang sama, Anda dapat menggunakan Kunci Bersama untuk mengautentikasi file sumber. Jika Anda menyalin file dari akun penyimpanan lain, atau jika Anda menyalin blob dari akun penyimpanan yang sama atau akun penyimpanan lain, maka Anda harus mengautentikasi file sumber atau blob menggunakan tanda tangan akses bersama. Jika sumbernya adalah blob publik, tidak ada autentikasi yang diperlukan untuk melakukan operasi penyalinan. File dalam salinan bayangan berbagi juga dapat ditentukan sebagai sumber salinan.

options: FileStartCopyOptions

Opsi untuk operasi Mulai Salin File.

Mengembalikan

Promise<FileStartCopyResponse>

Membuat File Azure baru atau mengganti File Azure yang sudah ada, lalu mengunggah Buffer(Node)/Blob/ArrayBuffer/ArrayBufferView ke dalamnya.

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

Parameter

data: Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer(Node), Blob, ArrayBuffer atau ArrayBufferView

options: FileParallelUploadOptions

Mengembalikan

Promise<void>

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

Membuat File Azure baru atau mengganti File Azure yang sudah ada, lalu mengunggah file lokal ke file tersebut.

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

Parameter

filePath: string

Jalur lengkap file lokal

options: FileParallelUploadOptions

Mengembalikan

Promise<void>

Unggah rentang byte ke file. Operasi ini hanya dapat dipanggil pada file yang ada. Ini tidak akan mengubah ukuran, properti, atau metadata file. Mulai dan hitungan rentang harus ditentukan. Rentangnya bisa berukuran hingga 4 MB.

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

Parameter

body: HttpRequestBody

Blob, string, ArrayBuffer, ArrayBufferView atau fungsi yang mengembalikan aliran Readable baru yang offset-nya berasal dari sumber data yang dimulai.

offset: number

Posisi offset file Azure tujuan untuk diunggah.

contentLength: number

Panjang tubuh dalam byte. Gunakan Buffer.byteLength() untuk menghitung panjang isi untuk string termasuk karakter non-Base64/Hex-encoded.

options: FileUploadRangeOptions

Opsi untuk operasi Rentang Unggahan File.

Mengembalikan

Promise<FileUploadRangeResponse>

Data respons untuk operasi Rentang Unggahan File.

Contoh penggunaan:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

const shareName = "<share name>";
const directoryName = "<directory name>";
const directoryClient = serviceClient.getShareClient(shareName).getDirectoryClient(directoryName);

const content = "Hello World!";
const fileName = `newdirectory${+new Date()}`;
const fileClient = directoryClient.getFileClient(fileName);
await fileClient.create(content.length);
console.log(`Create file ${fileName} successfully`);

// Upload file range
await fileClient.uploadRange(content, 0, content.length);
console.log(`Upload file range "${content}" to ${fileName} successfully`);

Unggah rentang byte ke file tempat konten dibaca dari URL file lain. Rentangnya bisa berukuran hingga 4 MB.

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

Parameter

sourceURL: string

Tentukan URL ke sumber salin, Tanda Tangan Akses Bersama (SAS) mungkin diperlukan untuk autentikasi.

sourceOffset: number

Offset sumber untuk disalin. Teruskan 0 untuk menyalin dari awal file sumber.

destOffset: number

Offset file tujuan.

count: number

Jumlah byte yang akan diunggah dari file sumber.

options: FileUploadRangeFromURLOptions

Opsi untuk mengonfigurasi operasi File - Unggah Rentang dari URL.

Mengembalikan

Promise<FileUploadRangeFromURLResponse>

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

Menerima Node.js pabrik aliran yang dapat dibaca, dan mengunggah dalam blok ke File Azure. Pabrik aliran yang dapat dibaca harus mengembalikan aliran Node.js Dapat Dibaca mulai dari offset yang ditentukan. Offset adalah offset dalam file Azure yang akan diunggah.

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

Parameter

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

Mengembalikan aliran Node.js dapat dibaca mulai dari offset yang ditentukan

size: number

Ukuran file Azure

options: FileParallelUploadOptions

Mengembalikan

Promise<void>

HANYA TERSEDIA DI BROWSER.

Mengunggah objek Blob browser ke file Azure. Memerlukan blobFactory sebagai sumber data, yang perlu mengembalikan objek Blob dengan offset dan ukuran yang disediakan.

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

Parameter

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

size: number

options: FileParallelUploadOptions

Mengembalikan

Promise<void>

HANYA TERSEDIA DALAM RUNTIME NODE.JS.

Membuat File Azure baru atau mengganti File Azure yang sudah ada, lalu mengunggah aliran Node.js Dapat Dibaca ke dalamnya. Metode ini akan mencoba membuat File Azure, lalu mulai mengunggah gugus menurut gugus. Ukuran gugus didefinisikan oleh parameter bufferSize. Pastikan ukuran potensi aliran tidak melebihi ukuran file.

TIPS PENINGKATAN PERFORMA:

Input stream highWaterMark lebih baik mengatur nilai yang sama dengan parameter bufferSize, yang akan menghindari operasi Buffer.concat().

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

Parameter

stream: Readable

Node.js aliran yang dapat dibaca. Harus kurang atau sama dengan ukuran file.

size: number

Ukuran file yang akan dibuat. Ukuran maksimum yang diizinkan adalah 4 TB. Jika nilai ini lebih besar dari ukuran aliran, akan ada byte kosong dalam ekor file.

bufferSize: number

Ukuran setiap buffer yang dialokasikan dalam byte, juga ukuran gugus/rentang selama file yang diunggah. Ukuran harus lebih besar dari 0 dan kurang dari atau sama dengan 4 * 1024 * 1024 (4MB)

maxBuffers: number

Buffer maks akan mengalokasikan selama pengunggahan, korelasi positif dengan konkurensi pengunggahan maks

options: FileUploadStreamOptions

Mengembalikan

Promise<void>

Membuat objek ShareFileClient baru yang identik dengan sumber tetapi dengan tanda waktu rekam jepret berbagi yang ditentukan. Berikan "" akan menghapus rekam jepret dan mengembalikan URL ke ShareFileClient dasar.

function withShareSnapshot(shareSnapshot: string): ShareFileClient

Parameter

shareSnapshot: string

Tanda waktu rekam jepret berbagi.

Mengembalikan

ShareFileClient

Objek ShareFileClient baru yang identik dengan sumber tetapi dengan tanda waktu rekam jepret berbagi yang ditentukan.

Bagikan melalui

ShareFileClient class

Konstruktor

Properti

Properti yang Diwariskan

Metode

Detail Konstruktor

ShareFileClient(string, Credential | TokenCredential, ShareClientOptions)

Parameter

ShareFileClient(string, Pipeline, ShareClientConfig)

Parameter

Detail Properti

name

Nilai Properti

path

Nilai Properti

shareName

Nilai Properti

Detail Properti yang Diwariskan

accountName

Nilai Properti

url

Nilai Properti

Detail Metode

abortCopyFromURL(string, FileAbortCopyFromURLOptions)

Parameter

Mengembalikan

clearRange(number, number, FileClearRangeOptions)

Parameter

Mengembalikan

create(number, FileCreateOptions)

Parameter

Mengembalikan

createHardLink(string, FileCreateHardLinkOptions)

Parameter

Mengembalikan

createSymbolicLink(string, FileCreateSymbolicLinkOptions)

Parameter

Mengembalikan

delete(FileDeleteOptions)

Parameter

Mengembalikan

deleteIfExists(FileDeleteOptions)

Parameter

Mengembalikan

download(number, number, FileDownloadOptions)

Parameter

Mengembalikan

downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions)

Parameter

Mengembalikan

downloadToBuffer(number, number, FileDownloadToBufferOptions)

Parameter

Mengembalikan

downloadToFile(string, number, number, FileDownloadOptions)

Parameter

Mengembalikan

exists(FileExistsOptions)

Parameter

Mengembalikan

forceCloseAllHandles(FileForceCloseHandlesOptions)

Parameter

Mengembalikan

forceCloseHandle(string, FileForceCloseHandlesOptions)

Parameter

Mengembalikan

generateSasStringToSign(FileGenerateSasUrlOptions)

Parameter

Mengembalikan

generateSasUrl(FileGenerateSasUrlOptions)

Parameter

Mengembalikan

getProperties(FileGetPropertiesOptions)

Parameter

Mengembalikan

getRangeList(FileGetRangeListOptions)

Parameter

Mengembalikan

getRangeListDiff(string, FileGetRangeListOptions)

Parameter