你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
ManagementClient 类
- java.
lang. Object - com.
microsoft. azure. servicebus. management. ManagementClient
- com.
public class ManagementClient
同步客户端，用于对服务总线实体执行管理操作。 用于 ManagementClientAsync 异步操作。
构造函数摘要
| 构造函数 | 说明 | |
|---|---|---|
| ManagementClient(ConnectionStringBuilder connectionStringBuilder) | ||
| ManagementClient(URI namespaceEndpointURI, ClientSettings clientSettings) | ||
方法摘要
方法继承自 java.lang.Object
构造函数详细信息
ManagementClient
public ManagementClient(ConnectionStringBuilder connectionStringBuilder)
参数:
ManagementClient
public ManagementClient(URI namespaceEndpointURI, ClientSettings clientSettings)
参数:
方法详细信息
close
createQueue
public QueueDescription createQueue(QueueDescription queueDescription)
使用给定名称在服务命名空间中创建一个新队列。 有关队列属性的默认值，请参阅 QueueDescription 。
参数:
- 一个 QueueDescription 对象，描述将用于创建新队列的属性。
返回:
引发:
- 同一服务命名空间下存在同一名称的实体。
- 同一服务命名空间下存在同一名称的实体。
createQueue
public QueueDescription createQueue(String queuePath)
使用给定名称在服务命名空间中创建一个新队列。 有关队列属性的默认值，请参阅 QueueDescription 。
参数:
- 相对于服务命名空间基址的队列名称。
返回:
引发:
- 实体名称为 null、空、太长或使用非法字符。
- 实体名称为 null、空、太长或使用非法字符。
createRule
public RuleDescription createRule(String topicName, String subscriptionName, RuleDescription ruleDescription)
为给定主题 - 订阅创建新规则。 有关订阅属性的默认值，请参阅 RuleDescription 。
参数:
- 主题名称。
- 订阅的名称。
- 一个 RuleDescription 对象，描述将用于创建新规则的属性。
返回:
引发:
- 同一服务命名空间下存在同一名称的实体。
- 同一服务命名空间下存在同一名称的实体。
createSubscription
public SubscriptionDescription createSubscription(SubscriptionDescription subscriptionDescription)
使用给定名称在服务命名空间中创建一个新订阅。 有关订阅属性的默认值，请参阅 SubscriptionDescription 。
参数:
- 一个 SubscriptionDescription 对象，描述将用于创建新订阅的属性。
返回:
引发:
- 同一服务命名空间下存在同一名称的实体。
- 同一服务命名空间下存在同一名称的实体。
createSubscription
public SubscriptionDescription createSubscription(SubscriptionDescription subscriptionDescription, RuleDescription defaultRule)
使用提供的默认规则在服务命名空间中创建新订阅。 有关订阅属性的默认值，请参阅 SubscriptionDescription 。
参数:
- 一个 SubscriptionDescription 对象，描述将用于创建新订阅的属性。
- 描述 RuleDescription 默认规则的 对象。 如果为 null，则将创建直通筛选器。
返回:
引发:
- 同一服务命名空间下存在同一名称的实体。
- 同一服务命名空间下存在同一名称的实体。
createSubscription
public SubscriptionDescription createSubscription(String topicPath, String subscriptionName)
在具有给定名称的服务命名空间中为给定主题创建一个新订阅。 有关订阅属性的默认值，请参阅 SubscriptionDescription 。
参数:
- 相对于服务命名空间基址的主题名称。
- 订阅的名称。
返回:
引发:
- 实体名称为 null、空、太长或使用非法字符。
- 实体名称为 null、空、太长或使用非法字符。
createTopic
public TopicDescription createTopic(TopicDescription topicDescription)
使用给定名称在服务命名空间中创建一个新主题。 有关主题属性的默认值，请参阅 TopicDescription 。
参数:
- 一个 QueueDescription 对象，描述将用于创建新主题的属性。
返回:
引发:
- 同一服务命名空间下存在同一名称的实体。
- 同一服务命名空间下存在同一名称的实体。
createTopic
public TopicDescription createTopic(String topicPath)
使用给定名称在服务命名空间中创建一个新主题。 有关主题属性的默认值，请参阅 TopicDescription 。
参数:
- 相对于服务命名空间基址的主题名称。
返回:
引发:
- 实体名称为 null、空、太长或使用非法字符。
- 实体名称为 null、空、太长或使用非法字符。
deleteQueue
public Void deleteQueue(String path)
删除由相对于服务命名空间基址的路径描述的队列。
参数:
- 相对于服务命名空间基址的实体的名称。
引发:
- path 不为 null/空/太长/无效。
- path 不为 null/空/太长/无效。
deleteRule
public Void deleteRule(String topicPath, String subscriptionName, String ruleName)
删除给定主题订阅的规则。
参数:
- 主题的名称。
- 订阅的名称。
- 规则的名称。
引发:
- path 不为 null/空/太长/无效。
- path 不为 null/空/太长/无效。
deleteSubscription
public Void deleteSubscription(String topicPath, String subscriptionName)
删除 topicPath 和 subscriptionName 描述的订阅。
参数:
- 主题的名称。
- 订阅的名称。
引发:
- path 不为 null/空/太长/无效。
- path 不为 null/空/太长/无效。
deleteTopic
public Void deleteTopic(String path)
删除由相对于服务命名空间基址的路径描述的主题。
参数:
- 相对于服务命名空间基址的实体的名称。
引发:
- path 不为 null/空/太长/无效。
- path 不为 null/空/太长/无效。
getNamespaceInfo
public NamespaceInfo getNamespaceInfo()
检索与命名空间相关的信息。 适用于任何声明 (发送/侦听/管理) 。
返回:
- NamespaceInfo 包含命名空间信息。
引发:
- 发生内部错误或意外异常。
- 发生内部错误或意外异常。
getQueue
public QueueDescription getQueue(String path)
从服务命名空间检索队列
参数:
- 相对于服务总线命名空间的队列路径。
返回:
- QueueDescription 包含有关队列的信息。
引发:
- 如果路径为 null、空或不采用正确的格式或长度，则引发。
- 如果路径为 null、空或不采用正确的格式或长度，则引发。
getQueueRuntimeInfo
public QueueRuntimeInfo getQueueRuntimeInfo(String path)
检索队列的运行时信息。
参数:
- 相对于服务总线命名空间的队列路径。
返回:
- 包含有关队列的运行时信息的 QueueRuntimeInfo。
引发:
- 如果路径为 null、空或不采用正确的格式或长度，则引发。
- 如果路径为 null、空或不采用正确的格式或长度，则引发。
getQueues
public List
检索命名空间中存在的队列列表。
返回:
引发:
- 操作超时。超时期限通过 ClientSettings.operationTimeout 启动
- 操作超时。超时期限通过 ClientSettings.operationTimeout 启动
getQueues
public List
检索命名空间中存在的队列列表。 可以通过操作计数和跳过参数来模拟实体列表的页面。 skip (0) +count (100) 提供前 100 个实体。 skip (100) +count (100) 提供接下来的 100 个实体。
参数:
- 要提取的队列数。 默认为 100。 允许的最大值为 100。
- 要跳过的队列数。 默认值为 0。 不能为负值。
返回:
引发:
- 操作超时。超时期限通过 ClientSettings.operationTimeout 启动
- 操作超时。超时期限通过 ClientSettings.operationTimeout 启动
getRule
public RuleDescription getRule(String topicPath, String subscriptionName, String ruleName)
从服务命名空间检索给定主题和订阅的规则
参数:
- 主题相对于服务总线命名空间的路径。
- 订阅的名称。
- 规则的名称。
返回:
- RuleDescription 包含有关订阅的信息。
引发:
- 如果路径为 null、空或不采用正确的格式或长度，则引发。
- 如果路径为 null、空或不采用正确的格式或长度，则引发。
getRules
public List
检索命名空间中给定主题订阅的规则列表。
参数:
- 主题的名称。
- 订阅的名称。
返回:
引发:
- 操作超时。超时期限通过 ClientSettings.operationTimeout 启动
- 操作超时。超时期限通过 ClientSettings.operationTimeout 启动
getRules
public List
检索命名空间中给定主题订阅的规则列表。 可以通过操作计数和跳过参数来模拟实体列表的页面。 skip (0) +count (100) 提供前 100 个实体。 skip (100) +count (100) 提供接下来的 100 个实体。
参数:
- 主题的名称。
- 订阅的名称。
- 要提取的规则数。 默认为 100。 允许的最大值为 100。
- 要跳过的规则数量。 默认值为 0。 不能为负值。
返回:
引发:
- 操作超时。超时期限通过 ClientSettings.operationTimeout 启动
- 操作超时。超时期限通过 ClientSettings.operationTimeout 启动
getSubscription
public SubscriptionDescription getSubscription(String topicPath, String subscriptionName)
从服务命名空间检索给定主题的订阅
参数:
- 主题相对于服务总线命名空间的路径。
- 订阅的名称
返回:
- SubscriptionDescription 包含有关订阅的信息。
引发:
- 如果路径为 null、空或不采用正确的格式或长度，则引发。
- 如果路径为 null、空或不采用正确的格式或长度，则引发。
getSubscriptionRuntimeInfo
public SubscriptionRuntimeInfo getSubscriptionRuntimeInfo(String topicPath, String subscriptionName)
检索给定主题中订阅的运行时信息
参数:
- 主题相对于服务总线命名空间的路径。
- 订阅的名称
返回:
- 包含有关订阅的运行时信息的 SubscriptionRuntimeInfo。
引发:
- 如果路径为 null、空或不采用正确的格式或长度，则引发。
- 如果路径为 null、空或不采用正确的格式或长度，则引发。
getSubscriptions
public List
检索命名空间中给定主题的订阅列表。
参数:
- 主题的名称。
返回:
引发:
- 操作超时。超时期限通过 ClientSettings.operationTimeout 启动
- 操作超时。超时期限通过 ClientSettings.operationTimeout 启动
getSubscriptions
public List
检索命名空间中给定主题的订阅列表。 可以通过操作计数和跳过参数来模拟实体列表的页面。 skip (0) +count (100) 提供前 100 个实体。 skip (100) +count (100) 提供接下来的 100 个实体。
参数:
- 主题的名称。
- 要提取的订阅数。 默认为 100。 允许的最大值为 100。
- 要跳过的订阅数。 默认值为 0。 不能为负值。
返回:
引发:
- 操作超时。超时期限通过 ClientSettings.operationTimeout 启动
- 操作超时。超时期限通过 ClientSettings.operationTimeout 启动
getTopic
public TopicDescription getTopic(String path)
从服务命名空间检索主题
参数:
- 相对于服务总线命名空间的队列路径。
返回:
- 包含有关主题的信息的说明。
引发:
- 如果路径为 null、空或不采用正确的格式或长度，则引发。
- 如果路径为 null、空或不采用正确的格式或长度，则引发。
getTopicRuntimeInfo
public TopicRuntimeInfo getTopicRuntimeInfo(String path)
检索主题的运行时信息
参数:
- 相对于服务总线命名空间的队列路径。
返回:
- 包含有关主题的运行时信息的 TopicRuntimeInfo。
引发:
- 如果路径为 null、空或不采用正确的格式或长度，则引发。
- 如果路径为 null、空或不采用正确的格式或长度，则引发。
getTopics
public List
检索命名空间中存在的主题列表。
返回:
引发:
- 操作超时。超时期限通过 ClientSettings.operationTimeout 启动
- 操作超时。超时期限通过 ClientSettings.operationTimeout 启动
getTopics
public List
检索命名空间中存在的主题列表。 可以通过操作计数和跳过参数来模拟实体列表的页面。 skip (0) +count (100) 提供前 100 个实体。 skip (100) +count (100) 提供接下来的 100 个实体。
参数:
- 要提取的主题数。 默认为 100。 允许的最大值为 100。
- 要跳过的主题数。 默认值为 0。 不能为负值。
返回:
引发:
- 操作超时。超时期限通过 ClientSettings.operationTimeout 启动
- 操作超时。超时期限通过 ClientSettings.operationTimeout 启动
queueExists
public Boolean queueExists(String path)
检查给定队列是否存在。
参数:
- 实体检查的路径
返回:
- 如果实体存在，则为 True。 否则为 False。
引发:
- path 不为 null/空/太长/无效。
- path 不为 null/空/太长/无效。
ruleExists
public Boolean ruleExists(String topicPath, String subscriptionName, String ruleName)
检查给定订阅是否存在给定规则。
参数:
- 主题的路径
- 订阅的名称。
- 规则名称
返回:
- 如果实体存在，则为 True。 否则为 False。
引发:
- path 不为 null/空/太长/无效。
- path 不为 null/空/太长/无效。
subscriptionExists
public Boolean subscriptionExists(String topicPath, String subscriptionName)
检查给定订阅是否存在。
参数:
- 主题的路径
- 订阅的名称。
返回:
- 如果实体存在，则为 True。 否则为 False。
引发:
- path 不为 null/空/太长/无效。
- path 不为 null/空/太长/无效。
topicExists
public Boolean topicExists(String path)
检查给定主题是否存在。
参数:
- 实体检查的路径
返回:
- 如果实体存在，则为 True。 否则为 False。
引发:
- path 不为 null/空/太长/无效。
- path 不为 null/空/太长/无效。
updateQueue
public QueueDescription updateQueue(QueueDescription queueDescription)
汇报现有队列。
参数:
- 一个 QueueDescription 对象，描述将用于更新队列的属性。
返回:
引发:
- 找不到所描述的实体。
- 找不到所描述的实体。
updateRule
public RuleDescription updateRule(String topicName, String subscriptionName, RuleDescription ruleDescription)
汇报现有规则。
参数:
- 主题名称。
- 订阅的名称。
- 一个 RuleDescription 对象，描述将用于更新规则的属性。
返回:
引发:
- 找不到所描述的实体。
- 找不到所描述的实体。
updateSubscription
public SubscriptionDescription updateSubscription(SubscriptionDescription subscriptionDescription)
汇报现有订阅。
参数:
- 一个 SubscriptionDescription 对象，描述将用于更新订阅的属性。
返回:
引发:
- 找不到所描述的实体。
- 找不到所描述的实体。
updateTopic
public TopicDescription updateTopic(TopicDescription topicDescription)
汇报现有主题。
参数:
- 一个 TopicDescription 对象，描述将用于更新主题的属性。
返回:
引发:
- 找不到所描述的实体。
- 找不到所描述的实体。
