ServiceBusAdministrationClient Klasse
- java.
lang. Object - com.
azure. messaging. servicebus. administration. ServiceBusAdministrationClient
- com.
public final class ServiceBusAdministrationClient
Ein synchroner 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.
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();
Beispiel: Erstellen einer Warteschlange
Im folgenden Beispiel wird eine Warteschlange mit Standardwerten erstellt. Standardwerte werden in CreateQueueOptions()aufgeführt.
QueueProperties queue = client.createQueue("my-new-queue");
System.out.printf("Queue created. Name: %s. Lock Duration: %s.%n",
queue.getName(), queue.getLockDuration());
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.
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());
Beispiel: Auflisten aller Warteschlangen
Im folgenden Codebeispiel werden alle Warteschlangen im Service Bus-Namespace aufgelistet.
client.listQueues().forEach(queue -> {
System.out.printf("Queue [%s]. Lock Duration: %s.%n",
queue.getName(), queue.getLockDuration());
});
Beispiel: Warteschlange löschen
Im folgenden Codebeispiel wird das Löschen einer vorhandenen Warteschlange veranschaulicht.
try {
client.deleteQueue("my-existing-queue");
} catch (AzureException exception) {
System.err.println("Exception occurred deleting queue: " + exception);
}
Methodenzusammenfassung
Geerbte Methoden von java.lang.Object
Details zur Methode
createQueue
public QueueProperties createQueue(String queueName)
Erstellt eine Warteschlange mit dem angegebenen Namen.
Parameters:
Returns:
createQueue
public QueueProperties createQueue(String queueName, CreateQueueOptions queueOptions)
Erstellt eine Warteschlange mit .CreateQueueOptions
Parameters:
Returns:
createQueueWithResponse
public Response
Erstellt eine Warteschlange und gibt die erstellte Warteschlange zusätzlich zur HTTP-Antwort zurück.
Parameters:
Returns:
createRule
public RuleProperties createRule(String topicName, String subscriptionName, String ruleName)
Erstellt eine Regel unter dem angegebenen Thema und Abonnement.
Parameters:
Returns:
createRule
public RuleProperties createRule(String topicName, String ruleName, String subscriptionName, CreateRuleOptions ruleOptions)
Erstellt eine Regel mit .CreateRuleOptions
Parameters:
Returns:
createRuleWithResponse
public Response
Erstellt eine Regel und gibt die erstellte Regel zusätzlich zur HTTP-Antwort zurück.
Parameters:
Returns:
createSubscription
public SubscriptionProperties createSubscription(String topicName, String subscriptionName)
Erstellt ein Abonnement mit dem angegebenen Thema und den angegebenen Abonnementnamen.
Parameters:
Returns:
createSubscription
public SubscriptionProperties createSubscription(String topicName, String subscriptionName, CreateSubscriptionOptions subscriptionOptions)
Erstellt ein Abonnement mit .CreateSubscriptionOptions
Parameters:
Returns:
createSubscription
public SubscriptionProperties createSubscription(String topicName, String subscriptionName, String ruleName, CreateSubscriptionOptions subscriptionOptions, CreateRuleOptions ruleOptions)
Erstellt ein Abonnement mit der CreateSubscriptionOptions Standardregel und CreateRuleOptions.
Parameters:
Returns:
createSubscriptionWithResponse
public Response
Erstellt ein Abonnement und gibt das erstellte Abonnement zusätzlich zur HTTP-Antwort zurück.
Parameters:
Returns:
createSubscriptionWithResponse
public Response
Erstellt ein Abonnement mit konfigurierter Standardregel und gibt zusätzlich zur HTTP-Antwort das erstellte Abonnement zurück.
Parameters:
Returns:
createTopic
public TopicProperties createTopic(String topicName)
Erstellt ein Thema mit dem angegebenen Namen.
Parameters:
Returns:
createTopic
public TopicProperties createTopic(String topicName, CreateTopicOptions topicOptions)
Erstellt ein Thema mit CreateTopicOptions.
Parameters:
Returns:
createTopicWithResponse
public Response
Erstellt ein Thema und gibt zusätzlich zur HTTP-Antwort das erstellte Thema zurück.
Parameters:
Returns:
deleteQueue
public void deleteQueue(String queueName)
Löscht eine Warteschlange mit dem übereinstimmenden queueName
.
Parameters:
deleteQueueWithResponse
public Response
Löscht die übereinstimmende queueName
Warteschlange und gibt die HTTP-Antwort zurück.
Parameters:
Returns:
deleteRule
public void deleteRule(String topicName, String subscriptionName, String ruleName)
Löscht eine Regel mit dem übereinstimmenden ruleName
.
Parameters:
deleteRuleWithResponse
public Response
Löscht die übereinstimmende ruleName
Regel und gibt die HTTP-Antwort zurück.
Parameters:
Returns:
deleteSubscription
public void deleteSubscription(String topicName, String subscriptionName)
Löscht ein Abonnement, das dem subscriptionName
im Thema topicName
entspricht.
Parameters:
deleteSubscriptionWithResponse
public Response
Löscht das übereinstimmende subscriptionName
Abonnement und gibt die HTTP-Antwort zurück.
Parameters:
Returns:
deleteTopic
public void deleteTopic(String topicName)
Löscht ein Thema mit dem entsprechenden topicName
.
Parameters:
deleteTopicWithResponse
public Response
Löscht das übereinstimmende topicName
Thema und gibt die HTTP-Antwort zurück.
Parameters:
Returns:
getNamespaceProperties
public NamespaceProperties getNamespaceProperties()
Ruft Informationen zum Service Bus-Namespace ab.
Returns:
getNamespacePropertiesWithResponse
public Response
Ruft Informationen zum Service Bus-Namespace zusammen mit der HTTP-Antwort ab.
Parameters:
Returns:
getQueue
public QueueProperties getQueue(String queueName)
Ruft Informationen zur Warteschlange ab.
Parameters:
Returns:
getQueueExists
public boolean getQueueExists(String queueName)
Ruft ab, ob eine Warteschlange mit queueName
im Service Bus-Namespace vorhanden ist.
Parameters:
Returns:
true
, wenn die Warteschlange vorhanden ist; andernfalls false
.getQueueExistsWithResponse
public Response
Ruft ab, ob eine Warteschlange mit queueName
im Service Bus-Namespace vorhanden ist.
Parameters:
Returns:
true
, wenn die Warteschlange vorhanden ist, andernfalls false
.getQueueRuntimeProperties
public QueueRuntimeProperties getQueueRuntimeProperties(String queueName)
Ruft Laufzeiteigenschaften für die Warteschlange ab.
Parameters:
Returns:
getQueueRuntimePropertiesWithResponse
public Response
Ruft Laufzeiteigenschaften für die Warteschlange zusammen mit ihrer HTTP-Antwort ab.
Parameters:
Returns:
getQueueWithResponse
public Response
Ruft Informationen zur Warteschlange zusammen mit ihrer HTTP-Antwort ab.
Parameters:
Returns:
getRule
public RuleProperties getRule(String topicName, String subscriptionName, String ruleName)
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 Response
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 SubscriptionProperties getSubscription(String topicName, String subscriptionName)
Ruft Informationen zur Warteschlange ab.
Parameters:
Returns:
getSubscriptionExists
public boolean getSubscriptionExists(String topicName, String subscriptionName)
Ruft ab, ob ein Abonnement innerhalb eines Themas vorhanden ist.
Parameters:
Returns:
true
, wenn das Abonnement vorhanden ist.getSubscriptionExistsWithResponse
public Response
Ruft ab, ob ein Abonnement innerhalb eines Themas vorhanden ist.
Parameters:
Returns:
true
, wenn das Abonnement vorhanden ist, andernfalls false
.getSubscriptionRuntimeProperties
public SubscriptionRuntimeProperties getSubscriptionRuntimeProperties(String topicName, String subscriptionName)
Ruft Laufzeiteigenschaften zum Abonnement ab.
Parameters:
Returns:
getSubscriptionRuntimePropertiesWithResponse
public Response
Ruft Laufzeiteigenschaften zum Abonnement ab.
Parameters:
Returns:
getSubscriptionWithResponse
public Response
Ruft Informationen zum Abonnement zusammen mit seiner HTTP-Antwort ab.
Parameters:
Returns:
getTopic
public TopicProperties getTopic(String topicName)
Ruft Informationen zum Thema ab.
Parameters:
Returns:
getTopicExists
public boolean getTopicExists(String topicName)
Ruft ab, ob ein Thema mit topicName
im Service Bus-Namespace vorhanden ist.
Parameters:
Returns:
true
, wenn das Thema vorhanden ist.getTopicExistsWithResponse
public Response
Ruft ab, ob ein Thema mit topicName
im Service Bus-Namespace vorhanden ist.
Parameters:
Returns:
true
, wenn das Thema vorhanden ist, andernfalls false
.getTopicRuntimeProperties
public TopicRuntimeProperties getTopicRuntimeProperties(String topicName)
Ruft Laufzeiteigenschaften zum Thema ab.
Parameters:
Returns:
getTopicRuntimePropertiesWithResponse
public Response
Ruft Laufzeiteigenschaften zum Thema mit der HTTP-Antwort ab.
Parameters:
Returns:
getTopicWithResponse
public Response
Ruft Informationen zum Thema zusammen mit der HTTP-Antwort ab.
Parameters:
Returns:
listQueues
public PagedIterable
Ruft alle Warteschlangen im Service Bus-Namespace ab.
Returns:
listQueues
public PagedIterable
Ruft alle Warteschlangen im Service Bus-Namespace ab.
Parameters:
Returns:
listRules
public PagedIterable
Ruft alle Regeln für ein Thema und ein Abonnement ab.
Parameters:
Returns:
listRules
public PagedIterable
Ruft alle Regeln für ein Thema und ein Abonnement ab.
Parameters:
Returns:
listSubscriptions
public PagedIterable
Ruft alle Abonnements für ein Thema ab.
Parameters:
Returns:
topicName
listSubscriptions
public PagedIterable
Ruft alle Abonnements für ein Thema ab.
Parameters:
Returns:
topicName
listTopics
public PagedIterable
Ruft alle Themen im Service Bus-Namespace ab.
Returns:
listTopics
public PagedIterable
Ruft alle Themen im Service Bus-Namespace ab.
Parameters:
Returns:
updateQueue
public QueueProperties updateQueue(QueueProperties queue)
Updates eine Warteschlange mit dem angegebenen QueueProperties. Muss QueueProperties 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:
- 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 Response
Updates eine Warteschlange mit dem angegebenen QueueProperties. Muss QueueProperties 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:
- 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 RuleProperties updateRule(String topicName, String subscriptionName, RuleProperties rule)
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 Response
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 SubscriptionProperties updateSubscription(SubscriptionProperties subscription)
Updates ein Abonnement mit dem angegebenen SubscriptionProperties. Muss SubscriptionProperties 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:
- 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 Response
Updates ein Abonnement mit dem angegebenen SubscriptionProperties. Muss SubscriptionProperties 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:
- 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 TopicProperties updateTopic(TopicProperties topic)
Updates ein Thema mit dem angegebenen TopicProperties. Muss TopicProperties 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:
- 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 Response
Updates ein Thema mit dem angegebenen TopicProperties. Muss TopicProperties 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:
- 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