ShareURL class

الحزمة:

@azure/storage-file

يمثل ShareURL عنوان URL لمشاركة Azure Storage مما يسمح لك بمعالجة الدلائل والملفات الخاصة به.

يمتد

StorageURL

المنشئون

ShareURL(string, Pipeline)

إنشاء مثيل ل ShareURL.

الخصائص

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

الأساليب

create(Aborter, IShareCreateOptions)	إنشاء مشاركة جديدة ضمن الحساب المحدد. إذا كانت المشاركة بنفس الاسم موجودة بالفعل، تفشل العملية.
createPermission(Aborter, string)	إنشاء إذن ملف (واصف أمان) على مستوى المشاركة. يمكن استخدام واصف الأمان الذي تم إنشاؤه للملفات/الدلائل في المشاركة.
createSnapshot(Aborter, IShareCreateSnapshotOptions)	إنشاء لقطة للقراءة فقط لمشاركة.
delete(Aborter, IShareDeleteMethodOptions)	وضع علامة على المشاركة المحددة للحذف. يتم حذف المشاركة وأي دلائل أو ملفات موجودة داخلها لاحقا أثناء تجميع البيانات المهملة.
fromServiceURL(ServiceURL, string)	إنشاء كائن ShareURL من ServiceURL
getAccessPolicy(Aborter)	الحصول على أذونات المشاركة المحددة. تشير الأذونات إلى ما إذا كان يمكن الوصول إلى بيانات المشاركة بشكل عام. تحذير: من المحتمل أن يفقد تاريخ JavaScript الدقة عند تحليل سلسلة البدء وانتهاء الصلاحية. على سبيل المثال، التاريخ الجديد("2018-12-31T03:44:23.8827891Z").toISOString() سيحصل على "2018-12-31T03:44:23.882Z".
getPermission(Aborter, string)	الحصول على لغة تعريف واصف الأمان (SDDL) لمفتاح إذن ملف معين يشير إلى واصف أمان.
getProperties(Aborter)	إرجاع كافة بيانات التعريف المعرفة من قبل المستخدم وخصائص النظام للمشاركة المحددة.
getStatistics(Aborter)	استرداد الإحصائيات المتعلقة بالمشاركة.
newPipeline(Credential, INewPipelineOptions)	أسلوب ثابت يستخدم لإنشاء كائن مسار جديد مع توفير بيانات الاعتماد.
setAccessPolicy(Aborter, ISignedIdentifier[])	تعيين الأذونات للمشاركة المحددة. تشير الأذونات إلى ما إذا كان يمكن الوصول إلى الدلائل أو الملفات في المشاركة بشكل عام. عند تعيين أذونات للمشاركة، يتم استبدال الأذونات الموجودة. إذا لم يتم توفير shareAcl، فستتم إزالة مشاركة قائمة التحكم بالوصول الموجودة.
setMetadata(Aborter, IMetadata)	تعيين زوج واحد أو أكثر من أزواج قيمة الاسم المعرفة من قبل المستخدم للمشاركة المحددة. إذا لم يتم توفير خيار أو لم يتم تحديد بيانات تعريف في معلمة الخيار، فستتم إزالة بيانات تعريف المشاركة.
setQuota(Aborter, number)	تعيين الحصة النسبية للمشاركة المحددة.
withPipeline(Pipeline)	إنشاء كائن ShareURL جديد مطابق للمصدر ولكن مع مسار نهج الطلب المحدد.
withSnapshot(string)	إنشاء كائن ShareURL جديد مطابق للمصدر ولكن مع الطابع الزمني للقطة المحددة. توفير "" سيؤدي إلى إزالة اللقطة وإرجاع عنوان URL إلى المشاركة الأساسية.

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

ShareURL(string, Pipeline)

إنشاء مثيل ل ShareURL.

new ShareURL(url: string, pipeline: Pipeline)

المعلمات

url

string

سلسلة URL تشير إلى مشاركة ملف Azure Storage، مثل "https://myaccount.file.core.windows.net/share". يمكنك إلحاق SAS إذا كنت تستخدم AnonymousCredential، مثل "https://myaccount.file.core.windows.net/share?sasString".

pipeline

Pipeline

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

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

pipeline

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

pipeline: Pipeline

قيمة الخاصية

Pipeline

url

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

url: string

قيمة الخاصية

string

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

create(Aborter, IShareCreateOptions)

إنشاء مشاركة جديدة ضمن الحساب المحدد. إذا كانت المشاركة بنفس الاسم موجودة بالفعل، تفشل العملية.

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

المعلمات

aborter

Aborter

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

options

IShareCreateOptions

المرتجعات

Promise<Models.ShareCreateResponse>

createPermission(Aborter, string)

إنشاء إذن ملف (واصف أمان) على مستوى المشاركة. يمكن استخدام واصف الأمان الذي تم إنشاؤه للملفات/الدلائل في المشاركة.

function createPermission(aborter: Aborter, filePermission: string)

المعلمات

aborter

Aborter

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

filePermission

string

إذن الملف الموضح في SDDL

المرتجعات

Promise<Models.ShareCreatePermissionResponse>

createSnapshot(Aborter, IShareCreateSnapshotOptions)

إنشاء لقطة للقراءة فقط لمشاركة.

function createSnapshot(aborter: Aborter, options?: IShareCreateSnapshotOptions)

المعلمات

aborter

Aborter

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

options

IShareCreateSnapshotOptions

المرتجعات

Promise<Models.ShareCreateSnapshotResponse>

delete(Aborter, IShareDeleteMethodOptions)

وضع علامة على المشاركة المحددة للحذف. يتم حذف المشاركة وأي دلائل أو ملفات موجودة داخلها لاحقا أثناء تجميع البيانات المهملة.

function delete(aborter: Aborter, options?: IShareDeleteMethodOptions)

المعلمات

aborter

Aborter

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

options

IShareDeleteMethodOptions

المرتجعات

Promise<Models.ShareDeleteResponse>

fromServiceURL(ServiceURL, string)

إنشاء كائن ShareURL من ServiceURL

static function fromServiceURL(serviceURL: ServiceURL, shareName: string)

المعلمات

serviceURL

ServiceURL

shareName

string

المرتجعات

ShareURL

getAccessPolicy(Aborter)

الحصول على أذونات المشاركة المحددة. تشير الأذونات إلى ما إذا كان يمكن الوصول إلى بيانات المشاركة بشكل عام. تحذير: من المحتمل أن يفقد تاريخ JavaScript الدقة عند تحليل سلسلة البدء وانتهاء الصلاحية. على سبيل المثال، التاريخ الجديد("2018-12-31T03:44:23.8827891Z").toISOString() سيحصل على "2018-12-31T03:44:23.882Z".

function getAccessPolicy(aborter: Aborter)

المعلمات

aborter

Aborter

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

المرتجعات

Promise<ShareGetAccessPolicyResponse>

getPermission(Aborter, string)

الحصول على لغة تعريف واصف الأمان (SDDL) لمفتاح إذن ملف معين يشير إلى واصف أمان.

function getPermission(aborter: Aborter, filePermissionKey: string)

المعلمات

aborter

Aborter

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

filePermissionKey

string

مفتاح أذونات الملف الذي يشير إلى واصف الأمان للإذن.

المرتجعات

Promise<Models.ShareGetPermissionResponse>

getProperties(Aborter)

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

function getProperties(aborter: Aborter)

المعلمات

aborter

Aborter

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

المرتجعات

Promise<Models.ShareGetPropertiesResponse>

getStatistics(Aborter)

استرداد الإحصائيات المتعلقة بالمشاركة.

function getStatistics(aborter: Aborter)

المعلمات

aborter

Aborter

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

المرتجعات

Promise<ShareGetStatisticsResponse>

newPipeline(Credential, INewPipelineOptions)

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

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

المعلمات

credential

Credential

مثل AnonymousCredential، SharedKeyCredential.

pipelineOptions

INewPipelineOptions

المرتجعات

Pipeline

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

setAccessPolicy(Aborter, ISignedIdentifier[])

تعيين الأذونات للمشاركة المحددة. تشير الأذونات إلى ما إذا كان يمكن الوصول إلى الدلائل أو الملفات في المشاركة بشكل عام. عند تعيين أذونات للمشاركة، يتم استبدال الأذونات الموجودة. إذا لم يتم توفير shareAcl، فستتم إزالة مشاركة قائمة التحكم بالوصول الموجودة.

function setAccessPolicy(aborter: Aborter, shareAcl?: ISignedIdentifier[])

المعلمات

aborter

Aborter

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

shareAcl

ISignedIdentifier[]

المرتجعات

Promise<Models.ShareSetAccessPolicyResponse>

setMetadata(Aborter, IMetadata)

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

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

المعلمات

aborter

Aborter

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

metadata

IMetadata

المرتجعات

Promise<Models.ShareSetMetadataResponse>

setQuota(Aborter, number)

تعيين الحصة النسبية للمشاركة المحددة.

function setQuota(aborter: Aborter, quotaInGB: number)

المعلمات

aborter

Aborter

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

quotaInGB

number

تحديد الحد الأقصى لحجم المشاركة بالجيجابايت

المرتجعات

Promise<Models.ShareSetQuotaResponse>

withPipeline(Pipeline)

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

function withPipeline(pipeline: Pipeline)

المعلمات

pipeline

Pipeline

المرتجعات

ShareURL

withSnapshot(string)

إنشاء كائن ShareURL جديد مطابق للمصدر ولكن مع الطابع الزمني للقطة المحددة. توفير "" سيؤدي إلى إزالة اللقطة وإرجاع عنوان URL إلى المشاركة الأساسية.

function withSnapshot(snapshot: string)

المعلمات

snapshot

string

المرتجعات

ShareURL

كائن ShareURL جديد مطابق للمصدر ولكن مع الطابع الزمني للقطة المحددة