ServiceBusAdministrationAsyncClient Klasse
- java.
lang. Object - com.
azure. messaging. servicebus. administration. ServiceBusAdministrationAsyncClient
- com.
public final class ServiceBusAdministrationAsyncClient
Ein asynchroner Client zum Verwalten eines Service Bus-Namespaces. Instanziiert über ServiceBusAdministrationClientBuilder.
Beispiel: Erstellen des asynchronen Clients
Im folgenden Codebeispiel wird die Erstellung des asynchronen Verwaltungsclients veranschaulicht. Die im folgenden Beispiel verwendeten Anmeldeinformationen dienen DefaultAzureCredential der Authentifizierung. Es eignet sich für die meisten Szenarien, einschließlich lokaler Entwicklungs- und Produktionsumgebungen. Darüber hinaus wird empfohlen, die verwaltete Identität für die Authentifizierung in Produktionsumgebungen zu verwenden. Weitere Informationen zu verschiedenen Authentifizierungsmethoden und den entsprechenden Anmeldeinformationstypen finden Sie in der Dokumentation zu Azure Identity.
// DefaultAzureCredential creates a credential based on the environment it is executed in.
TokenCredential credential = new DefaultAzureCredentialBuilder().build();
// 'fullyQualifiedNamespace' will look similar to "{your-namespace}.servicebus.windows.net"
ServiceBusAdministrationAsyncClient client = new ServiceBusAdministrationClientBuilder()
.credential(fullyQualifiedNamespace, new DefaultAzureCredentialBuilder().build())
.buildAsyncClient();
Beispiel: Erstellen einer Warteschlange
Im folgenden Beispiel wird eine Warteschlange mit Standardwerten erstellt. Standardwerte werden in CreateQueueOptions()aufgeführt.
// `.subscribe()` is a non-blocking call. It'll move onto the next
// instruction after setting up the `consumer` and `errorConsumer` callbacks.
client.createQueue("my-new-queue").subscribe(queue -> {
System.out.printf("Queue created. Name: %s. Lock Duration: %s.%n",
queue.getName(), queue.getLockDuration());
}, error -> {
System.err.println("Error creating queue: " + error);
});
Beispiel: Bearbeiten eines vorhandenen Abonnements
Im folgenden Codebeispiel wird das Aktualisieren eines vorhandenen Abonnements veranschaulicht. Benutzer sollten die Eigenschaften des Abonnements abrufen, die Eigenschaften ändern und das Objekt dann an die Updatemethode übergeben.
// 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.
// `.subscribe()` is a non-blocking call. It'll move onto the next
// instruction after setting up the `consumer` and `errorConsumer` callbacks.
client.getSubscription("my-topic", "my-subscription")
.flatMap(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.
return client.updateSubscription(subscription);
})
.subscribe(subscription -> {
System.out.printf("Subscription updated. Name: %s. Delivery count: %s.%n",
subscription.getSubscriptionName(), subscription.getMaxDeliveryCount());
}, error -> {
System.err.println("Error updating subscription: " + error);
});
Beispiel: Auflisten aller Warteschlangen
Im folgenden Codebeispiel werden alle Warteschlangen im Service Bus-Namespace aufgelistet.
// `.subscribe()` is a non-blocking call. It'll move onto the next
// instruction after setting up the `consumer` and `errorConsumer` callbacks.
client.listQueues().subscribe(queue -> {
System.out.printf("Queue [%s]. Lock Duration: %s.%n",
queue.getName(), queue.getLockDuration());
}, error -> {
System.err.println("Error fetching queues: " + error);
});
Beispiel: Warteschlange löschen
Im folgenden Codebeispiel wird das Löschen einer vorhandenen Warteschlange veranschaulicht.
// `.subscribe()` is a non-blocking call. It'll move onto the next
// instruction after setting up the `consumer`, `errorConsumer`, `completeConsumer` callbacks.
asyncClient.deleteQueue("my-existing-queue").subscribe(unused -> {
}, error -> {
System.err.println("Error deleting queue: " + error);
}, () -> {
System.out.println("Deleted queue.");
});
Methodenzusammenfassung
Geerbte Methoden von java.lang.Object
Details zur Methode
createQueue
public Mono
Erstellt eine Warteschlange mit dem angegebenen Namen.
Parameters:
Returns:
createQueue
public Mono
Erstellt eine Warteschlange mit dem und dem CreateQueueOptions angegebenen Warteschlangennamen.
Parameters:
Returns:
createQueueWithResponse
public Mono<>
Erstellt eine Warteschlange und gibt die erstellte Warteschlange zusätzlich zur HTTP-Antwort zurück.
Parameters:
Returns:
createRule
public Mono
Erstellt eine Regel unter dem angegebenen Thema und Abonnement.
Parameters:
Returns:
createRule
public Mono
Erstellt eine Regel mit .CreateRuleOptions
Parameters:
Returns:
createRuleWithResponse
public Mono<>
Erstellt eine Regel und gibt die erstellte Regel zusätzlich zur HTTP-Antwort zurück.
Parameters:
Returns:
createSubscription
public Mono
Erstellt ein Abonnement mit dem angegebenen Thema und den angegebenen Abonnementnamen.
Parameters:
Returns:
createSubscription
public Mono
Erstellt ein Abonnement mit .CreateSubscriptionOptions
Parameters:
Returns:
createSubscription
public Mono
Erstellt ein Abonnement mit einer Standardregel mit CreateSubscriptionOptions und CreateRuleOptions.
Parameters:
Returns:
createSubscriptionWithResponse
public Mono<>
Erstellt ein Abonnement und gibt das erstellte Abonnement zusätzlich zur HTTP-Antwort zurück.
Parameters:
Returns:
createSubscriptionWithResponse
public Mono<>
Erstellt ein Abonnement mit der Standardregel und gibt das erstellte Abonnement zusätzlich zur HTTP-Antwort zurück.
Parameters:
Returns:
createTopic
public Mono
Erstellt ein Thema mit dem angegebenen Namen.
Parameters:
Returns:
createTopic
public Mono
Erstellt ein Thema mit .CreateTopicOptions
Parameters:
Returns:
createTopicWithResponse
public Mono<>
Erstellt ein Thema und gibt das erstellte Thema zusätzlich zur HTTP-Antwort zurück.
Parameters:
Returns:
deleteQueue
public Mono
Löscht eine Warteschlange mit dem übereinstimmenden queueName.
Parameters:
Returns:
deleteQueueWithResponse
public Mono<>
Löscht die übereinstimmende queueName Warteschlange und gibt die HTTP-Antwort zurück.
Parameters:
Returns:
deleteRule
public Mono
Löscht eine Regel mit dem übereinstimmenden ruleName.
Parameters:
Returns:
deleteRuleWithResponse
public Mono<>
Löscht die übereinstimmende ruleName Regel und gibt die HTTP-Antwort zurück.
Parameters:
Returns:
deleteSubscription
public Mono
Löscht ein Abonnement mit dem übereinstimmenden subscriptionName.
Parameters:
Returns:
deleteSubscriptionWithResponse
public Mono<>
Löscht das übereinstimmende subscriptionName Abonnement und gibt die HTTP-Antwort zurück.
Parameters:
Returns:
deleteTopic
public Mono
Löscht ein Thema mit dem übereinstimmenden topicName.
Parameters:
Returns:
deleteTopicWithResponse
public Mono<>
Löscht das übereinstimmende topicName Thema und gibt die HTTP-Antwort zurück.
Parameters:
Returns:
getNamespaceProperties
public Mono
Ruft Informationen zum Service Bus-Namespace ab.
Returns:
getNamespacePropertiesWithResponse
public Mono<>
Ruft Informationen zum Service Bus-Namespace zusammen mit seiner HTTP-Antwort ab.
Returns:
getQueue
public Mono
Ruft Informationen zur Warteschlange ab.
Parameters:
Returns:
getQueueExists
public Mono
Ruft ab, ob eine Warteschlange mit queueName im Service Bus-Namespace vorhanden ist.
Parameters:
Returns:
getQueueExistsWithResponse
public Mono<>
Ruft ab, ob eine Warteschlange mit queueName im Service Bus-Namespace vorhanden ist.
Parameters:
Returns:
getQueueRuntimeProperties
public Mono
Ruft Laufzeiteigenschaften zur Warteschlange ab.
Parameters:
Returns:
getQueueRuntimePropertiesWithResponse
public Mono<>
Ruft Laufzeiteigenschaften zur Warteschlange zusammen mit ihrer HTTP-Antwort ab.
Parameters:
Returns:
getQueueWithResponse
public Mono<>
Ruft Informationen zur Warteschlange zusammen mit ihrer HTTP-Antwort ab.
Parameters:
Returns:
getRule
public Mono
Ruft eine Regel aus dem Dienstnamespace ab. Nur die folgenden Datentypen werden in Filter und Aktionsparametern deserialisiert: string, int, long, boolean, double und OffsetDateTime. Andere Datentypen geben den Zeichenfolgenwert zurück.
Parameters:
Returns:
getRuleWithResponse
public Mono<>
Ruft eine Regel aus dem Dienstnamespace ab. Nur die folgenden Datentypen werden in Filter und Aktionsparametern deserialisiert: string, int, long, bool, double und OffsetDateTime. Andere Datentypen geben den Zeichenfolgenwert zurück.
Parameters:
Returns:
getSubscription
public Mono
Ruft Informationen zur Warteschlange ab.
Parameters:
Returns:
getSubscriptionExists
public Mono
Ruft ab, ob ein Abonnement innerhalb eines Themas vorhanden ist.
Parameters:
Returns:
getSubscriptionExistsWithResponse
public Mono<>
Ruft ab, ob ein Abonnement innerhalb eines Themas vorhanden ist.
Parameters:
Returns:
getSubscriptionRuntimeProperties
public Mono
Ruft Laufzeiteigenschaften für das Abonnement ab.
Parameters:
Returns:
getSubscriptionRuntimePropertiesWithResponse
public Mono<>
Ruft Laufzeiteigenschaften für das Abonnement ab.
Parameters:
Returns:
getSubscriptionWithResponse
public Mono<>
Ruft Informationen zum Abonnement zusammen mit seiner HTTP-Antwort ab.
Parameters:
Returns:
getTopic
public Mono
Ruft Informationen zum Thema ab.
Parameters:
Returns:
getTopicExists
public Mono
Ruft ab, ob ein Thema mit topicName im Service Bus-Namespace vorhanden ist.
Parameters:
Returns:
getTopicExistsWithResponse
public Mono<>
Ruft ab, ob ein Thema mit topicName im Service Bus-Namespace vorhanden ist.
Parameters:
Returns:
getTopicRuntimeProperties
public Mono
Ruft Laufzeiteigenschaften zum Thema ab.
Parameters:
Returns:
getTopicRuntimePropertiesWithResponse
public Mono<>
Ruft Laufzeiteigenschaften zum Thema mit seiner HTTP-Antwort ab.
Parameters:
Returns:
getTopicWithResponse
public Mono<>
Ruft Informationen zum Thema zusammen mit der HTTP-Antwort ab.
Parameters:
Returns:
listQueues
public PagedFlux
Ruft alle Warteschlangen im Service Bus-Namespace ab.
Returns:
listRules
public PagedFlux
Ruft alle Regeln für ein Thema und ein Abonnement ab.
Parameters:
Returns:
listSubscriptions
public PagedFlux
Ruft alle Abonnements für ein Thema ab.
Parameters:
Returns:
topicNamelistTopics
public PagedFlux
Ruft alle Themen im Service Bus-Namespace ab.
Returns:
updateQueue
public Mono
Updates eine Warteschlange mit dem angegebenen QueueProperties. Die QueueProperties muss vollständig aufgefüllt werden, da alle Eigenschaften ersetzt werden. Wenn eine Eigenschaft nicht festgelegt ist, wird der Standardwert des Diensts verwendet. Der vorgeschlagene Flow lautet:
- getQueue(String queueName)
- Aktualisieren der erforderliche Elemente.
- Übergeben Sie die aktualisierte Beschreibung an diese Methode.
Es gibt eine Teilmenge der Eigenschaften, die aktualisiert werden können. Weitere Informationen finden Sie unter den links unten. Sie lauten wie folgt:
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setLockDuration(Duration lockDuration)
- setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
- setMaxDeliveryCount(Integer maxDeliveryCount)
Parameters:
Returns:
updateQueueWithResponse
public Mono<>
Updates eine Warteschlange mit dem angegebenen QueueProperties. Die QueueProperties muss vollständig aufgefüllt werden, da alle Eigenschaften ersetzt werden. Wenn eine Eigenschaft nicht festgelegt ist, wird der Standardwert des Diensts verwendet. Der vorgeschlagene Flow lautet:
- getQueue(String queueName)
- Aktualisieren der erforderliche Elemente.
- Übergeben Sie die aktualisierte Beschreibung an diese Methode.
Es gibt eine Teilmenge der Eigenschaften, die aktualisiert werden können. Weitere Informationen finden Sie unter den links unten. Sie lauten wie folgt:
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setLockDuration(Duration lockDuration)
- setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
- setMaxDeliveryCount(Integer maxDeliveryCount)
Parameters:
Returns:
updateRule
public Mono
Updates eine Regel mit dem angegebenen RuleProperties. Muss RuleProperties vollständig aufgefüllt werden, wenn alle Eigenschaften ersetzt werden. Wenn eine Eigenschaft nicht festgelegt ist, wird der Standardwert des Diensts verwendet. Der vorgeschlagene Flow lautet:
- getRule(String topicName, String subscriptionName, String ruleName)
- Aktualisieren der erforderliche Elemente.
- Übergeben Sie die aktualisierte Beschreibung an diese Methode.
Parameters:
Returns:
updateRuleWithResponse
public Mono<>
Updates eine Regel mit dem angegebenen RuleProperties. Muss RuleProperties vollständig aufgefüllt werden, wenn alle Eigenschaften ersetzt werden. Wenn eine Eigenschaft nicht festgelegt ist, wird der Standardwert des Diensts verwendet. Der vorgeschlagene Flow lautet:
- getRule(String topicName, String subscriptionName, String ruleName)
- Aktualisieren der erforderliche Elemente.
- Übergeben Sie die aktualisierte Beschreibung an diese Methode.
Parameters:
Returns:
updateSubscription
public Mono
Updates ein Abonnement mit dem angegebenen SubscriptionProperties. Die SubscriptionProperties muss vollständig aufgefüllt werden, da alle Eigenschaften ersetzt werden. Wenn eine Eigenschaft nicht festgelegt ist, wird der Standardwert des Diensts verwendet. Der vorgeschlagene Flow lautet:
- getSubscription(String topicName, String subscriptionName)
- Aktualisieren der erforderliche Elemente.
- Übergeben Sie die aktualisierte Beschreibung an diese Methode.
Es gibt eine Teilmenge der Eigenschaften, die aktualisiert werden können. Weitere Informationen finden Sie unter den links unten. Sie lauten wie folgt:
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setLockDuration(Duration lockDuration)
- setMaxDeliveryCount(int maxDeliveryCount)
Parameters:
Returns:
updateSubscriptionWithResponse
public Mono<>
Updates ein Abonnement mit dem angegebenen SubscriptionProperties. Die SubscriptionProperties muss vollständig aufgefüllt werden, da alle Eigenschaften ersetzt werden. Wenn eine Eigenschaft nicht festgelegt ist, wird der Standardwert des Diensts verwendet. Der vorgeschlagene Flow lautet:
- getSubscription(String topicName, String subscriptionName)
- Aktualisieren der erforderliche Elemente.
- Übergeben Sie die aktualisierte Beschreibung an diese Methode.
Es gibt eine Teilmenge der Eigenschaften, die aktualisiert werden können. Weitere Informationen finden Sie unter den links unten. Sie lauten wie folgt:
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setLockDuration(Duration lockDuration)
- setMaxDeliveryCount(int maxDeliveryCount)
Parameters:
Returns:
updateTopic
public Mono
Updates ein Thema mit dem angegebenen TopicProperties. Die TopicProperties muss vollständig aufgefüllt werden, da alle Eigenschaften ersetzt werden. Wenn eine Eigenschaft nicht festgelegt ist, wird der Standardwert des Diensts verwendet. Der vorgeschlagene Flow lautet:
- getTopic(String topicName)
- Aktualisieren der erforderliche Elemente.
- Übergeben Sie die aktualisierte Beschreibung an diese Methode.
Es gibt eine Teilmenge der Eigenschaften, die aktualisiert werden können. Weitere Informationen finden Sie unter den links unten. Sie lauten wie folgt:
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
Parameters:
Returns:
updateTopicWithResponse
public Mono<>
Updates ein Thema mit dem angegebenen TopicProperties. Die TopicProperties muss vollständig aufgefüllt werden, da alle Eigenschaften ersetzt werden. Wenn eine Eigenschaft nicht festgelegt ist, wird der Standardwert des Diensts verwendet. Der vorgeschlagene Flow lautet:
- getTopic(String topicName)
- Aktualisieren der erforderliche Elemente.
- Übergeben Sie die aktualisierte Beschreibung an diese Methode.
Es gibt eine Teilmenge der Eigenschaften, die aktualisiert werden können. Weitere Informationen finden Sie unter den links unten. Sie lauten wie folgt:
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
Parameters:
Returns:
Gilt für:
Azure SDK for Java
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für