ServiceBusAdministrationClient Classe
Utilisez ce client pour créer, mettre à jour, répertorier et supprimer des ressources d’un espace de noms ServiceBus.
- Héritage
-
builtins.objectServiceBusAdministrationClient
Constructeur
ServiceBusAdministrationClient(fully_qualified_namespace: str, credential: TokenCredential, *, api_version: str | ApiVersion = ApiVersion.V2021_05, **kwargs: Any)
Paramètres
- credential
- <xref:TokenCredential>
Pour vous authentifier pour gérer les entités de l’espace de noms ServiceBus.
- api_version
- str ou ApiVersion
Version de l’API Service Bus à utiliser pour les requêtes. La valeur par défaut est la version de service la plus récente compatible avec le KIT de développement logiciel (SDK) actuel. La définition d’une version antérieure peut réduire la compatibilité des fonctionnalités.
Méthodes
close | |
create_queue |
Créez une file d’attente. |
create_rule |
Créez une règle pour un abonnement à une rubrique. |
create_subscription |
Créez un abonnement à une rubrique. |
create_topic |
Créez une rubrique. |
delete_queue |
Supprimer une file d’attente. |
delete_rule |
Supprimer une règle d’abonnement à une rubrique. |
delete_subscription |
Supprimez un abonnement à une rubrique. |
delete_topic |
Supprimer une rubrique. |
from_connection_string |
Créez un client à partir d’une chaîne de connexion. |
get_namespace_properties |
Obtenir les propriétés de l’espace de noms |
get_queue |
Obtenez les propriétés d’une file d’attente. |
get_queue_runtime_properties |
Obtenez les informations d’exécution d’une file d’attente. |
get_rule |
Obtenez les propriétés d’une règle d’abonnement à une rubrique. |
get_subscription |
Obtenez les propriétés d’un abonnement à une rubrique. |
get_subscription_runtime_properties |
Obtenez les informations d’exécution d’un abonnement à une rubrique. |
get_topic |
Obtenir les propriétés d’une rubrique. |
get_topic_runtime_properties |
Obtenir les informations d’exécution d’une rubrique. |
list_queues |
Répertoriez les files d’attente d’un espace de noms ServiceBus. |
list_queues_runtime_properties |
Répertoriez les informations d’exécution des files d’attente dans un espace de noms ServiceBus. |
list_rules |
Répertorier les règles d’un abonnement à une rubrique. |
list_subscriptions |
Répertoriez les abonnements d’une rubrique ServiceBus. |
list_subscriptions_runtime_properties |
Répertoriez les informations d’exécution des abonnements d’une rubrique ServiceBus. |
list_topics |
Répertoriez les rubriques d’un espace de noms ServiceBus. |
list_topics_runtime_properties |
Répertoriez les informations d’exécution des rubriques d’un espace de noms ServiceBus. |
update_queue |
Mettre à jour une file d’attente. Avant d’appeler cette méthode, vous devez utiliser get_queue, create_queue ou list_queues pour obtenir un instance QueueProperties, puis mettre à jour les propriétés. Seule une partie des propriétés peut être mise à jour. Consultez la page https://docs.microsoft.com/en-us/rest/api/servicebus/update-queue. Vous pouvez également passer mot clé arguments pour mettre à jour les propriétés sous la forme de <property_name>=<property_value> qui remplace tout ce qui a été spécifié dans le instance QueueProperties. Pour connaître les noms des propriétés, reportez-vous à ~azure.servicebus.management.QueueProperties. |
update_rule |
Mettre à jour une règle. Avant d’appeler cette méthode, vous devez utiliser get_rule, create_rule ou list_rules pour obtenir un instance RuleProperties, puis mettre à jour les propriétés. Vous pouvez également passer mot clé arguments pour mettre à jour les propriétés sous la forme de <property_name>=<property_value> qui remplace tout ce qui a été spécifié dans le instance RuleProperties. Pour connaître les noms des propriétés, reportez-vous à ~azure.servicebus.management.RuleProperties. |
update_subscription |
Mettre à jour un abonnement. Avant d’appeler cette méthode, vous devez utiliser get_subscription, update_subscription ou list_subscription pour obtenir un instance SubscriptionProperties, puis mettre à jour les propriétés. Vous pouvez également passer mot clé arguments pour la mise à jour des propriétés sous la forme de <property_name>=<property_value> qui remplace tout ce qui a été spécifié dans le instance SubscriptionProperties. Pour connaître les noms des propriétés, reportez-vous à ~azure.servicebus.management.SubscriptionProperties. |
update_topic |
Mettre à jour une rubrique. Avant d’appeler cette méthode, vous devez utiliser get_topic, create_topic ou list_topics pour obtenir un instance TopicProperties, puis mettre à jour les propriétés. Seule une partie des propriétés peut être mise à jour. Consultez la page https://docs.microsoft.com/en-us/rest/api/servicebus/update-topic. Vous pouvez également passer mot clé arguments pour mettre à jour les propriétés sous la forme de <property_name>=<property_value> qui remplace tout ce qui a été spécifié dans le instance TopicProperties. Pour connaître les noms des propriétés, reportez-vous à ~azure.servicebus.management.TopicProperties. |
close
close() -> None
create_queue
Créez une file d’attente.
create_queue(queue_name: str, *, authorization_rules: List[AuthorizationRule] | None = None, auto_delete_on_idle: timedelta | str | None = None, dead_lettering_on_message_expiration: bool | None = None, default_message_time_to_live: timedelta | str | None = None, duplicate_detection_history_time_window: timedelta | str | None = None, enable_batched_operations: bool | None = None, enable_express: bool | None = None, enable_partitioning: bool | None = None, lock_duration: timedelta | str | None = None, max_delivery_count: int | None = None, max_size_in_megabytes: int | None = None, requires_duplicate_detection: bool | None = None, requires_session: bool | None = None, forward_to: str | None = None, user_metadata: str | None = None, forward_dead_lettered_messages_to: str | None = None, max_message_size_in_kilobytes: int | None = None, **kwargs: Any) -> QueueProperties
Paramètres
- authorization_rules
- list[AuthorizationRule]
Règles d’autorisation pour la ressource.
Intervalle d’inactivité timeSpan ISO 8601 après lequel la file d’attente est automatiquement supprimée. La durée minimale est de 5 minutes. La valeur d’entrée de type ~datetime.timedelta ou chaîne au format de durée ISO 8601 comme « PT300S » est acceptée.
- dead_lettering_on_message_expiration
- bool
Valeur qui indique si cette file d’attente prend en charge les lettres mortes lorsqu’un message expire.
Intervalle de temps de message par défaut ISO 8601 pour la valeur dynamique. Il s’agit de la durée d’expiration du message, à partir du moment où le message est envoyé à Service Bus. Il s’agit de la valeur par défaut utilisée lorsque TimeToLive n’est pas défini sur un message lui-même. La valeur d’entrée de type ~datetime.timedelta ou chaîne au format de durée ISO 8601 comme « PT300S » est acceptée.
Structure timeSpan ISO 8601 qui définit la durée de l’historique de détection des doublons. La valeur par défaut est 10 minutes. La valeur d’entrée de type ~datetime.timedelta ou chaîne au format de durée ISO 8601 comme « PT300S » est acceptée.
- enable_batched_operations
- bool
Valeur qui indique si les opérations par lots côté serveur sont activées.
- enable_express
- bool
Valeur qui indique si les entités Express sont activées. Une file d’attente express conserve temporairement un message en mémoire avant de l’écrire dans un stockage persistant.
- enable_partitioning
- bool
Valeur qui indique si la file d’attente doit être partitionnée entre plusieurs répartiteurs de messages.
Durée de la période ISO 8601 d’un peek-lock ; autrement dit, la durée pendant laquelle le message est verrouillé pour d’autres récepteurs. La valeur maximale de LockDuration est de 5 minutes ; la valeur par défaut est 1 minute. La valeur d’entrée de type ~datetime.timedelta ou chaîne au format de durée ISO 8601 comme « PT300S » est acceptée.
- max_delivery_count
- int
Nombre maximal de livraisons. Un message devient une lettre morte après ce nombre de remises. La valeur par défaut est 10.
- max_size_in_megabytes
- int
Taille maximale de la file d’attente en mégaoctets, qui correspond à la taille de la mémoire allouée à la file d’attente.
- requires_duplicate_detection
- bool
Valeur indiquant si cette file d’attente nécessite une détection des doublons.
- requires_session
- bool
Valeur qui indique si la file d’attente prend en charge le concept de sessions.
- forward_to
- str
Nom de l’entité destinataire à laquelle tous les messages envoyés à la file d’attente sont transférés.
- user_metadata
- str
Metdata personnalisées que l’utilisateur peut associer à la description. La longueur maximale est de 1 024 caractères.
- forward_dead_lettered_messages_to
- str
Nom de l’entité destinataire à laquelle tous les messages de lettres mortes de cet abonnement sont transférés.
- max_message_size_in_kilobytes
- int
Taille maximale, en kilo-octets, de la charge utile de message qui peut être acceptée par la file d’attente. Cette fonctionnalité est disponible uniquement si vous utilisez un espace de noms Premium et une version ultérieure de l’API Service Bus « 2021-05 ». La valeur minimale autorisée est 1024 tandis que la valeur maximale autorisée est 102400. La valeur par défaut est 1024.
Type de retour
create_rule
Créez une règle pour un abonnement à une rubrique.
create_rule(topic_name: str, subscription_name: str, rule_name: str, *, filter: ~azure.servicebus.management._models.CorrelationRuleFilter | ~azure.servicebus.management._models.SqlRuleFilter = <azure.servicebus.management._models.TrueRuleFilter object>, action: ~azure.servicebus.management._models.SqlRuleAction | None = None, **kwargs: ~typing.Any) -> RuleProperties
Paramètres
- filter
- Union[CorrelationRuleFilter, SqlRuleFilter]
Filtre de la règle. La valeur par défaut est ~azure.servicebus.management.TrueRuleFilter
- action
- Optional[SqlRuleAction]
Action de la règle.
Type de retour
create_subscription
Créez un abonnement à une rubrique.
create_subscription(topic_name: str, subscription_name: str, *, lock_duration: timedelta | str | None = None, requires_session: bool | None = None, default_message_time_to_live: timedelta | str | None = None, dead_lettering_on_message_expiration: bool | None = None, dead_lettering_on_filter_evaluation_exceptions: bool | None = None, max_delivery_count: int | None = None, enable_batched_operations: bool | None = None, forward_to: str | None = None, user_metadata: str | None = None, forward_dead_lettered_messages_to: str | None = None, auto_delete_on_idle: timedelta | str | None = None, **kwargs: Any) -> SubscriptionProperties
Paramètres
Durée de la période ISO 8601 d’un peek-lock ; autrement dit, la durée pendant laquelle le message est verrouillé pour d’autres récepteurs. La valeur maximale de LockDuration est de 5 minutes ; la valeur par défaut est 1 minute. La valeur d’entrée de type ~datetime.timedelta ou chaîne au format de durée ISO 8601 comme « PT300S » est acceptée.
- requires_session
- bool
Valeur qui indique si la file d’attente prend en charge le concept de sessions.
Intervalle de temps de message par défaut ISO 8601 pour la valeur dynamique. Il s’agit de la durée d’expiration du message, à partir du moment où le message est envoyé à Service Bus. Il s’agit de la valeur par défaut utilisée lorsque TimeToLive n’est pas défini sur un message lui-même. La valeur d’entrée de type ~datetime.timedelta ou chaîne au format de durée ISO 8601 comme « PT300S » est acceptée.
- dead_lettering_on_message_expiration
- bool
Valeur qui indique si cet abonnement a une prise en charge de lettres mortes lorsqu’un message expire.
- dead_lettering_on_filter_evaluation_exceptions
- bool
Valeur qui indique si cet abonnement a une prise en charge de lettres mortes lorsqu’un message expire.
- max_delivery_count
- int
Nombre maximal de livraisons. Un message devient une lettre morte après ce nombre de remises. La valeur par défaut est 10.
- enable_batched_operations
- bool
Valeur qui indique si les opérations par lots côté serveur sont activées.
- forward_to
- str
Nom de l’entité destinataire à laquelle tous les messages envoyés à l’abonnement sont transférés.
- user_metadata
- str
Métadonnées associées à l’abonnement. Nombre maximal de caractères : 1 024.
- forward_dead_lettered_messages_to
- str
Nom de l’entité destinataire à laquelle tous les messages envoyés à l’abonnement sont transférés.
Intervalle d’inactivité timeSpan ISO 8601 après lequel l’abonnement est automatiquement supprimé. La durée minimale est de 5 minutes. La valeur d’entrée de type ~datetime.timedelta ou chaîne au format de durée ISO 8601 comme « PT300S » est acceptée.
Type de retour
create_topic
Créez une rubrique.
create_topic(topic_name: str, *, default_message_time_to_live: timedelta | str | None = None, max_size_in_megabytes: int | None = None, requires_duplicate_detection: bool | None = None, duplicate_detection_history_time_window: timedelta | str | None = None, enable_batched_operations: bool | None = None, size_in_bytes: int | None = None, filtering_messages_before_publishing: bool | None = None, authorization_rules: List[AuthorizationRule] | None = None, support_ordering: bool | None = None, auto_delete_on_idle: timedelta | str | None = None, enable_partitioning: bool | None = None, enable_express: bool | None = None, user_metadata: str | None = None, max_message_size_in_kilobytes: int | None = None, **kwargs: Any) -> TopicProperties
Paramètres
Intervalle de temps de message par défaut ISO 8601 pour la valeur dynamique. Il s’agit de la durée d’expiration du message, à partir du moment où le message est envoyé à Service Bus. Il s’agit de la valeur par défaut utilisée lorsque TimeToLive n’est pas défini sur un message lui-même. La valeur d’entrée de type ~datetime.timedelta ou chaîne au format de durée ISO 8601 comme « PT300S » est acceptée.
- max_size_in_megabytes
- int
Taille maximale de la rubrique en mégaoctets, qui correspond à la taille de la mémoire allouée à la rubrique.
- requires_duplicate_detection
- bool
Valeur indiquant si cette rubrique nécessite une détection des doublons.
Structure timeSpan ISO 8601 qui définit la durée de l’historique de détection des doublons. La valeur par défaut est 10 minutes. La valeur d’entrée de type ~datetime.timedelta ou chaîne au format de durée ISO 8601 comme « PT300S » est acceptée.
- enable_batched_operations
- bool
Valeur qui indique si les opérations par lots côté serveur sont activées.
- size_in_bytes
- int
Taille de la rubrique, en octets.
- filtering_messages_before_publishing
- bool
Filtrez les messages avant de les publier.
- authorization_rules
- list[AuthorizationRule]
Règles d’autorisation pour la ressource.
- support_ordering
- bool
Valeur qui indique si la rubrique prend en charge le classement.
Intervalle d’inactivité timeSpan ISO 8601 après lequel la rubrique est automatiquement supprimée. La durée minimale est de 5 minutes. La valeur d’entrée de type ~datetime.timedelta ou chaîne au format de durée ISO 8601 comme « PT300S » est acceptée.
- enable_partitioning
- bool
Valeur qui indique si la rubrique doit être partitionnée entre plusieurs répartiteurs de messages.
- enable_express
- bool
Valeur qui indique si les entités Express sont activées. Une file d’attente express conserve temporairement un message en mémoire avant de l’écrire dans un stockage persistant.
- user_metadata
- str
Métadonnées associées à la rubrique.
- max_message_size_in_kilobytes
- int
Taille maximale, en kilo-octets, de la charge utile de message qui peut être acceptée par la file d’attente. Cette fonctionnalité est disponible uniquement si vous utilisez un espace de noms Premium et une version ultérieure de l’API Service Bus « 2021-05 ». La valeur minimale autorisée est 1024 tandis que la valeur maximale autorisée est 102400. La valeur par défaut est 1024.
Type de retour
delete_queue
Supprimer une file d’attente.
delete_queue(queue_name: str, **kwargs: Any) -> None
Paramètres
- queue_name
- str
Nom de la file d’attente ou d’une File d’attenteProperties portant le nom.
Type de retour
delete_rule
Supprimer une règle d’abonnement à une rubrique.
delete_rule(topic_name: str, subscription_name: str, rule_name: str, **kwargs: Any) -> None
Paramètres
Type de retour
delete_subscription
Supprimez un abonnement à une rubrique.
delete_subscription(topic_name: str, subscription_name: str, **kwargs: Any) -> None
Paramètres
Type de retour
delete_topic
Supprimer une rubrique.
delete_topic(topic_name: str, **kwargs: Any) -> None
Paramètres
Type de retour
from_connection_string
Créez un client à partir d’une chaîne de connexion.
from_connection_string(conn_str: str, *, api_version: str | ApiVersion = ApiVersion.V2021_05, **kwargs: Any) -> ServiceBusAdministrationClient
Paramètres
- api_version
- str ou ApiVersion
Version de l’API Service Bus à utiliser pour les requêtes. La valeur par défaut est la version de service la plus récente compatible avec le KIT de développement logiciel (SDK) actuel. La définition d’une version antérieure peut entraîner une compatibilité des fonctionnalités réduite.
Type de retour
get_namespace_properties
Obtenir les propriétés de l’espace de noms
get_namespace_properties(**kwargs: Any) -> NamespaceProperties
Retours
Propriétés de l’espace de noms.
Type de retour
get_queue
Obtenez les propriétés d’une file d’attente.
get_queue(queue_name: str, **kwargs: Any) -> QueueProperties
Paramètres
Retours
Propriétés de la file d’attente.
Type de retour
get_queue_runtime_properties
Obtenez les informations d’exécution d’une file d’attente.
get_queue_runtime_properties(queue_name: str, **kwargs: Any) -> QueueRuntimeProperties
Paramètres
Retours
Informations d’exécution de la file d’attente.
Type de retour
get_rule
Obtenez les propriétés d’une règle d’abonnement à une rubrique.
get_rule(topic_name: str, subscription_name: str, rule_name: str, **kwargs: Any) -> RuleProperties
Paramètres
Retours
Propriétés de la règle spécifiée.
Type de retour
get_subscription
Obtenez les propriétés d’un abonnement à une rubrique.
get_subscription(topic_name: str, subscription_name: str, **kwargs: Any) -> SubscriptionProperties
Paramètres
Retours
Une instance d’SubscriptionProperties
Type de retour
get_subscription_runtime_properties
Obtenez les informations d’exécution d’un abonnement à une rubrique.
get_subscription_runtime_properties(topic_name: str, subscription_name: str, **kwargs: Any) -> SubscriptionRuntimeProperties
Paramètres
Retours
Un instance de SubscriptionRuntimeProperties
Type de retour
get_topic
Obtenir les propriétés d’une rubrique.
get_topic(topic_name: str, **kwargs: Any) -> TopicProperties
Paramètres
Retours
Propriétés de la rubrique.
Type de retour
get_topic_runtime_properties
Obtenir les informations d’exécution d’une rubrique.
get_topic_runtime_properties(topic_name: str, **kwargs: Any) -> TopicRuntimeProperties
Paramètres
Retours
Informations d’exécution de la rubrique.
Type de retour
list_queues
Répertoriez les files d’attente d’un espace de noms ServiceBus.
list_queues(**kwargs: Any) -> ItemPaged[QueueProperties]
Retours
Réponse itérable (pagination automatique) de QueueProperties.
Type de retour
list_queues_runtime_properties
Répertoriez les informations d’exécution des files d’attente dans un espace de noms ServiceBus.
list_queues_runtime_properties(**kwargs: Any) -> ItemPaged[QueueRuntimeProperties]
Retours
Réponse itérable (pagination automatique) de QueueRuntimeProperties.
Type de retour
list_rules
Répertorier les règles d’un abonnement à une rubrique.
list_rules(topic_name: str, subscription_name: str, **kwargs: Any) -> ItemPaged[RuleProperties]
Paramètres
Retours
Réponse itérable (pagination automatique) de RuleProperties.
Type de retour
list_subscriptions
Répertoriez les abonnements d’une rubrique ServiceBus.
list_subscriptions(topic_name: str, **kwargs: Any) -> ItemPaged[SubscriptionProperties]
Paramètres
Retours
Réponse itérable (pagination automatique) de SubscriptionProperties.
Type de retour
list_subscriptions_runtime_properties
Répertoriez les informations d’exécution des abonnements d’une rubrique ServiceBus.
list_subscriptions_runtime_properties(topic_name: str, **kwargs: Any) -> ItemPaged[SubscriptionRuntimeProperties]
Paramètres
Retours
Réponse itérable (pagination automatique) de SubscriptionRuntimeProperties.
Type de retour
list_topics
Répertoriez les rubriques d’un espace de noms ServiceBus.
list_topics(**kwargs: Any) -> ItemPaged[TopicProperties]
Retours
Réponse itérable (pagination automatique) de TopicProperties.
Type de retour
list_topics_runtime_properties
Répertoriez les informations d’exécution des rubriques d’un espace de noms ServiceBus.
list_topics_runtime_properties(**kwargs: Any) -> ItemPaged[TopicRuntimeProperties]
Retours
Réponse itérable (pagination automatique) de TopicRuntimeProperties.
Type de retour
update_queue
Mettre à jour une file d’attente.
Avant d’appeler cette méthode, vous devez utiliser get_queue, create_queue ou list_queues pour obtenir un instance QueueProperties, puis mettre à jour les propriétés. Seule une partie des propriétés peut être mise à jour. Consultez la page https://docs.microsoft.com/en-us/rest/api/servicebus/update-queue. Vous pouvez également passer mot clé arguments pour mettre à jour les propriétés sous la forme de <property_name>=<property_value> qui remplace tout ce qui a été spécifié dans le instance QueueProperties. Pour connaître les noms des propriétés, reportez-vous à ~azure.servicebus.management.QueueProperties.
update_queue(queue: QueueProperties | Mapping[str, Any], **kwargs: Any) -> None
Paramètres
- queue
- QueueProperties
File d’attente retournée par get_queue, create_queue ou list_queues et dont les propriétés sont mises à jour.
Type de retour
update_rule
Mettre à jour une règle.
Avant d’appeler cette méthode, vous devez utiliser get_rule, create_rule ou list_rules pour obtenir un instance RuleProperties, puis mettre à jour les propriétés. Vous pouvez également passer mot clé arguments pour mettre à jour les propriétés sous la forme de <property_name>=<property_value> qui remplace tout ce qui a été spécifié dans le instance RuleProperties. Pour connaître les noms des propriétés, reportez-vous à ~azure.servicebus.management.RuleProperties.
update_rule(topic_name: str, subscription_name: str, rule: RuleProperties | Mapping[str, Any], **kwargs: Any) -> None
Paramètres
- rule
- RuleProperties
Règle retournée par get_rule, create_rule ou list_rules et qui a les propriétés mises à jour.
Type de retour
update_subscription
Mettre à jour un abonnement.
Avant d’appeler cette méthode, vous devez utiliser get_subscription, update_subscription ou list_subscription pour obtenir un instance SubscriptionProperties, puis mettre à jour les propriétés. Vous pouvez également passer mot clé arguments pour la mise à jour des propriétés sous la forme de <property_name>=<property_value> qui remplace tout ce qui a été spécifié dans le instance SubscriptionProperties. Pour connaître les noms des propriétés, reportez-vous à ~azure.servicebus.management.SubscriptionProperties.
update_subscription(topic_name: str, subscription: SubscriptionProperties | Mapping[str, Any], **kwargs: Any) -> None
Paramètres
- subscription
- SubscriptionProperties
L’abonnement retourné par get_subscription, update_subscription ou list_subscription et dont les propriétés sont mises à jour.
Type de retour
update_topic
Mettre à jour une rubrique.
Avant d’appeler cette méthode, vous devez utiliser get_topic, create_topic ou list_topics pour obtenir un instance TopicProperties, puis mettre à jour les propriétés. Seule une partie des propriétés peut être mise à jour. Consultez la page https://docs.microsoft.com/en-us/rest/api/servicebus/update-topic. Vous pouvez également passer mot clé arguments pour mettre à jour les propriétés sous la forme de <property_name>=<property_value> qui remplace tout ce qui a été spécifié dans le instance TopicProperties. Pour connaître les noms des propriétés, reportez-vous à ~azure.servicebus.management.TopicProperties.
update_topic(topic: TopicProperties | Mapping[str, Any], **kwargs: Any) -> None
Paramètres
- topic
- TopicProperties
Rubrique retournée par get_topic, create_topic ou list_topics et dont les propriétés sont mises à jour.
Type de retour
Azure SDK for Python