ServiceBusAdministrationClient class

Referensi

Paket:: @azure/service-bus

Semua operasi mengembalikan janji yang diselesaikan ke objek yang memiliki output yang relevan. Objek ini juga memiliki properti yang disebut _response yang dapat Anda gunakan jika Anda ingin mengakses respons langsung dari layanan.

Memperluas: ServiceClient

Konstruktor

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)	Menginisialisasi instans baru kelas ServiceBusAdministrationClient.
ServiceBusAdministrationClient(string, TokenCredential \| NamedKeyCredential, ServiceBusAdministrationClientOptions)

Properti yang Diwariskan

pipeline

Alur yang digunakan oleh klien ini untuk membuat permintaan

Metode

createQueue(string, CreateQueueOptions)	Membuat antrean dengan nama yang diberikan, dikonfigurasi menggunakan opsi yang diberikan
createRule(string, string, string, CorrelationRuleFilter \| SqlRuleFilter, OperationOptions)	Membuat aturan dengan nama yang diberikan, dikonfigurasi menggunakan opsi yang diberikan.
createRule(string, string, string, CorrelationRuleFilter \| SqlRuleFilter, SqlRuleAction, OperationOptions)	Membuat aturan dengan nama yang diberikan, dikonfigurasi menggunakan opsi yang diberikan.
createSubscription(string, string, CreateSubscriptionOptions)	Membuat langganan dengan nama tertentu, dikonfigurasi menggunakan opsi yang diberikan
createTopic(string, CreateTopicOptions)	Membuat topik dengan nama yang diberikan, dikonfigurasi menggunakan opsi yang diberikan
deleteQueue(string, OperationOptions)	Menghapus antrean.
deleteRule(string, string, string, OperationOptions)	Menghapus aturan.
deleteSubscription(string, string, OperationOptions)	Menghapus langganan.
deleteTopic(string, OperationOptions)	Menghapus topik.
getNamespaceProperties(OperationOptions)	Mengembalikan objek yang mewakili metadata yang terkait dengan namespace bus layanan.
getQueue(string, OperationOptions)	Mengembalikan objek yang mewakili Antrean dan propertinya. Jika Anda ingin mendapatkan info runtime Antrean seperti detail jumlah pesan, gunakan `getQueueRuntimeProperties` API.
getQueueRuntimeProperties(string, OperationOptions)	Mengembalikan objek yang mewakili info runtime antrean seperti detail jumlah pesan.
getRule(string, string, string, OperationOptions)	Mengembalikan objek yang mewakili Aturan dengan nama yang diberikan bersama dengan semua propertinya.
getSubscription(string, string, OperationOptions)	Mengembalikan objek yang mewakili Langganan dan propertinya. Jika Anda ingin mendapatkan info runtime Langganan seperti detail jumlah pesan, gunakan `getSubscriptionRuntimeProperties` API.
getSubscriptionRuntimeProperties(string, string, OperationOptions)	Mengembalikan objek yang mewakili info runtime Langganan seperti detail jumlah pesan.
getTopic(string, OperationOptions)	Mengembalikan objek yang mewakili Topik dan propertinya. Jika Anda ingin mendapatkan info runtime Topik seperti detail jumlah langganan, gunakan `getTopicRuntimeProperties` API.
getTopicRuntimeProperties(string, OperationOptions)	Mengembalikan objek yang mewakili info runtime Topik seperti jumlah langganan.
listQueues(OperationOptions)	Mengembalikan iterator yang dapat di-iterasi asinkron untuk mencantumkan semua antrean. .byPage() mengembalikan iterator yang dapat di-iterasi asinkron untuk mencantumkan antrean di halaman.
listQueuesRuntimeProperties(OperationOptions)	Mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan info runtime antrean. .byPage() mengembalikan iterator yang dapat di-iterasi asinkron untuk mencantumkan info runtime antrean di halaman.
listRules(string, string, OperationOptions)	Mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan semua aturan di bawah langganan yang ditentukan. .byPage() mengembalikan iterator yang dapat di-iterasi asinkron untuk mencantumkan aturan di halaman.
listSubscriptions(string, OperationOptions)	Mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan semua langganan di bawah topik yang ditentukan. .byPage() mengembalikan iterator yang dapat di-iterasi asinkron untuk mencantumkan langganan di halaman.
listSubscriptionsRuntimeProperties(string, OperationOptions)	Mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan info runtime langganan di bawah topik yang ditentukan. .byPage() mengembalikan iterator yang dapat di-iterasi asinkron untuk mencantumkan info runtime langganan di halaman.
listTopics(OperationOptions)	Mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan semua topik. .byPage() mengembalikan iterator yang dapat di-iterasi asinkron untuk mencantumkan topik di halaman.
listTopicsRuntimeProperties(OperationOptions)	Mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan info runtime topik. .byPage() mengembalikan iterator yang dapat di-iterator asinkron untuk mencantumkan info runtime topik di halaman.
queueExists(string, OperationOptions)	Memeriksa apakah antrean tertentu ada atau tidak.
ruleExists(string, string, string, OperationOptions)	Memeriksa apakah aturan tertentu ada atau tidak.
subscriptionExists(string, string, OperationOptions)	Memeriksa apakah langganan tertentu ada dalam topik atau tidak.
topicExists(string, OperationOptions)	Memeriksa apakah topik tertentu ada atau tidak.
updateQueue(WithResponse<QueueProperties>, OperationOptions)	Updates antrean berdasarkan properti antrean yang disediakan. Semua properti antrean harus diatur meskipun hanya subset yang benar-benar dapat diperbarui. Oleh karena itu, alur yang disarankan adalah menggunakan output dari `getQueue()`, memperbarui properti yang diinginkan di dalamnya, dan kemudian meneruskan objek yang dimodifikasi ke `updateQueue()`. Properti yang tidak dapat diperbarui ditandai sebagai readonly di `QueueProperties` antarmuka.
updateRule(string, string, WithResponse<RuleProperties>, OperationOptions)	Updates properti pada Aturan dengan nama yang diberikan berdasarkan opsi yang diberikan. Semua properti aturan harus diatur meskipun salah satunya sedang diperbarui. Oleh karena itu, alur yang disarankan adalah menggunakan output dari `getRule()`, memperbarui properti yang diinginkan di dalamnya, dan kemudian meneruskan objek yang dimodifikasi ke `updateRule()`.
updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)	Updates langganan berdasarkan properti langganan yang disediakan. Semua properti langganan harus diatur meskipun hanya subset yang benar-benar dapat diperbarui. Oleh karena itu, alur yang disarankan adalah menggunakan output dari `getSubscription()`, memperbarui properti yang diinginkan di dalamnya, dan kemudian meneruskan objek yang dimodifikasi ke `updateSubscription()`. Properti yang tidak dapat diperbarui ditandai sebagai readonly di `SubscriptionProperties` antarmuka.
updateTopic(WithResponse<TopicProperties>, OperationOptions)	Updates topik berdasarkan properti topik yang disediakan. Semua properti topik harus diatur meskipun hanya subset yang benar-benar dapat diperbarui. Oleh karena itu, alur yang disarankan adalah menggunakan output dari `getTopic()`, memperbarui properti yang diinginkan di dalamnya, dan kemudian meneruskan objek yang dimodifikasi ke `updateTopic()`. Properti yang tidak dapat diperbarui ditandai sebagai readonly di `TopicProperties` antarmuka.

Metode yang Diwarisi

sendOperationRequest<T>(OperationArguments, OperationSpec)	Kirim permintaan HTTP yang diisi menggunakan OperationSpec yang disediakan.
sendRequest(PipelineRequest)	Kirim httpRequest yang disediakan.

Detail Konstruktor

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

Menginisialisasi instans baru kelas ServiceBusAdministrationClient.

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

Parameter

connectionString: string

String koneksi yang diperlukan klien untuk menyambungkan ke Azure.

options: ServiceBusAdministrationClientOptions

PipelineOptions

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

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

Parameter

fullyQualifiedNamespace: string

Namespace layanan yang sepenuhnya memenuhi syarat dari instans Azure Service Bus Anda yang kemungkinan mirip dengan .servicebus.windows.net.

credential: TokenCredential | NamedKeyCredential

Objek kredensial yang digunakan oleh klien untuk mendapatkan token untuk mengautentikasi koneksi dengan Azure Service Bus. Lihat @azure/identitas untuk membuat kredensial. Jika Anda menggunakan implementasi TokenCredential antarmuka Anda sendiri terhadap AAD, atur "cakupan" agar bus layanan menjadi ["https://servicebus.azure.net//user_impersonation"] mendapatkan token yang sesuai. AzureNamedKeyCredential Gunakan dari @azure/core-auth jika Anda ingin meneruskan SharedAccessKeyName dan SharedAccessKey tanpa menggunakan string koneksi. Bidang-bidang ini masing-masing memetakan ke name bidang dan key di AzureNamedKeyCredential.

options: ServiceBusAdministrationClientOptions

PipelineOptions

Detail Properti yang Diwariskan

pipeline

Alur yang digunakan oleh klien ini untuk membuat permintaan

pipeline: Pipeline

Nilai Properti

Pipeline

Diwarisi Dari ServiceClient.pipeline

Detail Metode

createQueue(string, CreateQueueOptions)

Membuat antrean dengan nama yang diberikan, dikonfigurasi menggunakan opsi yang diberikan

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

Parameter

queueName: string

options: CreateQueueOptions

Opsi untuk mengonfigurasi Antrean yang dibuat(Misalnya, Anda dapat mengonfigurasi antrean untuk mendukung partisi atau sesi) dan opsi operasi yang dapat digunakan untuk membatalkan, melacak, dan mengontrol konfigurasi lain pada permintaan HTTP.

Berikut ini adalah kesalahan yang dapat diharapkan dari operasi ini

Mengembalikan

Promise<WithResponse<QueueProperties>>

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

Membuat aturan dengan nama yang diberikan, dikonfigurasi menggunakan opsi yang diberikan.

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

Parameter

topicName: string

subscriptionName: string

ruleName: string

ruleFilter: CorrelationRuleFilter | SqlRuleFilter

Menentukan ekspresi filter yang dievaluasi aturan.

operationOptions: OperationOptions

Opsi yang dapat digunakan untuk membatalkan, melacak, dan mengontrol konfigurasi lain pada permintaan HTTP.

Berikut ini adalah kesalahan yang dapat diharapkan dari operasi ini

Mengembalikan

Promise<WithResponse<RuleProperties>>

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

Membuat aturan dengan nama yang diberikan, dikonfigurasi menggunakan opsi yang diberikan.

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

Parameter

topicName: string

subscriptionName: string

ruleName: string

ruleFilter: CorrelationRuleFilter | SqlRuleFilter

Menentukan ekspresi filter yang dievaluasi aturan.

ruleAction: SqlRuleAction

Ekspresi seperti SQL yang dapat dijalankan pada pesan jika filter terkait berlaku.

operationOptions: OperationOptions

Opsi yang dapat digunakan untuk membatalkan, melacak, dan mengontrol konfigurasi lain pada permintaan HTTP.

Berikut ini adalah kesalahan yang dapat diharapkan dari operasi ini

Mengembalikan

Promise<WithResponse<RuleProperties>>

createSubscription(string, string, CreateSubscriptionOptions)

Membuat langganan dengan nama tertentu, dikonfigurasi menggunakan opsi yang diberikan

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

Parameter

topicName: string

subscriptionName: string

options: CreateSubscriptionOptions

Opsi untuk mengonfigurasi Langganan yang dibuat(Misalnya, Anda dapat mengonfigurasi Langganan untuk mendukung partisi atau sesi) dan opsi operasi yang dapat digunakan untuk membatalkan, melacak, dan mengontrol konfigurasi lain pada permintaan HTTP.

Berikut ini adalah kesalahan yang dapat diharapkan dari operasi ini

Mengembalikan

Promise<WithResponse<SubscriptionProperties>>

createTopic(string, CreateTopicOptions)

Membuat topik dengan nama yang diberikan, dikonfigurasi menggunakan opsi yang diberikan

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

Parameter

topicName: string

options: CreateTopicOptions

Opsi untuk mengonfigurasi Topik yang dibuat (Misalnya, Anda dapat mengonfigurasi topik untuk mendukung partisi) dan opsi operasi yang dapat digunakan untuk membatalkan, melacak, dan mengontrol konfigurasi lain pada permintaan HTTP.

Berikut ini adalah kesalahan yang dapat diharapkan dari operasi ini

Mengembalikan

Promise<WithResponse<TopicProperties>>

deleteQueue(string, OperationOptions)

Menghapus antrean.

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

Parameter

queueName: string

operationOptions: OperationOptions

Opsi yang dapat digunakan untuk membatalkan, melacak, dan mengontrol konfigurasi lain pada permintaan HTTP.

Berikut ini adalah kesalahan yang dapat diharapkan dari operasi ini

Mengembalikan

Promise<{ _response: HttpResponse }>

deleteRule(string, string, string, OperationOptions)

Menghapus aturan.

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

Parameter

topicName: string

subscriptionName: string

ruleName: string

operationOptions: OperationOptions

Opsi yang dapat digunakan untuk membatalkan, melacak, dan mengontrol konfigurasi lain pada permintaan HTTP.

Berikut ini adalah kesalahan yang dapat diharapkan dari operasi ini

Mengembalikan

Promise<{ _response: HttpResponse }>

deleteSubscription(string, string, OperationOptions)

Menghapus langganan.

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

Parameter

topicName: string

subscriptionName: string

operationOptions: OperationOptions

Opsi yang dapat digunakan untuk membatalkan, melacak, dan mengontrol konfigurasi lain pada permintaan HTTP.

Berikut ini adalah kesalahan yang dapat diharapkan dari operasi ini

Mengembalikan

Promise<{ _response: HttpResponse }>

deleteTopic(string, OperationOptions)

Menghapus topik.

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

Parameter

topicName: string

operationOptions: OperationOptions

Opsi yang dapat digunakan untuk membatalkan, melacak, dan mengontrol konfigurasi lain pada permintaan HTTP.

Berikut ini adalah kesalahan yang dapat diharapkan dari operasi ini

Mengembalikan

Promise<{ _response: HttpResponse }>

getNamespaceProperties(OperationOptions)

Mengembalikan objek yang mewakili metadata yang terkait dengan namespace bus layanan.

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

Parameter

operationOptions: OperationOptions

Opsi yang dapat digunakan untuk membatalkan, melacak, dan mengontrol konfigurasi lain pada permintaan HTTP.

Mengembalikan

Promise<WithResponse<NamespaceProperties>>

getQueue(string, OperationOptions)

Mengembalikan objek yang mewakili Antrean dan propertinya. Jika Anda ingin mendapatkan info runtime Antrean seperti detail jumlah pesan, gunakan getQueueRuntimeProperties API.

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

Parameter

queueName: string

operationOptions: OperationOptions

Opsi yang dapat digunakan untuk membatalkan, melacak, dan mengontrol konfigurasi lain pada permintaan HTTP.

Berikut ini adalah kesalahan yang dapat diharapkan dari operasi ini

Mengembalikan

Promise<WithResponse<QueueProperties>>

getQueueRuntimeProperties(string, OperationOptions)

Mengembalikan objek yang mewakili info runtime antrean seperti detail jumlah pesan.

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

Parameter

queueName: string

operationOptions: OperationOptions

Opsi yang dapat digunakan untuk membatalkan, melacak, dan mengontrol konfigurasi lain pada permintaan HTTP.

Berikut ini adalah kesalahan yang dapat diharapkan dari operasi ini

Mengembalikan

Promise<WithResponse<QueueRuntimeProperties>>

getRule(string, string, string, OperationOptions)

Mengembalikan objek yang mewakili Aturan dengan nama yang diberikan bersama dengan semua propertinya.

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

Parameter

topicName: string

subscriptionName: string

ruleName: string

operationOptions: OperationOptions

Opsi yang dapat digunakan untuk membatalkan, melacak, dan mengontrol konfigurasi lain pada permintaan HTTP.

Berikut ini adalah kesalahan yang dapat diharapkan dari operasi ini

Mengembalikan

Promise<WithResponse<RuleProperties>>

getSubscription(string, string, OperationOptions)

Mengembalikan objek yang mewakili Langganan dan propertinya. Jika Anda ingin mendapatkan info runtime Langganan seperti detail jumlah pesan, gunakan getSubscriptionRuntimeProperties API.

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

Parameter

topicName: string

subscriptionName: string

operationOptions: OperationOptions

Opsi yang dapat digunakan untuk membatalkan, melacak, dan mengontrol konfigurasi lain pada permintaan HTTP.

Berikut ini adalah kesalahan yang dapat diharapkan dari operasi ini

Mengembalikan

Promise<WithResponse<SubscriptionProperties>>

getSubscriptionRuntimeProperties(string, string, OperationOptions)

Mengembalikan objek yang mewakili info runtime Langganan seperti detail jumlah pesan.

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

Parameter

topicName: string

subscriptionName: string

operationOptions: OperationOptions

Opsi yang dapat digunakan untuk membatalkan, melacak, dan mengontrol konfigurasi lain pada permintaan HTTP.

Berikut ini adalah kesalahan yang dapat diharapkan dari operasi ini

Mengembalikan

Promise<WithResponse<SubscriptionRuntimeProperties>>

getTopic(string, OperationOptions)

Mengembalikan objek yang mewakili Topik dan propertinya. Jika Anda ingin mendapatkan info runtime Topik seperti detail jumlah langganan, gunakan getTopicRuntimeProperties API.

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

Parameter

topicName: string

operationOptions: OperationOptions

Opsi yang dapat digunakan untuk membatalkan, melacak, dan mengontrol konfigurasi lain pada permintaan HTTP.

Berikut ini adalah kesalahan yang dapat diharapkan dari operasi ini

Mengembalikan

Promise<WithResponse<TopicProperties>>

getTopicRuntimeProperties(string, OperationOptions)

Mengembalikan objek yang mewakili info runtime Topik seperti jumlah langganan.

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

Parameter

topicName: string

operationOptions: OperationOptions

Opsi yang dapat digunakan untuk membatalkan, melacak, dan mengontrol konfigurasi lain pada permintaan HTTP.

Berikut ini adalah kesalahan yang dapat diharapkan dari operasi ini

Mengembalikan

Promise<WithResponse<TopicRuntimeProperties>>

listQueues(OperationOptions)

Mengembalikan iterator yang dapat di-iterasi asinkron untuk mencantumkan semua antrean.

.byPage() mengembalikan iterator yang dapat di-iterasi asinkron untuk mencantumkan antrean di halaman.

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

Parameter

options: OperationOptions

Mengembalikan

PagedAsyncIterableIterator<QueueProperties, EntitiesResponse<QueueProperties>, PageSettings>

AsyncIterableIterator yang mendukung paging.

listQueuesRuntimeProperties(OperationOptions)

Mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan info runtime antrean.

.byPage() mengembalikan iterator yang dapat di-iterasi asinkron untuk mencantumkan info runtime antrean di halaman.

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

Parameter

options: OperationOptions

Mengembalikan

PagedAsyncIterableIterator<QueueRuntimeProperties, EntitiesResponse<QueueRuntimeProperties>, PageSettings>

AsyncIterableIterator yang mendukung paging.

listRules(string, string, OperationOptions)

Mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan semua aturan di bawah langganan yang ditentukan.

.byPage() mengembalikan iterator yang dapat di-iterasi asinkron untuk mencantumkan aturan di halaman.

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

Parameter

topicName: string

subscriptionName: string

options: OperationOptions

Mengembalikan

PagedAsyncIterableIterator<RuleProperties, EntitiesResponse<RuleProperties>, PageSettings>

AsinkronIterableIterator yang mendukung paging.

listSubscriptions(string, OperationOptions)

Mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan semua langganan di bawah topik yang ditentukan.

.byPage() mengembalikan iterator yang dapat di-iterasi asinkron untuk mencantumkan langganan di halaman.

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

Parameter

topicName: string

options: OperationOptions

Mengembalikan

PagedAsyncIterableIterator<SubscriptionProperties, EntitiesResponse<SubscriptionProperties>, PageSettings>

AsinkronIterableIterator yang mendukung paging.

listSubscriptionsRuntimeProperties(string, OperationOptions)

Mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan info runtime langganan di bawah topik yang ditentukan.

.byPage() mengembalikan iterator yang dapat di-iterasi asinkron untuk mencantumkan info runtime langganan di halaman.

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

Parameter

topicName: string

options: OperationOptions

Mengembalikan

PagedAsyncIterableIterator<SubscriptionRuntimeProperties, EntitiesResponse<SubscriptionRuntimeProperties>, PageSettings>

AsinkronIterableIterator yang mendukung paging.

listTopics(OperationOptions)

Mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan semua topik.

.byPage() mengembalikan iterator yang dapat di-iterasi asinkron untuk mencantumkan topik di halaman.

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

Parameter

options: OperationOptions

Mengembalikan

PagedAsyncIterableIterator<TopicProperties, EntitiesResponse<TopicProperties>, PageSettings>

AsinkronIterableIterator yang mendukung paging.

listTopicsRuntimeProperties(OperationOptions)

Mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan info runtime topik.

.byPage() mengembalikan iterator yang dapat di-iterator asinkron untuk mencantumkan info runtime topik di halaman.

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

Parameter

options: OperationOptions

Mengembalikan

PagedAsyncIterableIterator<TopicRuntimeProperties, EntitiesResponse<TopicRuntimeProperties>, PageSettings>

AsinkronIterableIterator yang mendukung paging.

queueExists(string, OperationOptions)

Memeriksa apakah antrean tertentu ada atau tidak.

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

Parameter

queueName: string

operationOptions: OperationOptions

Opsi yang dapat digunakan untuk membatalkan, melacak, dan mengontrol konfigurasi lain pada permintaan HTTP.

Mengembalikan

Promise<boolean>

ruleExists(string, string, string, OperationOptions)

Memeriksa apakah aturan tertentu ada atau tidak.

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

Parameter

topicName: string

subscriptionName: string

ruleName: string

operationOptions: OperationOptions

Mengembalikan

Promise<boolean>

subscriptionExists(string, string, OperationOptions)

Memeriksa apakah langganan tertentu ada dalam topik atau tidak.

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

Parameter

topicName: string

subscriptionName: string

operationOptions: OperationOptions

Opsi yang dapat digunakan untuk membatalkan, melacak, dan mengontrol konfigurasi lain pada permintaan HTTP.

Mengembalikan

Promise<boolean>

topicExists(string, OperationOptions)

Memeriksa apakah topik tertentu ada atau tidak.

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

Parameter

topicName: string

operationOptions: OperationOptions

Opsi yang dapat digunakan untuk membatalkan, melacak, dan mengontrol konfigurasi lain pada permintaan HTTP.

Mengembalikan

Promise<boolean>

updateQueue(WithResponse<QueueProperties>, OperationOptions)

Updates antrean berdasarkan properti antrean yang disediakan. Semua properti antrean harus diatur meskipun hanya subset yang benar-benar dapat diperbarui. Oleh karena itu, alur yang disarankan adalah menggunakan output dari getQueue(), memperbarui properti yang diinginkan di dalamnya, dan kemudian meneruskan objek yang dimodifikasi ke updateQueue().

Properti yang tidak dapat diperbarui ditandai sebagai readonly di QueueProperties antarmuka.

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

Parameter

queue: WithResponse<QueueProperties>

Objek yang mewakili properti antrean dan respons mentah. requiresSession, requiresDuplicateDetection, enablePartitioning, dan name tidak dapat diperbarui setelah membuat antrean.

operationOptions: OperationOptions

Opsi yang dapat digunakan untuk membatalkan, melacak, dan mengontrol konfigurasi lain pada permintaan HTTP.

Berikut ini adalah kesalahan yang dapat diharapkan dari operasi ini

Mengembalikan

Promise<WithResponse<QueueProperties>>

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

Updates properti pada Aturan dengan nama yang diberikan berdasarkan opsi yang diberikan. Semua properti aturan harus diatur meskipun salah satunya sedang diperbarui. Oleh karena itu, alur yang disarankan adalah menggunakan output dari getRule(), memperbarui properti yang diinginkan di dalamnya, dan kemudian meneruskan objek yang dimodifikasi ke updateRule().

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

Parameter

topicName: string

subscriptionName: string

rule: WithResponse<RuleProperties>

Opsi untuk mengonfigurasi Aturan yang sedang diperbarui dan respons mentah. Misalnya, Anda dapat mengonfigurasi filter untuk diterapkan pada Topik/Langganan terkait.

operationOptions: OperationOptions

Opsi yang dapat digunakan untuk membatalkan, melacak, dan mengontrol konfigurasi lain pada permintaan HTTP.

Berikut ini adalah kesalahan yang dapat diharapkan dari operasi ini

Mengembalikan

Promise<WithResponse<RuleProperties>>

updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)

Updates langganan berdasarkan properti langganan yang disediakan. Semua properti langganan harus diatur meskipun hanya subset yang benar-benar dapat diperbarui. Oleh karena itu, alur yang disarankan adalah menggunakan output dari getSubscription(), memperbarui properti yang diinginkan di dalamnya, dan kemudian meneruskan objek yang dimodifikasi ke updateSubscription().

Properti yang tidak dapat diperbarui ditandai sebagai readonly di SubscriptionProperties antarmuka.

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

Parameter

subscription: WithResponse<SubscriptionProperties>

Objek yang mewakili properti langganan dan respons mentah. subscriptionName, topicName, dan requiresSession tidak dapat diperbarui setelah membuat langganan.

operationOptions: OperationOptions

Opsi yang dapat digunakan untuk membatalkan, melacak, dan mengontrol konfigurasi lain pada permintaan HTTP.

Berikut ini adalah kesalahan yang dapat diharapkan dari operasi ini

Mengembalikan

Promise<WithResponse<SubscriptionProperties>>

updateTopic(WithResponse<TopicProperties>, OperationOptions)

Updates topik berdasarkan properti topik yang disediakan. Semua properti topik harus diatur meskipun hanya subset yang benar-benar dapat diperbarui. Oleh karena itu, alur yang disarankan adalah menggunakan output dari getTopic(), memperbarui properti yang diinginkan di dalamnya, dan kemudian meneruskan objek yang dimodifikasi ke updateTopic().

Properti yang tidak dapat diperbarui ditandai sebagai readonly di TopicProperties antarmuka.

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

Parameter

topic: WithResponse<TopicProperties>

Objek yang mewakili properti topik dan respons mentah. requiresDuplicateDetection, enablePartitioning, dan name tidak dapat diperbarui setelah membuat topik.

operationOptions: OperationOptions

Opsi yang dapat digunakan untuk membatalkan, melacak, dan mengontrol konfigurasi lain pada permintaan HTTP.

Berikut ini adalah kesalahan yang dapat diharapkan dari operasi ini

Mengembalikan

Promise<WithResponse<TopicProperties>>

Detail Metode yang Diwarisi

sendOperationRequest<T>(OperationArguments, OperationSpec)

Kirim permintaan HTTP yang diisi menggunakan OperationSpec yang disediakan.

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

Parameter

operationArguments: OperationArguments

Argumen tempat nilai templat permintaan HTTP akan diisi.

operationSpec: OperationSpec

OperationSpec yang digunakan untuk mengisi httpRequest.

Mengembalikan

Promise<T>

Diwarisi Dari ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Kirim httpRequest yang disediakan.

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

Parameter

request: PipelineRequest

Mengembalikan

Promise<PipelineResponse>

Diwarisi Dari ServiceClient.sendRequest

Bagikan melalui

ServiceBusAdministrationClient class

Konstruktor

Properti yang Diwariskan

Metode

Metode yang Diwarisi

Detail Konstruktor

ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)

Parameter

ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)

Parameter

Detail Properti yang Diwariskan

pipeline

Nilai Properti

Detail Metode

createQueue(string, CreateQueueOptions)

Parameter

Mengembalikan

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

Parameter

Mengembalikan

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

Parameter

Mengembalikan

createSubscription(string, string, CreateSubscriptionOptions)

Parameter

Mengembalikan

createTopic(string, CreateTopicOptions)

Parameter

Mengembalikan

deleteQueue(string, OperationOptions)

Parameter

Mengembalikan

deleteRule(string, string, string, OperationOptions)

Parameter

Mengembalikan

deleteSubscription(string, string, OperationOptions)

Parameter

Mengembalikan

deleteTopic(string, OperationOptions)

Parameter

Mengembalikan

getNamespaceProperties(OperationOptions)

Parameter

Mengembalikan

getQueue(string, OperationOptions)

Parameter

Mengembalikan

getQueueRuntimeProperties(string, OperationOptions)

Parameter

Mengembalikan

getRule(string, string, string, OperationOptions)

Parameter

Mengembalikan

getSubscription(string, string, OperationOptions)

Parameter

Mengembalikan

getSubscriptionRuntimeProperties(string, string, OperationOptions)

Parameter

Mengembalikan

getTopic(string, OperationOptions)

Parameter

Mengembalikan

getTopicRuntimeProperties(string, OperationOptions)

Parameter

Mengembalikan

listQueues(OperationOptions)

Parameter

Mengembalikan

listQueuesRuntimeProperties(OperationOptions)

Parameter

Mengembalikan

listRules(string, string, OperationOptions)

Parameter

Mengembalikan

listSubscriptions(string, OperationOptions)

Parameter

Mengembalikan

listSubscriptionsRuntimeProperties(string, OperationOptions)

Parameter