ServiceBusAdministrationClient Classe
- java.
lang. Object - com.
azure. messaging. servicebus. administration. ServiceBusAdministrationClient
- com.
public final class ServiceBusAdministrationClient
Client synchrone pour la gestion d’un espace de noms Service Bus. Instancié via ServiceBusAdministrationClientBuilder.
Exemple : Créer le client asynchrone
L’exemple de code suivant illustre la création du client d’administration asynchrone. Les informations d’identification utilisées dans l’exemple suivant sont pour l’authentification DefaultAzureCredential
. Il convient à la plupart des scénarios, y compris aux environnements de développement et de production locaux. En outre, nous vous recommandons d’utiliser l’identité managée pour l’authentification dans les environnements de production. Vous trouverez plus d’informations sur les différentes méthodes d’authentification et leurs types d’informations d’identification correspondants dans la documentation 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();
Exemple : Créer une file d’attente
L’exemple suivant crée une file d’attente avec des valeurs par défaut. Les valeurs par défaut sont répertoriées dans CreateQueueOptions().
QueueProperties queue = client.createQueue("my-new-queue");
System.out.printf("Queue created. Name: %s. Lock Duration: %s.%n",
queue.getName(), queue.getLockDuration());
Exemple : Modifier un abonnement existant
L’exemple de code suivant illustre la mise à jour d’un abonnement existant. Les utilisateurs doivent extraire les propriétés de l’abonnement, modifier les propriétés, puis passer l’objet à la méthode de mise à jour.
// 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());
Exemple : Répertorier toutes les files d’attente
L’exemple de code suivant répertorie toutes les files d’attente dans l’espace de noms Service Bus.
client.listQueues().forEach(queue -> {
System.out.printf("Queue [%s]. Lock Duration: %s.%n",
queue.getName(), queue.getLockDuration());
});
Exemple : Supprimer la file d’attente
L’exemple de code ci-dessous illustre la suppression d’une file d’attente existante.
try {
client.deleteQueue("my-existing-queue");
} catch (AzureException exception) {
System.err.println("Exception occurred deleting queue: " + exception);
}
Résumé de la méthode
Méthodes héritées de java.lang.Object
Détails de la méthode
createQueue
public QueueProperties createQueue(String queueName)
Crée une file d’attente avec le nom donné.
Parameters:
Returns:
createQueue
public QueueProperties createQueue(String queueName, CreateQueueOptions queueOptions)
Crée une file d’attente avec .CreateQueueOptions
Parameters:
Returns:
createQueueWithResponse
public Response
Crée une file d’attente et retourne la file d’attente créée en plus de la réponse HTTP.
Parameters:
Returns:
createRule
public RuleProperties createRule(String topicName, String subscriptionName, String ruleName)
Crée une règle sous la rubrique et l’abonnement donnés
Parameters:
Returns:
createRule
public RuleProperties createRule(String topicName, String ruleName, String subscriptionName, CreateRuleOptions ruleOptions)
Crée une règle avec .CreateRuleOptions
Parameters:
Returns:
createRuleWithResponse
public Response
Crée une règle et retourne la règle créée en plus de la réponse HTTP.
Parameters:
Returns:
createSubscription
public SubscriptionProperties createSubscription(String topicName, String subscriptionName)
Crée un abonnement avec les noms de rubrique et d’abonnement donnés.
Parameters:
Returns:
createSubscription
public SubscriptionProperties createSubscription(String topicName, String subscriptionName, CreateSubscriptionOptions subscriptionOptions)
Crée un abonnement avec .CreateSubscriptionOptions
Parameters:
Returns:
createSubscription
public SubscriptionProperties createSubscription(String topicName, String subscriptionName, String ruleName, CreateSubscriptionOptions subscriptionOptions, CreateRuleOptions ruleOptions)
Crée un abonnement avec la règle par défaut à l’aide de CreateSubscriptionOptions et CreateRuleOptions.
Parameters:
Returns:
createSubscriptionWithResponse
public Response
Crée un abonnement et retourne l’abonnement créé en plus de la réponse HTTP.
Parameters:
Returns:
createSubscriptionWithResponse
public Response
Crée un abonnement avec la règle par défaut configurée et retourne l’abonnement créé en plus de la réponse HTTP.
Parameters:
Returns:
createTopic
public TopicProperties createTopic(String topicName)
Crée une rubrique portant le nom donné.
Parameters:
Returns:
createTopic
public TopicProperties createTopic(String topicName, CreateTopicOptions topicOptions)
Crée une rubrique avec .CreateTopicOptions
Parameters:
Returns:
createTopicWithResponse
public Response
Crée une rubrique et retourne la rubrique créée en plus de la réponse HTTP.
Parameters:
Returns:
deleteQueue
public void deleteQueue(String queueName)
Supprime une file d’attente correspondant à queueName
.
Parameters:
deleteQueueWithResponse
public Response
Supprime une file d’attente correspondant queueName
et retourne la réponse HTTP.
Parameters:
Returns:
deleteRule
public void deleteRule(String topicName, String subscriptionName, String ruleName)
Supprime une règle correspondant ruleName
à .
Parameters:
deleteRuleWithResponse
public Response
Supprime une règle correspondant ruleName
et retourne la réponse HTTP.
Parameters:
Returns:
deleteSubscription
public void deleteSubscription(String topicName, String subscriptionName)
Supprime un abonnement correspondant à la subscriptionName
rubrique topicName
dans .
Parameters:
deleteSubscriptionWithResponse
public Response
Supprime un abonnement correspondant subscriptionName
et retourne la réponse HTTP.
Parameters:
Returns:
deleteTopic
public void deleteTopic(String topicName)
Supprime une rubrique correspondant à topicName
.
Parameters:
deleteTopicWithResponse
public Response
Supprime une rubrique correspondant topicName
et retourne la réponse HTTP.
Parameters:
Returns:
getNamespaceProperties
public NamespaceProperties getNamespaceProperties()
Obtient des informations sur l’espace de noms Service Bus.
Returns:
getNamespacePropertiesWithResponse
public Response
Obtient des informations sur l’espace de noms Service Bus ainsi que sa réponse HTTP.
Parameters:
Returns:
getQueue
public QueueProperties getQueue(String queueName)
Obtient des informations sur la file d’attente.
Parameters:
Returns:
getQueueExists
public boolean getQueueExists(String queueName)
Obtient si une file d’attente avec queueName
existe dans l’espace de noms Service Bus.
Parameters:
Returns:
true
si la file d’attente existe ; sinon false
.getQueueExistsWithResponse
public Response
Obtient si une file d’attente avec queueName
existe dans l’espace de noms Service Bus.
Parameters:
Returns:
true
si la file d’attente existe ; sinon false
.getQueueRuntimeProperties
public QueueRuntimeProperties getQueueRuntimeProperties(String queueName)
Obtient les propriétés du runtime sur la file d’attente.
Parameters:
Returns:
getQueueRuntimePropertiesWithResponse
public Response
Obtient les propriétés d’exécution de la file d’attente ainsi que sa réponse HTTP.
Parameters:
Returns:
getQueueWithResponse
public Response
Obtient des informations sur la file d’attente ainsi que sa réponse HTTP.
Parameters:
Returns:
getRule
public RuleProperties getRule(String topicName, String subscriptionName, String ruleName)
Obtient une règle de l’espace de noms de service. Seuls les types de données suivants sont désérialisés dans les paramètres Filtres et Action : string, int, long, boolean, double et OffsetDateTime. D’autres types de données retournent sa valeur de chaîne.
Parameters:
Returns:
getRuleWithResponse
public Response
Obtient une règle de l’espace de noms de service. Seuls les types de données suivants sont désérialisés dans les paramètres Filtres et Action : string, int, long, bool, double et OffsetDateTime. D’autres types de données retournent sa valeur de chaîne.
Parameters:
Returns:
getSubscription
public SubscriptionProperties getSubscription(String topicName, String subscriptionName)
Obtient des informations sur la file d’attente.
Parameters:
Returns:
getSubscriptionExists
public boolean getSubscriptionExists(String topicName, String subscriptionName)
Obtient l’existence d’un abonnement dans une rubrique.
Parameters:
Returns:
true
si l’abonnement existe.getSubscriptionExistsWithResponse
public Response
Obtient l’existence d’un abonnement dans une rubrique.
Parameters:
Returns:
true
si l’abonnement existe ; sinon false
.getSubscriptionRuntimeProperties
public SubscriptionRuntimeProperties getSubscriptionRuntimeProperties(String topicName, String subscriptionName)
Obtient les propriétés d’exécution de l’abonnement.
Parameters:
Returns:
getSubscriptionRuntimePropertiesWithResponse
public Response
Obtient les propriétés d’exécution de l’abonnement.
Parameters:
Returns:
getSubscriptionWithResponse
public Response
Obtient des informations sur l’abonnement ainsi que sa réponse HTTP.
Parameters:
Returns:
getTopic
public TopicProperties getTopic(String topicName)
Obtient des informations sur le sujet.
Parameters:
Returns:
getTopicExists
public boolean getTopicExists(String topicName)
Obtient si une rubrique avec topicName
existe dans l’espace de noms Service Bus.
Parameters:
Returns:
true
si la rubrique existe.getTopicExistsWithResponse
public Response
Obtient si une rubrique avec topicName
existe dans l’espace de noms Service Bus.
Parameters:
Returns:
true
si la rubrique existe ; sinon false
.getTopicRuntimeProperties
public TopicRuntimeProperties getTopicRuntimeProperties(String topicName)
Obtient les propriétés d’exécution de la rubrique.
Parameters:
Returns:
getTopicRuntimePropertiesWithResponse
public Response
Obtient les propriétés d’exécution de la rubrique avec sa réponse HTTP.
Parameters:
Returns:
getTopicWithResponse
public Response
Obtient des informations sur le sujet ainsi que sa réponse HTTP.
Parameters:
Returns:
listQueues
public PagedIterable
Récupère toutes les files d’attente dans l’espace de noms Service Bus.
Returns:
listQueues
public PagedIterable
Récupère toutes les files d’attente dans l’espace de noms Service Bus.
Parameters:
Returns:
listRules
public PagedIterable
Récupère toutes les règles d’une rubrique et d’un abonnement.
Parameters:
Returns:
listRules
public PagedIterable
Récupère toutes les règles d’une rubrique et d’un abonnement.
Parameters:
Returns:
listSubscriptions
public PagedIterable
Récupère tous les abonnements d’une rubrique.
Parameters:
Returns:
topicName
listSubscriptions
public PagedIterable
Récupère tous les abonnements d’une rubrique.
Parameters:
Returns:
topicName
listTopics
public PagedIterable
Récupère toutes les rubriques de l’espace de noms Service Bus.
Returns:
listTopics
public PagedIterable
Récupère toutes les rubriques de l’espace de noms Service Bus.
Parameters:
Returns:
updateQueue
public QueueProperties updateQueue(QueueProperties queue)
Mises à jour une file d’attente avec le donnéQueueProperties. Le QueueProperties doit être entièrement rempli, car toutes les propriétés sont remplacées. Si aucune propriété n’est définie, la valeur par défaut du service est utilisée. Le flux suggéré est le suivant :
- getQueue(String queueName)
- Mettre à jour les éléments requis.
- Transmettez la description mise à jour dans cette méthode.
Il existe un sous-ensemble de propriétés qui peuvent être mises à jour. Vous trouverez plus d’informations dans les liens ci-dessous. Il s'agit des éléments suivants :
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setLockDuration(Duration lockDuration)
- setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
- setMaxDeliveryCount(Integer maxDeliveryCount)
Parameters:
Returns:
updateQueueWithResponse
public Response
Mises à jour une file d’attente avec le donnéQueueProperties. Le QueueProperties doit être entièrement rempli, car toutes les propriétés sont remplacées. Si aucune propriété n’est définie, la valeur par défaut du service est utilisée. Le flux suggéré est le suivant :
- getQueue(String queueName)
- Mettre à jour les éléments requis.
- Transmettez la description mise à jour dans cette méthode.
Il existe un sous-ensemble de propriétés qui peuvent être mises à jour. Vous trouverez plus d’informations dans les liens ci-dessous. Il s'agit des éléments suivants :
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setLockDuration(Duration lockDuration)
- setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
- setMaxDeliveryCount(Integer maxDeliveryCount)
Parameters:
Returns:
updateRule
public RuleProperties updateRule(String topicName, String subscriptionName, RuleProperties rule)
Mises à jour une règle avec le donnéRuleProperties. Le RuleProperties doit être entièrement rempli, car toutes les propriétés sont remplacées. Si aucune propriété n’est définie, la valeur par défaut du service est utilisée. Le flux suggéré est le suivant :
- getRule(String topicName, String subscriptionName, String ruleName)
- Mettre à jour les éléments requis.
- Transmettez la description mise à jour dans cette méthode.
Parameters:
Returns:
updateRuleWithResponse
public Response
Mises à jour une règle avec le donnéRuleProperties. Le RuleProperties doit être entièrement rempli, car toutes les propriétés sont remplacées. Si aucune propriété n’est définie, la valeur par défaut du service est utilisée. Le flux suggéré est le suivant :
- getRule(String topicName, String subscriptionName, String ruleName)
- Mettre à jour les éléments requis.
- Transmettez la description mise à jour dans cette méthode.
Parameters:
Returns:
updateSubscription
public SubscriptionProperties updateSubscription(SubscriptionProperties subscription)
Mises à jour un abonnement avec le donnéSubscriptionProperties. Le SubscriptionProperties doit être entièrement rempli, car toutes les propriétés sont remplacées. Si aucune propriété n’est définie, la valeur par défaut du service est utilisée. Le flux suggéré est le suivant :
- getSubscription(String topicName, String subscriptionName)
- Mettre à jour les éléments requis.
- Transmettez la description mise à jour dans cette méthode.
Il existe un sous-ensemble de propriétés qui peuvent être mises à jour. Vous trouverez plus d’informations dans les liens ci-dessous. Il s'agit des éléments suivants :
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setLockDuration(Duration lockDuration)
- setMaxDeliveryCount(int maxDeliveryCount)
Parameters:
Returns:
updateSubscriptionWithResponse
public Response
Mises à jour un abonnement avec le donnéSubscriptionProperties. Le SubscriptionProperties doit être entièrement rempli, car toutes les propriétés sont remplacées. Si aucune propriété n’est définie, la valeur par défaut du service est utilisée. Le flux suggéré est le suivant :
- getSubscription(String topicName, String subscriptionName)
- Mettre à jour les éléments requis.
- Transmettez la description mise à jour dans cette méthode.
Il existe un sous-ensemble de propriétés qui peuvent être mises à jour. Vous trouverez plus d’informations dans les liens ci-dessous. Il s'agit des éléments suivants :
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setLockDuration(Duration lockDuration)
- setMaxDeliveryCount(int maxDeliveryCount)
Parameters:
Returns:
updateTopic
public TopicProperties updateTopic(TopicProperties topic)
Mises à jour une rubrique avec le donnéTopicProperties. Le TopicProperties doit être entièrement rempli, car toutes les propriétés sont remplacées. Si aucune propriété n’est définie, la valeur par défaut du service est utilisée. Le flux suggéré est le suivant :
- getTopic(String topicName)
- Mettre à jour les éléments requis.
- Transmettez la description mise à jour dans cette méthode.
Il existe un sous-ensemble de propriétés qui peuvent être mises à jour. Vous trouverez plus d’informations dans les liens ci-dessous. Il s'agit des éléments suivants :
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
Parameters:
Returns:
updateTopicWithResponse
public Response
Mises à jour une rubrique avec le donnéTopicProperties. Le TopicProperties doit être entièrement rempli, car toutes les propriétés sont remplacées. Si aucune propriété n’est définie, la valeur par défaut du service est utilisée. Le flux suggéré est le suivant :
- getTopic(String topicName)
- Mettre à jour les éléments requis.
- Transmettez la description mise à jour dans cette méthode.
Il existe un sous-ensemble de propriétés qui peuvent être mises à jour. Vous trouverez plus d’informations dans les liens ci-dessous. Il s'agit des éléments suivants :
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
Parameters:
Returns:
S’applique à
Azure SDK for Java