ServiceBusAdministrationClient class

初始化 ServiceBusAdministrationClient 類別的新實例。

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

參數

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

參數

此用戶端用來提出要求的管線

pipeline: Pipeline

屬性值

繼承自 ServiceClient.pipeline

使用指定的選項來建立具有指定名稱的佇列

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

參數

傳回

使用指定的選項來建立具有指定名稱的規則。

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

參數

傳回

使用指定的選項來建立具有指定名稱的規則。

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

參數

傳回

使用指定的選項來建立具有指定名稱的訂用帳戶

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

參數

傳回

使用指定的選項來建立具有指定名稱的主題

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

參數

傳回

刪除佇列。

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

參數

傳回

刪除規則。

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

參數

傳回

刪除訂用帳戶。

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

參數

傳回

刪除主題。

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

參數

傳回

傳回 物件，表示與服務匯流排命名空間相關的中繼資料。

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

參數

傳回

傳回代表 Queue 及其屬性的物件。 如果您想要取得佇列執行時間資訊，例如訊息計數詳細資料，請使用 getQueueRuntimeProperties API。

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

參數

傳回

傳回 物件，表示佇列執行時間資訊，例如訊息計數詳細資料。

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

參數

傳回

傳回 物件，代表具有指定名稱的 Rule 及其所有屬性。

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

參數

傳回

傳回代表 Subscription 及其屬性的物件。 如果您想要取得訂用帳戶執行時間資訊，例如訊息計數詳細資料，請使用 getSubscriptionRuntimeProperties API。

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

參數

傳回

傳回 物件，表示訂閱執行時間資訊，例如訊息計數詳細資料。

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

參數

傳回

傳回代表 Topic 及其屬性的物件。 如果您想要取得主題執行時間資訊，例如訂用帳戶計數詳細資料，請使用 getTopicRuntimeProperties API。

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

參數

傳回

傳回 物件，代表主題執行時間資訊，例如訂用帳戶計數。

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

參數

傳回

傳回可重複的非同步反覆運算器，以列出所有佇列。

.byPage () 會傳回非同步反覆運算器，以列出頁面中的佇列。

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

參數

傳回

支援分頁的 asyncIterableIterator。

傳回非同步反覆運算器，以列出佇列的執行時間資訊。

.byPage () 會傳回非同步反覆運算器，以列出頁面中佇列的執行時間資訊。

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

參數

傳回

支援分頁的 asyncIterableIterator。

傳回非同步反覆運算器，以列出指定之訂用帳戶下的所有規則。

.byPage () 會傳回非同步反覆運算器，以列出頁面中的規則。

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

參數

傳回

支援分頁的 asyncIterableIterator。

傳回可同步反覆運算器，以列出指定主題下的所有訂用帳戶。

.byPage () 會傳回可同步反覆運算器，以列出頁面中的訂用帳戶。

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

參數

傳回

支援分頁的 asyncIterableIterator。

傳回非同步反覆運算器，以列出指定主題下訂用帳戶的執行時間資訊。

.byPage () 會傳回可同步反覆運算器，以在頁面中列出訂用帳戶的執行時間資訊。

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

參數

傳回

支援分頁的 asyncIterableIterator。

傳回可同步反覆運算器來列出所有主題。

.byPage () 會傳回可同步反覆運算器，以列出頁面的主題。

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

參數

傳回

支援分頁的 asyncIterableIterator。

傳回可同步反覆運算器，以列出主題的執行時間資訊。

.byPage () 會傳回非同步反覆運算器，以列出頁面主題的執行時間資訊。

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

參數

傳回

支援分頁的 asyncIterableIterator。

檢查指定的佇列是否存在。

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

參數

傳回

檢查指定的規則是否存在。

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

參數

傳回

檢查主題中是否有指定的訂用帳戶。

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

參數

傳回

檢查指定的主題是否存在。

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

參數

傳回

根據提供的佇列屬性更新佇列。 即使只有一部分的佇列屬性實際上是可更新的，也必須設定所有佇列屬性。 因此，建議的流程是使用 的 getQueue() 輸出，更新其中所需的屬性，然後將修改的物件傳遞至 updateQueue() 。

無法更新的屬性會在 介面中 QueueProperties 標示為唯讀。

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

參數

傳回

根據指定的選項，依指定名稱在 Rule 上更新屬性。 即使其中一個規則屬性正在更新，也必須設定所有規則屬性。 因此，建議的流程是使用 的 getRule() 輸出，更新其中所需的屬性，然後將修改的物件傳遞至 updateRule() 。

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

參數

傳回

根據提供的訂用帳戶屬性更新訂用帳戶。 即使只有一部分的訂閱屬性實際上是可更新，也必須設定所有訂用帳戶屬性。 因此，建議的流程是使用 的 getSubscription() 輸出，更新其中所需的屬性，然後將修改的物件傳遞至 updateSubscription() 。

無法更新的屬性會在 介面中 SubscriptionProperties 標示為唯讀。

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

參數

傳回

根據提供的主題屬性更新主題。 即使只有一部分的主題屬性實際上是可更新，還是必須設定所有主題屬性。 因此，建議的流程是使用 的 getTopic() 輸出，更新其中所需的屬性，然後將修改的物件傳遞至 updateTopic() 。

無法更新的屬性會在 介面中 TopicProperties 標示為唯讀。

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

參數

傳回

傳送使用提供的 OperationSpec 填入的 HTTP 要求。

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

參數

傳回

繼承自 ServiceClient.sendOperationRequest

傳送提供的 HTTPRequest。

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

參數

傳回

繼承自 ServiceClient.sendRequest