ServiceBusAdministrationClient class
所有作業都會傳回可解析為具有相關輸出之對象的承諾。
如果想要從服務存取直接回應，這些物件也有稱為 _response 的屬性。
- Extends
建構函式
繼承的屬性
| pipeline | 此客戶端用來提出要求的管線 |
方法
繼承的方法
| send |
傳送使用提供的 OperationSpec 填入的 HTTP 要求。 |
| send |
傳送提供的 HTTPRequest。 |
建構函式詳細資料
ServiceBusAdministrationClient(string, ServiceBusAdministrationClientOptions)
初始化 ServiceBusAdministrationClient 類別的新實例。
new ServiceBusAdministrationClient(connectionString: string, options?: ServiceBusAdministrationClientOptions)參數
- connectionString
-
string
用戶端連線至 Azure 所需的連接字串。
PipelineOptions
ServiceBusAdministrationClient(string, TokenCredential | NamedKeyCredential, ServiceBusAdministrationClientOptions)
new ServiceBusAdministrationClient(fullyQualifiedNamespace: string, credential: TokenCredential | NamedKeyCredential, options?: ServiceBusAdministrationClientOptions)參數
- fullyQualifiedNamespace
-
string
服務總線實例的完整命名空間，可能類似於 .servicebus.windows.net。
- credential
用戶端用來取得令牌來驗證與 Azure 服務總線連線的認證物件。 如需建立認證，請參閱@azure/身分識別。
如果您要針對 AAD 使用自己的 TokenCredential 介面實作，請將服務總線的「範圍」設定為 ["https://servicebus.azure.net//user_impersonation"]，以取得適當的令牌。
如果您想要傳入 SharedAccessKeyName 和 SharedAccessKey 而不使用連接字串，請使用 @azure/core-auth 中的 AzureNamedKeyCredential。 這些欄位分別對應至 AzureNamedKeyCredential中的 [name] 和 [key] 字段。
PipelineOptions
繼承的屬性詳細資料
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
定義規則評估的篩選表達式。
傳回
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
定義規則評估的篩選表達式。
- ruleAction
- SqlRuleAction
應套用相關聯的篩選，可以在訊息上執行的 SQL 類似表達式。
傳回
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
傳回
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
傳回
Promise<{ _response: HttpResponse }>
deleteSubscription(string, string, OperationOptions)
刪除訂用帳戶。
function deleteSubscription(topicName: string, subscriptionName: string, operationOptions?: OperationOptions): Promise<{ _response: HttpResponse }>參數
- topicName
-
string
- subscriptionName
-
string
傳回
Promise<{ _response: HttpResponse }>
deleteTopic(string, OperationOptions)
刪除主題。
function deleteTopic(topicName: string, operationOptions?: OperationOptions): Promise<{ _response: HttpResponse }>參數
- topicName
-
string
傳回
Promise<{ _response: HttpResponse }>
getNamespaceProperties(OperationOptions)
傳回 物件，表示與服務總線命名空間相關的元數據。
function getNamespaceProperties(operationOptions?: OperationOptions): Promise<WithResponse<NamespaceProperties>>參數
- operationOptions
- OperationOptions
可用來中止、追蹤和控制 HTTP 要求上其他組態的選項。
傳回
Promise<WithResponse<NamespaceProperties>>
getQueue(string, OperationOptions)
傳回物件，表示 Queue 及其屬性。
如果您想要取得佇列運行時間資訊，例如訊息計數詳細數據，請使用 getQueueRuntimeProperties API。
function getQueue(queueName: string, operationOptions?: OperationOptions): Promise<WithResponse<QueueProperties>>參數
- queueName
-
string
傳回
Promise<WithResponse<QueueProperties>>
getQueueRuntimeProperties(string, OperationOptions)
傳回 物件，表示佇列運行時間資訊，例如訊息計數詳細數據。
function getQueueRuntimeProperties(queueName: string, operationOptions?: OperationOptions): Promise<WithResponse<QueueRuntimeProperties>>參數
- queueName
-
string
傳回
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
傳回
Promise<WithResponse<RuleProperties>>
getSubscription(string, string, OperationOptions)
傳回物件，表示 Subscription 及其屬性。
如果您想要取得訂用帳戶運行時間資訊，例如訊息計數詳細數據，請使用 getSubscriptionRuntimeProperties API。
function getSubscription(topicName: string, subscriptionName: string, operationOptions?: OperationOptions): Promise<WithResponse<SubscriptionProperties>>參數
- topicName
-
string
- subscriptionName
-
string
傳回
Promise<WithResponse<SubscriptionProperties>>
getSubscriptionRuntimeProperties(string, string, OperationOptions)
傳回 物件，表示訂閱運行時間資訊，例如訊息計數詳細數據。
function getSubscriptionRuntimeProperties(topicName: string, subscriptionName: string, operationOptions?: OperationOptions): Promise<WithResponse<SubscriptionRuntimeProperties>>參數
- topicName
-
string
- subscriptionName
-
string
傳回
Promise<WithResponse<SubscriptionRuntimeProperties>>
getTopic(string, OperationOptions)
傳回物件，表示 Topic 及其屬性。
如果您想要取得主題運行時間資訊，例如訂用帳戶計數詳細數據，請使用 getTopicRuntimeProperties API。
function getTopic(topicName: string, operationOptions?: OperationOptions): Promise<WithResponse<TopicProperties>>參數
- topicName
-
string
傳回
Promise<WithResponse<TopicProperties>>
getTopicRuntimeProperties(string, OperationOptions)
傳回 物件，代表主題運行時間資訊，例如訂用帳戶計數。
function getTopicRuntimeProperties(topicName: string, operationOptions?: OperationOptions): Promise<WithResponse<TopicRuntimeProperties>>參數
- topicName
-
string
傳回
Promise<WithResponse<TopicRuntimeProperties>>
listQueues(OperationOptions)
傳回可同步反覆運算器以列出所有佇列。
.byPage（） 會傳回異步可反覆運算器，以在頁面中列出佇列。
function listQueues(options?: OperationOptions): PagedAsyncIterableIterator<QueueProperties, EntitiesResponse<QueueProperties>, PageSettings>參數
- options
- OperationOptions
傳回
支援分頁的 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
傳回
支援分頁的 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
傳回
支援分頁的 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
物件，表示佇列的屬性和原始回應。
requiresSession、requiresDuplicateDetection、enablePartitioning和 name 在建立佇列之後無法更新。
傳回
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
設定要更新的規則和原始響應的選項。 例如，您可以設定篩選條件，以套用至相關聯的主題/訂用帳戶。
傳回
Promise<WithResponse<RuleProperties>>
updateSubscription(WithResponse<SubscriptionProperties>, OperationOptions)
根據提供的訂用帳戶屬性更新訂閱。
即使只有其中一部分實際上是可更新的，也必須設定所有訂用帳戶屬性。
因此，建議的流程是使用來自 getSubscription()的輸出、更新中所需的屬性，然後將修改的物件傳遞至 updateSubscription()。
無法更新的屬性會在 SubscriptionProperties 介面中標示為唯讀。
function updateSubscription(subscription: WithResponse<SubscriptionProperties>, operationOptions?: OperationOptions): Promise<WithResponse<SubscriptionProperties>>參數
- subscription
物件，表示訂閱的屬性和原始回應。
建立訂用帳戶之後，無法更新 subscriptionName、topicName和 requiresSession。
傳回
Promise<WithResponse<SubscriptionProperties>>
updateTopic(WithResponse<TopicProperties>, OperationOptions)
根據所提供的主題屬性來更新主題。
即使只有部分主題屬性實際上是可更新的，也必須設定所有主題屬性。
因此，建議的流程是使用來自 getTopic()的輸出、更新中所需的屬性，然後將修改的物件傳遞至 updateTopic()。
無法更新的屬性會在 TopicProperties 介面中標示為唯讀。
function updateTopic(topic: WithResponse<TopicProperties>, operationOptions?: OperationOptions): Promise<WithResponse<TopicProperties>>參數
- topic
物件，表示主題的屬性和原始回應。
建立主題之後，無法更新 requiresDuplicateDetection、enablePartitioning和 name。
傳回
Promise<WithResponse<TopicProperties>>
繼承的方法的詳細資料
sendOperationRequest<T>(OperationArguments, OperationSpec)
傳送使用提供的 OperationSpec 填入的 HTTP 要求。
function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>參數
- operationArguments
- OperationArguments
HTTP 要求樣板化值的自變數將會從 中填入。
- operationSpec
- OperationSpec
要用來填入 HTTPRequest 的 OperationSpec。
傳回
Promise<T>
繼承自 ServiceClient.sendOperationRequest
sendRequest(PipelineRequest)
傳送提供的 HTTPRequest。
function sendRequest(request: PipelineRequest): Promise<PipelineResponse>參數
- request
- PipelineRequest
傳回
Promise<PipelineResponse>
繼承自 ServiceClient.sendRequest