ShareFileClient class
يمثل ShareFileClient عنوان URL لملف تخزين Azure.
- يمتد
-
StorageClient
المنشئون
| Share |
إنشاء مثيل ShareFileClient. |
| Share |
إنشاء مثيل ShareFileClient. |
الخصائص الموروثة
| account |
|
| url | قيمة سلسلة عنوان URL. |
الأساليب
| abort |
إحباط عملية "ملف النسخ" المعلقة، وترك ملف وجهة بدون طول وبيانات تعريف كاملة. راجع https://learn.microsoft.com/rest/api/storageservices/abort-copy-file |
| clear |
مسح النطاق المحدد وإصدار المساحة المستخدمة في التخزين لهذا النطاق. |
| create(number, File |
إنشاء ملف جديد أو استبدال ملف. لاحظ أنه يقوم بتهيئة الملف بدون محتوى فقط. راجع https://learn.microsoft.com/rest/api/storageservices/create-file |
| create |
NFS فقط. إنشاء ارتباط ثابت إلى ملف الملف المحدد بواسطة المسار. |
| create |
NFS فقط. ينشئ رابطا رمزيا. |
| delete(File |
إزالة الملف من حساب التخزين. عند حذف ملف بنجاح، تتم إزالته على الفور من فهرس حساب التخزين ولم يعد يمكن للعملاء الوصول إليه. تتم إزالة بيانات الملف لاحقا من الخدمة أثناء تجميع البيانات المهملة. سيفشل حذف ملف مع رمز الحالة 409 (تعارض) ورمز الخطأ SharingViolation إذا كان الملف مفتوحا على عميل SMB. حذف ملف غير معتمد على لقطة مشاركة، وهي نسخة للقراءة فقط من المشاركة. ستفشل محاولة تنفيذ هذه العملية على لقطة مشاركة مع 400 (InvalidQueryParameterValue) راجع https://learn.microsoft.com/rest/api/storageservices/delete-file2 |
| delete |
إزالة الملف من حساب التخزين إذا كان موجودا. عند حذف ملف بنجاح، تتم إزالته على الفور من فهرس حساب التخزين ولم يعد يمكن للعملاء الوصول إليه. تتم إزالة بيانات الملف لاحقا من الخدمة أثناء تجميع البيانات المهملة. سيفشل حذف ملف مع رمز الحالة 409 (تعارض) ورمز الخطأ SharingViolation إذا كان الملف مفتوحا على عميل SMB. حذف ملف غير معتمد على لقطة مشاركة، وهي نسخة للقراءة فقط من المشاركة. ستفشل محاولة تنفيذ هذه العملية على لقطة مشاركة مع 400 (InvalidQueryParameterValue) راجع https://learn.microsoft.com/rest/api/storageservices/delete-file2 |
| download(number, number, File |
قراءة ملف من النظام أو تنزيله، بما في ذلك بيانات التعريف والخصائص الخاصة به.
راجع https://learn.microsoft.com/rest/api/storageservices/get-file |
| download |
متوفر فقط في وقت تشغيل NODE.JS. تنزيل ملف Azure بالتوازي مع مخزن مؤقت. الإزاحة والعد اختيارية، مرر 0 لكليهما لتنزيل الملف بأكمله. تحذير: يمكن أن تدعم المخازن المؤقتة ملفات تصل إلى حوالي غيغابايت واحد فقط على أنظمة 32 بت أو حوالي غيغابايت على أنظمة 64 بت بسبب قيود Node.js/V8. بالنسبة للملفات الأكبر من هذا الحجم، ضع في اعتبارك downloadToFile. |
| download |
متوفر فقط في وقت تشغيل NODE.JS تنزيل ملف Azure بالتوازي مع مخزن مؤقت. الإزاحة والعد اختيارية، وتمرير 0 لكليهما لتنزيل الملف بأكمله تحذير: يمكن أن تدعم المخازن المؤقتة ملفات تصل إلى حوالي غيغابايت واحد فقط على أنظمة 32 بت أو حوالي غيغابايت على أنظمة 64 بت بسبب قيود Node.js/V8. بالنسبة للملفات الأكبر من هذا الحجم، ضع في اعتبارك downloadToFile. |
| download |
متوفر فقط في وقت تشغيل NODE.JS. تنزيل Azure Blob إلى ملف محلي. يفشل إذا تم إنهاء مسار الملف المحدد بالفعل. الإزاحة والعد اختيارية، وتمرير 0 وغير معرفة على التوالي لتنزيل الكائن الثنائي كبير الحجم بأكمله. |
| exists(File |
إرجاع true إذا كان الملف المحدد موجودا؛ خطأ خلاف ذلك. ملاحظة: استخدم هذه الدالة بعناية حيث قد يتم حذف ملف موجود من قبل عملاء أو تطبيقات أخرى. قد تتم إضافة الملفات الجديدة بالعكس بواسطة عملاء أو تطبيقات أخرى بعد اكتمال هذه الدالة. |
| force |
فرض إغلاق كافة المقابض لملف. راجع https://learn.microsoft.com/rest/api/storageservices/force-close-handles |
| force |
فرض إغلاق مقبض معين لملف. راجع https://learn.microsoft.com/rest/api/storageservices/force-close-handles |
| generate |
متوفر فقط للعملاء الذين تم إنشاؤهم باستخدام بيانات اعتماد مفتاح مشترك. إنشاء سلسلة لتوقيع URI توقيع الوصول المشترك للخدمة (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة بيانات اعتماد المفتاح المشترك للعميل. راجع https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas |
| generate |
متوفر فقط للعملاء الذين تم إنشاؤهم باستخدام بيانات اعتماد مفتاح مشترك. إنشاء عنوان URI لتوقيع الوصول المشترك للخدمة (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة بيانات اعتماد المفتاح المشترك للعميل. راجع https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas |
| generate |
إنشاء عنوان URI لتوقيع الوصول المشترك للخدمة (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة إدخال بيانات اعتماد مفتاح تفويض المستخدم. راجع https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas |
| generate |
إنشاء عنوان URI لتوقيع الوصول المشترك للخدمة (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة إدخال بيانات اعتماد مفتاح تفويض المستخدم. راجع https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas |
| get |
إرجاع كافة بيانات التعريف المعرفة من قبل المستخدم وخصائص HTTP القياسية وخصائص النظام للملف. لا يقوم بإعادة محتوى الملف. راجع https://learn.microsoft.com/rest/api/storageservices/get-file-properties |
| get |
إرجاع قائمة النطاقات الصالحة لملف. |
| get |
إرجاع قائمة النطاقات التي تختلف بين لقطة مشاركة سابقة وهذا الملف. |
| get |
احصل على ShareLeaseClient الذي يدير عقود الإيجار على الملف. |
| get |
NFS فقط. الحصول على محتوى رابط رمزي. |
| list |
إرجاع مكرر غير متزامن قابل للتكبير لسرد جميع المقابض. ضمن الحساب المحدد. يقوم .byPage() بإرجاع مكرر غير متزامن قابل للتكريب لسرد المقابض في الصفحات. |
| rename(string, File |
إعادة تسمية ملف. تدعم واجهة برمجة التطبيقات هذه إعادة تسمية ملف في نفس المشاركة فقط. |
| resize(number, File |
تغيير حجم الملف. راجع https://learn.microsoft.com/rest/api/storageservices/set-file-properties |
| set |
تعيين رؤوس HTTP على الملف. إذا لم يتم توفير أي خيار، أو لم يتم توفير قيمة لرؤوس HTTP للملف في الخيارات، مسح رؤوس HTTP للملف هذه بدون قيمة. راجع https://learn.microsoft.com/rest/api/storageservices/set-file-properties |
| set |
تحديث بيانات التعريف المعرفة من قبل المستخدم للملف المحدد. إذا لم يتم تعريف بيانات التعريف في معلمة الخيار، فستتم إزالة بيانات تعريف الملف. راجع https://learn.microsoft.com/rest/api/storageservices/set-file-metadata |
| set |
تعيين خصائص على الملف. راجع https://learn.microsoft.com/rest/api/storageservices/set-file-properties |
| start |
نسخ كائن ثنائي كبير الحجم أو ملف إلى ملف وجهة داخل حساب التخزين. |
| upload |
إنشاء ملف Azure جديد أو استبدال ملف Azure موجود، ثم تحميل مخزن مؤقت (عقدة)/Blob/ArrayBuffer/ArrayBufferView إليه. |
| upload |
متوفر فقط في وقت تشغيل NODE.JS. إنشاء ملف Azure جديد أو استبدال ملف Azure موجود، ثم تحميل ملف محلي إليه. |
| upload |
تحميل نطاق من وحدات البايت إلى ملف. يمكن استدعاء هذه العملية على ملف موجود فقط. لن يغير حجم الملف أو خصائصه أو بيانات تعريفه. يجب تحديد كل من بداية النطاق وعدده. يمكن أن يصل حجم النطاق إلى 4 ميغابايت. |
| upload |
قم بتحميل نطاق من وحدات البايت إلى ملف حيث تتم قراءة المحتويات من عنوان URL لملف آخر. يمكن أن يصل حجم النطاق إلى 4 ميغابايت. |
| upload |
متوفر فقط في وقت تشغيل NODE.JS. يقبل Node.js مصنع دفق قابل للقراءة، ويحمل في كتل إلى ملف Azure. يجب أن يقوم مصنع الدفق القابل للقراءة بإرجاع دفق Node.js قابل للقراءة بدءا من الإزاحة المعرفة. الإزاحة هي الإزاحة في ملف Azure الذي سيتم تحميله. |
| upload |
متوفر فقط في المستعرضات. تحميل كائن Blob مستعرض إلى ملف Azure. يتطلب blobFactory كمصدر بيانات، والذي يحتاج إلى إرجاع كائن Blob مع توفير الإزاحة والحجم. |
| upload |
متوفر فقط في وقت تشغيل NODE.JS. إنشاء ملف Azure جديد أو استبدال ملف Azure موجود، ثم تحميل دفق Node.js قابل للقراءة فيه.
سيحاول هذا الأسلوب إنشاء ملف Azure، ثم يبدأ في تحميل مجموعة حسب المجموعة.
يتم تعريف حجم المجموعة بواسطة معلمة تلميحات تحسين الأداء:
|
| with |
إنشاء كائن ShareFileClient جديد مطابق للمصدر ولكن مع الطابع الزمني المحدد للقطة المشاركة. توفير "" سيؤدي إلى إزالة اللقطة وإرجاع عنوان URL إلى ShareFileClient الأساسي. |
تفاصيل المنشئ
ShareFileClient(string, Credential | TokenCredential, ShareClientOptions)
إنشاء مثيل ShareFileClient.
new ShareFileClient(url: string, credential?: Credential | TokenCredential, options?: ShareClientOptions)
المعلمات
- url
-
string
سلسلة URL تشير إلى ملف Azure Storage، مثل "https://myaccount.file.core.windows.net/myshare/mydirectory/file". يمكنك إلحاق SAS إذا كنت تستخدم AnonymousCredential، مثل "https://myaccount.file.core.windows.net/myshare/mydirectory/file?sasString". يقبل هذا الأسلوب عنوان URL مشفر أو عنوان URL غير مشفر يشير إلى ملف. لن يتم إلغاء سلسلة URL المرمزة مرتين، سيتم إلغاء الأحرف الخاصة فقط في مسار URL. ومع ذلك، إذا كان اسم ملف أو دليل يتضمن %، يجب ترميز اسم الملف أو الدليل في عنوان URL. مثل ملف يسمى "myfile%"، يجب أن يكون عنوان URL "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25".
- credential
مثل ، StorageSharedKeyCredential أو TokenCredential، إذا لم يتم تحديده، يتم استخدام AnonymousCredential.
- options
- ShareClientOptions
Optional. خيارات لتكوين البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.
ShareFileClient(string, Pipeline, ShareClientConfig)
إنشاء مثيل ShareFileClient.
new ShareFileClient(url: string, pipeline: Pipeline, options?: ShareClientConfig)
المعلمات
- url
-
string
سلسلة URL تشير إلى ملف Azure Storage، مثل "https://myaccount.file.core.windows.net/myshare/mydirectory/file". يمكنك إلحاق SAS إذا كنت تستخدم AnonymousCredential، مثل "https://myaccount.file.core.windows.net/myshare/mydirectory/file?sasString". يقبل هذا الأسلوب عنوان URL مشفر أو عنوان URL غير مشفر يشير إلى ملف. لن يتم إلغاء سلسلة URL المرمزة مرتين، سيتم إلغاء الأحرف الخاصة فقط في مسار URL. ومع ذلك، إذا كان اسم ملف أو دليل يتضمن %، يجب ترميز اسم الملف أو الدليل في عنوان URL. مثل ملف يسمى "myfile%"، يجب أن يكون عنوان URL "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25".
- pipeline
- Pipeline
استدعاء newPipeline() لإنشاء مسار افتراضي، أو توفير مسار مخصص.
- options
- ShareClientConfig
تفاصيل الخاصية
name
اسم الملف
string name
قيمة الخاصية
string
path
المسار الكامل للملف
string path
قيمة الخاصية
string
shareName
اسم المشاركة المطابق لعميل الملف هذا
string shareName
قيمة الخاصية
string
تفاصيل الخاصية الموروثة
accountName
accountName: string
قيمة الخاصية
string
موروث من StorageClient.accountName
url
قيمة سلسلة عنوان URL.
url: string
قيمة الخاصية
string
موروث من StorageClient.url
تفاصيل الأسلوب
abortCopyFromURL(string, FileAbortCopyFromURLOptions)
إحباط عملية "ملف النسخ" المعلقة، وترك ملف وجهة بدون طول وبيانات تعريف كاملة.
راجع https://learn.microsoft.com/rest/api/storageservices/abort-copy-file
function abortCopyFromURL(copyId: string, options?: FileAbortCopyFromURLOptions): Promise<FileAbortCopyResponse>
المعلمات
- copyId
-
string
معرف عملية نسخ الملف لإجهاضه.
- options
- FileAbortCopyFromURLOptions
خيارات لعملية "File Abort Copy From URL".
المرتجعات
Promise<FileAbortCopyResponse>
clearRange(number, number, FileClearRangeOptions)
مسح النطاق المحدد وإصدار المساحة المستخدمة في التخزين لهذا النطاق.
function clearRange(offset: number, contentLength: number, options?: FileClearRangeOptions): Promise<FileUploadRangeResponse>
المعلمات
- offset
-
number
- contentLength
-
number
- options
- FileClearRangeOptions
خيارات لعملية مسح النطاق للملفات.
المرتجعات
Promise<FileUploadRangeResponse>
create(number, FileCreateOptions)
إنشاء ملف جديد أو استبدال ملف. لاحظ أنه يقوم بتهيئة الملف بدون محتوى فقط.
راجع https://learn.microsoft.com/rest/api/storageservices/create-file
function create(size: number, options?: FileCreateOptions): Promise<FileCreateResponse>
المعلمات
- size
-
number
يحدد الحد الأقصى للحجم بالبايت للملف، حتى 4 تيرابايت.
- options
- FileCreateOptions
خيارات لعملية إنشاء ملف.
المرتجعات
Promise<FileCreateResponse>
بيانات الاستجابة لعملية إنشاء ملف.
مثال على الاستخدام:
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`);
createHardLink(string, FileCreateHardLinkOptions)
NFS فقط. إنشاء ارتباط ثابت إلى ملف الملف المحدد بواسطة المسار.
function createHardLink(targetFile: string, options?: FileCreateHardLinkOptions): Promise<FileCreateHardLinkResponse>
المعلمات
- targetFile
-
string
مسار الملف لإنشاء الارتباط الثابت إلى، وليس تضمين المشاركة. على سبيل المثال: "targetDirectory/targetSubDirectory/.../targetFile"
- options
- FileCreateHardLinkOptions
خيارات لإنشاء عملية الارتباط الثابت.
المرتجعات
Promise<FileCreateHardLinkResponse>
createSymbolicLink(string, FileCreateSymbolicLinkOptions)
NFS فقط. ينشئ رابطا رمزيا.
function createSymbolicLink(linkText: string, options?: FileCreateSymbolicLinkOptions): Promise<FileCreateSymbolicLinkResponse>
المعلمات
- linkText
-
string
يشير المسار إلى الملف الأصلي ، الرابط الرمزي. المسار من نوع السلسلة التي لم يتم حلها ويتم تخزينها كما هي. يمكن أن يكون المسار مسارا مطلقا أو المسار النسبي اعتمادا على المحتوى المخزن في ملف الارتباط الرمزي.
- options
- FileCreateSymbolicLinkOptions
خيارات لإنشاء عملية الارتباط الثابت.
المرتجعات
Promise<FileCreateSymbolicLinkResponse>
delete(FileDeleteOptions)
إزالة الملف من حساب التخزين. عند حذف ملف بنجاح، تتم إزالته على الفور من فهرس حساب التخزين ولم يعد يمكن للعملاء الوصول إليه. تتم إزالة بيانات الملف لاحقا من الخدمة أثناء تجميع البيانات المهملة.
سيفشل حذف ملف مع رمز الحالة 409 (تعارض) ورمز الخطأ SharingViolation إذا كان الملف مفتوحا على عميل SMB.
حذف ملف غير معتمد على لقطة مشاركة، وهي نسخة للقراءة فقط من المشاركة. ستفشل محاولة تنفيذ هذه العملية على لقطة مشاركة مع 400 (InvalidQueryParameterValue)
راجع https://learn.microsoft.com/rest/api/storageservices/delete-file2
function delete(options?: FileDeleteOptions): Promise<FileDeleteResponse>
المعلمات
- options
- FileDeleteOptions
خيارات لعملية حذف الملف.
المرتجعات
Promise<FileDeleteResponse>
بيانات الاستجابة لعملية حذف الملف.
deleteIfExists(FileDeleteOptions)
إزالة الملف من حساب التخزين إذا كان موجودا. عند حذف ملف بنجاح، تتم إزالته على الفور من فهرس حساب التخزين ولم يعد يمكن للعملاء الوصول إليه. تتم إزالة بيانات الملف لاحقا من الخدمة أثناء تجميع البيانات المهملة.
سيفشل حذف ملف مع رمز الحالة 409 (تعارض) ورمز الخطأ SharingViolation إذا كان الملف مفتوحا على عميل SMB.
حذف ملف غير معتمد على لقطة مشاركة، وهي نسخة للقراءة فقط من المشاركة. ستفشل محاولة تنفيذ هذه العملية على لقطة مشاركة مع 400 (InvalidQueryParameterValue)
راجع https://learn.microsoft.com/rest/api/storageservices/delete-file2
function deleteIfExists(options?: FileDeleteOptions): Promise<FileDeleteIfExistsResponse>
المعلمات
- options
- FileDeleteOptions
المرتجعات
Promise<FileDeleteIfExistsResponse>
download(number, number, FileDownloadOptions)
قراءة ملف من النظام أو تنزيله، بما في ذلك بيانات التعريف والخصائص الخاصة به.
- في Node.js، ترجع البيانات في دفق قابل للقراءة
readableStreamBody - في المستعرضات، ترجع البيانات في وعد
contentAsBlob
راجع https://learn.microsoft.com/rest/api/storageservices/get-file
function download(offset?: number, count?: number, options?: FileDownloadOptions): Promise<FileDownloadResponseModel>
المعلمات
- offset
-
number
من أي موضع للملف المراد تنزيله، أكبر من أو يساوي 0
- count
-
number
مقدار البيانات التي سيتم تنزيلها، أكبر من 0. سيتم التنزيل إلى النهاية عند عدم تحديده
- options
- FileDownloadOptions
خيارات لعملية تنزيل الملفات.
المرتجعات
Promise<FileDownloadResponseModel>
بيانات الاستجابة لعملية تنزيل الملف.
مثال على الاستخدام (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);
});
}
مثال على الاستخدام (المتصفحات):
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()}`);
}
downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions)
متوفر فقط في وقت تشغيل NODE.JS.
تنزيل ملف Azure بالتوازي مع مخزن مؤقت. الإزاحة والعد اختيارية، مرر 0 لكليهما لتنزيل الملف بأكمله.
تحذير: يمكن أن تدعم المخازن المؤقتة ملفات تصل إلى حوالي غيغابايت واحد فقط على أنظمة 32 بت أو حوالي غيغابايت على أنظمة 64 بت بسبب قيود Node.js/V8. بالنسبة للملفات الأكبر من هذا الحجم، ضع في اعتبارك downloadToFile.
function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: FileDownloadToBufferOptions): Promise<Buffer>
المعلمات
- buffer
-
Buffer
المخزن المؤقت المطلوب تعبئته، يجب أن يكون طوله أكبر من العدد
- offset
-
number
من أي موضع من Azure File لتنزيله
- count
-
number
مقدار البيانات التي سيتم تنزيلها. سيتم التنزيل إلى النهاية عند تمرير غير معرف
- options
- FileDownloadToBufferOptions
المرتجعات
Promise<Buffer>
downloadToBuffer(number, number, FileDownloadToBufferOptions)
متوفر فقط في وقت تشغيل NODE.JS
تنزيل ملف Azure بالتوازي مع مخزن مؤقت. الإزاحة والعد اختيارية، وتمرير 0 لكليهما لتنزيل الملف بأكمله
تحذير: يمكن أن تدعم المخازن المؤقتة ملفات تصل إلى حوالي غيغابايت واحد فقط على أنظمة 32 بت أو حوالي غيغابايت على أنظمة 64 بت بسبب قيود Node.js/V8. بالنسبة للملفات الأكبر من هذا الحجم، ضع في اعتبارك downloadToFile.
function downloadToBuffer(offset?: number, count?: number, options?: FileDownloadToBufferOptions): Promise<Buffer>
المعلمات
- offset
-
number
من أي موضع من ملف Azure المراد تنزيله
- count
-
number
مقدار البيانات التي سيتم تنزيلها. سيتم التنزيل إلى النهاية عند تمرير غير معرف
- options
- FileDownloadToBufferOptions
المرتجعات
Promise<Buffer>
downloadToFile(string, number, number, FileDownloadOptions)
متوفر فقط في وقت تشغيل NODE.JS.
تنزيل Azure Blob إلى ملف محلي. يفشل إذا تم إنهاء مسار الملف المحدد بالفعل. الإزاحة والعد اختيارية، وتمرير 0 وغير معرفة على التوالي لتنزيل الكائن الثنائي كبير الحجم بأكمله.
function downloadToFile(filePath: string, offset?: number, count?: number, options?: FileDownloadOptions): Promise<FileDownloadResponseModel>
المعلمات
- filePath
-
string
- offset
-
number
من أي موضع للكتلة الثنائية كبيرة الحجم للتنزيل.
- count
-
number
مقدار البيانات التي سيتم تنزيلها. سيتم التنزيل إلى النهاية عند تمرير غير معرف.
- options
- FileDownloadOptions
خيارات لخيارات تنزيل Blob.
المرتجعات
Promise<FileDownloadResponseModel>
بيانات الاستجابة لعملية تنزيل الكائن الثنائي كبير الحجم، ولكن مع تعيين readableStreamBody إلى غير معرف نظرا لأن محتواه تمت قراءته بالفعل وكتابته في ملف محلي في المسار المحدد.
exists(FileExistsOptions)
إرجاع true إذا كان الملف المحدد موجودا؛ خطأ خلاف ذلك.
ملاحظة: استخدم هذه الدالة بعناية حيث قد يتم حذف ملف موجود من قبل عملاء أو تطبيقات أخرى. قد تتم إضافة الملفات الجديدة بالعكس بواسطة عملاء أو تطبيقات أخرى بعد اكتمال هذه الدالة.
function exists(options?: FileExistsOptions): Promise<boolean>
المعلمات
- options
- FileExistsOptions
خيارات لعملية Exists.
المرتجعات
Promise<boolean>
forceCloseAllHandles(FileForceCloseHandlesOptions)
فرض إغلاق كافة المقابض لملف.
راجع https://learn.microsoft.com/rest/api/storageservices/force-close-handles
function forceCloseAllHandles(options?: FileForceCloseHandlesOptions): Promise<CloseHandlesInfo>
المعلمات
- options
- FileForceCloseHandlesOptions
خيارات لفرض عملية إغلاق المقابض.
المرتجعات
Promise<CloseHandlesInfo>
forceCloseHandle(string, FileForceCloseHandlesOptions)
فرض إغلاق مقبض معين لملف.
راجع https://learn.microsoft.com/rest/api/storageservices/force-close-handles
function forceCloseHandle(handleId: string, options?: FileForceCloseHandlesOptions): Promise<FileForceCloseHandlesResponse>
المعلمات
- handleId
-
string
معرف مقبض معين، لا يمكن أن يكون علامة نجمية "*". استخدم forceCloseAllHandles() لإغلاق جميع المقابض.
- options
- FileForceCloseHandlesOptions
المرتجعات
Promise<FileForceCloseHandlesResponse>
generateSasStringToSign(FileGenerateSasUrlOptions)
متوفر فقط للعملاء الذين تم إنشاؤهم باستخدام بيانات اعتماد مفتاح مشترك.
إنشاء سلسلة لتوقيع URI توقيع الوصول المشترك للخدمة (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة بيانات اعتماد المفتاح المشترك للعميل.
راجع https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
function generateSasStringToSign(options: FileGenerateSasUrlOptions): string
المعلمات
- options
- FileGenerateSasUrlOptions
المعلمات الاختيارية.
المرتجعات
string
SAS URI الذي يتكون من URI للمورد الذي يمثله هذا العميل، متبوعا بالرمز المميز SAS الذي تم إنشاؤه.
generateSasUrl(FileGenerateSasUrlOptions)
متوفر فقط للعملاء الذين تم إنشاؤهم باستخدام بيانات اعتماد مفتاح مشترك.
إنشاء عنوان URI لتوقيع الوصول المشترك للخدمة (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة بيانات اعتماد المفتاح المشترك للعميل.
راجع https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
function generateSasUrl(options: FileGenerateSasUrlOptions): string
المعلمات
- options
- FileGenerateSasUrlOptions
المعلمات الاختيارية.
المرتجعات
string
SAS URI الذي يتكون من URI للمورد الذي يمثله هذا العميل، متبوعا بالرمز المميز SAS الذي تم إنشاؤه.
generateUserDelegationSasUrl(ShareGenerateSasUrlOptions, UserDelegationKey)
إنشاء عنوان URI لتوقيع الوصول المشترك للخدمة (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة إدخال بيانات اعتماد مفتاح تفويض المستخدم.
راجع https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
function generateUserDelegationSasUrl(options: ShareGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string
المعلمات
- options
- ShareGenerateSasUrlOptions
المعلمات الاختيارية.
- userDelegationKey
- UserDelegationKey
مفتاح تفويض المستخدم المستخدم لتوقيع رابط مستخدم SAS
المرتجعات
string
SAS URI الذي يتكون من URI للمورد الذي يمثله هذا العميل، متبوعا بالرمز المميز SAS الذي تم إنشاؤه.
generateUserDelegationStringToSign(ShareGenerateSasUrlOptions, UserDelegationKey)
إنشاء عنوان URI لتوقيع الوصول المشترك للخدمة (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة إدخال بيانات اعتماد مفتاح تفويض المستخدم.
راجع https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
function generateUserDelegationStringToSign(options: ShareGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string
المعلمات
- options
- ShareGenerateSasUrlOptions
المعلمات الاختيارية.
- userDelegationKey
- UserDelegationKey
مفتاح تفويض المستخدم المستخدم لتوقيع رابط مستخدم SAS
المرتجعات
string
SAS URI الذي يتكون من URI للمورد الذي يمثله هذا العميل، متبوعا بالرمز المميز SAS الذي تم إنشاؤه.
getProperties(FileGetPropertiesOptions)
إرجاع كافة بيانات التعريف المعرفة من قبل المستخدم وخصائص HTTP القياسية وخصائص النظام للملف. لا يقوم بإعادة محتوى الملف.
راجع https://learn.microsoft.com/rest/api/storageservices/get-file-properties
function getProperties(options?: FileGetPropertiesOptions): Promise<FileGetPropertiesResponse>
المعلمات
- options
- FileGetPropertiesOptions
خيارات لعملية File Get Properties.
المرتجعات
Promise<FileGetPropertiesResponse>
بيانات الاستجابة لعملية File Get Properties.
getRangeList(FileGetRangeListOptions)
إرجاع قائمة النطاقات الصالحة لملف.
function getRangeList(options?: FileGetRangeListOptions): Promise<FileGetRangeListResponse>
المعلمات
- options
- FileGetRangeListOptions
خيارات عملية File Get range List.
المرتجعات
Promise<FileGetRangeListResponse>
getRangeListDiff(string, FileGetRangeListOptions)
إرجاع قائمة النطاقات التي تختلف بين لقطة مشاركة سابقة وهذا الملف.
function getRangeListDiff(prevShareSnapshot: string, options?: FileGetRangeListOptions): Promise<FileGetRangeListDiffResponse>
المعلمات
- prevShareSnapshot
-
string
معلمة اللقطة السابقة هي قيمة DateTime مبهمة تحدد لقطة المشاركة السابقة للمقارنة معها.
- options
- FileGetRangeListOptions
المرتجعات
Promise<FileGetRangeListDiffResponse>
getShareLeaseClient(string)
احصل على ShareLeaseClient الذي يدير عقود الإيجار على الملف.
function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient
المعلمات
- proposeLeaseId
-
string
معرف التأجير المقترح الأولي.
المرتجعات
عنصر ShareLeaseClient جديد لإدارة عقود الإيجار على الملف.
getSymbolicLink(FileGetSymbolicLinkOptions)
NFS فقط. الحصول على محتوى رابط رمزي.
function getSymbolicLink(options?: FileGetSymbolicLinkOptions): Promise<FileGetSymbolicLinkResponse>
المعلمات
- options
- FileGetSymbolicLinkOptions
خيارات للحصول على عملية ارتباط رمزي.
المرتجعات
Promise<FileGetSymbolicLinkResponse>
listHandles(FileListHandlesOptions)
إرجاع مكرر غير متزامن قابل للتكبير لسرد جميع المقابض. ضمن الحساب المحدد.
يقوم .byPage() بإرجاع مكرر غير متزامن قابل للتكريب لسرد المقابض في الصفحات.
function listHandles(options?: FileListHandlesOptions): PagedAsyncIterableIterator<HandleItem, FileListHandlesResponse, PageSettings>
المعلمات
المرتجعات
rename(string, FileRenameOptions)
إعادة تسمية ملف. تدعم واجهة برمجة التطبيقات هذه إعادة تسمية ملف في نفس المشاركة فقط.
function rename(destinationPath: string, options?: FileRenameOptions): Promise<{ destinationFileClient: ShareFileClient, fileRenameResponse: FileRenameResponse }>
المعلمات
- destinationPath
-
string
تحديد مسار الوجهة لإعادة التسمية إليه. سيتم ترميز المسار لوضعه في عنوان URL لتحديد الوجهة.
- options
- FileRenameOptions
خيارات لعملية إعادة التسمية.
المرتجعات
Promise<{ destinationFileClient: ShareFileClient, fileRenameResponse: FileRenameResponse }>
بيانات الاستجابة لعملية إعادة تسمية الملف.
مثال على الاستخدام:
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);
resize(number, FileResizeOptions)
تغيير حجم الملف.
راجع https://learn.microsoft.com/rest/api/storageservices/set-file-properties
function resize(length: number, options?: FileResizeOptions): Promise<FileSetHTTPHeadersResponse>
المعلمات
- length
-
number
تغيير حجم ملف إلى الحجم المحدد بالبايت. إذا كانت قيمة البايت المحددة أقل من الحجم الحالي للملف، مسح كافة النطاقات فوق قيمة البايت المحددة.
- options
- FileResizeOptions
خيارات لعملية تغيير حجم الملف.
المرتجعات
Promise<FileSetHTTPHeadersResponse>
بيانات الاستجابة لعملية "File Set HTTP Headers".
setHttpHeaders(FileHttpHeaders, FileSetHttpHeadersOptions)
تعيين رؤوس HTTP على الملف.
إذا لم يتم توفير أي خيار، أو لم يتم توفير قيمة لرؤوس HTTP للملف في الخيارات، مسح رؤوس HTTP للملف هذه بدون قيمة.
راجع https://learn.microsoft.com/rest/api/storageservices/set-file-properties
function setHttpHeaders(fileHttpHeaders?: FileHttpHeaders, options?: FileSetHttpHeadersOptions): Promise<FileSetHTTPHeadersResponse>
المعلمات
- fileHttpHeaders
- FileHttpHeaders
- options
- FileSetHttpHeadersOptions
خيارات لعملية "File Set HTTP Headers".
المرتجعات
Promise<FileSetHTTPHeadersResponse>
بيانات الاستجابة لعملية "File Set HTTP Headers".
setMetadata(Metadata, FileSetMetadataOptions)
تحديث بيانات التعريف المعرفة من قبل المستخدم للملف المحدد.
إذا لم يتم تعريف بيانات التعريف في معلمة الخيار، فستتم إزالة بيانات تعريف الملف.
راجع https://learn.microsoft.com/rest/api/storageservices/set-file-metadata
function setMetadata(metadata?: Metadata, options?: FileSetMetadataOptions): Promise<FileSetMetadataResponse>
المعلمات
- metadata
- Metadata
إذا لم يتم توفير بيانات تعريف، فستتم إزالة جميع بيانات تعريف الدليل الموجودة
- options
- FileSetMetadataOptions
خيارات لعملية بيانات التعريف لمجموعة الملفات.
المرتجعات
Promise<FileSetMetadataResponse>
بيانات الاستجابة لعملية بيانات تعريف مجموعة الملفات.
setProperties(FileProperties)
تعيين خصائص على الملف.
راجع https://learn.microsoft.com/rest/api/storageservices/set-file-properties
function setProperties(properties?: FileProperties): Promise<SetPropertiesResponse>
المعلمات
- properties
- FileProperties
خصائص الملف. بالنسبة لرؤوس HTTP للملف (على سبيل المثال، نوع المحتوى)، إذا لم يتم توفير أي قيم، فستتم إزالة رؤوس HTTP الموجودة. بالنسبة لخصائص الملف الأخرى (على سبيل المثال fileAttributes)، إذا لم يتم توفير قيم، الاحتفاظ بالقيم الموجودة.
المرتجعات
Promise<SetPropertiesResponse>
startCopyFromURL(string, FileStartCopyOptions)
نسخ كائن ثنائي كبير الحجم أو ملف إلى ملف وجهة داخل حساب التخزين.
function startCopyFromURL(copySource: string, options?: FileStartCopyOptions): Promise<FileStartCopyResponse>
المعلمات
- copySource
-
string
يحدد عنوان URL للملف المصدر أو الكائن الثنائي كبير الحجم، حتى 2 كيلوبايت في الطول. لنسخ ملف إلى ملف آخر داخل نفس حساب التخزين، يمكنك استخدام المفتاح المشترك لمصادقة الملف المصدر. إذا كنت تقوم بنسخ ملف من حساب تخزين آخر، أو إذا كنت تقوم بنسخ كائن ثنائي كبير الحجم من نفس حساب التخزين أو حساب تخزين آخر، فيجب عليك مصادقة الملف المصدر أو الكائن الثنائي كبير الحجم باستخدام توقيع وصول مشترك. إذا كان المصدر كائن ثنائي كبير الحجم عام، فلا يلزم مصادقة لتنفيذ عملية النسخ. يمكن أيضا تحديد ملف في لقطة مشاركة كمصدر نسخ.
- options
- FileStartCopyOptions
خيارات لعملية نسخ بدء تشغيل الملف.
المرتجعات
Promise<FileStartCopyResponse>
uploadData(Blob | ArrayBuffer | ArrayBufferView | Buffer, FileParallelUploadOptions)
إنشاء ملف Azure جديد أو استبدال ملف Azure موجود، ثم تحميل مخزن مؤقت (عقدة)/Blob/ArrayBuffer/ArrayBufferView إليه.
function uploadData(data: Blob | ArrayBuffer | ArrayBufferView | Buffer, options?: FileParallelUploadOptions): Promise<void>
المعلمات
- data
-
Blob | ArrayBuffer | ArrayBufferView | Buffer
المخزن المؤقت (العقدة) أو Blob أو ArrayBuffer أو ArrayBufferView
- options
- FileParallelUploadOptions
المرتجعات
Promise<void>
uploadFile(string, FileParallelUploadOptions)
متوفر فقط في وقت تشغيل NODE.JS.
إنشاء ملف Azure جديد أو استبدال ملف Azure موجود، ثم تحميل ملف محلي إليه.
function uploadFile(filePath: string, options?: FileParallelUploadOptions): Promise<void>
المعلمات
- filePath
-
string
المسار الكامل للملف المحلي
- options
- FileParallelUploadOptions
المرتجعات
Promise<void>
uploadRange(RequestBodyType, number, number, FileUploadRangeOptions)
تحميل نطاق من وحدات البايت إلى ملف. يمكن استدعاء هذه العملية على ملف موجود فقط. لن يغير حجم الملف أو خصائصه أو بيانات تعريفه. يجب تحديد كل من بداية النطاق وعدده. يمكن أن يصل حجم النطاق إلى 4 ميغابايت.
function uploadRange(body: RequestBodyType, offset: number, contentLength: number, options?: FileUploadRangeOptions): Promise<FileUploadRangeResponse>
المعلمات
- body
- HttpRequestBody
Blob أو سلسلة أو ArrayBuffer أو ArrayBufferView أو دالة تقوم بإرجاع دفق جديد قابل للقراءة تكون إزاحته من بداية مصدر البيانات.
- offset
-
number
إزاحة موضع ملف Azure الوجهة المراد تحميله.
- contentLength
-
number
طول الجسم بالبايت. استخدم Buffer.byteLength() لحساب طول النص الأساسي لسلسلة بما في ذلك الأحرف غير المرمزة ب Base64/Hex.
- options
- FileUploadRangeOptions
خيارات لعملية File Upload Range.
المرتجعات
Promise<FileUploadRangeResponse>
بيانات الاستجابة لعملية File Upload Range.
مثال على الاستخدام:
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`);
uploadRangeFromURL(string, number, number, number, FileUploadRangeFromURLOptions)
قم بتحميل نطاق من وحدات البايت إلى ملف حيث تتم قراءة المحتويات من عنوان URL لملف آخر. يمكن أن يصل حجم النطاق إلى 4 ميغابايت.
function uploadRangeFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: FileUploadRangeFromURLOptions): Promise<FileUploadRangeFromURLResponse>
المعلمات
- sourceURL
-
string
حدد عنوان URL لمصدر النسخ، ربما يكون توقيع الوصول المشترك (SAS) مطلوبا للمصادقة.
- sourceOffset
-
number
إزاحة المصدر للنسخ منها. مرر 0 للنسخ من بداية الملف المصدر.
- destOffset
-
number
إزاحة ملف الوجهة.
- count
-
number
عدد وحدات البايت التي سيتم تحميلها من الملف المصدر.
- options
- FileUploadRangeFromURLOptions
خيارات لتكوين ملف - تحميل النطاق من عملية عنوان URL.
المرتجعات
Promise<FileUploadRangeFromURLResponse>
uploadResetableStream((offset: number, count?: number) => ReadableStream, number, FileParallelUploadOptions)
متوفر فقط في وقت تشغيل NODE.JS.
يقبل Node.js مصنع دفق قابل للقراءة، ويحمل في كتل إلى ملف Azure. يجب أن يقوم مصنع الدفق القابل للقراءة بإرجاع دفق Node.js قابل للقراءة بدءا من الإزاحة المعرفة. الإزاحة هي الإزاحة في ملف Azure الذي سيتم تحميله.
function uploadResetableStream(streamFactory: (offset: number, count?: number) => ReadableStream, size: number, options?: FileParallelUploadOptions): Promise<void>
المعلمات
- streamFactory
-
(offset: number, count?: number) => ReadableStream
إرجاع دفق Node.js قابل للقراءة بدءا من الإزاحة المعرفة
- size
-
number
حجم ملف Azure
- options
- FileParallelUploadOptions
المرتجعات
Promise<void>
uploadSeekableBlob((offset: number, size: number) => Blob, number, FileParallelUploadOptions)
متوفر فقط في المستعرضات.
تحميل كائن Blob مستعرض إلى ملف Azure. يتطلب blobFactory كمصدر بيانات، والذي يحتاج إلى إرجاع كائن Blob مع توفير الإزاحة والحجم.
function uploadSeekableBlob(blobFactory: (offset: number, size: number) => Blob, size: number, options?: FileParallelUploadOptions): Promise<void>
المعلمات
- blobFactory
-
(offset: number, size: number) => Blob
- size
-
number
- options
- FileParallelUploadOptions
المرتجعات
Promise<void>
uploadStream(Readable, number, number, number, FileUploadStreamOptions)
متوفر فقط في وقت تشغيل NODE.JS.
إنشاء ملف Azure جديد أو استبدال ملف Azure موجود، ثم تحميل دفق Node.js قابل للقراءة فيه.
سيحاول هذا الأسلوب إنشاء ملف Azure، ثم يبدأ في تحميل مجموعة حسب المجموعة.
يتم تعريف حجم المجموعة بواسطة معلمة bufferSize.
الرجاء التأكد من أن الحجم المحتمل للتدفق لا يتجاوز حجم الملف.
تلميحات تحسين الأداء:
- تدفق الإدخال highWaterMark من الأفضل تعيين نفس القيمة باستخدام معلمة bufferSize، والتي ستتجنب عمليات Buffer.concat().
function uploadStream(stream: Readable, size: number, bufferSize: number, maxBuffers: number, options?: FileUploadStreamOptions): Promise<void>
المعلمات
- stream
-
Readable
Node.js دفق قابل للقراءة. يجب أن يكون حجم الملف أقل أو مساويا له.
- size
-
number
حجم الملف الذي سيتم إنشاؤه. الحد الأقصى للحجم المسموح به هو 4 تيرابايت. إذا كانت هذه القيمة أكبر من حجم الدفق، فسيكون هناك بايت فارغ في ذيل الملف.
- bufferSize
-
number
حجم كل مخزن مؤقت مخصص بالبايت، وكذلك حجم المجموعة/النطاق أثناء الملف الذي تم تحميله. يجب أن يكون الحجم أكبر من 0 وأقل من أو يساوي 4 * 1024 * 1024 (4 ميغابايت)
- maxBuffers
-
number
سيتم تخصيص الحد الأقصى للمخازن المؤقتة أثناء التحميل، والارتباط الإيجابي مع الحد الأقصى للتزامن مع التحميل
- options
- FileUploadStreamOptions
المرتجعات
Promise<void>
withShareSnapshot(string)
إنشاء كائن ShareFileClient جديد مطابق للمصدر ولكن مع الطابع الزمني المحدد للقطة المشاركة. توفير "" سيؤدي إلى إزالة اللقطة وإرجاع عنوان URL إلى ShareFileClient الأساسي.
function withShareSnapshot(shareSnapshot: string): ShareFileClient
المعلمات
- shareSnapshot
-
string
الطابع الزمني للقطة المشاركة.
المرتجعات
كائن ShareFileClient جديد مطابق للمصدر ولكن مع الطابع الزمني المحدد للقطة المشاركة.