ServiceBusAdministrationClient Classe
Usare questo client per creare, aggiornare, elencare ed eliminare le risorse di uno spazio dei nomi ServiceBus.
- Ereditarietà
-
builtins.objectServiceBusAdministrationClient
Costruttore
ServiceBusAdministrationClient(fully_qualified_namespace: str, credential: TokenCredential, *, api_version: str | ApiVersion = ApiVersion.V2021_05, **kwargs: Any)
Parametri
- fully_qualified_namespace
- str
Nome host completo per lo spazio dei nomi del bus di servizio.
- credential
- <xref:TokenCredential>
Per eseguire l'autenticazione per gestire le entità dello spazio dei nomi ServiceBus.
- api_version
- str oppure ApiVersion
Versione dell'API del bus di servizio da usare per le richieste. Il valore predefinito è la versione del servizio più recente compatibile con l'SDK corrente. L'impostazione su una versione precedente può comportare una riduzione della compatibilità delle funzionalità.
Metodi
close | |
create_queue |
Creare una coda. |
create_rule |
Creare una regola per una sottoscrizione di argomento. |
create_subscription |
Creare una sottoscrizione di argomento. |
create_topic |
Creare un argomento. |
delete_queue |
Elimina una coda. |
delete_rule |
Eliminare una regola di sottoscrizione dell'argomento. |
delete_subscription |
Eliminare una sottoscrizione di argomento. |
delete_topic |
Eliminare un argomento. |
from_connection_string |
Creare un client dalla stringa di connessione. |
get_namespace_properties |
Ottenere le proprietà dello spazio dei nomi |
get_queue |
Ottenere le proprietà di una coda. |
get_queue_runtime_properties |
Ottenere le informazioni di runtime di una coda. |
get_rule |
Ottenere le proprietà di una regola di sottoscrizione dell'argomento. |
get_subscription |
Ottenere le proprietà di una sottoscrizione di argomento. |
get_subscription_runtime_properties |
Ottenere informazioni sul runtime della sottoscrizione di un argomento. |
get_topic |
Ottenere le proprietà di un argomento. |
get_topic_runtime_properties |
Ottenere le informazioni di runtime di un argomento. |
list_queues |
Elencare le code di uno spazio dei nomi ServiceBus. |
list_queues_runtime_properties |
Elencare le informazioni di runtime delle code in uno spazio dei nomi ServiceBus. |
list_rules |
Elencare le regole di una sottoscrizione di argomento. |
list_subscriptions |
Elencare le sottoscrizioni di un argomento servicebus. |
list_subscriptions_runtime_properties |
Elencare le informazioni di runtime delle sottoscrizioni di un argomento ServiceBus. |
list_topics |
Elencare gli argomenti di uno spazio dei nomi ServiceBus. |
list_topics_runtime_properties |
Elencare le informazioni di runtime degli argomenti di uno spazio dei nomi ServiceBus. |
update_queue |
Aggiornare una coda. Prima di chiamare questo metodo, è necessario usare get_queue, create_queue o list_queues per ottenere un'istanza queueProperties , quindi aggiornare le proprietà. È possibile aggiornare solo una parte delle proprietà. Vedere https://docs.microsoft.com/en-us/rest/api/servicebus/update-queue. È anche possibile passare argomenti di parole chiave per l'aggiornamento delle proprietà sotto forma di <property_name>=<property_value> che eseguirà l'override di qualsiasi elemento specificato nell'istanza queueProperties . Per i nomi delle proprietà, vedere ~azure.servicebus.management.QueueProperties. |
update_rule |
Aggiornare una regola. Prima di chiamare questo metodo, è necessario usare get_rule, create_rule o list_rules per ottenere un'istanza RuleProperties , quindi aggiornare le proprietà. È anche possibile passare argomenti di parole chiave per l'aggiornamento delle proprietà sotto forma di <property_name>=<property_value> che eseguirà l'override di qualsiasi elemento specificato nell'istanza RuleProperties . Per i nomi delle proprietà, vedere ~azure.servicebus.management.RuleProperties. |
update_subscription |
Aggiornare una sottoscrizione. Prima di chiamare questo metodo, è necessario usare get_subscription, update_subscription o list_subscription per ottenere un'istanza subscriptionProperties , quindi aggiornare le proprietà. È anche possibile passare argomenti di parola chiave per l'aggiornamento delle proprietà sotto forma di <property_name>=<property_value> che eseguirà l'override di qualsiasi elemento specificato nell'istanza subscriptionProperties . Per i nomi delle proprietà, vedere ~azure.servicebus.management.SubscriptionProperties. |
update_topic |
Aggiornare un argomento. Prima di chiamare questo metodo, è necessario usare get_topic, create_topic o list_topics per ottenere un'istanza di TopicProperties , quindi aggiornare le proprietà. È possibile aggiornare solo una parte delle proprietà. Vedere https://docs.microsoft.com/en-us/rest/api/servicebus/update-topic. È anche possibile passare argomenti di parola chiave per l'aggiornamento delle proprietà sotto forma di <property_name>=<property_value> che eseguirà l'override di qualsiasi elemento specificato nell'istanza di TopicProperties . Per i nomi delle proprietà, vedere ~azure.servicebus.management.TopicProperties. |
close
close() -> None
create_queue
Creare una coda.
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
Parametri
- authorization_rules
- list[AuthorizationRule]
Regole di autorizzazione per la risorsa.
Intervallo di inattività ISO 8601 timeSpan dopo il quale la coda viene eliminata automaticamente. La durata minima è 5 minuti. Il valore di input di tipo ~datetime.timedelta o stringa nel formato di durata ISO 8601 come "PT300S" viene accettato.
- dead_lettering_on_message_expiration
- bool
Valore che indica se la coda include supporto per messaggi non recapitabili alla scadenza di un messaggio.
IsO 8601 timepan del messaggio predefinito per il valore attivo. Questa è la durata dopo la quale il messaggio scade, a partire dal momento in cui il messaggio viene inviato al bus di servizio. Questo è il valore predefinito usato quando TimeToLive non è impostato su un messaggio stesso. Il valore di input di tipo ~datetime.timedelta o stringa nel formato di durata ISO 8601 come "PT300S" viene accettato.
Struttura timeSpan ISO 8601 che definisce la durata della cronologia di rilevamento duplicati. Il valore predefinito è 10 minuti. Il valore di input di tipo ~datetime.timedelta o stringa nel formato di durata ISO 8601 come "PT300S" viene accettato.
- enable_batched_operations
- bool
Valore che indica se le operazioni in batch sul lato server sono abilitate.
- enable_express
- bool
Valore che indica se le entità express sono abilitate. Una coda rapida contiene temporaneamente un messaggio in memoria prima di scriverlo nell'archiviazione permanente.
- enable_partitioning
- bool
Valore che indica se la coda deve essere partizionata tra più broker di messaggi.
DURATA ISO 8601 intervallo di tempo di un blocco a comparsa; ovvero la quantità di tempo in cui il messaggio è bloccato per altri ricevitori. Il valore massimo per LockDuration è 5 minuti; il valore predefinito è 1 minuto. Il valore di input di tipo ~datetime.timedelta o stringa nel formato di durata ISO 8601 come "PT300S" viene accettato.
- max_delivery_count
- int
Numero massimo di recapito. Una volta superato questo numero, il messaggio non verrà più recapito. Il valore predefinito è 10.
- max_size_in_megabytes
- int
Dimensione massima della coda in megabyte, ovvero la dimensione della memoria allocata per la coda.
- requires_duplicate_detection
- bool
Valore che indica se la coda richiede il rilevamento dei duplicati.
- requires_session
- bool
Valore che indica se la coda supporta il concetto di sessioni.
- forward_to
- str
Nome dell'entità destinatario a cui vengono inoltrati tutti i messaggi inviati alla coda.
- user_metadata
- str
Metdata personalizzato che l'utente può associare alla descrizione. La lunghezza massima è 1024 caratteri.
- forward_dead_lettered_messages_to
- str
Nome dell'entità destinatario a cui vengono inoltrati tutti i messaggi non recapitati di questa sottoscrizione.
- max_message_size_in_kilobytes
- int
Dimensione massima in kilobyte di payload del messaggio che può essere accettata dalla coda. Questa funzionalità è disponibile solo quando si usano uno spazio dei nomi Premium e la versione dell'API del bus di servizio "2021-05" o versione successiva. Il valore minimo consentito è 1024, mentre il valore massimo consentito è 102400. Il valore predefinito è 1024.
Tipo restituito
create_rule
Creare una regola per una sottoscrizione di argomento.
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
Parametri
- filter
- Union[CorrelationRuleFilter, SqlRuleFilter]
Filtro della regola. Il valore predefinito è ~azure.servicebus.management.TrueRuleFilter
- action
- Optional[SqlRuleAction]
Azione della regola.
Tipo restituito
create_subscription
Creare una sottoscrizione di argomento.
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
Parametri
DURATA ISO 8601 intervallo di tempo di un blocco a comparsa; ovvero la quantità di tempo in cui il messaggio è bloccato per altri ricevitori. Il valore massimo per LockDuration è 5 minuti; il valore predefinito è 1 minuto. Il valore di input di tipo ~datetime.timedelta o stringa nel formato di durata ISO 8601 come "PT300S" viene accettato.
- requires_session
- bool
Valore che indica se la coda supporta il concetto di sessioni.
IsO 8601 timepan del messaggio predefinito per il valore attivo. Questa è la durata dopo la quale il messaggio scade, a partire dal momento in cui il messaggio viene inviato al bus di servizio. Questo è il valore predefinito usato quando TimeToLive non è impostato su un messaggio stesso. Il valore di input di tipo ~datetime.timedelta o stringa nel formato di durata ISO 8601 come "PT300S" viene accettato.
- dead_lettering_on_message_expiration
- bool
Valore che indica se la sottoscrizione include supporto per messaggi non recapitabili alla scadenza di un messaggio.
- dead_lettering_on_filter_evaluation_exceptions
- bool
Valore che indica se la sottoscrizione include supporto per messaggi non recapitabili alla scadenza di un messaggio.
- max_delivery_count
- int
Numero massimo di recapito. Una volta superato questo numero, il messaggio non verrà più recapito. Il valore predefinito è 10.
- enable_batched_operations
- bool
Valore che indica se le operazioni in batch sul lato server sono abilitate.
- forward_to
- str
Nome dell'entità destinatario a cui vengono inoltrati tutti i messaggi inviati alla sottoscrizione.
- user_metadata
- str
Metadati associati alla sottoscrizione. Il numero massimo di caratteri è 1024.
- forward_dead_lettered_messages_to
- str
Nome dell'entità destinatario a cui vengono inoltrati tutti i messaggi inviati alla sottoscrizione.
Intervallo di inattività ISO 8601 timeSpan dopo il quale la sottoscrizione viene eliminata automaticamente. La durata minima è 5 minuti. Il valore di input di tipo ~datetime.timedelta o stringa nel formato di durata ISO 8601 come "PT300S" viene accettato.
Tipo restituito
create_topic
Creare un argomento.
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
Parametri
IsO 8601 timepan del messaggio predefinito per il valore attivo. Questa è la durata dopo la quale il messaggio scade, a partire dal momento in cui il messaggio viene inviato al bus di servizio. Questo è il valore predefinito usato quando TimeToLive non è impostato su un messaggio stesso. Il valore di input di tipo ~datetime.timedelta o stringa nel formato di durata ISO 8601 come "PT300S" viene accettato.
- max_size_in_megabytes
- int
Dimensioni massime dell'argomento in megabyte, ovvero la dimensione della memoria allocata per l'argomento.
- requires_duplicate_detection
- bool
Valore che indica se questo argomento richiede il rilevamento dei duplicati.
Struttura timeSpan ISO 8601 che definisce la durata della cronologia di rilevamento duplicati. Il valore predefinito è 10 minuti. Il valore di input di tipo ~datetime.timedelta o stringa nel formato di durata ISO 8601 come "PT300S" viene accettato.
- enable_batched_operations
- bool
Valore che indica se le operazioni in batch sul lato server sono abilitate.
- size_in_bytes
- int
Dimensioni dell'argomento, in byte.
- filtering_messages_before_publishing
- bool
Filtrare i messaggi prima della pubblicazione.
- authorization_rules
- list[AuthorizationRule]
Regole di autorizzazione per la risorsa.
- support_ordering
- bool
Valore che indica se l'argomento supporta l'ordinamento.
Intervallo di inattività ISO 8601 timeSpan dopo il quale l'argomento viene eliminato automaticamente. La durata minima è 5 minuti. Il valore di input di tipo ~datetime.timedelta o stringa nel formato di durata ISO 8601 come "PT300S" viene accettato.
- enable_partitioning
- bool
Valore che indica se l'argomento deve essere partizionato tra più broker di messaggi.
- enable_express
- bool
Valore che indica se le entità express sono abilitate. Una coda rapida contiene temporaneamente un messaggio in memoria prima di scriverlo nell'archiviazione permanente.
- user_metadata
- str
Metadati associati all'argomento.
- max_message_size_in_kilobytes
- int
Dimensione massima in kilobyte di payload del messaggio che può essere accettata dalla coda. Questa funzionalità è disponibile solo quando si usano uno spazio dei nomi Premium e la versione dell'API del bus di servizio "2021-05" o versione successiva. Il valore minimo consentito è 1024, mentre il valore massimo consentito è 102400. Il valore predefinito è 1024.
Tipo restituito
delete_queue
Elimina una coda.
delete_queue(queue_name: str, **kwargs: Any) -> None
Parametri
Tipo restituito
delete_rule
Eliminare una regola di sottoscrizione dell'argomento.
delete_rule(topic_name: str, subscription_name: str, rule_name: str, **kwargs: Any) -> None
Parametri
Tipo restituito
delete_subscription
Eliminare una sottoscrizione di argomento.
delete_subscription(topic_name: str, subscription_name: str, **kwargs: Any) -> None
Parametri
Tipo restituito
delete_topic
Eliminare un argomento.
delete_topic(topic_name: str, **kwargs: Any) -> None
Parametri
Tipo restituito
from_connection_string
Creare un client dalla stringa di connessione.
from_connection_string(conn_str: str, *, api_version: str | ApiVersion = ApiVersion.V2021_05, **kwargs: Any) -> ServiceBusAdministrationClient
Parametri
- api_version
- str oppure ApiVersion
Versione dell'API del bus di servizio da usare per le richieste. Il valore predefinito è la versione del servizio più recente compatibile con l'SDK corrente. L'impostazione su una versione precedente può comportare una riduzione della compatibilità delle funzionalità.
Tipo restituito
get_namespace_properties
Ottenere le proprietà dello spazio dei nomi
get_namespace_properties(**kwargs: Any) -> NamespaceProperties
Restituisce
Proprietà dello spazio dei nomi.
Tipo restituito
get_queue
Ottenere le proprietà di una coda.
get_queue(queue_name: str, **kwargs: Any) -> QueueProperties
Parametri
Restituisce
Proprietà della coda.
Tipo restituito
get_queue_runtime_properties
Ottenere le informazioni di runtime di una coda.
get_queue_runtime_properties(queue_name: str, **kwargs: Any) -> QueueRuntimeProperties
Parametri
Restituisce
Informazioni di runtime della coda.
Tipo restituito
get_rule
Ottenere le proprietà di una regola di sottoscrizione dell'argomento.
get_rule(topic_name: str, subscription_name: str, rule_name: str, **kwargs: Any) -> RuleProperties
Parametri
Restituisce
Proprietà della regola specificata.
Tipo restituito
get_subscription
Ottenere le proprietà di una sottoscrizione di argomento.
get_subscription(topic_name: str, subscription_name: str, **kwargs: Any) -> SubscriptionProperties
Parametri
Restituisce
Istanza di SubscriptionProperties
Tipo restituito
get_subscription_runtime_properties
Ottenere informazioni sul runtime della sottoscrizione di un argomento.
get_subscription_runtime_properties(topic_name: str, subscription_name: str, **kwargs: Any) -> SubscriptionRuntimeProperties
Parametri
Restituisce
Istanza di SubscriptionRuntimeProperties
Tipo restituito
get_topic
Ottenere le proprietà di un argomento.
get_topic(topic_name: str, **kwargs: Any) -> TopicProperties
Parametri
Restituisce
Proprietà dell'argomento.
Tipo restituito
get_topic_runtime_properties
Ottenere le informazioni di runtime di un argomento.
get_topic_runtime_properties(topic_name: str, **kwargs: Any) -> TopicRuntimeProperties
Parametri
Restituisce
Informazioni di runtime dell'argomento.
Tipo restituito
list_queues
Elencare le code di uno spazio dei nomi ServiceBus.
list_queues(**kwargs: Any) -> ItemPaged[QueueProperties]
Restituisce
Risposta iterabile (paging automatico) di QueueProperties.
Tipo restituito
list_queues_runtime_properties
Elencare le informazioni di runtime delle code in uno spazio dei nomi ServiceBus.
list_queues_runtime_properties(**kwargs: Any) -> ItemPaged[QueueRuntimeProperties]
Restituisce
Risposta iterabile (paging automatico) di QueueRuntimeProperties.
Tipo restituito
list_rules
Elencare le regole di una sottoscrizione di argomento.
list_rules(topic_name: str, subscription_name: str, **kwargs: Any) -> ItemPaged[RuleProperties]
Parametri
Restituisce
Risposta iterabile (paging automatico) di RuleProperties.
Tipo restituito
list_subscriptions
Elencare le sottoscrizioni di un argomento servicebus.
list_subscriptions(topic_name: str, **kwargs: Any) -> ItemPaged[SubscriptionProperties]
Parametri
Restituisce
Risposta iterabile (paging automatico) di SubscriptionProperties.
Tipo restituito
list_subscriptions_runtime_properties
Elencare le informazioni di runtime delle sottoscrizioni di un argomento ServiceBus.
list_subscriptions_runtime_properties(topic_name: str, **kwargs: Any) -> ItemPaged[SubscriptionRuntimeProperties]
Parametri
Restituisce
Risposta iterabile (paging automatico) di SubscriptionRuntimeProperties.
Tipo restituito
list_topics
Elencare gli argomenti di uno spazio dei nomi ServiceBus.
list_topics(**kwargs: Any) -> ItemPaged[TopicProperties]
Restituisce
Risposta iterabile (paging automatico) di TopicProperties.
Tipo restituito
list_topics_runtime_properties
Elencare le informazioni di runtime degli argomenti di uno spazio dei nomi ServiceBus.
list_topics_runtime_properties(**kwargs: Any) -> ItemPaged[TopicRuntimeProperties]
Restituisce
Risposta iterabile (paging automatico) di TopicRuntimeProperties.
Tipo restituito
update_queue
Aggiornare una coda.
Prima di chiamare questo metodo, è necessario usare get_queue, create_queue o list_queues per ottenere un'istanza queueProperties , quindi aggiornare le proprietà. È possibile aggiornare solo una parte delle proprietà. Vedere https://docs.microsoft.com/en-us/rest/api/servicebus/update-queue. È anche possibile passare argomenti di parole chiave per l'aggiornamento delle proprietà sotto forma di <property_name>=<property_value> che eseguirà l'override di qualsiasi elemento specificato nell'istanza queueProperties . Per i nomi delle proprietà, vedere ~azure.servicebus.management.QueueProperties.
update_queue(queue: QueueProperties | Mapping[str, Any], **kwargs: Any) -> None
Parametri
- queue
- QueueProperties
La coda restituita da get_queue, create_queue o list_queues e ha le proprietà aggiornate.
Tipo restituito
update_rule
Aggiornare una regola.
Prima di chiamare questo metodo, è necessario usare get_rule, create_rule o list_rules per ottenere un'istanza RuleProperties , quindi aggiornare le proprietà. È anche possibile passare argomenti di parole chiave per l'aggiornamento delle proprietà sotto forma di <property_name>=<property_value> che eseguirà l'override di qualsiasi elemento specificato nell'istanza RuleProperties . Per i nomi delle proprietà, vedere ~azure.servicebus.management.RuleProperties.
update_rule(topic_name: str, subscription_name: str, rule: RuleProperties | Mapping[str, Any], **kwargs: Any) -> None
Parametri
- rule
- RuleProperties
La regola restituita da get_rule, create_rule o list_rules e ha le proprietà aggiornate.
Tipo restituito
update_subscription
Aggiornare una sottoscrizione.
Prima di chiamare questo metodo, è necessario usare get_subscription, update_subscription o list_subscription per ottenere un'istanza subscriptionProperties , quindi aggiornare le proprietà. È anche possibile passare argomenti di parola chiave per l'aggiornamento delle proprietà sotto forma di <property_name>=<property_value> che eseguirà l'override di qualsiasi elemento specificato nell'istanza subscriptionProperties . Per i nomi delle proprietà, vedere ~azure.servicebus.management.SubscriptionProperties.
update_subscription(topic_name: str, subscription: SubscriptionProperties | Mapping[str, Any], **kwargs: Any) -> None
Parametri
- subscription
- SubscriptionProperties
La sottoscrizione restituita da get_subscription, update_subscription o list_subscription e ha le proprietà aggiornate.
Tipo restituito
update_topic
Aggiornare un argomento.
Prima di chiamare questo metodo, è necessario usare get_topic, create_topic o list_topics per ottenere un'istanza di TopicProperties , quindi aggiornare le proprietà. È possibile aggiornare solo una parte delle proprietà. Vedere https://docs.microsoft.com/en-us/rest/api/servicebus/update-topic. È anche possibile passare argomenti di parola chiave per l'aggiornamento delle proprietà sotto forma di <property_name>=<property_value> che eseguirà l'override di qualsiasi elemento specificato nell'istanza di TopicProperties . Per i nomi delle proprietà, vedere ~azure.servicebus.management.TopicProperties.
update_topic(topic: TopicProperties | Mapping[str, Any], **kwargs: Any) -> None
Parametri
- topic
- TopicProperties
L'argomento restituito da get_topic, create_topic o list_topics e ha le proprietà aggiornate.
Tipo restituito
Azure SDK for Python