DirectoryURL class

الحزمة:

@azure/storage-file

يمثل DirectoryURL عنوان URL لدليل Azure Storage مما يسمح لك بمعالجة ملفاته ودلائله.

يمتد

StorageURL

المنشئون

DirectoryURL(string, Pipeline)

إنشاء مثيل DirectoryURL.

الخصائص

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

الأساليب

create(Aborter, IDirectoryCreateOptions)	إنشاء دليل جديد ضمن المشاركة المحددة أو الدليل الأصل.
delete(Aborter)	إزالة الدليل الفارغ المحدد. لاحظ أن الدليل يجب أن يكون فارغا قبل أن يمكن حذفه.
forceCloseHandle(Aborter, string)	فرض إغلاق مقبض معين لدليل.
forceCloseHandlesSegment(Aborter, undefined | string, IDirectoryForceCloseHandlesSegmentOptions)	فرض إغلاق كافة المقابض لدليل.
fromDirectoryURL(DirectoryURL, string)	إنشاء كائن DirectoryURL من DirectoryURL موجود.
fromShareURL(ShareURL, string)	إنشاء كائن DirectoryURL من ShareURL.
getProperties(Aborter)	إرجاع كافة خصائص النظام للدليل المحدد، ويمكن أيضا استخدامها للتحقق من وجود دليل. لا تتضمن البيانات التي تم إرجاعها الملفات الموجودة في الدليل أو أي أدلة فرعية.
listFilesAndDirectoriesSegment(Aborter, undefined | string, IDirectoryListFilesAndDirectoriesSegmentOptions)	إرجاع قائمة بالملفات أو الدلائل ضمن المشاركة أو الدليل المحدد. يسرد المحتويات فقط لمستوى واحد من التسلسل الهرمي للدليل.
listHandlesSegment(Aborter, undefined | string, IDirectoryListHandlesSegmentOptions)	سرد مقابض الدليل.
newPipeline(Credential, INewPipelineOptions)	أسلوب ثابت يستخدم لإنشاء كائن مسار جديد مع توفير بيانات الاعتماد.
setMetadata(Aborter, IMetadata)	تحديث بيانات التعريف المعرفة من قبل المستخدم للدليل المحدد.
setProperties(Aborter, IDirectoryProperties)	تعيين خصائص على الدليل.
withPipeline(Pipeline)	إنشاء كائن DirectoryURL جديد مطابق للمصدر ولكن مع مسار نهج الطلب المحدد.

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

DirectoryURL(string, Pipeline)

إنشاء مثيل DirectoryURL.

new DirectoryURL(url: string, pipeline: Pipeline)

المعلمات

url

string

سلسلة URL تشير إلى دليل ملف Azure Storage، مثل "https://myaccount.file.core.windows.net/myshare/mydirectory". يمكنك إلحاق SAS إذا كنت تستخدم AnonymousCredential، مثل "https://myaccount.file.core.windows.net/myshare/mydirectory?sasString". يقبل هذا الأسلوب عنوان URL مشفر أو عنوان URL غير مشفر يشير إلى دليل. لن يتم إلغاء سلسلة URL المرمزة مرتين، سيتم إلغاء الأحرف الخاصة فقط في مسار URL. ومع ذلك، إذا كان اسم الدليل يتضمن %، يجب ترميز اسم الدليل في عنوان URL. مثل دليل يسمى "mydir%"، يجب أن يكون عنوان URL "https://myaccount.file.core.windows.net/myshare/mydir%25".

pipeline

Pipeline

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

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

pipeline

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

pipeline: Pipeline

قيمة الخاصية

Pipeline

url

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

url: string

قيمة الخاصية

string

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

create(Aborter, IDirectoryCreateOptions)

إنشاء دليل جديد ضمن المشاركة المحددة أو الدليل الأصل.

function create(aborter: Aborter, options?: IDirectoryCreateOptions)

المعلمات

aborter

Aborter

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

options

IDirectoryCreateOptions

المرتجعات

Promise<Models.DirectoryCreateResponse>

delete(Aborter)

إزالة الدليل الفارغ المحدد. لاحظ أن الدليل يجب أن يكون فارغا قبل أن يمكن حذفه.

function delete(aborter: Aborter)

المعلمات

aborter

Aborter

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

المرتجعات

Promise<Models.DirectoryDeleteResponse>

forceCloseHandle(Aborter, string)

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

function forceCloseHandle(aborter: Aborter, handleId: string)

المعلمات

aborter

Aborter

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

handleId

string

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

المرتجعات

Promise<Models.DirectoryForceCloseHandlesResponse>

forceCloseHandlesSegment(Aborter, undefined | string, IDirectoryForceCloseHandlesSegmentOptions)

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

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

المعلمات

aborter

Aborter

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

marker

undefined | string

options

IDirectoryForceCloseHandlesSegmentOptions

المرتجعات

Promise<Models.DirectoryForceCloseHandlesResponse>

fromDirectoryURL(DirectoryURL, string)

إنشاء كائن DirectoryURL من DirectoryURL موجود.

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

المعلمات

directoryURL

DirectoryURL

كائن DirectoryURL

directoryName

string

اسم دليل فرعي

المرتجعات

DirectoryURL

fromShareURL(ShareURL, string)

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

static function fromShareURL(shareURL: ShareURL, directoryName: string)

المعلمات

shareURL

ShareURL

كائن ShareURL

directoryName

string

اسم دليل

المرتجعات

DirectoryURL

getProperties(Aborter)

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

function getProperties(aborter: Aborter)

المعلمات

aborter

Aborter

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

المرتجعات

Promise<Models.DirectoryGetPropertiesResponse>

listFilesAndDirectoriesSegment(Aborter, undefined | string, IDirectoryListFilesAndDirectoriesSegmentOptions)

إرجاع قائمة بالملفات أو الدلائل ضمن المشاركة أو الدليل المحدد. يسرد المحتويات فقط لمستوى واحد من التسلسل الهرمي للدليل.

function listFilesAndDirectoriesSegment(aborter: Aborter, marker?: undefined | string, options?: IDirectoryListFilesAndDirectoriesSegmentOptions)

المعلمات

aborter

Aborter

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

marker

undefined | string

options

IDirectoryListFilesAndDirectoriesSegmentOptions

المرتجعات

Promise<Models.DirectoryListFilesAndDirectoriesSegmentResponse>

listHandlesSegment(Aborter, undefined | string, IDirectoryListHandlesSegmentOptions)

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

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

المعلمات

aborter

Aborter

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

marker

undefined | string

options

IDirectoryListHandlesSegmentOptions

المرتجعات

Promise<Models.DirectoryListHandlesResponse>

newPipeline(Credential, INewPipelineOptions)

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

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

المعلمات

credential

Credential

مثل AnonymousCredential، SharedKeyCredential.

pipelineOptions

INewPipelineOptions

المرتجعات

Pipeline

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

setMetadata(Aborter, IMetadata)

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

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

المعلمات

aborter

Aborter

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

metadata

IMetadata

المرتجعات

Promise<Models.DirectorySetMetadataResponse>

setProperties(Aborter, IDirectoryProperties)

تعيين خصائص على الدليل.

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

المعلمات

aborter

Aborter

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

properties

IDirectoryProperties

المرتجعات

Promise<Models.DirectorySetPropertiesResponse>

withPipeline(Pipeline)

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

function withPipeline(pipeline: Pipeline)

المعلمات

pipeline

Pipeline

المرتجعات

DirectoryURL