ShareClient class

الحزمة:: @azure/storage-file-share

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

يمتد: StorageClient

المنشئون

ShareClient(string, Credential \| TokenCredential, ShareClientOptions)	إنشاء مثيل ل ShareClient.
ShareClient(string, Pipeline, ShareClientConfig)	إنشاء مثيل ل ShareClient.
ShareClient(string, string, ShareClientOptions)

الخصائص

name

اسم المشاركة

rootDirectoryClient

يحصل على عميل الدليل للدليل الجذر لهذه المشاركة. لاحظ أن الدليل الجذر موجود دائما ولا يمكن حذفه.

كائن ShareDirectoryClient جديد للدليل الجذر.

الخصائص الموروثة

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

الأساليب

create(ShareCreateOptions)	إنشاء مشاركة جديدة ضمن الحساب المحدد. إذا كانت المشاركة بنفس الاسم موجودة بالفعل، تفشل العملية. راجع https://learn.microsoft.com/rest/api/storageservices/create-share
createDirectory(string, DirectoryCreateOptions)	إنشاء دليل فرعي جديد ضمن هذه المشاركة. راجع https://learn.microsoft.com/rest/api/storageservices/create-directory
createFile(string, number, FileCreateOptions)	إنشاء ملف جديد أو استبدال ملف ضمن الدليل الجذر لهذه المشاركة. لاحظ أنه يقوم بتهيئة الملف بدون محتوى فقط. راجع https://learn.microsoft.com/rest/api/storageservices/create-file
createIfNotExists(ShareCreateOptions)	إنشاء مشاركة جديدة ضمن الحساب المحدد. إذا كانت المشاركة بنفس الاسم موجودة بالفعل، فلن يتم تغييرها. راجع https://learn.microsoft.com/rest/api/storageservices/create-share
createPermission(string \| SharePermission, ShareCreatePermissionOptions)	إنشاء إذن ملف (واصف أمان) على مستوى المشاركة. يمكن استخدام واصف الأمان الذي تم إنشاؤه للملفات/الدلائل في المشاركة. راجع https://learn.microsoft.com/rest/api/storageservices/create-permission
createSnapshot(ShareCreateSnapshotOptions)	إنشاء لقطة للقراءة فقط لمشاركة.
delete(ShareDeleteMethodOptions)	وضع علامة على المشاركة المحددة للحذف. يتم حذف المشاركة وأي دلائل أو ملفات موجودة داخلها لاحقا أثناء تجميع البيانات المهملة. راجع https://learn.microsoft.com/rest/api/storageservices/delete-share
deleteDirectory(string, DirectoryDeleteOptions)	إزالة الدليل الفرعي الفارغ المحدد ضمن هذه المشاركة. لاحظ أن الدليل يجب أن يكون فارغا قبل أن يمكن حذفه. راجع https://learn.microsoft.com/rest/api/storageservices/delete-directory
deleteFile(string, FileDeleteOptions)	إزالة ملف ضمن الدليل الجذر لهذه المشاركة من حساب التخزين. عند حذف ملف بنجاح، تتم إزالته على الفور من فهرس حساب التخزين ولم يعد يمكن للعملاء الوصول إليه. تتم إزالة بيانات الملف لاحقا من الخدمة أثناء تجميع البيانات المهملة. سيفشل حذف الملف مع رمز الحالة 409 (تعارض) ورمز الخطأ `SharingViolation` إذا كان الملف مفتوحا على عميل SMB. حذف ملف غير معتمد على لقطة مشاركة، وهي نسخة للقراءة فقط من المشاركة. ستفشل محاولة تنفيذ هذه العملية على لقطة مشاركة مع 400 (`InvalidQueryParameterValue`) راجع https://learn.microsoft.com/rest/api/storageservices/delete-file2
deleteIfExists(ShareDeleteMethodOptions)	وضع علامة على المشاركة المحددة للحذف إذا كانت موجودة. يتم حذف المشاركة وأي دلائل أو ملفات موجودة داخلها لاحقا أثناء تجميع البيانات المهملة. راجع https://learn.microsoft.com/rest/api/storageservices/delete-share
exists(ShareExistsOptions)	إرجاع true إذا كان مورد مشاركة Azrue الذي يمثله هذا العميل موجودا؛ خطأ خلاف ذلك. ملاحظة: استخدم هذه الدالة بعناية حيث قد يتم حذف مشاركة موجودة من قبل عملاء أو تطبيقات أخرى. قد تتم إضافة المشاركات الجديدة بالعكس بواسطة عملاء أو تطبيقات أخرى بعد اكتمال هذه الوظيفة.
generateSasStringToSign(ShareGenerateSasUrlOptions)	متوفر فقط ل ShareClient الذي تم إنشاؤه باستخدام بيانات اعتماد مفتاح مشترك. إنشاء سلسلة لتوقيع URI توقيع الوصول المشترك للخدمة (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة بيانات اعتماد المفتاح المشترك للعميل. راجع https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(ShareGenerateSasUrlOptions)	متوفر فقط ل ShareClient الذي تم إنشاؤه باستخدام بيانات اعتماد مفتاح مشترك. إنشاء عنوان URI لتوقيع الوصول المشترك للخدمة (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة بيانات اعتماد المفتاح المشترك للعميل. راجع https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(ShareGenerateSasUrlOptions, UserDelegationKey)	إنشاء عنوان URI لتوقيع الوصول المشترك للخدمة (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة إدخال بيانات اعتماد مفتاح تفويض المستخدم. راجع https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationStringToSign(ShareGenerateSasUrlOptions, UserDelegationKey)	إنشاء عنوان URI لتوقيع الوصول المشترك للخدمة (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة إدخال بيانات اعتماد مفتاح تفويض المستخدم. راجع https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
getAccessPolicy(ShareGetAccessPolicyOptions)	الحصول على أذونات المشاركة المحددة. تشير الأذونات إلى ما إذا كان يمكن الوصول إلى بيانات المشاركة بشكل عام. تحذير: من المحتمل أن يفقد تاريخ JavaScript الدقة عند تحليل سلسلة البدء وانتهاء الصلاحية. على سبيل المثال، التاريخ الجديد("2018-12-31T03:44:23.8827891Z").toISOString() سيحصل على "2018-12-31T03:44:23.882Z". راجع https://learn.microsoft.com/rest/api/storageservices/get-share-acl
getDirectoryClient(string)	إنشاء كائن ShareDirectoryClient.
getPermission(string, ShareGetPermissionOptions)	الحصول على لغة تعريف واصف الأمان (SDDL) لمفتاح إذن ملف معين يشير إلى واصف أمان. راجع https://learn.microsoft.com/rest/api/storageservices/get-permission
getProperties(ShareGetPropertiesOptions)	إرجاع كافة بيانات التعريف المعرفة من قبل المستخدم وخصائص النظام للمشاركة المحددة. راجع https://learn.microsoft.com/rest/api/storageservices/get-share-properties تحذير: سيكون للكائن `metadata` الذي تم إرجاعه في الاستجابة مفاتيحه بأحرف صغيرة، حتى لو احتوت في الأصل على أحرف كبيرة. يختلف هذا عن مفاتيح بيانات التعريف التي تم إرجاعها بواسطة الأسلوب `listShares`ShareServiceClient باستخدام خيار `includeMetadata`، والذي سيحتفظ بأحرفها الأصلية.
getShareLeaseClient(string)	احصل على ShareLeaseClient الذي يدير عقود الإيجار على الملف.
getStatistics(ShareGetStatisticsOptions)	استرداد الإحصائيات المتعلقة بالمشاركة.
setAccessPolicy(SignedIdentifier[], ShareSetAccessPolicyOptions)	تعيين الأذونات للمشاركة المحددة. تشير الأذونات إلى ما إذا كان يمكن الوصول إلى الدلائل أو الملفات في المشاركة بشكل عام. عند تعيين أذونات للمشاركة، يتم استبدال الأذونات الموجودة. إذا لم يتم توفير shareAcl، فستتم إزالة مشاركة قائمة التحكم بالوصول الموجودة. عند إنشاء نهج وصول مخزن على مشاركة، قد يستغرق سريانه ما يصل إلى 30 ثانية. أثناء هذا الفاصل الزمني، سيفشل توقيع الوصول المشترك المقترن بنهج الوصول المخزن مع رمز الحالة 403 (ممنوع)، حتى يصبح نهج الوصول نشطا. راجع https://learn.microsoft.com/rest/api/storageservices/set-share-acl
setMetadata(Metadata, ShareSetMetadataOptions)	تعيين زوج واحد أو أكثر من أزواج قيمة الاسم المعرفة من قبل المستخدم للمشاركة المحددة. إذا لم يتم توفير خيار أو لم يتم تحديد بيانات تعريف في معلمة الخيار، فستتم إزالة بيانات تعريف المشاركة. راجع https://learn.microsoft.com/rest/api/storageservices/set-share-metadata
setProperties(ShareSetPropertiesOptions)	تعيين خصائص المشاركة.
setQuota(number, ShareSetQuotaOptions)	تعيين الحصة النسبية للمشاركة المحددة.
withSnapshot(string)	إنشاء كائن ShareClient جديد مطابق للمصدر ولكن مع الطابع الزمني للقطة المحددة. توفير "" سيؤدي إلى إزالة اللقطة وإرجاع عنوان URL إلى المشاركة الأساسية.

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

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

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

المعلمات

url: string

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

credential: Credential | TokenCredential

مثل AnonymousCredential أو StorageSharedKeyCredential. إذا لم يتم تحديده، يتم استخدام AnonymousCredential.

options: ShareClientOptions

Optional. خيارات لتكوين البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.

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

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

المعلمات

url: string

pipeline: Pipeline

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

options: ShareClientConfig

new ShareClient(connectionString: string, name: string, options?: ShareClientOptions)

المعلمات

connectionString: string

سلسلة اتصال الحساب أو سلسلة اتصال SAS لحساب تخزين Azure. [ ملاحظة - يمكن استخدام سلسلة اتصال الحساب فقط في وقت تشغيل NODE.JS. ] مثال سلسلة اتصال الحساب - DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net مثال سلسلة اتصال SAS - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

name: string

مشاركة الاسم.

options: ShareClientOptions

Optional. خيارات لتكوين البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.

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

اسم المشاركة

string name

قيمة الخاصية

string

يحصل على عميل الدليل للدليل الجذر لهذه المشاركة. لاحظ أن الدليل الجذر موجود دائما ولا يمكن حذفه.

كائن ShareDirectoryClient جديد للدليل الجذر.

ShareDirectoryClient rootDirectoryClient

قيمة الخاصية

ShareDirectoryClient

تفاصيل الخاصية الموروثة

accountName: string

قيمة الخاصية

string

موروث من StorageClient.accountName

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

url: string

قيمة الخاصية

string

موروث من StorageClient.url

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

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

راجع https://learn.microsoft.com/rest/api/storageservices/create-share

function create(options?: ShareCreateOptions): Promise<ShareCreateResponse>

المعلمات

options: ShareCreateOptions

خيارات لمشاركة عملية الإنشاء.

المرتجعات

Promise<ShareCreateResponse>

بيانات الاستجابة لعملية إنشاء المشاركة.

إنشاء دليل فرعي جديد ضمن هذه المشاركة.

راجع https://learn.microsoft.com/rest/api/storageservices/create-directory

function createDirectory(directoryName: string, options?: DirectoryCreateOptions): Promise<{ directoryClient: ShareDirectoryClient, directoryCreateResponse: DirectoryCreateResponse }>

المعلمات

directoryName: string

options: DirectoryCreateOptions

خيارات عملية إنشاء الدليل.

المرتجعات

Promise<{ directoryClient: ShareDirectoryClient, directoryCreateResponse: DirectoryCreateResponse }>

بيانات استجابة إنشاء الدليل وعميل الدليل المقابل.

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

راجع https://learn.microsoft.com/rest/api/storageservices/create-file

function createFile(fileName: string, size: number, options?: FileCreateOptions): Promise<{ fileClient: ShareFileClient, fileCreateResponse: FileCreateResponse }>

المعلمات

fileName: string

size: number

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

options: FileCreateOptions

خيارات لعملية إنشاء ملف.

المرتجعات

Promise<{ fileClient: ShareFileClient, fileCreateResponse: FileCreateResponse }>

بيانات استجابة إنشاء الملف وعميل الملف المقابل.

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

راجع https://learn.microsoft.com/rest/api/storageservices/create-share

function createIfNotExists(options?: ShareCreateOptions): Promise<ShareCreateIfNotExistsResponse>

المعلمات

options: ShareCreateOptions

المرتجعات

Promise<ShareCreateIfNotExistsResponse>

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

راجع https://learn.microsoft.com/rest/api/storageservices/create-permission

function createPermission(filePermission: string | SharePermission, options?: ShareCreatePermissionOptions): Promise<ShareCreatePermissionResponse>

المعلمات

filePermission: string | SharePermission

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

options: ShareCreatePermissionOptions

خيارات لمشاركة عملية إنشاء إذن.

المرتجعات

Promise<ShareCreatePermissionResponse>

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

function createSnapshot(options?: ShareCreateSnapshotOptions): Promise<ShareCreateSnapshotResponse>

المعلمات

options: ShareCreateSnapshotOptions

خيارات لمشاركة عملية إنشاء لقطة.

المرتجعات

Promise<ShareCreateSnapshotResponse>

بيانات الاستجابة لعملية مشاركة إنشاء لقطة.

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

راجع https://learn.microsoft.com/rest/api/storageservices/delete-share

function delete(options?: ShareDeleteMethodOptions): Promise<ShareDeleteResponse>

المعلمات

options: ShareDeleteMethodOptions

خيارات لمشاركة عملية الحذف.

المرتجعات

Promise<ShareDeleteResponse>

بيانات الاستجابة لعملية "مشاركة الحذف".

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

راجع https://learn.microsoft.com/rest/api/storageservices/delete-directory

function deleteDirectory(directoryName: string, options?: DirectoryDeleteOptions): Promise<DirectoryDeleteResponse>

المعلمات

directoryName: string

options: DirectoryDeleteOptions

خيارات لعملية حذف الدليل.

المرتجعات

Promise<DirectoryDeleteResponse>

بيانات استجابة حذف الدليل.

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

سيفشل حذف الملف مع رمز الحالة 409 (تعارض) ورمز الخطأ SharingViolation إذا كان الملف مفتوحا على عميل SMB.

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

راجع https://learn.microsoft.com/rest/api/storageservices/delete-file2

function deleteFile(fileName: string, options?: FileDeleteOptions): Promise<FileDeleteResponse>

المعلمات

fileName: string

options: FileDeleteOptions

خيارات لعملية حذف الملف.

المرتجعات

Promise<FileDeleteResponse>

Promise<FileDeleteResponse> File حذف بيانات الاستجابة.

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

راجع https://learn.microsoft.com/rest/api/storageservices/delete-share

function deleteIfExists(options?: ShareDeleteMethodOptions): Promise<ShareDeleteIfExistsResponse>

المعلمات

options: ShareDeleteMethodOptions

المرتجعات

Promise<ShareDeleteIfExistsResponse>

إرجاع true إذا كان مورد مشاركة Azrue الذي يمثله هذا العميل موجودا؛ خطأ خلاف ذلك.

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

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

المعلمات

options: ShareExistsOptions

خيارات لعملية Exists.

المرتجعات

Promise<boolean>

متوفر فقط ل ShareClient الذي تم إنشاؤه باستخدام بيانات اعتماد مفتاح مشترك.

إنشاء سلسلة لتوقيع URI توقيع الوصول المشترك للخدمة (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة بيانات اعتماد المفتاح المشترك للعميل.

راجع https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: ShareGenerateSasUrlOptions): string

المعلمات

options: ShareGenerateSasUrlOptions

المعلمات الاختيارية.

المرتجعات

string

SAS URI الذي يتكون من URI للمورد الذي يمثله هذا العميل، متبوعا بالرمز المميز SAS الذي تم إنشاؤه.

متوفر فقط ل ShareClient الذي تم إنشاؤه باستخدام بيانات اعتماد مفتاح مشترك.

إنشاء عنوان URI لتوقيع الوصول المشترك للخدمة (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة بيانات اعتماد المفتاح المشترك للعميل.

راجع https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: ShareGenerateSasUrlOptions): string

المعلمات

options: ShareGenerateSasUrlOptions

المعلمات الاختيارية.

المرتجعات

string

SAS URI الذي يتكون من URI للمورد الذي يمثله هذا العميل، متبوعا بالرمز المميز SAS الذي تم إنشاؤه.

إنشاء عنوان 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 الذي تم إنشاؤه.

راجع 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 الذي تم إنشاؤه.

الحصول على أذونات المشاركة المحددة. تشير الأذونات إلى ما إذا كان يمكن الوصول إلى بيانات المشاركة بشكل عام.

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

راجع https://learn.microsoft.com/rest/api/storageservices/get-share-acl

function getAccessPolicy(options?: ShareGetAccessPolicyOptions): Promise<ShareGetAccessPolicyResponse>

المعلمات

options: ShareGetAccessPolicyOptions

المرتجعات

Promise<ShareGetAccessPolicyResponse>

بيانات الاستجابة لعملية Share Get Access Policy.

إنشاء كائن ShareDirectoryClient.

function getDirectoryClient(directoryName: string): ShareDirectoryClient

المعلمات

directoryName: string

اسم دليل

المرتجعات

ShareDirectoryClient

كائن ShareDirectoryClient لاسم الدليل المحدد.

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

راجع https://learn.microsoft.com/rest/api/storageservices/get-permission

function getPermission(filePermissionKey: string, options?: ShareGetPermissionOptions): Promise<ShareGetPermissionResponse>

المعلمات

filePermissionKey: string

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

options: ShareGetPermissionOptions

خيارات لمشاركة عملية إنشاء إذن.

المرتجعات

Promise<ShareGetPermissionResponse>

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

راجع https://learn.microsoft.com/rest/api/storageservices/get-share-properties

تحذير: سيكون للكائن metadata الذي تم إرجاعه في الاستجابة مفاتيحه بأحرف صغيرة، حتى لو احتوت في الأصل على أحرف كبيرة. يختلف هذا عن مفاتيح بيانات التعريف التي تم إرجاعها بواسطة الأسلوب listSharesShareServiceClient باستخدام خيار includeMetadata، والذي سيحتفظ بأحرفها الأصلية.

function getProperties(options?: ShareGetPropertiesOptions): Promise<ShareGetPropertiesResponse>

المعلمات

options: ShareGetPropertiesOptions

المرتجعات

Promise<ShareGetPropertiesResponse>

بيانات الاستجابة لعملية Share Get Properties.

احصل على ShareLeaseClient الذي يدير عقود الإيجار على الملف.

function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient

المعلمات

proposeLeaseId: string

معرف التأجير المقترح الأولي.

المرتجعات

ShareLeaseClient

عنصر ShareLeaseClient جديد لإدارة عقود الإيجار على الملف.

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

function getStatistics(options?: ShareGetStatisticsOptions): Promise<ShareGetStatisticsResponse>

المعلمات

options: ShareGetStatisticsOptions

المرتجعات

Promise<ShareGetStatisticsResponse>

بيانات الاستجابة لعملية مشاركة الحصول على الإحصائيات.

تعيين الأذونات للمشاركة المحددة. تشير الأذونات إلى ما إذا كان يمكن الوصول إلى الدلائل أو الملفات في المشاركة بشكل عام.

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

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

راجع https://learn.microsoft.com/rest/api/storageservices/set-share-acl

function setAccessPolicy(shareAcl?: SignedIdentifier[], options?: ShareSetAccessPolicyOptions): Promise<ShareSetAccessPolicyResponse>

المعلمات

shareAcl: SignedIdentifier[]

صفيف من المعرفات الموقعة، لكل منها معرف فريد وتفاصيل نهج الوصول.

options: ShareSetAccessPolicyOptions

المرتجعات

Promise<ShareSetAccessPolicyResponse>

بيانات الاستجابة لعملية نهج الوصول لمجموعة المشاركة.

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

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

راجع https://learn.microsoft.com/rest/api/storageservices/set-share-metadata

function setMetadata(metadata?: Metadata, options?: ShareSetMetadataOptions): Promise<ShareSetMetadataResponse>

المعلمات

metadata: Metadata

إذا لم يتم توفير بيانات تعريف، فستتم إزالة جميع بيانات تعريف الدليل الموجودة.

options: ShareSetMetadataOptions

المرتجعات

Promise<ShareSetMetadataResponse>

بيانات الاستجابة لعملية Share Set Metadata.

تعيين خصائص المشاركة.

function setProperties(options?: ShareSetPropertiesOptions): Promise<ShareSetPropertiesResponse>

المعلمات

options: ShareSetPropertiesOptions

المرتجعات

Promise<ShareSetPropertiesResponse>

بيانات الاستجابة لعملية "خصائص مجموعة المشاركة".

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

Use setProperties instead.

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

function setQuota(quotaInGB: number, options?: ShareSetQuotaOptions): Promise<ShareSetQuotaResponse>

المعلمات

quotaInGB: number

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

options: ShareSetQuotaOptions

المرتجعات

Promise<ShareSetQuotaResponse>

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

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

function withSnapshot(snapshot: string): ShareClient

المعلمات

snapshot: string

الطابع الزمني للقطة.

المرتجعات

ShareClient

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

مشاركة عبر

ShareClient class

المنشئون

الخصائص

الخصائص الموروثة

الأساليب

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

ShareClient(string, Credential | TokenCredential, ShareClientOptions)

المعلمات

ShareClient(string, Pipeline, ShareClientConfig)

المعلمات

ShareClient(string, string, ShareClientOptions)

المعلمات

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

name

قيمة الخاصية

rootDirectoryClient

قيمة الخاصية

تفاصيل الخاصية الموروثة

accountName

قيمة الخاصية

url

قيمة الخاصية

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

create(ShareCreateOptions)

المعلمات

المرتجعات

createDirectory(string, DirectoryCreateOptions)

المعلمات

المرتجعات

createFile(string, number, FileCreateOptions)

المعلمات

المرتجعات

createIfNotExists(ShareCreateOptions)

المعلمات

المرتجعات

createPermission(string | SharePermission, ShareCreatePermissionOptions)

المعلمات

المرتجعات

createSnapshot(ShareCreateSnapshotOptions)

المعلمات

المرتجعات

delete(ShareDeleteMethodOptions)

المعلمات

المرتجعات

deleteDirectory(string, DirectoryDeleteOptions)

المعلمات

المرتجعات

deleteFile(string, FileDeleteOptions)

المعلمات

المرتجعات

deleteIfExists(ShareDeleteMethodOptions)

المعلمات

المرتجعات

exists(ShareExistsOptions)

المعلمات

المرتجعات

generateSasStringToSign(ShareGenerateSasUrlOptions)

المعلمات

المرتجعات

generateSasUrl(ShareGenerateSasUrlOptions)

المعلمات

المرتجعات

generateUserDelegationSasUrl(ShareGenerateSasUrlOptions, UserDelegationKey)

المعلمات

المرتجعات

generateUserDelegationStringToSign(ShareGenerateSasUrlOptions, UserDelegationKey)

المعلمات

المرتجعات

getAccessPolicy(ShareGetAccessPolicyOptions)

المعلمات

المرتجعات

getDirectoryClient(string)

المعلمات

المرتجعات

getPermission(string, ShareGetPermissionOptions)

المعلمات

المرتجعات

getProperties(ShareGetPropertiesOptions)

المعلمات