ManagementClient Classe
- java.
lang. Object - com.
microsoft. azure. servicebus. management. ManagementClient
- com.
public class ManagementClient
Client synchrone pour effectuer des opérations de gestion sur les entités Service Bus. Utilisez pour les ManagementClientAsync opérations asynchrones.
Récapitulatif du constructeur
Constructeur | Description | |
---|---|---|
ManagementClient(ConnectionStringBuilder connectionStringBuilder) | ||
ManagementClient(URI namespaceEndpointURI, ClientSettings clientSettings) |
Résumé de la méthode
Modificateur et type | Méthode et description |
---|---|
void |
close()
Supprime et ferme le client de gestion |
Queue |
createQueue(QueueDescription queueDescription)
Crée une file d’attente dans l’espace de noms de service avec le nom donné. |
Queue |
createQueue(String queuePath)
Crée une file d’attente dans l’espace de noms de service avec le nom donné. |
Rule |
createRule(String topicName, String subscriptionName, RuleDescription ruleDescription)
Crée une règle pour une rubrique donnée - abonnement. |
Subscription |
createSubscription(SubscriptionDescription subscriptionDescription)
Crée un abonnement dans l’espace de noms de service avec le nom donné. |
Subscription |
createSubscription(SubscriptionDescription subscriptionDescription, RuleDescription defaultRule)
Crée un abonnement dans l’espace de noms de service avec la règle par défaut fournie. |
Subscription |
createSubscription(String topicPath, String subscriptionName)
Crée un abonnement pour une rubrique donnée dans l’espace de noms de service avec le nom donné. |
Topic |
createTopic(TopicDescription topicDescription)
Crée une rubrique dans l’espace de noms de service avec le nom donné. |
Topic |
createTopic(String topicPath)
Crée une rubrique dans l’espace de noms de service avec le nom donné. |
Void |
deleteQueue(String path)
Supprime la file d’attente décrite par le chemin d’accès relatif à l’adresse de base de l’espace de noms de service. |
Void |
deleteRule(String topicPath, String subscriptionName, String ruleName)
Supprime la règle pour un abonnement à une rubrique donnée. |
Void |
deleteSubscription(String topicPath, String subscriptionName)
Supprime l’abonnement décrit par la rubrique |
Void |
deleteTopic(String path)
Supprime la rubrique décrite par le chemin d’accès relatif à l’adresse de base de l’espace de noms de service. |
Namespace |
getNamespaceInfo()
Récupère les informations relatives à l’espace de noms. |
Queue |
getQueue(String path)
Récupère une file d’attente à partir de l’espace de noms de service |
Queue |
getQueueRuntimeInfo(String path)
Récupère les informations d’exécution d’une file d’attente. |
List<Queue |
getQueues()
Récupère la liste des files d’attente présentes dans l’espace de noms. |
List<Queue |
getQueues(int count, int skip)
Récupère la liste des files d’attente présentes dans l’espace de noms. |
Rule |
getRule(String topicPath, String subscriptionName, String ruleName)
Récupère une règle pour une rubrique et un abonnement donnés à partir de l’espace de noms de service |
List<Rule |
getRules(String topicName, String subscriptionName)
Récupère la liste des règles pour un abonnement à une rubrique donnée dans l’espace de noms. |
List<Rule |
getRules(String topicName, String subscriptionName, int count, int skip)
Récupère la liste des règles pour un abonnement à une rubrique donnée dans l’espace de noms. |
Subscription |
getSubscription(String topicPath, String subscriptionName)
Récupère un abonnement pour une rubrique donnée à partir de l’espace de noms de service |
Subscription |
getSubscriptionRuntimeInfo(String topicPath, String subscriptionName)
Récupère les informations d’exécution d’un abonnement dans une rubrique donnée |
List<Subscription |
getSubscriptions(String topicName)
Récupère la liste des abonnements pour une rubrique donnée dans l’espace de noms. |
List<Subscription |
getSubscriptions(String topicName, int count, int skip)
Récupère la liste des abonnements pour une rubrique donnée dans l’espace de noms. |
Topic |
getTopic(String path)
Récupère une rubrique de l’espace de noms de service |
Topic |
getTopicRuntimeInfo(String path)
Récupère les informations d’exécution d’une rubrique |
List<Topic |
getTopics()
Récupère la liste des rubriques présentes dans l’espace de noms. |
List<Topic |
getTopics(int count, int skip)
Récupère la liste des rubriques présentes dans l’espace de noms. |
Boolean |
queueExists(String path)
Vérifie si une file d’attente donnée existe ou non. |
Boolean |
ruleExists(String topicPath, String subscriptionName, String ruleName)
Vérifie si une règle donnée existe ou non pour un abonnement donné. |
Boolean |
subscriptionExists(String topicPath, String subscriptionName)
Vérifie si un abonnement donné existe ou non. |
Boolean |
topicExists(String path)
Vérifie si une rubrique donnée existe ou non. |
Queue |
updateQueue(QueueDescription queueDescription)
Mises à jour une file d’attente existante. |
Rule |
updateRule(String topicName, String subscriptionName, RuleDescription ruleDescription)
Mises à jour une règle existante. |
Subscription |
updateSubscription(SubscriptionDescription subscriptionDescription)
Mises à jour un abonnement existant. |
Topic |
updateTopic(TopicDescription topicDescription)
Mises à jour une rubrique existante. |
Méthodes héritées de java.lang.Object
Détails du constructeur
ManagementClient
public ManagementClient(ConnectionStringBuilder connectionStringBuilder)
Paramètres:
ManagementClient
public ManagementClient(URI namespaceEndpointURI, ClientSettings clientSettings)
Paramètres:
Détails de la méthode
close
public void close()
Supprime et ferme managementClient.
Exception:
createQueue
public QueueDescription createQueue(QueueDescription queueDescription)
Crée une file d’attente dans l’espace de noms de service avec le nom donné. Consultez pour connaître QueueDescription les valeurs par défaut des propriétés de file d’attente.
Paramètres:
- Objet QueueDescription décrivant les attributs avec lesquels la nouvelle file d’attente sera créée.
Retours:
Exception:
- Une entité portant le même nom existe sous le même espace de noms de service.
- Une entité portant le même nom existe sous le même espace de noms de service.
createQueue
public QueueDescription createQueue(String queuePath)
Crée une file d’attente dans l’espace de noms de service avec le nom donné. Consultez pour connaître QueueDescription les valeurs par défaut des propriétés de file d’attente.
Paramètres:
- Nom de la file d’attente par rapport à l’adresse de base de l’espace de noms de service.
Retours:
Exception:
- Le nom de l’entité est null, vide, trop long ou utilise des caractères non conformes.
- Le nom de l’entité est null, vide, trop long ou utilise des caractères non conformes.
createRule
public RuleDescription createRule(String topicName, String subscriptionName, RuleDescription ruleDescription)
Crée une règle pour une rubrique donnée - abonnement. Consultez pour connaître RuleDescription les valeurs par défaut des propriétés d’abonnement.
Paramètres:
- Nom de la rubrique.
- Nom de l'abonnement.
- Objet RuleDescription décrivant les attributs avec lesquels la nouvelle règle sera créée.
Retours:
Exception:
- Une entité portant le même nom existe sous le même espace de noms de service.
- Une entité portant le même nom existe sous le même espace de noms de service.
createSubscription
public SubscriptionDescription createSubscription(SubscriptionDescription subscriptionDescription)
Crée un abonnement dans l’espace de noms de service avec le nom donné. Consultez SubscriptionDescription les valeurs par défaut des propriétés de l’abonnement.
Paramètres:
- Objet SubscriptionDescription décrivant les attributs avec lesquels le nouvel abonnement sera créé.
Retours:
Exception:
- Une entité portant le même nom existe sous le même espace de noms de service.
- Une entité portant le même nom existe sous le même espace de noms de service.
createSubscription
public SubscriptionDescription createSubscription(SubscriptionDescription subscriptionDescription, RuleDescription defaultRule)
Crée un abonnement dans l’espace de noms de service avec la règle par défaut fournie. Consultez SubscriptionDescription les valeurs par défaut des propriétés de l’abonnement.
Paramètres:
- Objet SubscriptionDescription décrivant les attributs avec lesquels le nouvel abonnement sera créé.
- Objet RuleDescription décrivant la règle par défaut. Si la valeur est null, le filtre direct est créé.
Retours:
Exception:
- Une entité portant le même nom existe sous le même espace de noms de service.
- Une entité portant le même nom existe sous le même espace de noms de service.
createSubscription
public SubscriptionDescription createSubscription(String topicPath, String subscriptionName)
Crée un abonnement pour une rubrique donnée dans l’espace de noms de service avec le nom donné. Consultez SubscriptionDescription les valeurs par défaut des propriétés de l’abonnement.
Paramètres:
- Nom de la rubrique relative à l’adresse de base de l’espace de noms de service.
- Nom de l'abonnement.
Retours:
Exception:
- Le nom d’entité est null, vide, trop long ou utilise des caractères non autorisés.
- Le nom d’entité est null, vide, trop long ou utilise des caractères non autorisés.
createTopic
public TopicDescription createTopic(TopicDescription topicDescription)
Crée une rubrique dans l’espace de noms de service avec le nom donné. Consultez TopicDescription les valeurs par défaut des propriétés de rubrique.
Paramètres:
- Objet QueueDescription décrivant les attributs avec lesquels la nouvelle rubrique sera créée.
Retours:
Exception:
- Une entité portant le même nom existe sous le même espace de noms de service.
- Une entité portant le même nom existe sous le même espace de noms de service.
createTopic
public TopicDescription createTopic(String topicPath)
Crée une rubrique dans l’espace de noms de service avec le nom donné. Consultez TopicDescription les valeurs par défaut des propriétés de rubrique.
Paramètres:
- Nom de la rubrique relative à l’adresse de base de l’espace de noms de service.
Retours:
Exception:
- Le nom d’entité est null, vide, trop long ou utilise des caractères non autorisés.
- Le nom d’entité est null, vide, trop long ou utilise des caractères non autorisés.
deleteQueue
public Void deleteQueue(String path)
Supprime la file d’attente décrite par le chemin d’accès relatif à l’adresse de base de l’espace de noms de service.
Paramètres:
- Nom de l’entité relative à l’adresse de base de l’espace de noms de service.
Exception:
- path n’est pas null / empty / trop long / non valide.
- path n’est pas null / empty / trop long / non valide.
deleteRule
public Void deleteRule(String topicPath, String subscriptionName, String ruleName)
Supprime la règle pour un abonnement à une rubrique donnée.
Paramètres:
- Nom de la rubrique.
- Nom de l'abonnement.
- nom de la règle.
Exception:
- path n’est pas null / empty / trop long / non valide.
- path n’est pas null / empty / trop long / non valide.
deleteSubscription
public Void deleteSubscription(String topicPath, String subscriptionName)
Supprime l’abonnement décrit par topicPath et subscriptionName.
Paramètres:
- Nom de la rubrique.
- Nom de l'abonnement.
Exception:
- path n’est pas null / empty / trop long / non valide.
- path n’est pas null / empty / trop long / non valide.
deleteTopic
public Void deleteTopic(String path)
Supprime la rubrique décrite par le chemin d’accès relatif à l’adresse de base de l’espace de noms de service.
Paramètres:
- Nom de l’entité relative à l’adresse de base de l’espace de noms de service.
Exception:
- path n’est pas null / empty / trop long / non valide.
- path n’est pas null / empty / trop long / non valide.
getNamespaceInfo
public NamespaceInfo getNamespaceInfo()
Récupère les informations relatives à l’espace de noms. Fonctionne avec n’importe quelle revendication (Envoyer/Écouter/Gérer).
Retours:
- NamespaceInfo contenant des informations d’espace de noms.
Exception:
- Une erreur interne ou une exception inattendue s’est produite.
- Une erreur interne ou une exception inattendue s’est produite.
getQueue
public QueueDescription getQueue(String path)
Récupère une file d’attente à partir de l’espace de noms de service
Paramètres:
- Chemin de la file d’attente par rapport à l’espace de noms Service Bus.
Retours:
- QueueDescription contenant des informations sur la file d’attente.
Exception:
- Levée si le chemin d’accès est null, vide ou n’est pas au format ou à la longueur correct.
- Levée si le chemin d’accès est null, vide ou n’est pas au format ou à la longueur correct.
getQueueRuntimeInfo
public QueueRuntimeInfo getQueueRuntimeInfo(String path)
Récupère les informations d’exécution d’une file d’attente.
Paramètres:
- Chemin de la file d’attente par rapport à l’espace de noms Service Bus.
Retours:
- QueueRuntimeInfo contenant des informations d’exécution sur la file d’attente.
Exception:
- Levée si le chemin d’accès est null, vide ou n’est pas au format ou à la longueur correct.
- Levée si le chemin d’accès est null, vide ou n’est pas au format ou à la longueur correct.
getQueues
public List
Récupère la liste des files d’attente présentes dans l’espace de noms.
Retours:
Exception:
- L’opération expire. La période de délai d’expiration est lancée via ClientSettings.operationTimeout
- L’opération expire. La période de délai d’expiration est lancée via ClientSettings.operationTimeout
getQueues
public List
Récupère la liste des files d’attente présentes dans l’espace de noms. Vous pouvez simuler des pages de liste d’entités en manipulant le nombre et les paramètres d’ignorer. skip(0)+count(100) donne les 100 premières entités. skip(100)+count(100) donne les 100 entités suivantes.
Paramètres:
- Nombre de files d’attente à récupérer. La valeur par défaut est 100. La valeur maximale autorisée est 100.
- Nombre de files d’attente à ignorer. La valeur par défaut est 0. Impossible d’être négatif.
Retours:
Exception:
- L’opération expire. La période de délai d’expiration est lancée via ClientSettings.operationTimeout
- L’opération expire. La période de délai d’expiration est lancée via ClientSettings.operationTimeout
getRule
public RuleDescription getRule(String topicPath, String subscriptionName, String ruleName)
Récupère une règle pour une rubrique et un abonnement donnés à partir de l’espace de noms de service
Paramètres:
- Chemin d’accès de la rubrique relative à l’espace de noms Service Bus.
- Nom de l'abonnement.
- nom de la règle.
Retours:
- RuleDescription contenant des informations sur l’abonnement.
Exception:
- Levée si le chemin est null, vide ou non au format ou à la longueur appropriée.
- Levée si le chemin est null, vide ou non au format ou à la longueur appropriée.
getRules
public List
Récupère la liste des règles pour un abonnement à une rubrique donnée dans l’espace de noms.
Paramètres:
- Nom de la rubrique.
- Nom de l'abonnement.
Retours:
Exception:
- L’opération expire. Le délai d’expiration est lancé via ClientSettings.operationTimeout
- L’opération expire. Le délai d’expiration est lancé via ClientSettings.operationTimeout
getRules
public List
Récupère la liste des règles pour un abonnement à une rubrique donnée dans l’espace de noms. Vous pouvez simuler des pages de liste d’entités en manipulant les paramètres count et skip. skip(0)+count(100) donne les 100 premières entités. skip(100)+count(100) donne les 100 entités suivantes.
Paramètres:
- Nom de la rubrique.
- Nom de l'abonnement.
- Nombre de règles à récupérer. La valeur par défaut est 100. La valeur maximale autorisée est 100.
- Le nombre de règles à ignorer. La valeur par défaut est 0. Ne peut pas être négatif.
Retours:
Exception:
- L’opération expire. Le délai d’expiration est lancé via ClientSettings.operationTimeout
- L’opération expire. Le délai d’expiration est lancé via ClientSettings.operationTimeout
getSubscription
public SubscriptionDescription getSubscription(String topicPath, String subscriptionName)
Récupère un abonnement pour une rubrique donnée à partir de l’espace de noms de service
Paramètres:
- Chemin d’accès de la rubrique relative à l’espace de noms Service Bus.
- Nom de l’abonnement
Retours:
- SubscriptionDescription contenant des informations sur l’abonnement.
Exception:
- Levée si le chemin est null, vide ou non au format ou à la longueur appropriée.
- Levée si le chemin est null, vide ou non au format ou à la longueur appropriée.
getSubscriptionRuntimeInfo
public SubscriptionRuntimeInfo getSubscriptionRuntimeInfo(String topicPath, String subscriptionName)
Récupère les informations d’exécution d’un abonnement dans une rubrique donnée
Paramètres:
- Chemin d’accès de la rubrique relative à l’espace de noms Service Bus.
- Nom de l’abonnement
Retours:
- SubscriptionRuntimeInfo contenant les informations d’exécution sur l’abonnement.
Exception:
- Levée si le chemin est null, vide ou non au format ou à la longueur appropriée.
- Levée si le chemin est null, vide ou non au format ou à la longueur appropriée.
getSubscriptions
public List
Récupère la liste des abonnements pour une rubrique donnée dans l’espace de noms.
Paramètres:
- Nom de la rubrique.
Retours:
Exception:
- L’opération expire. Le délai d’expiration est lancé via ClientSettings.operationTimeout
- L’opération expire. Le délai d’expiration est lancé via ClientSettings.operationTimeout
getSubscriptions
public List
Récupère la liste des abonnements pour une rubrique donnée dans l’espace de noms. Vous pouvez simuler des pages de liste d’entités en manipulant les paramètres count et skip. skip(0)+count(100) donne les 100 premières entités. skip(100)+count(100) donne les 100 entités suivantes.
Paramètres:
- Nom de la rubrique.
- Nombre d’abonnements à récupérer. La valeur par défaut est 100. La valeur maximale autorisée est 100.
- Nombre d’abonnements à ignorer. La valeur par défaut est 0. Ne peut pas être négatif.
Retours:
Exception:
- L’opération expire. Le délai d’expiration est lancé via ClientSettings.operationTimeout
- L’opération expire. Le délai d’expiration est lancé via ClientSettings.operationTimeout
getTopic
public TopicDescription getTopic(String path)
Récupère une rubrique de l’espace de noms de service
Paramètres:
- Chemin de la file d’attente relatif à l’espace de noms Service Bus.
Retours:
- Description contenant des informations sur le sujet.
Exception:
- Levée si le chemin est null, vide ou non au format ou à la longueur appropriée.
- Levée si le chemin est null, vide ou non au format ou à la longueur appropriée.
getTopicRuntimeInfo
public TopicRuntimeInfo getTopicRuntimeInfo(String path)
Récupère les informations d’exécution d’une rubrique
Paramètres:
- Chemin de la file d’attente relatif à l’espace de noms Service Bus.
Retours:
- TopicRuntimeInfo contenant des informations d’exécution sur la rubrique.
Exception:
- Levée si le chemin est null, vide ou non au format ou à la longueur appropriée.
- Levée si le chemin est null, vide ou non au format ou à la longueur appropriée.
getTopics
public List
Récupère la liste des rubriques présentes dans l’espace de noms.
Retours:
Exception:
- L’opération expire. Le délai d’expiration est lancé via ClientSettings.operationTimeout
- L’opération expire. Le délai d’expiration est lancé via ClientSettings.operationTimeout
getTopics
public List
Récupère la liste des rubriques présentes dans l’espace de noms. Vous pouvez simuler des pages de liste d’entités en manipulant les paramètres count et skip. skip(0)+count(100) donne les 100 premières entités. skip(100)+count(100) donne les 100 entités suivantes.
Paramètres:
- Nombre de rubriques à extraire. La valeur par défaut est 100. La valeur maximale autorisée est 100.
- Nombre de rubriques à ignorer. La valeur par défaut est 0. Ne peut pas être négatif.
Retours:
Exception:
- L’opération expire. Le délai d’expiration est lancé via ClientSettings.operationTimeout
- L’opération expire. Le délai d’expiration est lancé via ClientSettings.operationTimeout
queueExists
public Boolean queueExists(String path)
Vérifie si une file d’attente donnée existe ou non.
Paramètres:
- Chemin d’accès de l’entité à case activée
Retours:
- True si l’entité existe. Sinon, false.
Exception:
- path n’est pas null / empty / trop long / non valide.
- path n’est pas null / empty / trop long / non valide.
ruleExists
public Boolean ruleExists(String topicPath, String subscriptionName, String ruleName)
Vérifie si une règle donnée existe ou non pour un abonnement donné.
Paramètres:
- Chemin d’accès de la rubrique
- Nom de l'abonnement.
- Nom de la règle
Retours:
- True si l’entité existe. Sinon, false.
Exception:
- path n’est pas null / empty / trop long / non valide.
- path n’est pas null / empty / trop long / non valide.
subscriptionExists
public Boolean subscriptionExists(String topicPath, String subscriptionName)
Vérifie si un abonnement donné existe ou non.
Paramètres:
- Chemin d’accès de la rubrique
- Nom de l'abonnement.
Retours:
- True si l’entité existe. Sinon, false.
Exception:
- path n’est pas null / empty / trop long / non valide.
- path n’est pas null / empty / trop long / non valide.
topicExists
public Boolean topicExists(String path)
Vérifie si une rubrique donnée existe ou non.
Paramètres:
- Chemin d’accès de l’entité à case activée
Retours:
- True si l’entité existe. Sinon, false.
Exception:
- path n’est pas null / empty / trop long / non valide.
- path n’est pas null / empty / trop long / non valide.
updateQueue
public QueueDescription updateQueue(QueueDescription queueDescription)
Mises à jour une file d’attente existante.
Paramètres:
- Objet QueueDescription décrivant les attributs avec lesquels la file d’attente sera mise à jour.
Retours:
Exception:
- L’entité décrite est introuvable.
- L’entité décrite est introuvable.
updateRule
public RuleDescription updateRule(String topicName, String subscriptionName, RuleDescription ruleDescription)
Mises à jour une règle existante.
Paramètres:
- Nom de la rubrique.
- Nom de l'abonnement.
- Objet RuleDescription décrivant les attributs avec lesquels la règle sera mise à jour.
Retours:
Exception:
- L’entité décrite est introuvable.
- L’entité décrite est introuvable.
updateSubscription
public SubscriptionDescription updateSubscription(SubscriptionDescription subscriptionDescription)
Mises à jour un abonnement existant.
Paramètres:
- Objet SubscriptionDescription décrivant les attributs avec lesquels l’abonnement sera mis à jour.
Retours:
Exception:
- L’entité décrite est introuvable.
- L’entité décrite est introuvable.
updateTopic
public TopicDescription updateTopic(TopicDescription topicDescription)
Mises à jour une rubrique existante.
Paramètres:
- Objet TopicDescription décrivant les attributs avec lesquels la rubrique sera mise à jour.
Retours:
Exception:
- L’entité décrite est introuvable.
- L’entité décrite est introuvable.
S’applique à
Azure SDK for Java