ServiceBusAdministrationClient クラス
- java.
lang. Object - com.
azure. messaging. servicebus. administration. ServiceBusAdministrationClient
- com.
public final class ServiceBusAdministrationClient
Service Bus 名前空間を管理するための 同期 クライアント。 を使用して ServiceBusAdministrationClientBuilderインスタンス化されます。
サンプル: 非同期クライアントを作成する
次のコード サンプルは、非同期管理クライアントの作成を示しています。 次の例で使用する資格情報は、認証用です DefaultAzureCredential
。 ローカルの開発環境や運用環境など、ほとんどのシナリオに適しています。 さらに、運用環境での認証には マネージド ID を 使用することをお勧めします。 さまざまな認証方法と、それに対応する資格情報の種類の詳細については、 Azure Id のドキュメントを参照してください。
HttpLogOptions logOptions = new HttpLogOptions()
.setLogLevel(HttpLogDetailLevel.HEADERS);
// DefaultAzureCredential creates a credential based on the environment it is executed in.
TokenCredential tokenCredential = new DefaultAzureCredentialBuilder().build();
// 'fullyQualifiedNamespace' will look similar to "{your-namespace}.servicebus.windows.net"
ServiceBusAdministrationClient client = new ServiceBusAdministrationClientBuilder()
.credential(fullyQualifiedNamespace, tokenCredential)
.httpLogOptions(logOptions)
.buildClient();
サンプル: キューを作成する
次の例では、既定値を使用してキューを作成します。 既定値は に CreateQueueOptions()一覧表示されます。
QueueProperties queue = client.createQueue("my-new-queue");
System.out.printf("Queue created. Name: %s. Lock Duration: %s.%n",
queue.getName(), queue.getLockDuration());
サンプル: 既存のサブスクリプションを編集する
次のコード サンプルは、既存のサブスクリプションの更新を示しています。 ユーザーは、サブスクリプションのプロパティをフェッチし、プロパティを変更してから、 オブジェクトを update メソッドに渡す必要があります。
// To update the subscription we have to:
// 1. Get the subscription info from the service.
// 2. Update the SubscriptionProperties we want to change.
// 3. Call the updateSubscription() with the updated object.
SubscriptionProperties subscription = client.getSubscription("my-topic", "my-subscription");
System.out.println("Original delivery count: " + subscription.getMaxDeliveryCount());
// Updating it to a new value.
subscription.setMaxDeliveryCount(5);
// Persisting the updates to the subscription object.
SubscriptionProperties updated = client.updateSubscription(subscription);
System.out.printf("Subscription updated. Name: %s. Delivery count: %s.%n",
updated.getSubscriptionName(), updated.getMaxDeliveryCount());
サンプル: すべてのキューを一覧表示する
次のコード サンプルでは、Service Bus 名前空間内のすべてのキューを一覧表示します。
client.listQueues().forEach(queue -> {
System.out.printf("Queue [%s]. Lock Duration: %s.%n",
queue.getName(), queue.getLockDuration());
});
サンプル: キューの削除
次のコード サンプルは、既存のキューの削除を示しています。
try {
client.deleteQueue("my-existing-queue");
} catch (AzureException exception) {
System.err.println("Exception occurred deleting queue: " + exception);
}
メソッドの概要
メソッドの継承元: java.lang.Object
メソッドの詳細
createQueue
public QueueProperties createQueue(String queueName)
指定した名前のキューを作成します。
Parameters:
Returns:
createQueue
public QueueProperties createQueue(String queueName, CreateQueueOptions queueOptions)
を使用してキューを作成します CreateQueueOptions。
Parameters:
Returns:
createQueueWithResponse
public Response
キューを作成し、HTTP 応答に加えて作成されたキューを返します。
Parameters:
Returns:
createRule
public RuleProperties createRule(String topicName, String subscriptionName, String ruleName)
指定されたトピックとサブスクリプションの下にルールを作成します
Parameters:
Returns:
createRule
public RuleProperties createRule(String topicName, String ruleName, String subscriptionName, CreateRuleOptions ruleOptions)
を使用してルールを作成します CreateRuleOptions。
Parameters:
Returns:
createRuleWithResponse
public Response
ルールを作成し、HTTP 応答に加えて作成されたルールを返します。
Parameters:
Returns:
createSubscription
public SubscriptionProperties createSubscription(String topicName, String subscriptionName)
指定されたトピックとサブスクリプション名を持つサブスクリプションを作成します。
Parameters:
Returns:
createSubscription
public SubscriptionProperties createSubscription(String topicName, String subscriptionName, CreateSubscriptionOptions subscriptionOptions)
を使用してサブスクリプションを作成します CreateSubscriptionOptions。
Parameters:
Returns:
createSubscription
public SubscriptionProperties createSubscription(String topicName, String subscriptionName, String ruleName, CreateSubscriptionOptions subscriptionOptions, CreateRuleOptions ruleOptions)
と CreateRuleOptionsを使用して、既定の規則を使用してサブスクリプションをCreateSubscriptionOptions作成します。
Parameters:
Returns:
createSubscriptionWithResponse
public Response
サブスクリプションを作成し、HTTP 応答に加えて作成されたサブスクリプションを返します。
Parameters:
Returns:
createSubscriptionWithResponse
public Response
既定の規則が構成されたサブスクリプションを作成し、HTTP 応答に加えて作成されたサブスクリプションを返します。
Parameters:
Returns:
createTopic
public TopicProperties createTopic(String topicName)
指定した名前のトピックを作成します。
Parameters:
Returns:
createTopic
public TopicProperties createTopic(String topicName, CreateTopicOptions topicOptions)
を使用してトピックを作成します CreateTopicOptions。
Parameters:
Returns:
createTopicWithResponse
public Response
トピックを作成し、HTTP 応答に加えて作成されたトピックを返します。
Parameters:
Returns:
deleteQueue
public void deleteQueue(String queueName)
一致 queueName
する キューを削除します。
Parameters:
deleteQueueWithResponse
public Response
一致 queueName
するキューを削除し、HTTP 応答を返します。
Parameters:
Returns:
deleteRule
public void deleteRule(String topicName, String subscriptionName, String ruleName)
一致 ruleName
する ルールを削除します。
Parameters:
deleteRuleWithResponse
public Response
一致 ruleName
するルールを削除し、HTTP 応答を返します。
Parameters:
Returns:
deleteSubscription
public void deleteSubscription(String topicName, String subscriptionName)
トピック topicName
の と一致するサブスクリプションをsubscriptionName
削除します。
Parameters:
deleteSubscriptionWithResponse
public Response
一致 subscriptionName
するサブスクリプションを削除し、HTTP 応答を返します。
Parameters:
Returns:
deleteTopic
public void deleteTopic(String topicName)
一致 topicName
する トピックを削除します。
Parameters:
deleteTopicWithResponse
public Response
一致 topicName
するトピックを削除し、HTTP 応答を返します。
Parameters:
Returns:
getNamespaceProperties
public NamespaceProperties getNamespaceProperties()
Service Bus 名前空間に関する情報を取得します。
Returns:
getNamespacePropertiesWithResponse
public Response
Service Bus 名前空間に関する情報とその HTTP 応答を取得します。
Parameters:
Returns:
getQueue
public QueueProperties getQueue(String queueName)
キューに関する情報を取得します。
Parameters:
Returns:
getQueueExists
public boolean getQueueExists(String queueName)
のキュー queueName
が Service Bus 名前空間に存在するかどうかを取得します。
Parameters:
Returns:
true
キューが存在する場合は 。それ以外の場合 false
は 。getQueueExistsWithResponse
public Response
のキュー queueName
が Service Bus 名前空間に存在するかどうかを取得します。
Parameters:
Returns:
true
キューが存在する場合は 。それ以外の場合 false
は 。getQueueRuntimeProperties
public QueueRuntimeProperties getQueueRuntimeProperties(String queueName)
キューに関するランタイム プロパティを取得します。
Parameters:
Returns:
getQueueRuntimePropertiesWithResponse
public Response
キューに関するランタイム プロパティとその HTTP 応答を取得します。
Parameters:
Returns:
getQueueWithResponse
public Response
HTTP 応答と共にキューに関する情報を取得します。
Parameters:
Returns:
getRule
public RuleProperties getRule(String topicName, String subscriptionName, String ruleName)
サービス名前空間からルールを取得します。 フィルターパラメーターとアクション パラメーター (string、int、long、boolean、double、OffsetDateTime) では、次のデータ型のみが逆シリアル化されます。 その他のデータ型は、その文字列値を返します。
Parameters:
Returns:
getRuleWithResponse
public Response
サービス名前空間からルールを取得します。 フィルターパラメーターとアクション パラメーター (string、int、long、bool、double、OffsetDateTime) では、次のデータ型のみが逆シリアル化されます。 その他のデータ型は、その文字列値を返します。
Parameters:
Returns:
getSubscription
public SubscriptionProperties getSubscription(String topicName, String subscriptionName)
キューに関する情報を取得します。
Parameters:
Returns:
getSubscriptionExists
public boolean getSubscriptionExists(String topicName, String subscriptionName)
トピック内にサブスクリプションが存在するかどうかを取得します。
Parameters:
Returns:
true
サブスクリプションが存在する場合は 。getSubscriptionExistsWithResponse
public Response
トピック内にサブスクリプションが存在するかどうかを取得します。
Parameters:
Returns:
true
サブスクリプションが存在する場合は 。それ以外の場合 false
は 。getSubscriptionRuntimeProperties
public SubscriptionRuntimeProperties getSubscriptionRuntimeProperties(String topicName, String subscriptionName)
サブスクリプションに関するランタイム プロパティを取得します。
Parameters:
Returns:
getSubscriptionRuntimePropertiesWithResponse
public Response
サブスクリプションに関するランタイム プロパティを取得します。
Parameters:
Returns:
getSubscriptionWithResponse
public Response
サブスクリプションに関する情報とその HTTP 応答を取得します。
Parameters:
Returns:
getTopic
public TopicProperties getTopic(String topicName)
トピックに関する情報を取得します。
Parameters:
Returns:
getTopicExists
public boolean getTopicExists(String topicName)
のトピック topicName
が Service Bus 名前空間に存在するかどうかを取得します。
Parameters:
Returns:
true
トピックが存在する場合は 。getTopicExistsWithResponse
public Response
のトピック topicName
が Service Bus 名前空間に存在するかどうかを取得します。
Parameters:
Returns:
true
トピックが存在する場合は 。それ以外の場合 false
は 。getTopicRuntimeProperties
public TopicRuntimeProperties getTopicRuntimeProperties(String topicName)
トピックに関するランタイム プロパティを取得します。
Parameters:
Returns:
getTopicRuntimePropertiesWithResponse
public Response
HTTP 応答を使用して、トピックに関するランタイム プロパティを取得します。
Parameters:
Returns:
getTopicWithResponse
public Response
HTTP 応答と共にトピックに関する情報を取得します。
Parameters:
Returns:
listQueues
public PagedIterable
Service Bus 名前空間内のすべてのキューをフェッチします。
Returns:
listQueues
public PagedIterable
Service Bus 名前空間内のすべてのキューをフェッチします。
Parameters:
Returns:
listRules
public PagedIterable
トピックとサブスクリプションのすべてのルールをフェッチします。
Parameters:
Returns:
listRules
public PagedIterable
トピックとサブスクリプションのすべてのルールをフェッチします。
Parameters:
Returns:
listSubscriptions
public PagedIterable
トピックのすべてのサブスクリプションをフェッチします。
Parameters:
Returns:
topicName
。listSubscriptions
public PagedIterable
トピックのすべてのサブスクリプションをフェッチします。
Parameters:
Returns:
topicName
。listTopics
public PagedIterable
Service Bus 名前空間のすべてのトピックをフェッチします。
Returns:
listTopics
public PagedIterable
Service Bus 名前空間のすべてのトピックをフェッチします。
Parameters:
Returns:
updateQueue
public QueueProperties updateQueue(QueueProperties queue)
指定QueuePropertiesした を使用してキューを更新します。 QueuePropertiesすべてのプロパティが置き換えられるので、 は完全に設定する必要があります。 プロパティが設定されていない場合は、サービスの既定値が使用されます。 推奨されるフローは次のとおりです。
- getQueue(String queueName)
- 必要な要素を更新します。
- 更新された説明をこのメソッドに渡します。
更新できるプロパティのサブセットがあります。 詳細については、以下のリンクを参照してください。 これらは次のとおりです。
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setLockDuration(Duration lockDuration)
- setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
- setMaxDeliveryCount(Integer maxDeliveryCount)
Parameters:
Returns:
updateQueueWithResponse
public Response
指定QueuePropertiesした を使用してキューを更新します。 QueuePropertiesすべてのプロパティが置き換えられるので、 は完全に設定する必要があります。 プロパティが設定されていない場合は、サービスの既定値が使用されます。 推奨されるフローは次のとおりです。
- getQueue(String queueName)
- 必要な要素を更新します。
- 更新された説明をこのメソッドに渡します。
更新できるプロパティのサブセットがあります。 詳細については、以下のリンクを参照してください。 これらは次のとおりです。
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setLockDuration(Duration lockDuration)
- setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
- setMaxDeliveryCount(Integer maxDeliveryCount)
Parameters:
Returns:
updateRule
public RuleProperties updateRule(String topicName, String subscriptionName, RuleProperties rule)
指定RulePropertiesした を使用してルールを更新します。 RulePropertiesすべてのプロパティが置き換えられるので、 は完全に設定する必要があります。 プロパティが設定されていない場合は、サービスの既定値が使用されます。 推奨されるフローは次のとおりです。
- getRule(String topicName, String subscriptionName, String ruleName)
- 必要な要素を更新します。
- 更新された説明をこのメソッドに渡します。
Parameters:
Returns:
updateRuleWithResponse
public Response
指定RulePropertiesした を使用してルールを更新します。 RulePropertiesすべてのプロパティが置き換えられるので、 は完全に設定する必要があります。 プロパティが設定されていない場合は、サービスの既定値が使用されます。 推奨されるフローは次のとおりです。
- getRule(String topicName, String subscriptionName, String ruleName)
- 必要な要素を更新します。
- 更新された説明をこのメソッドに渡します。
Parameters:
Returns:
updateSubscription
public SubscriptionProperties updateSubscription(SubscriptionProperties subscription)
指定SubscriptionPropertiesした を使用してサブスクリプションを更新します。 SubscriptionPropertiesすべてのプロパティが置き換えられるので、 は完全に設定する必要があります。 プロパティが設定されていない場合は、サービスの既定値が使用されます。 推奨されるフローは次のとおりです。
- getSubscription(String topicName, String subscriptionName)
- 必要な要素を更新します。
- 更新された説明をこのメソッドに渡します。
更新できるプロパティのサブセットがあります。 詳細については、以下のリンクを参照してください。 これらは次のとおりです。
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setLockDuration(Duration lockDuration)
- setMaxDeliveryCount(int maxDeliveryCount)
Parameters:
Returns:
updateSubscriptionWithResponse
public Response
指定SubscriptionPropertiesした を使用してサブスクリプションを更新します。 SubscriptionPropertiesすべてのプロパティが置き換えられるので、 は完全に設定する必要があります。 プロパティが設定されていない場合は、サービスの既定値が使用されます。 推奨されるフローは次のとおりです。
- getSubscription(String topicName, String subscriptionName)
- 必要な要素を更新します。
- 更新された説明をこのメソッドに渡します。
更新できるプロパティのサブセットがあります。 詳細については、以下のリンクを参照してください。 これらは次のとおりです。
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setLockDuration(Duration lockDuration)
- setMaxDeliveryCount(int maxDeliveryCount)
Parameters:
Returns:
updateTopic
public TopicProperties updateTopic(TopicProperties topic)
指定TopicPropertiesした を使用してトピックを更新します。 TopicPropertiesすべてのプロパティが置き換えられるので、 は完全に設定する必要があります。 プロパティが設定されていない場合は、サービスの既定値が使用されます。 推奨されるフローは次のとおりです。
- getTopic(String topicName)
- 必要な要素を更新します。
- 更新された説明をこのメソッドに渡します。
更新できるプロパティのサブセットがあります。 詳細については、以下のリンクを参照してください。 これらは次のとおりです。
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
Parameters:
Returns:
updateTopicWithResponse
public Response
指定TopicPropertiesした を使用してトピックを更新します。 TopicPropertiesすべてのプロパティが置き換えられるので、 は完全に設定する必要があります。 プロパティが設定されていない場合は、サービスの既定値が使用されます。 推奨されるフローは次のとおりです。
- getTopic(String topicName)
- 必要な要素を更新します。
- 更新された説明をこのメソッドに渡します。
更新できるプロパティのサブセットがあります。 詳細については、以下のリンクを参照してください。 これらは次のとおりです。
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
Parameters:
Returns:
適用対象
Azure SDK for Java