FileURL class

الحزمة:

@azure/storage-file

يمثل FileURL عنوان URL لملف Azure Storage.

يمتد

StorageURL

المنشئون

FileURL(string, Pipeline)

إنشاء مثيل FileURL.

الخصائص

pipeline	طلب البنية الأساسية لبرنامج ربط العمليات التجارية للنهج.
url	قيمة سلسلة عنوان URL.

الأساليب

abortCopyFromURL(Aborter, string)	إحباط عملية "ملف النسخ" المعلقة، وترك ملف وجهة بدون طول وبيانات تعريف كاملة.
clearRange(Aborter, number, number)	مسح النطاق المحدد وإصدار المساحة المستخدمة في التخزين لهذا النطاق.
create(Aborter, number, IFileCreateOptions)	إنشاء ملف جديد أو استبدال ملف. لاحظ أنه يقوم بتهيئة الملف بدون محتوى فقط.
delete(Aborter)	إزالة الملف من حساب التخزين. عند حذف ملف بنجاح، تتم إزالته على الفور من فهرس حساب التخزين ولم يعد يمكن للعملاء الوصول إليه. تتم إزالة بيانات الملف لاحقا من الخدمة أثناء تجميع البيانات المهملة. سيفشل حذف ملف مع رمز الحالة 409 (تعارض) ورمز الخطأ SharingViolation إذا كان الملف مفتوحا على عميل SMB. حذف ملف غير معتمد على لقطة مشاركة، وهي نسخة للقراءة فقط من المشاركة. ستفشل محاولة تنفيذ هذه العملية على لقطة مشاركة مع 400 (InvalidQueryParameterValue)
download(Aborter, number, undefined | number, IFileDownloadOptions)	قراءة ملف من النظام أو تنزيله، بما في ذلك بيانات التعريف والخصائص الخاصة به. في Node.js، ترجع البيانات في دفق قابل للقراءة readableStreamBody في المستعرضات، ترجع البيانات في وعد blobBody
forceCloseHandle(Aborter, string)	فرض إغلاق مقبض معين لملف.
forceCloseHandlesSegment(Aborter, undefined | string)	فرض إغلاق كافة المقابض لملف.
fromDirectoryURL(DirectoryURL, string)	إنشاء كائن FileURL من كائن DirectoryURL.
getProperties(Aborter)	إرجاع كافة بيانات التعريف المعرفة من قبل المستخدم وخصائص HTTP القياسية وخصائص النظام للملف. لا يقوم بإعادة محتوى الملف.
getRangeList(Aborter, IFileGetRangeListOptions)	إرجاع قائمة النطاقات الصالحة لملف.
listHandlesSegment(Aborter, undefined | string, IFileListHandlesSegmentOptions)	سرد مقابض ملف.
newPipeline(Credential, INewPipelineOptions)	أسلوب ثابت يستخدم لإنشاء كائن مسار جديد مع توفير بيانات الاعتماد.
resize(Aborter, number)	تغيير حجم الملف.
setHTTPHeaders(Aborter, IFileHTTPHeaders)	تعيين رؤوس HTTP على الملف. إذا لم يتم توفير أي خيار، أو لم يتم توفير قيمة لرؤوس HTTP للملف في الخيارات، مسح رؤوس HTTP للملف هذه بدون قيمة.
setMetadata(Aborter, IMetadata)	تحديث بيانات التعريف المعرفة من قبل المستخدم للملف المحدد. إذا لم يتم تعريف بيانات التعريف في معلمة الخيار، فستتم إزالة بيانات تعريف الملف.
setProperties(Aborter, IFileProperties)	تعيين خصائص على الملف.
startCopyFromURL(Aborter, string, IFileStartCopyOptions)	نسخ كائن ثنائي كبير الحجم أو ملف إلى ملف وجهة داخل حساب التخزين.
uploadRange(Aborter, HttpRequestBody, number, number, IFileUploadRangeOptions)	تحميل نطاق من وحدات البايت إلى ملف. يجب تحديد كل من بداية النطاق وعدده. يمكن أن يصل حجم النطاق إلى 4 ميغابايت.
uploadRangeFromURL(Aborter, string, number, number, number)	قم بتحميل نطاق من وحدات البايت إلى ملف حيث تتم قراءة المحتويات من عنوان URL لملف آخر. يمكن أن يصل حجم النطاق إلى 4 ميغابايت.
withPipeline(Pipeline)	إنشاء كائن FileURL جديد مطابق للمصدر ولكن مع مسار نهج الطلب المحدد.

تفاصيل المنشئ

FileURL(string, Pipeline)

إنشاء مثيل FileURL.

new FileURL(url: string, pipeline: Pipeline)

المعلمات

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

اتصل ب StorageURL.newPipeline() لإنشاء مسار افتراضي، أو توفير مسار مخصص.

تفاصيل الخاصية

pipeline

طلب البنية الأساسية لبرنامج ربط العمليات التجارية للنهج.

pipeline: Pipeline

قيمة الخاصية

Pipeline

url

قيمة سلسلة عنوان URL.

url: string

قيمة الخاصية

string

تفاصيل الأسلوب

abortCopyFromURL(Aborter, string)

إحباط عملية "ملف النسخ" المعلقة، وترك ملف وجهة بدون طول وبيانات تعريف كاملة.

function abortCopyFromURL(aborter: Aborter, copyId: string)

المعلمات

aborter

Aborter

إنشاء مثيل Aborter جديد باستخدام Aborter.none أو Aborter.timeout()، مستندات goto من Aborter للحصول على مزيد من الأمثلة حول إلغاء الطلب

copyId

string

المرتجعات

Promise<Models.FileAbortCopyResponse>

clearRange(Aborter, number, number)

مسح النطاق المحدد وإصدار المساحة المستخدمة في التخزين لهذا النطاق.

function clearRange(aborter: Aborter, offset: number, contentLength: number)

المعلمات

aborter

Aborter

إنشاء مثيل Aborter جديد باستخدام Aborter.none أو Aborter.timeout()، مستندات goto من Aborter للحصول على مزيد من الأمثلة حول إلغاء الطلب

offset

number

contentLength

number

المرتجعات

Promise<Models.FileUploadRangeResponse>

create(Aborter, number, IFileCreateOptions)

إنشاء ملف جديد أو استبدال ملف. لاحظ أنه يقوم بتهيئة الملف بدون محتوى فقط.

function create(aborter: Aborter, size: number, options?: IFileCreateOptions)

المعلمات

aborter

Aborter

إنشاء مثيل Aborter جديد باستخدام Aborter.none أو Aborter.timeout()، مستندات goto من Aborter للحصول على مزيد من الأمثلة حول إلغاء الطلب

size

number

يحدد الحد الأقصى للحجم بالبايت للملف، حتى 1 تيرابايت.

options

IFileCreateOptions

المرتجعات

Promise<Models.FileCreateResponse>

delete(Aborter)

إزالة الملف من حساب التخزين. عند حذف ملف بنجاح، تتم إزالته على الفور من فهرس حساب التخزين ولم يعد يمكن للعملاء الوصول إليه. تتم إزالة بيانات الملف لاحقا من الخدمة أثناء تجميع البيانات المهملة. سيفشل حذف ملف مع رمز الحالة 409 (تعارض) ورمز الخطأ SharingViolation إذا كان الملف مفتوحا على عميل SMB.

حذف ملف غير معتمد على لقطة مشاركة، وهي نسخة للقراءة فقط من المشاركة. ستفشل محاولة تنفيذ هذه العملية على لقطة مشاركة مع 400 (InvalidQueryParameterValue)

function delete(aborter: Aborter)

المعلمات

aborter

Aborter

إنشاء مثيل Aborter جديد باستخدام Aborter.none أو Aborter.timeout()، مستندات goto من Aborter للحصول على مزيد من الأمثلة حول إلغاء الطلب

المرتجعات

Promise<Models.FileDeleteResponse>

download(Aborter, number, undefined | number, IFileDownloadOptions)

قراءة ملف من النظام أو تنزيله، بما في ذلك بيانات التعريف والخصائص الخاصة به.

• في Node.js، ترجع البيانات في دفق قابل للقراءة readableStreamBody
• في المستعرضات، ترجع البيانات في وعد blobBody

function download(aborter: Aborter, offset: number, count?: undefined | number, options?: IFileDownloadOptions)

المعلمات

aborter

Aborter

إنشاء مثيل Aborter جديد باستخدام Aborter.none أو Aborter.timeout()، مستندات goto من Aborter للحصول على مزيد من الأمثلة حول إلغاء الطلب

offset

number

من أي موضع من الملف المراد تنزيله، >= 0

count

undefined | number

options

IFileDownloadOptions

المرتجعات

Promise<Models.FileDownloadResponse>

forceCloseHandle(Aborter, string)

فرض إغلاق مقبض معين لملف.

function forceCloseHandle(aborter: Aborter, handleId: string)

المعلمات

aborter

Aborter

إنشاء مثيل Aborter جديد باستخدام Aborter.none أو Aborter.timeout()، مستندات goto من Aborter للحصول على مزيد من الأمثلة حول إلغاء الطلب

handleId

string

معرف مقبض معين، لا يمكن أن يكون علامة نجمية "*". استخدم forceCloseHandlesSegment() لإغلاق جميع المقابض.

المرتجعات

Promise<Models.FileForceCloseHandlesResponse>

forceCloseHandlesSegment(Aborter, undefined | string)

فرض إغلاق كافة المقابض لملف.

function forceCloseHandlesSegment(aborter: Aborter, marker?: undefined | string)

المعلمات

aborter

Aborter

إنشاء مثيل Aborter جديد باستخدام Aborter.none أو Aborter.timeout()، مستندات goto من Aborter للحصول على مزيد من الأمثلة حول إلغاء الطلب

marker

undefined | string

المرتجعات

Promise<Models.FileForceCloseHandlesResponse>

fromDirectoryURL(DirectoryURL, string)

إنشاء كائن FileURL من كائن DirectoryURL.

static function fromDirectoryURL(directoryURL: DirectoryURL, fileName: string)

المعلمات

directoryURL

DirectoryURL

كائن DirectoryURL

fileName

string

اسم ملف

المرتجعات

FileURL

getProperties(Aborter)

إرجاع كافة بيانات التعريف المعرفة من قبل المستخدم وخصائص HTTP القياسية وخصائص النظام للملف. لا يقوم بإعادة محتوى الملف.

function getProperties(aborter: Aborter)

المعلمات

aborter

Aborter

إنشاء مثيل Aborter جديد باستخدام Aborter.none أو Aborter.timeout()، مستندات goto من Aborter للحصول على مزيد من الأمثلة حول إلغاء الطلب

المرتجعات

Promise<Models.FileGetPropertiesResponse>

getRangeList(Aborter, IFileGetRangeListOptions)

إرجاع قائمة النطاقات الصالحة لملف.

function getRangeList(aborter: Aborter, options?: IFileGetRangeListOptions)

المعلمات

aborter

Aborter

إنشاء مثيل Aborter جديد باستخدام Aborter.none أو Aborter.timeout()، مستندات goto من Aborter للحصول على مزيد من الأمثلة حول إلغاء الطلب

options

IFileGetRangeListOptions

المرتجعات

Promise<FileGetRangeListResponse>

listHandlesSegment(Aborter, undefined | string, IFileListHandlesSegmentOptions)

سرد مقابض ملف.

function listHandlesSegment(aborter: Aborter, marker?: undefined | string, options?: IFileListHandlesSegmentOptions)

المعلمات

aborter

Aborter

إنشاء مثيل Aborter جديد باستخدام Aborter.none أو Aborter.timeout()، مستندات goto من Aborter للحصول على مزيد من الأمثلة حول إلغاء الطلب

marker

undefined | string

options

IFileListHandlesSegmentOptions

المرتجعات

Promise<Models.FileListHandlesResponse>

newPipeline(Credential, INewPipelineOptions)

أسلوب ثابت يستخدم لإنشاء كائن مسار جديد مع توفير بيانات الاعتماد.

static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions)

المعلمات

credential

Credential

مثل AnonymousCredential، SharedKeyCredential.

pipelineOptions

INewPipelineOptions

المرتجعات

Pipeline

كائن مسار جديد.

resize(Aborter, number)

تغيير حجم الملف.

function resize(aborter: Aborter, length: number)

المعلمات

aborter

Aborter

إنشاء مثيل Aborter جديد باستخدام Aborter.none أو Aborter.timeout()، مستندات goto من Aborter للحصول على مزيد من الأمثلة حول إلغاء الطلب

length

number

تغيير حجم ملف إلى الحجم المحدد بالبايت. إذا كانت قيمة البايت المحددة أقل من الحجم الحالي للملف، مسح كافة النطاقات فوق قيمة البايت المحددة.

المرتجعات

Promise<Models.FileSetHTTPHeadersResponse>

setHTTPHeaders(Aborter, IFileHTTPHeaders)

تعيين رؤوس HTTP على الملف. إذا لم يتم توفير أي خيار، أو لم يتم توفير قيمة لرؤوس HTTP للملف في الخيارات، مسح رؤوس HTTP للملف هذه بدون قيمة.

function setHTTPHeaders(aborter: Aborter, fileHTTPHeaders?: IFileHTTPHeaders)

المعلمات

aborter

Aborter

إنشاء مثيل Aborter جديد باستخدام Aborter.none أو Aborter.timeout()، مستندات goto من Aborter للحصول على مزيد من الأمثلة حول إلغاء الطلب

fileHTTPHeaders

IFileHTTPHeaders

المرتجعات

Promise<Models.FileSetHTTPHeadersResponse>

setMetadata(Aborter, IMetadata)

تحديث بيانات التعريف المعرفة من قبل المستخدم للملف المحدد. إذا لم يتم تعريف بيانات التعريف في معلمة الخيار، فستتم إزالة بيانات تعريف الملف.

function setMetadata(aborter: Aborter, metadata?: IMetadata)

المعلمات

aborter

Aborter

إنشاء مثيل Aborter جديد باستخدام Aborter.none أو Aborter.timeout()، مستندات goto من Aborter للحصول على مزيد من الأمثلة حول إلغاء الطلب

metadata

IMetadata

المرتجعات

Promise<Models.FileSetMetadataResponse>

setProperties(Aborter, IFileProperties)

تعيين خصائص على الملف.

function setProperties(aborter: Aborter, properties?: IFileProperties)

المعلمات

aborter

Aborter

إنشاء مثيل Aborter جديد باستخدام Aborter.none أو Aborter.timeout()، مستندات goto من Aborter للحصول على مزيد من الأمثلة حول إلغاء الطلب

properties

IFileProperties

المرتجعات

Promise<ISetPropertiesResponse>

startCopyFromURL(Aborter, string, IFileStartCopyOptions)

نسخ كائن ثنائي كبير الحجم أو ملف إلى ملف وجهة داخل حساب التخزين.

function startCopyFromURL(aborter: Aborter, copySource: string, options?: IFileStartCopyOptions)

المعلمات

aborter

Aborter

إنشاء مثيل Aborter جديد باستخدام Aborter.none أو Aborter.timeout()، مستندات goto من Aborter للحصول على مزيد من الأمثلة حول إلغاء الطلب

copySource

string

يحدد عنوان URL للملف المصدر أو الكائن الثنائي كبير الحجم، حتى 2 كيلوبايت في الطول. لنسخ ملف إلى ملف آخر داخل نفس حساب التخزين، يمكنك استخدام المفتاح المشترك لمصادقة الملف المصدر. إذا كنت تقوم بنسخ ملف من حساب تخزين آخر، أو إذا كنت تقوم بنسخ كائن ثنائي كبير الحجم من نفس حساب التخزين أو حساب تخزين آخر، فيجب عليك مصادقة الملف المصدر أو الكائن الثنائي كبير الحجم باستخدام توقيع وصول مشترك. إذا كان المصدر كائن ثنائي كبير الحجم عام، فلا يلزم مصادقة لتنفيذ عملية النسخ. يمكن أيضا تحديد ملف في لقطة مشاركة كمصدر نسخ.

options

IFileStartCopyOptions

المرتجعات

Promise<Models.FileStartCopyResponse>

uploadRange(Aborter, HttpRequestBody, number, number, IFileUploadRangeOptions)

تحميل نطاق من وحدات البايت إلى ملف. يجب تحديد كل من بداية النطاق وعدده. يمكن أن يصل حجم النطاق إلى 4 ميغابايت.

function uploadRange(aborter: Aborter, body: HttpRequestBody, offset: number, contentLength: number, options?: IFileUploadRangeOptions)

المعلمات

aborter

Aborter

إنشاء مثيل Aborter جديد مع Aborter.none أو Aborter.timeout()، goto documents of Aborter للحصول على مزيد من الأمثلة حول إلغاء الطلب.

body

HttpRequestBody

Blob أو سلسلة أو ArrayBuffer أو ArrayBufferView أو دالة تقوم بإرجاع دفق جديد قابل للقراءة تكون إزاحته من بداية مصدر البيانات.

offset

number

إزاحة موضع ملف Azure الوجهة المراد تحميله.

contentLength

number

طول الجسم بالبايت. استخدم Buffer.byteLength() لحساب طول النص الأساسي لسلسلة بما في ذلك الأحرف غير المرمزة ب Base64/Hex.

options

IFileUploadRangeOptions

المرتجعات

Promise<Models.FileUploadRangeResponse>

uploadRangeFromURL(Aborter, string, number, number, number)

قم بتحميل نطاق من وحدات البايت إلى ملف حيث تتم قراءة المحتويات من عنوان URL لملف آخر. يمكن أن يصل حجم النطاق إلى 4 ميغابايت.

function uploadRangeFromURL(aborter: Aborter, sourceURL: string, sourceOffset: number, destOffset: number, count: number)

المعلمات

aborter

Aborter

إنشاء مثيل Aborter جديد مع Aborter.none أو Aborter.timeout()، goto documents of Aborter للحصول على مزيد من الأمثلة حول إلغاء الطلب.

sourceURL

string

حدد عنوان URL لمصدر النسخ، ربما يكون توقيع الوصول المشترك (SAS) مطلوبا للمصادقة.

sourceOffset

number

إزاحة المصدر للنسخ منها. مرر 0 للنسخ من بداية الملف المصدر.

destOffset

number

إزاحة ملف الوجهة.

count

number

عدد وحدات البايت التي سيتم تحميلها من الملف المصدر.

المرتجعات

Promise<Models.FileUploadRangeFromURLResponse>

withPipeline(Pipeline)

إنشاء كائن FileURL جديد مطابق للمصدر ولكن مع مسار نهج الطلب المحدد.

function withPipeline(pipeline: Pipeline)

المعلمات

pipeline

Pipeline

المرتجعات

FileURL