ServiceBusAdministrationClient class
所有作都会返回解析为具有相关输出的对象的承诺。
这些对象还具有一个名为 _response 的属性，如果要从服务访问直接响应，可以使用该属性。
- 扩展
构造函数
继承属性
| 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)
返回一个对象，该对象表示订阅及其属性。
如果要获取订阅运行时信息（如消息计数详细信息），请使用 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