ServiceBusAdministrationClient class

الحزمة:: @azure/service-bus

ترجع جميع العمليات الوعود التي يتم حلها إلى كائن يحتوي على الإخراج ذي الصلة. تحتوي هذه الكائنات أيضا على خاصية تسمى _response يمكنك استخدامها إذا كنت تريد الوصول إلى الاستجابة المباشرة من الخدمة.

يمتد: ServiceClient

المنشئون

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)	تهيئة مثيل جديد من فئة ServiceBusAdministrationClient.
ServiceBusAdministrationClient(string, TokenCredential \| NamedKeyCredential, ServiceBusAdministrationClientOptions)

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

pipeline

البنية الأساسية لبرنامج ربط العمليات التجارية المستخدمة من قبل هذا العميل لتقديم الطلبات

الأساليب

createQueue(string, CreateQueueOptions)	إنشاء قائمة انتظار باسم معين، تم تكوينها باستخدام الخيارات المحددة
createRule(string, string, string, CorrelationRuleFilter \| SqlRuleFilter, OperationOptions)	إنشاء قاعدة باسم معين، تم تكوينها باستخدام الخيارات المحددة.
createRule(string, string, string, CorrelationRuleFilter \| SqlRuleFilter, SqlRuleAction, OperationOptions)	إنشاء قاعدة باسم معين، تم تكوينها باستخدام الخيارات المحددة.
createSubscription(string, string, CreateSubscriptionOptions)	إنشاء اشتراك باسم معين، تم تكوينه باستخدام الخيارات المحددة
createTopic(string, CreateTopicOptions)	إنشاء موضوع باسم معين، تم تكوينه باستخدام الخيارات المحددة
deleteQueue(string, OperationOptions)	حذف قائمة انتظار.
deleteRule(string, string, string, OperationOptions)	حذف قاعدة.
deleteSubscription(string, string, OperationOptions)	حذف اشتراك.
deleteTopic(string, OperationOptions)	حذف موضوع.
getNamespaceProperties(OperationOptions)	إرجاع كائن يمثل بيانات التعريف المتعلقة بمساحة اسم ناقل الخدمة.
getQueue(string, OperationOptions)	إرجاع كائن يمثل قائمة الانتظار وخصائصها. إذا كنت تريد الحصول على معلومات وقت تشغيل قائمة الانتظار مثل تفاصيل عدد الرسائل، فاستخدم `getQueueRuntimeProperties` API.
getQueueRuntimeProperties(string, OperationOptions)	إرجاع كائن يمثل معلومات وقت تشغيل قائمة الانتظار مثل تفاصيل عدد الرسائل.
getRule(string, string, string, OperationOptions)	إرجاع كائن يمثل القاعدة بالاسم المحدد مع كافة خصائصها.
getSubscription(string, string, OperationOptions)	إرجاع كائن يمثل الاشتراك وخصائصه. إذا كنت ترغب في الحصول على معلومات وقت تشغيل الاشتراك مثل تفاصيل عدد الرسائل، فاستخدم `getSubscriptionRuntimeProperties` API.
getSubscriptionRuntimeProperties(string, string, OperationOptions)	إرجاع كائن يمثل معلومات وقت تشغيل الاشتراك مثل تفاصيل عدد الرسائل.
getTopic(string, OperationOptions)	إرجاع كائن يمثل الموضوع وخصائصه. إذا كنت ترغب في الحصول على معلومات وقت تشغيل الموضوع مثل تفاصيل عدد الاشتراكات، فاستخدم `getTopicRuntimeProperties` API.
getTopicRuntimeProperties(string, OperationOptions)	إرجاع كائن يمثل معلومات وقت تشغيل الموضوع مثل عدد الاشتراكات.
listQueues(OperationOptions)	إرجاع مكرر غير متزامن قابل للتكبير لسرد جميع قوائم الانتظار. يقوم .byPage() بإرجاع مكرر غير متزامن قابل للتكريب لسرد قوائم الانتظار في الصفحات.
listQueuesRuntimeProperties(OperationOptions)	ترجع هذه الدالة مكرر غير متزامن لسرد معلومات وقت التشغيل لقوائم الانتظار. يقوم .byPage() بإرجاع تكرار غير متزامن لسرد معلومات وقت التشغيل لقوائم الانتظار في الصفحات.
listRules(string, string, OperationOptions)	إرجاع مكرر غير متزامن قابل للتكبير لسرد جميع القواعد ضمن الاشتراك المحدد. يقوم .byPage() بإرجاع تكرار غير متزامن لسرد القواعد في الصفحات.
listSubscriptions(string, OperationOptions)	ترجع هذه الدالة مكرر غير متزامن لسرد جميع الاشتراكات ضمن الموضوع المحدد. يقوم .byPage() بإرجاع مكرر غير متزامن قابل للتكريب لسرد الاشتراكات في الصفحات.
listSubscriptionsRuntimeProperties(string, OperationOptions)	إرجاع مكرر غير متزامن قابل للتكدير لسرد معلومات وقت التشغيل للاشتراكات ضمن الموضوع المحدد. يقوم .byPage() بإرجاع تكرار غير متزامن لسرد معلومات وقت التشغيل للاشتراكات في الصفحات.
listTopics(OperationOptions)	إرجاع مكرر غير متزامن قابل للتكبير لسرد جميع الموضوعات. يقوم .byPage() بإرجاع مكرر غير متزامن قابل للتكريب لسرد الموضوعات في الصفحات.
listTopicsRuntimeProperties(OperationOptions)	ترجع هذه الدالة مكرر غير متزامن لسرد معلومات وقت التشغيل للمواضيع. يقوم .byPage() بإرجاع تكرار غير متزامن لسرد معلومات وقت التشغيل للمواضيع في الصفحات.
queueExists(string, OperationOptions)	التحقق من وجود قائمة انتظار معينة أم لا.
ruleExists(string, string, string, OperationOptions)	التحقق من وجود قاعدة معينة أم لا.
subscriptionExists(string, string, OperationOptions)	التحقق من وجود اشتراك معين في الموضوع أم لا.
topicExists(string, OperationOptions)	التحقق من وجود موضوع معين أم لا.
updateQueue(WithResponse<QueueProperties>, OperationOptions)	تحديث قائمة الانتظار استنادا إلى خصائص قائمة الانتظار المتوفرة. يجب تعيين كافة خصائص قائمة الانتظار على الرغم من أن مجموعة فرعية منها فقط قابلة للتحديث بالفعل. لذلك، التدفق المقترح هو استخدام الإخراج من `getQueue()`، وتحديث الخصائص المطلوبة فيه، ثم تمرير الكائن المعدل إلى `updateQueue()`. يتم وضع علامة للقراءة فقط على الخصائص التي لا يمكن تحديثها في واجهة `QueueProperties`.
updateRule(string, string, WithResponse<RuleProperties>, OperationOptions)	تحديث الخصائص على القاعدة بالاسم المحدد استنادا إلى الخيارات المحددة. يجب تعيين كافة خصائص القاعدة حتى إذا تم تحديث إحدى هذه الخصائص. لذلك، التدفق المقترح هو استخدام الإخراج من `getRule()`، وتحديث الخصائص المطلوبة فيه، ثم تمرير الكائن المعدل إلى `updateRule()`.
updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)	يحدث الاشتراك استنادا إلى خصائص الاشتراك المتوفرة. يجب تعيين جميع خصائص الاشتراك على الرغم من أن مجموعة فرعية منها فقط قابلة للتحديث بالفعل. لذلك، التدفق المقترح هو استخدام الإخراج من `getSubscription()`، وتحديث الخصائص المطلوبة فيه، ثم تمرير الكائن المعدل إلى `updateSubscription()`. يتم وضع علامة للقراءة فقط على الخصائص التي لا يمكن تحديثها في واجهة `SubscriptionProperties`.
updateTopic(WithResponse<TopicProperties>, OperationOptions)	يحدث الموضوع استنادا إلى خصائص الموضوع المتوفرة. يجب تعيين جميع خصائص الموضوع على الرغم من أن مجموعة فرعية منها فقط قابلة للتحديث بالفعل. لذلك، التدفق المقترح هو استخدام الإخراج من `getTopic()`، وتحديث الخصائص المطلوبة فيه، ثم تمرير الكائن المعدل إلى `updateTopic()`. يتم وضع علامة للقراءة فقط على الخصائص التي لا يمكن تحديثها في واجهة `TopicProperties`.

الأساليب المتوارثة

sendOperationRequest<T>(OperationArguments, OperationSpec)	إرسال طلب HTTP الذي يتم ملؤه باستخدام OperationSpec المتوفرة.
sendRequest(PipelineRequest)	إرسال httpRequest المتوفر.

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

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

تهيئة مثيل جديد من فئة ServiceBusAdministrationClient.

new ServiceBusAdministrationClient(connectionString: string, options?: ServiceBusAdministrationClientOptions)

المعلمات

connectionString: string

سلسلة الاتصال المطلوبة للعميل للاتصال ب Azure.

options: ServiceBusAdministrationClientOptions

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

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

new ServiceBusAdministrationClient(fullyQualifiedNamespace: string, credential: TokenCredential | NamedKeyCredential, options?: ServiceBusAdministrationClientOptions)

المعلمات

fullyQualifiedNamespace: string

مساحة الاسم المؤهلة بالكامل لمثيل ناقل خدمة Microsoft Azure والتي من المحتمل أن تكون مشابهة ل <yournamespace.servicebus.windows.net>.

credential: TokenCredential | NamedKeyCredential

كائن بيانات اعتماد يستخدمه العميل للحصول على الرمز المميز لمصادقة الاتصال مع ناقل خدمة Microsoft Azure. راجع @azure/الهوية لإنشاء بيانات الاعتماد. إذا كنت تستخدم التنفيذ الخاص بك لواجهة TokenCredential مقابل AAD، فقم بتعيين "النطاقات" لناقل الخدمة ليتم ["https://servicebus.azure.net//user_impersonation"] للحصول على الرمز المميز المناسب. استخدم AzureNamedKeyCredential من @azure/core-auth إذا كنت تريد تمرير SharedAccessKeyNameSharedAccessKey دون استخدام سلسلة اتصال. تعين هذه الحقول إلى الحقلين namekey على التوالي في AzureNamedKeyCredential.

options: ServiceBusAdministrationClientOptions

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

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

pipeline

البنية الأساسية لبرنامج ربط العمليات التجارية المستخدمة من قبل هذا العميل لتقديم الطلبات

pipeline: Pipeline

قيمة الخاصية

Pipeline

موروث من ServiceClient.pipeline

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

createQueue(string, CreateQueueOptions)

إنشاء قائمة انتظار باسم معين، تم تكوينها باستخدام الخيارات المحددة

function createQueue(queueName: string, options?: CreateQueueOptions): Promise<WithResponse<QueueProperties>>

المعلمات

queueName: string

options: CreateQueueOptions

خيارات لتكوين قائمة الانتظار التي يتم إنشاؤها (على سبيل المثال، يمكنك تكوين قائمة انتظار لدعم الأقسام أو الجلسات) وخيارات العملية التي يمكن استخدامها لإجهاض التكوينات الأخرى وتتبعها والتحكم فيها على طلب HTTP.

فيما يلي الأخطاء التي يمكن توقعها من هذه العملية

المرتجعات

Promise<WithResponse<QueueProperties>>

createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, OperationOptions)

إنشاء قاعدة باسم معين، تم تكوينها باستخدام الخيارات المحددة.

function createRule(topicName: string, subscriptionName: string, ruleName: string, ruleFilter: CorrelationRuleFilter | SqlRuleFilter, operationOptions?: OperationOptions): Promise<WithResponse<RuleProperties>>

المعلمات

topicName: string

subscriptionName: string

ruleName: string

ruleFilter: CorrelationRuleFilter | SqlRuleFilter

تعريف تعبير عامل التصفية الذي تقيمه القاعدة.

operationOptions: OperationOptions

الخيارات التي يمكن استخدامها لإجهاض التكوينات الأخرى وتتبعها والتحكم فيها على طلب HTTP.

فيما يلي الأخطاء التي يمكن توقعها من هذه العملية

المرتجعات

Promise<WithResponse<RuleProperties>>

createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, SqlRuleAction, OperationOptions)

إنشاء قاعدة باسم معين، تم تكوينها باستخدام الخيارات المحددة.

function createRule(topicName: string, subscriptionName: string, ruleName: string, ruleFilter: CorrelationRuleFilter | SqlRuleFilter, ruleAction: SqlRuleAction, operationOptions?: OperationOptions): Promise<WithResponse<RuleProperties>>

المعلمات

topicName: string

subscriptionName: string

ruleName: string

ruleFilter: CorrelationRuleFilter | SqlRuleFilter

تعريف تعبير عامل التصفية الذي تقيمه القاعدة.

ruleAction: SqlRuleAction

يجب تطبيق عامل التصفية المقترن ب SQL مثل التعبير الذي يمكن تنفيذه على الرسالة.

operationOptions: OperationOptions

الخيارات التي يمكن استخدامها لإجهاض التكوينات الأخرى وتتبعها والتحكم فيها على طلب HTTP.

فيما يلي الأخطاء التي يمكن توقعها من هذه العملية

المرتجعات

Promise<WithResponse<RuleProperties>>

createSubscription(string, string, CreateSubscriptionOptions)

إنشاء اشتراك باسم معين، تم تكوينه باستخدام الخيارات المحددة

function createSubscription(topicName: string, subscriptionName: string, options?: CreateSubscriptionOptions): Promise<WithResponse<SubscriptionProperties>>

المعلمات

topicName: string

subscriptionName: string

options: CreateSubscriptionOptions

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

فيما يلي الأخطاء التي يمكن توقعها من هذه العملية

المرتجعات

Promise<WithResponse<SubscriptionProperties>>

createTopic(string, CreateTopicOptions)

إنشاء موضوع باسم معين، تم تكوينه باستخدام الخيارات المحددة

function createTopic(topicName: string, options?: CreateTopicOptions): Promise<WithResponse<TopicProperties>>

المعلمات

topicName: string

options: CreateTopicOptions

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

فيما يلي الأخطاء التي يمكن توقعها من هذه العملية

المرتجعات

Promise<WithResponse<TopicProperties>>

deleteQueue(string, OperationOptions)

حذف قائمة انتظار.

function deleteQueue(queueName: string, operationOptions?: OperationOptions): Promise<{ _response: HttpResponse }>

المعلمات

queueName: string

operationOptions: OperationOptions

الخيارات التي يمكن استخدامها لإجهاض التكوينات الأخرى وتتبعها والتحكم فيها على طلب HTTP.

فيما يلي الأخطاء التي يمكن توقعها من هذه العملية

المرتجعات

Promise<{ _response: HttpResponse }>

deleteRule(string, string, string, OperationOptions)

حذف قاعدة.

function deleteRule(topicName: string, subscriptionName: string, ruleName: string, operationOptions?: OperationOptions): Promise<{ _response: HttpResponse }>

المعلمات

topicName: string

subscriptionName: string

ruleName: string

operationOptions: OperationOptions

الخيارات التي يمكن استخدامها لإجهاض التكوينات الأخرى وتتبعها والتحكم فيها على طلب HTTP.

فيما يلي الأخطاء التي يمكن توقعها من هذه العملية

المرتجعات

Promise<{ _response: HttpResponse }>

deleteSubscription(string, string, OperationOptions)

حذف اشتراك.

function deleteSubscription(topicName: string, subscriptionName: string, operationOptions?: OperationOptions): Promise<{ _response: HttpResponse }>

المعلمات

topicName: string

subscriptionName: string

operationOptions: OperationOptions

الخيارات التي يمكن استخدامها لإجهاض التكوينات الأخرى وتتبعها والتحكم فيها على طلب HTTP.

فيما يلي الأخطاء التي يمكن توقعها من هذه العملية

المرتجعات

Promise<{ _response: HttpResponse }>

deleteTopic(string, OperationOptions)

حذف موضوع.

function deleteTopic(topicName: string, operationOptions?: OperationOptions): Promise<{ _response: HttpResponse }>

المعلمات

topicName: string

operationOptions: OperationOptions

الخيارات التي يمكن استخدامها لإجهاض التكوينات الأخرى وتتبعها والتحكم فيها على طلب HTTP.

فيما يلي الأخطاء التي يمكن توقعها من هذه العملية

المرتجعات

Promise<{ _response: HttpResponse }>

getNamespaceProperties(OperationOptions)

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

function getNamespaceProperties(operationOptions?: OperationOptions): Promise<WithResponse<NamespaceProperties>>

المعلمات

operationOptions: OperationOptions

الخيارات التي يمكن استخدامها لإجهاض التكوينات الأخرى وتتبعها والتحكم فيها على طلب HTTP.

المرتجعات

Promise<WithResponse<NamespaceProperties>>

getQueue(string, OperationOptions)

إرجاع كائن يمثل قائمة الانتظار وخصائصها. إذا كنت تريد الحصول على معلومات وقت تشغيل قائمة الانتظار مثل تفاصيل عدد الرسائل، فاستخدم getQueueRuntimeProperties API.

function getQueue(queueName: string, operationOptions?: OperationOptions): Promise<WithResponse<QueueProperties>>

المعلمات

queueName: string

operationOptions: OperationOptions

الخيارات التي يمكن استخدامها لإجهاض التكوينات الأخرى وتتبعها والتحكم فيها على طلب HTTP.

فيما يلي الأخطاء التي يمكن توقعها من هذه العملية

المرتجعات

Promise<WithResponse<QueueProperties>>

getQueueRuntimeProperties(string, OperationOptions)

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

function getQueueRuntimeProperties(queueName: string, operationOptions?: OperationOptions): Promise<WithResponse<QueueRuntimeProperties>>

المعلمات

queueName: string

operationOptions: OperationOptions

الخيارات التي يمكن استخدامها لإجهاض التكوينات الأخرى وتتبعها والتحكم فيها على طلب HTTP.

فيما يلي الأخطاء التي يمكن توقعها من هذه العملية

المرتجعات

Promise<WithResponse<QueueRuntimeProperties>>

getRule(string, string, string, OperationOptions)

إرجاع كائن يمثل القاعدة بالاسم المحدد مع كافة خصائصها.

function getRule(topicName: string, subscriptionName: string, ruleName: string, operationOptions?: OperationOptions): Promise<WithResponse<RuleProperties>>

المعلمات

topicName: string

subscriptionName: string

ruleName: string

operationOptions: OperationOptions

الخيارات التي يمكن استخدامها لإجهاض التكوينات الأخرى وتتبعها والتحكم فيها على طلب HTTP.

فيما يلي الأخطاء التي يمكن توقعها من هذه العملية

المرتجعات

Promise<WithResponse<RuleProperties>>

getSubscription(string, string, OperationOptions)

إرجاع كائن يمثل الاشتراك وخصائصه. إذا كنت ترغب في الحصول على معلومات وقت تشغيل الاشتراك مثل تفاصيل عدد الرسائل، فاستخدم getSubscriptionRuntimeProperties API.

function getSubscription(topicName: string, subscriptionName: string, operationOptions?: OperationOptions): Promise<WithResponse<SubscriptionProperties>>

المعلمات

topicName: string

subscriptionName: string

operationOptions: OperationOptions

الخيارات التي يمكن استخدامها لإجهاض التكوينات الأخرى وتتبعها والتحكم فيها على طلب HTTP.

فيما يلي الأخطاء التي يمكن توقعها من هذه العملية

المرتجعات

Promise<WithResponse<SubscriptionProperties>>

getSubscriptionRuntimeProperties(string, string, OperationOptions)

إرجاع كائن يمثل معلومات وقت تشغيل الاشتراك مثل تفاصيل عدد الرسائل.

function getSubscriptionRuntimeProperties(topicName: string, subscriptionName: string, operationOptions?: OperationOptions): Promise<WithResponse<SubscriptionRuntimeProperties>>

المعلمات

topicName: string

subscriptionName: string

operationOptions: OperationOptions

الخيارات التي يمكن استخدامها لإجهاض التكوينات الأخرى وتتبعها والتحكم فيها على طلب HTTP.

فيما يلي الأخطاء التي يمكن توقعها من هذه العملية

المرتجعات

Promise<WithResponse<SubscriptionRuntimeProperties>>

getTopic(string, OperationOptions)

إرجاع كائن يمثل الموضوع وخصائصه. إذا كنت ترغب في الحصول على معلومات وقت تشغيل الموضوع مثل تفاصيل عدد الاشتراكات، فاستخدم getTopicRuntimeProperties API.

function getTopic(topicName: string, operationOptions?: OperationOptions): Promise<WithResponse<TopicProperties>>

المعلمات

topicName: string

operationOptions: OperationOptions

الخيارات التي يمكن استخدامها لإجهاض التكوينات الأخرى وتتبعها والتحكم فيها على طلب HTTP.

فيما يلي الأخطاء التي يمكن توقعها من هذه العملية

المرتجعات

Promise<WithResponse<TopicProperties>>

getTopicRuntimeProperties(string, OperationOptions)

إرجاع كائن يمثل معلومات وقت تشغيل الموضوع مثل عدد الاشتراكات.

function getTopicRuntimeProperties(topicName: string, operationOptions?: OperationOptions): Promise<WithResponse<TopicRuntimeProperties>>

المعلمات

topicName: string

operationOptions: OperationOptions

الخيارات التي يمكن استخدامها لإجهاض التكوينات الأخرى وتتبعها والتحكم فيها على طلب HTTP.

فيما يلي الأخطاء التي يمكن توقعها من هذه العملية

المرتجعات

Promise<WithResponse<TopicRuntimeProperties>>

listQueues(OperationOptions)

إرجاع مكرر غير متزامن قابل للتكبير لسرد جميع قوائم الانتظار.

يقوم .byPage() بإرجاع مكرر غير متزامن قابل للتكريب لسرد قوائم الانتظار في الصفحات.

function listQueues(options?: OperationOptions): PagedAsyncIterableIterator<QueueProperties, EntitiesResponse<QueueProperties>, PageSettings>

المعلمات

options: OperationOptions

المرتجعات

PagedAsyncIterableIterator<QueueProperties, EntitiesResponse<QueueProperties>, PageSettings>

asyncIterableIterator يدعم الترحيل.

listQueuesRuntimeProperties(OperationOptions)

ترجع هذه الدالة مكرر غير متزامن لسرد معلومات وقت التشغيل لقوائم الانتظار.

يقوم .byPage() بإرجاع تكرار غير متزامن لسرد معلومات وقت التشغيل لقوائم الانتظار في الصفحات.

function listQueuesRuntimeProperties(options?: OperationOptions): PagedAsyncIterableIterator<QueueRuntimeProperties, EntitiesResponse<QueueRuntimeProperties>, PageSettings>

المعلمات

options: OperationOptions

المرتجعات

PagedAsyncIterableIterator<QueueRuntimeProperties, EntitiesResponse<QueueRuntimeProperties>, PageSettings>

asyncIterableIterator يدعم الترحيل.

listRules(string, string, OperationOptions)

إرجاع مكرر غير متزامن قابل للتكبير لسرد جميع القواعد ضمن الاشتراك المحدد.

يقوم .byPage() بإرجاع تكرار غير متزامن لسرد القواعد في الصفحات.

function listRules(topicName: string, subscriptionName: string, options?: OperationOptions): PagedAsyncIterableIterator<RuleProperties, EntitiesResponse<RuleProperties>, PageSettings>

المعلمات

topicName: string

subscriptionName: string

options: OperationOptions

المرتجعات

PagedAsyncIterableIterator<RuleProperties, EntitiesResponse<RuleProperties>, PageSettings>

asyncIterableIterator يدعم الترحيل.

listSubscriptions(string, OperationOptions)

ترجع هذه الدالة مكرر غير متزامن لسرد جميع الاشتراكات ضمن الموضوع المحدد.

يقوم .byPage() بإرجاع مكرر غير متزامن قابل للتكريب لسرد الاشتراكات في الصفحات.

function listSubscriptions(topicName: string, options?: OperationOptions): PagedAsyncIterableIterator<SubscriptionProperties, EntitiesResponse<SubscriptionProperties>, PageSettings>

المعلمات

topicName: string

options: OperationOptions

المرتجعات

PagedAsyncIterableIterator<SubscriptionProperties, EntitiesResponse<SubscriptionProperties>, PageSettings>

asyncIterableIterator يدعم الترحيل.

listSubscriptionsRuntimeProperties(string, OperationOptions)

إرجاع مكرر غير متزامن قابل للتكدير لسرد معلومات وقت التشغيل للاشتراكات ضمن الموضوع المحدد.

يقوم .byPage() بإرجاع تكرار غير متزامن لسرد معلومات وقت التشغيل للاشتراكات في الصفحات.

function listSubscriptionsRuntimeProperties(topicName: string, options?: OperationOptions): PagedAsyncIterableIterator<SubscriptionRuntimeProperties, EntitiesResponse<SubscriptionRuntimeProperties>, PageSettings>

المعلمات

topicName: string

options: OperationOptions

المرتجعات

PagedAsyncIterableIterator<SubscriptionRuntimeProperties, EntitiesResponse<SubscriptionRuntimeProperties>, PageSettings>

asyncIterableIterator يدعم الترحيل.

listTopics(OperationOptions)

إرجاع مكرر غير متزامن قابل للتكبير لسرد جميع الموضوعات.

يقوم .byPage() بإرجاع مكرر غير متزامن قابل للتكريب لسرد الموضوعات في الصفحات.

function listTopics(options?: OperationOptions): PagedAsyncIterableIterator<TopicProperties, EntitiesResponse<TopicProperties>, PageSettings>

المعلمات

options: OperationOptions

المرتجعات

PagedAsyncIterableIterator<TopicProperties, EntitiesResponse<TopicProperties>, PageSettings>

asyncIterableIterator يدعم الترحيل.

listTopicsRuntimeProperties(OperationOptions)

ترجع هذه الدالة مكرر غير متزامن لسرد معلومات وقت التشغيل للمواضيع.

يقوم .byPage() بإرجاع تكرار غير متزامن لسرد معلومات وقت التشغيل للمواضيع في الصفحات.

function listTopicsRuntimeProperties(options?: OperationOptions): PagedAsyncIterableIterator<TopicRuntimeProperties, EntitiesResponse<TopicRuntimeProperties>, PageSettings>

المعلمات

options: OperationOptions

المرتجعات

PagedAsyncIterableIterator<TopicRuntimeProperties, EntitiesResponse<TopicRuntimeProperties>, PageSettings>

asyncIterableIterator يدعم الترحيل.

queueExists(string, OperationOptions)

التحقق من وجود قائمة انتظار معينة أم لا.

function queueExists(queueName: string, operationOptions?: OperationOptions): Promise<boolean>

المعلمات

queueName: string

operationOptions: OperationOptions

الخيارات التي يمكن استخدامها لإجهاض التكوينات الأخرى وتتبعها والتحكم فيها على طلب HTTP.

المرتجعات

Promise<boolean>

ruleExists(string, string, string, OperationOptions)

التحقق من وجود قاعدة معينة أم لا.

function ruleExists(topicName: string, subscriptionName: string, ruleName: string, operationOptions?: OperationOptions): Promise<boolean>

المعلمات

topicName: string

subscriptionName: string

ruleName: string

operationOptions: OperationOptions

المرتجعات

Promise<boolean>

subscriptionExists(string, string, OperationOptions)

التحقق من وجود اشتراك معين في الموضوع أم لا.

function subscriptionExists(topicName: string, subscriptionName: string, operationOptions?: OperationOptions): Promise<boolean>

المعلمات

topicName: string

subscriptionName: string

operationOptions: OperationOptions

الخيارات التي يمكن استخدامها لإجهاض التكوينات الأخرى وتتبعها والتحكم فيها على طلب HTTP.

المرتجعات

Promise<boolean>

topicExists(string, OperationOptions)

التحقق من وجود موضوع معين أم لا.

function topicExists(topicName: string, operationOptions?: OperationOptions): Promise<boolean>

المعلمات

topicName: string

operationOptions: OperationOptions

الخيارات التي يمكن استخدامها لإجهاض التكوينات الأخرى وتتبعها والتحكم فيها على طلب HTTP.

المرتجعات

Promise<boolean>

updateQueue(WithResponse<QueueProperties>, OperationOptions)

تحديث قائمة الانتظار استنادا إلى خصائص قائمة الانتظار المتوفرة. يجب تعيين كافة خصائص قائمة الانتظار على الرغم من أن مجموعة فرعية منها فقط قابلة للتحديث بالفعل. لذلك، التدفق المقترح هو استخدام الإخراج من getQueue()، وتحديث الخصائص المطلوبة فيه، ثم تمرير الكائن المعدل إلى updateQueue().

يتم وضع علامة للقراءة فقط على الخصائص التي لا يمكن تحديثها في واجهة QueueProperties.

function updateQueue(queue: WithResponse<QueueProperties>, operationOptions?: OperationOptions): Promise<WithResponse<QueueProperties>>

المعلمات

queue: WithResponse<QueueProperties>

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

operationOptions: OperationOptions

الخيارات التي يمكن استخدامها لإجهاض التكوينات الأخرى وتتبعها والتحكم فيها على طلب HTTP.

فيما يلي الأخطاء التي يمكن توقعها من هذه العملية

المرتجعات

Promise<WithResponse<QueueProperties>>

updateRule(string, string, WithResponse<RuleProperties>, OperationOptions)

تحديث الخصائص على القاعدة بالاسم المحدد استنادا إلى الخيارات المحددة. يجب تعيين كافة خصائص القاعدة حتى إذا تم تحديث إحدى هذه الخصائص. لذلك، التدفق المقترح هو استخدام الإخراج من getRule()، وتحديث الخصائص المطلوبة فيه، ثم تمرير الكائن المعدل إلى updateRule().

function updateRule(topicName: string, subscriptionName: string, rule: WithResponse<RuleProperties>, operationOptions?: OperationOptions): Promise<WithResponse<RuleProperties>>

المعلمات

topicName: string

subscriptionName: string

rule: WithResponse<RuleProperties>

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

operationOptions: OperationOptions

الخيارات التي يمكن استخدامها لإجهاض التكوينات الأخرى وتتبعها والتحكم فيها على طلب HTTP.

فيما يلي الأخطاء التي يمكن توقعها من هذه العملية

المرتجعات

Promise<WithResponse<RuleProperties>>

updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)

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

يتم وضع علامة للقراءة فقط على الخصائص التي لا يمكن تحديثها في واجهة SubscriptionProperties.

function updateSubscription(subscription: WithResponse<SubscriptionProperties>, operationOptions?: OperationOptions): Promise<WithResponse<SubscriptionProperties>>

المعلمات

subscription: WithResponse<SubscriptionProperties>

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

operationOptions: OperationOptions

الخيارات التي يمكن استخدامها لإجهاض التكوينات الأخرى وتتبعها والتحكم فيها على طلب HTTP.

فيما يلي الأخطاء التي يمكن توقعها من هذه العملية

المرتجعات

Promise<WithResponse<SubscriptionProperties>>

updateTopic(WithResponse<TopicProperties>, OperationOptions)

يحدث الموضوع استنادا إلى خصائص الموضوع المتوفرة. يجب تعيين جميع خصائص الموضوع على الرغم من أن مجموعة فرعية منها فقط قابلة للتحديث بالفعل. لذلك، التدفق المقترح هو استخدام الإخراج من getTopic()، وتحديث الخصائص المطلوبة فيه، ثم تمرير الكائن المعدل إلى updateTopic().

يتم وضع علامة للقراءة فقط على الخصائص التي لا يمكن تحديثها في واجهة TopicProperties.

function updateTopic(topic: WithResponse<TopicProperties>, operationOptions?: OperationOptions): Promise<WithResponse<TopicProperties>>

المعلمات

topic: WithResponse<TopicProperties>

كائن يمثل خصائص الموضوع والاستجابة الأولية. لا يمكن تحديث requiresDuplicateDetectionenablePartitioningname بعد إنشاء الموضوع.

operationOptions: OperationOptions

الخيارات التي يمكن استخدامها لإجهاض التكوينات الأخرى وتتبعها والتحكم فيها على طلب HTTP.

فيما يلي الأخطاء التي يمكن توقعها من هذه العملية

المرتجعات

Promise<WithResponse<TopicProperties>>

تفاصيل الأساليب المتوارثة

sendOperationRequest<T>(OperationArguments, OperationSpec)

إرسال طلب HTTP الذي يتم ملؤه باستخدام OperationSpec المتوفرة.

function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>

المعلمات

operationArguments: OperationArguments

سيتم ملء الوسيطات التي سيتم ملء القيم المقالب لطلب HTTP منها.

operationSpec: OperationSpec

OperationSpec المراد استخدامه لملء httpRequest.

المرتجعات

Promise<T>

موروث من ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

إرسال httpRequest المتوفر.

function sendRequest(request: PipelineRequest): Promise<PipelineResponse>

المعلمات

request: PipelineRequest

المرتجعات

Promise<PipelineResponse>

موروث من ServiceClient.sendRequest

مشاركة عبر

ServiceBusAdministrationClient class

المنشئون

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

الأساليب

الأساليب المتوارثة

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

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

المعلمات

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

المعلمات

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

pipeline

قيمة الخاصية

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

createQueue(string, CreateQueueOptions)

المعلمات

المرتجعات

createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, OperationOptions)

المعلمات

المرتجعات

createRule(string, string, string, CorrelationRuleFilter | SqlRuleFilter, SqlRuleAction, OperationOptions)

المعلمات

المرتجعات

createSubscription(string, string, CreateSubscriptionOptions)

المعلمات

المرتجعات

createTopic(string, CreateTopicOptions)

المعلمات

المرتجعات

deleteQueue(string, OperationOptions)

المعلمات

المرتجعات

deleteRule(string, string, string, OperationOptions)

المعلمات

المرتجعات

deleteSubscription(string, string, OperationOptions)

المعلمات

المرتجعات

deleteTopic(string, OperationOptions)

المعلمات

المرتجعات

getNamespaceProperties(OperationOptions)

المعلمات

المرتجعات

getQueue(string, OperationOptions)

المعلمات

المرتجعات

getQueueRuntimeProperties(string, OperationOptions)

المعلمات

المرتجعات

getRule(string, string, string, OperationOptions)

المعلمات

المرتجعات

getSubscription(string, string, OperationOptions)

المعلمات

المرتجعات

getSubscriptionRuntimeProperties(string, string, OperationOptions)

المعلمات

المرتجعات

getTopic(string, OperationOptions)

المعلمات

المرتجعات

getTopicRuntimeProperties(string, OperationOptions)

المعلمات

المرتجعات

listQueues(OperationOptions)

المعلمات

المرتجعات

listQueuesRuntimeProperties(OperationOptions)

المعلمات

المرتجعات

listRules(string, string, OperationOptions)

المعلمات

المرتجعات

listSubscriptions(string, OperationOptions)

المعلمات

المرتجعات

listSubscriptionsRuntimeProperties(string, OperationOptions)

المعلمات