ServiceBusAdministrationClient Třída
Pomocí tohoto klienta můžete vytvářet, aktualizovat, vypisovat a odstraňovat prostředky oboru názvů ServiceBus.
- Dědičnost
-
builtins.objectServiceBusAdministrationClient
Konstruktor
ServiceBusAdministrationClient(fully_qualified_namespace: str, credential: TokenCredential, *, api_version: str | ApiVersion = ApiVersion.V2021_05, **kwargs: Any)
Parametry
- fully_qualified_namespace
- str
Plně kvalifikovaný název hostitele pro obor názvů služby Service Bus.
- credential
- <xref:TokenCredential>
Ověření pro správu entit oboru názvů ServiceBus.
- api_version
- str nebo ApiVersion
Verze rozhraní API služby Service Bus, která se má použít pro požadavky. Výchozí hodnota je nejnovější verze služby, která je kompatibilní s aktuální sadou SDK. Nastavení na starší verzi může mít za následek snížení kompatibility funkcí.
Metody
close | |
create_queue |
Vytvořte frontu. |
create_rule |
Vytvořte pravidlo pro odběr tématu. |
create_subscription |
Vytvořte odběr tématu. |
create_topic |
Vytvořte téma. |
delete_queue |
Odstranění fronty |
delete_rule |
Odstraňte pravidlo odběru tématu. |
delete_subscription |
Odstranění předplatného tématu |
delete_topic |
Odstranění tématu |
from_connection_string |
Vytvořte klienta z připojovacího řetězce. |
get_namespace_properties |
Získání vlastností oboru názvů |
get_queue |
Získání vlastností fronty |
get_queue_runtime_properties |
Získejte informace o modulu runtime fronty. |
get_rule |
Získejte vlastnosti pravidla předplatného tématu. |
get_subscription |
Získání vlastností předplatného tématu |
get_subscription_runtime_properties |
Získejte informace o modulu runtime předplatného tématu. |
get_topic |
Získejte vlastnosti tématu. |
get_topic_runtime_properties |
Získejte informace o modulu runtime tématu. |
list_queues |
Vypíše fronty oboru názvů ServiceBus. |
list_queues_runtime_properties |
Vypište informace o modulu runtime front v oboru názvů ServiceBus. |
list_rules |
Vypište pravidla předplatného tématu. |
list_subscriptions |
Vypište předplatná tématu ServiceBus. |
list_subscriptions_runtime_properties |
Vypište informace o modulu runtime předplatných v tématu ServiceBus. |
list_topics |
Vypište témata oboru názvů ServiceBus. |
list_topics_runtime_properties |
Vypište informace o modulu runtime témat oboru názvů ServiceBus. |
update_queue |
Aktualizujte frontu. Před voláním této metody byste měli použít get_queue, create_queue nebo list_queues k získání instance QueueProperties a pak aktualizovat vlastnosti. Aktualizovat lze pouze část vlastností. Projděte si https://docs.microsoft.com/en-us/rest/api/servicebus/update-queuetéma . Můžete také předat argumenty klíčových slov pro aktualizaci vlastností ve formě <property_name>=<property_value> , které přepíšou vše, co bylo zadáno v instanci QueueProperties . Názvy vlastností najdete v tématu ~azure.servicebus.management.QueueProperties. |
update_rule |
Aktualizujte pravidlo. Před voláním této metody byste měli použít get_rule, create_rule nebo list_rules získat instanci RuleProperties a pak aktualizovat vlastnosti. Můžete také předat argumenty klíčových slov pro aktualizaci vlastností ve formě <property_name>=<property_value> , které přepíší vše, co bylo zadáno v instanci RuleProperties . Názvy vlastností najdete v tématu ~azure.servicebus.management.RuleProperties. |
update_subscription |
Aktualizace předplatného Před voláním této metody byste měli použít get_subscription, update_subscription nebo list_subscription k získání instance SubscriptionProperties a pak aktualizovat vlastnosti. Můžete také předat argumenty klíčových slov pro aktualizaci vlastností ve formě <property_name>=<property_value> , které přepíší vše, co bylo zadáno v instanci SubscriptionProperties . Názvy vlastností najdete v tématu ~azure.servicebus.management.SubscriptionProperties. |
update_topic |
Aktualizujte téma. Před voláním této metody byste měli použít get_topic, create_topic nebo list_topics k získání instance TopicProperties a pak aktualizovat vlastnosti. Aktualizovat lze pouze část vlastností. Projděte si https://docs.microsoft.com/en-us/rest/api/servicebus/update-topictéma . Můžete také předat argumenty klíčových slov pro aktualizaci vlastností ve formě <property_name>=<property_value> , které přepíší vše, co bylo zadáno v instanci TopicProperties . Názvy vlastností najdete v tématu ~azure.servicebus.management.TopicProperties. |
close
close() -> None
create_queue
Vytvořte frontu.
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
Parametry
- authorization_rules
- list[AuthorizationRule]
Autorizační pravidla pro prostředek.
Interval nečinnosti podle iso 8601 timeSpan, po jehož uplynutí je fronta automaticky odstraněna. Minimální doba trvání je 5 minut. Přijímá se vstupní hodnota typu ~datetime.timedelta nebo řetězec ve formátu doby trvání ISO 8601, například "PT300S".
- dead_lettering_on_message_expiration
- bool
Hodnota, která určuje, jestli má tato fronta podporu nedoručených zpráv, když vyprší platnost zprávy.
Výchozí časový rozsah zprávy ISO 8601 na živou hodnotu. Toto je doba, po které zpráva vyprší, počínaje odesláním zprávy do služby Service Bus. Toto je výchozí hodnota použitá v případě, že timeToLive není nastaven pro samotnou zprávu. Přijímá se vstupní hodnota typu ~datetime.timedelta nebo řetězec ve formátu doby trvání ISO 8601, například "PT300S".
Iso 8601 timeSpan struktura, která definuje dobu trvání historie detekce duplicit. Výchozí hodnota je 10 minut. Přijímá se vstupní hodnota typu ~datetime.timedelta nebo řetězec ve formátu doby trvání ISO 8601, například "PT300S".
- enable_batched_operations
- bool
Hodnota označující, jestli jsou povolené dávkové operace na straně serveru.
- enable_express
- bool
Hodnota, která označuje, jestli jsou povolené expresní entity. Expresní fronta dočasně uchovává zprávu v paměti, než ji zapíše do trvalého úložiště.
- enable_partitioning
- bool
Hodnota, která určuje, zda má být fronta rozdělena mezi více zprostředkovatelů zpráv.
Doba trvání časového rozsahu iso 8601 peek-lock; to znamená dobu, po kterou je zpráva uzamčena pro ostatní příjemce. Maximální hodnota pro LockDuration je 5 minut; výchozí hodnota je 1 minuta. Přijímá se vstupní hodnota typu ~datetime.timedelta nebo řetězec ve formátu doby trvání ISO 8601, například "PT300S".
- max_delivery_count
- int
Maximální počet doručení. Zpráva se po tomto počtu doručení automaticky nedoručí. Výchozí hodnota je 10.
- max_size_in_megabytes
- int
Maximální velikost fronty v megabajtech, což je velikost paměti přidělené frontě.
- requires_duplicate_detection
- bool
Hodnota označující, jestli tato fronta vyžaduje detekci duplicit.
- requires_session
- bool
Hodnota, která označuje, jestli fronta podporuje koncept relací.
- forward_to
- str
Název entity příjemce, které se přeposílají všechny zprávy odeslané do fronty.
- user_metadata
- str
Vlastní metdata, která může uživatel přidružit k popisu. Maximální délka je 1024 znaků.
- forward_dead_lettered_messages_to
- str
Název entity příjemce, na kterou se přeposílají všechny nedoručené zprávy tohoto odběru.
- max_message_size_in_kilobytes
- int
Maximální velikost datové části zprávy v kilobajtech, kterou může fronta přijmout. Tato funkce je dostupná jenom při použití oboru názvů Premium a rozhraní API služby Service Bus verze 2021-05 nebo vyšší. Minimální povolená hodnota je 1024, zatímco maximální povolená hodnota je 102400. Výchozí hodnota je 1024.
Návratový typ
create_rule
Vytvořte pravidlo pro odběr tématu.
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
Parametry
- filter
- Union[CorrelationRuleFilter, SqlRuleFilter]
Filtr pravidla. Výchozí hodnota je ~azure.servicebus.management.TrueRuleFilter.
- action
- Optional[SqlRuleAction]
Akce pravidla
Návratový typ
create_subscription
Vytvořte odběr tématu.
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
Parametry
Doba trvání časového rozsahu iso 8601 peek-lock; to znamená dobu, po kterou je zpráva uzamčena pro ostatní příjemce. Maximální hodnota pro LockDuration je 5 minut; výchozí hodnota je 1 minuta. Přijímá se vstupní hodnota typu ~datetime.timedelta nebo řetězec ve formátu doby trvání ISO 8601, například "PT300S".
- requires_session
- bool
Hodnota, která označuje, jestli fronta podporuje koncept relací.
Výchozí časový rozsah zprávy ISO 8601 na živou hodnotu. Toto je doba, po které zpráva vyprší, počínaje odesláním zprávy do služby Service Bus. Toto je výchozí hodnota použitá v případě, že timeToLive není nastaven pro samotnou zprávu. Přijímá se vstupní hodnota typu ~datetime.timedelta nebo řetězec ve formátu doby trvání ISO 8601, například "PT300S".
- dead_lettering_on_message_expiration
- bool
Hodnota, která určuje, jestli má tento odběr podporu nedoručených zpráv, když vyprší platnost zprávy.
- dead_lettering_on_filter_evaluation_exceptions
- bool
Hodnota, která určuje, jestli má tento odběr podporu nedoručených zpráv, když vyprší platnost zprávy.
- max_delivery_count
- int
Maximální počet doručení. Zpráva se po tomto počtu doručení automaticky nedoručí. Výchozí hodnota je 10.
- enable_batched_operations
- bool
Hodnota označující, jestli jsou povolené dávkové operace na straně serveru.
- forward_to
- str
Název entity příjemce, které se přeposílají všechny zprávy odeslané do odběru.
- user_metadata
- str
Metadata přidružená k předplatnému Maximální počet znaků je 1024.
- forward_dead_lettered_messages_to
- str
Název entity příjemce, které se přeposílají všechny zprávy odeslané do odběru.
Interval nečinnosti podle iso 8601 timeSpan, po jehož uplynutí se odběr automaticky odstraní. Minimální doba trvání je 5 minut. Přijímá se vstupní hodnota typu ~datetime.timedelta nebo řetězec ve formátu doby trvání ISO 8601, například "PT300S".
Návratový typ
create_topic
Vytvořte téma.
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
Parametry
Výchozí časový rozsah zprávy ISO 8601 na živou hodnotu. Toto je doba, po které zpráva vyprší, počínaje odesláním zprávy do služby Service Bus. Toto je výchozí hodnota použitá v případě, že timeToLive není nastaven pro samotnou zprávu. Přijímá se vstupní hodnota typu ~datetime.timedelta nebo řetězec ve formátu doby trvání ISO 8601, například "PT300S".
- max_size_in_megabytes
- int
Maximální velikost tématu v megabajtech, což je velikost paměti přidělené tématu.
- requires_duplicate_detection
- bool
Hodnota označující, jestli toto téma vyžaduje detekci duplicit.
Iso 8601 timeSpan struktura, která definuje dobu trvání historie detekce duplicit. Výchozí hodnota je 10 minut. Přijímá se vstupní hodnota typu ~datetime.timedelta nebo řetězec ve formátu doby trvání ISO 8601, například "PT300S".
- enable_batched_operations
- bool
Hodnota označující, jestli jsou povolené dávkové operace na straně serveru.
- size_in_bytes
- int
Velikost tématu v bajtech
- filtering_messages_before_publishing
- bool
Před publikováním můžete filtrovat zprávy.
- authorization_rules
- list[AuthorizationRule]
Autorizační pravidla pro prostředek.
- support_ordering
- bool
Hodnota, která označuje, zda téma podporuje řazení.
Iso 8601 timeSpan interval nečinnosti, po jehož uplynutí je téma automaticky odstraněno. Minimální doba trvání je 5 minut. Přijímá se vstupní hodnota typu ~datetime.timedelta nebo řetězec ve formátu doby trvání ISO 8601, například "PT300S".
- enable_partitioning
- bool
Hodnota, která označuje, zda má být téma rozděleno mezi více zprostředkovatelů zpráv.
- enable_express
- bool
Hodnota, která označuje, jestli jsou povolené expresní entity. Expresní fronta dočasně uchovává zprávu v paměti, než ji zapíše do trvalého úložiště.
- user_metadata
- str
Metadata přidružená k tématu.
- max_message_size_in_kilobytes
- int
Maximální velikost datové části zprávy v kilobajtech, kterou může fronta přijmout. Tato funkce je dostupná jenom při použití oboru názvů Premium a rozhraní API služby Service Bus verze 2021-05 nebo vyšší. Minimální povolená hodnota je 1024, zatímco maximální povolená hodnota je 102400. Výchozí hodnota je 1024.
Návratový typ
delete_queue
Odstranění fronty
delete_queue(queue_name: str, **kwargs: Any) -> None
Parametry
Návratový typ
delete_rule
Odstraňte pravidlo odběru tématu.
delete_rule(topic_name: str, subscription_name: str, rule_name: str, **kwargs: Any) -> None
Parametry
Návratový typ
delete_subscription
Odstranění předplatného tématu
delete_subscription(topic_name: str, subscription_name: str, **kwargs: Any) -> None
Parametry
Návratový typ
delete_topic
Odstranění tématu
delete_topic(topic_name: str, **kwargs: Any) -> None
Parametry
Návratový typ
from_connection_string
Vytvořte klienta z připojovacího řetězce.
from_connection_string(conn_str: str, *, api_version: str | ApiVersion = ApiVersion.V2021_05, **kwargs: Any) -> ServiceBusAdministrationClient
Parametry
- api_version
- str nebo ApiVersion
Verze rozhraní API služby Service Bus, která se má použít pro požadavky. Výchozí hodnota je nejnovější verze služby, která je kompatibilní s aktuální sadou SDK. Nastavení na starší verzi může mít za následek snížení kompatibility funkcí.
Návratový typ
get_namespace_properties
Získání vlastností oboru názvů
get_namespace_properties(**kwargs: Any) -> NamespaceProperties
Návraty
Vlastnosti oboru názvů.
Návratový typ
get_queue
Získání vlastností fronty
get_queue(queue_name: str, **kwargs: Any) -> QueueProperties
Parametry
Návraty
Vlastnosti fronty.
Návratový typ
get_queue_runtime_properties
Získejte informace o modulu runtime fronty.
get_queue_runtime_properties(queue_name: str, **kwargs: Any) -> QueueRuntimeProperties
Parametry
Návraty
Informace o modulu runtime fronty.
Návratový typ
get_rule
Získejte vlastnosti pravidla předplatného tématu.
get_rule(topic_name: str, subscription_name: str, rule_name: str, **kwargs: Any) -> RuleProperties
Parametry
Návraty
Vlastnosti zadaného pravidla.
Návratový typ
get_subscription
Získání vlastností předplatného tématu
get_subscription(topic_name: str, subscription_name: str, **kwargs: Any) -> SubscriptionProperties
Parametry
Návraty
An instance of SubscriptionProperties
Návratový typ
get_subscription_runtime_properties
Získejte informace o modulu runtime předplatného tématu.
get_subscription_runtime_properties(topic_name: str, subscription_name: str, **kwargs: Any) -> SubscriptionRuntimeProperties
Parametry
Návraty
An instance of SubscriptionRuntimeProperties
Návratový typ
get_topic
Získejte vlastnosti tématu.
get_topic(topic_name: str, **kwargs: Any) -> TopicProperties
Parametry
Návraty
Vlastnosti tématu.
Návratový typ
get_topic_runtime_properties
Získejte informace o modulu runtime tématu.
get_topic_runtime_properties(topic_name: str, **kwargs: Any) -> TopicRuntimeProperties
Parametry
Návraty
Informace o modulu runtime tématu.
Návratový typ
list_queues
Vypíše fronty oboru názvů ServiceBus.
list_queues(**kwargs: Any) -> ItemPaged[QueueProperties]
Návraty
Iterovatelná (automaticky stránkovací) odpověď QueueProperties.
Návratový typ
list_queues_runtime_properties
Vypište informace o modulu runtime front v oboru názvů ServiceBus.
list_queues_runtime_properties(**kwargs: Any) -> ItemPaged[QueueRuntimeProperties]
Návraty
Iterovatelná (automaticky stránkovací) odpověď QueueRuntimeProperties.
Návratový typ
list_rules
Vypište pravidla předplatného tématu.
list_rules(topic_name: str, subscription_name: str, **kwargs: Any) -> ItemPaged[RuleProperties]
Parametry
Návraty
Iterovatelná (automaticky stránkovací) odpověď RuleVlastnosti.
Návratový typ
list_subscriptions
Vypište předplatná tématu ServiceBus.
list_subscriptions(topic_name: str, **kwargs: Any) -> ItemPaged[SubscriptionProperties]
Parametry
Návraty
Iterovatelná (automaticky stránkovací) odpověď subscriptionVlastnosti.
Návratový typ
list_subscriptions_runtime_properties
Vypište informace o modulu runtime předplatných v tématu ServiceBus.
list_subscriptions_runtime_properties(topic_name: str, **kwargs: Any) -> ItemPaged[SubscriptionRuntimeProperties]
Parametry
Návraty
Iterovatelná (automaticky stránkovací) odpověď SubscriptionRuntimeProperties.
Návratový typ
list_topics
Vypište témata oboru názvů ServiceBus.
list_topics(**kwargs: Any) -> ItemPaged[TopicProperties]
Návraty
Iterable (auto-stránkování) odpověď TopicVlastnosti.
Návratový typ
list_topics_runtime_properties
Vypište informace o modulu runtime témat oboru názvů ServiceBus.
list_topics_runtime_properties(**kwargs: Any) -> ItemPaged[TopicRuntimeProperties]
Návraty
Iterable (auto-stránkování) odpověď TopicRuntimeProperties.
Návratový typ
update_queue
Aktualizujte frontu.
Před voláním této metody byste měli použít get_queue, create_queue nebo list_queues k získání instance QueueProperties a pak aktualizovat vlastnosti. Aktualizovat lze pouze část vlastností. Projděte si https://docs.microsoft.com/en-us/rest/api/servicebus/update-queuetéma . Můžete také předat argumenty klíčových slov pro aktualizaci vlastností ve formě <property_name>=<property_value> , které přepíšou vše, co bylo zadáno v instanci QueueProperties . Názvy vlastností najdete v tématu ~azure.servicebus.management.QueueProperties.
update_queue(queue: QueueProperties | Mapping[str, Any], **kwargs: Any) -> None
Parametry
- queue
- QueueProperties
Fronta vrácená z get_queue, create_queue nebo list_queues a má aktualizované vlastnosti.
Návratový typ
update_rule
Aktualizujte pravidlo.
Před voláním této metody byste měli použít get_rule, create_rule nebo list_rules získat instanci RuleProperties a pak aktualizovat vlastnosti. Můžete také předat argumenty klíčových slov pro aktualizaci vlastností ve formě <property_name>=<property_value> , které přepíší vše, co bylo zadáno v instanci RuleProperties . Názvy vlastností najdete v tématu ~azure.servicebus.management.RuleProperties.
update_rule(topic_name: str, subscription_name: str, rule: RuleProperties | Mapping[str, Any], **kwargs: Any) -> None
Parametry
- rule
- RuleProperties
Pravidlo, které je vráceno z get_rule, create_rule nebo list_rules a má aktualizované vlastnosti.
Návratový typ
update_subscription
Aktualizace předplatného
Před voláním této metody byste měli použít get_subscription, update_subscription nebo list_subscription k získání instance SubscriptionProperties a pak aktualizovat vlastnosti. Můžete také předat argumenty klíčových slov pro aktualizaci vlastností ve formě <property_name>=<property_value> , které přepíší vše, co bylo zadáno v instanci SubscriptionProperties . Názvy vlastností najdete v tématu ~azure.servicebus.management.SubscriptionProperties.
update_subscription(topic_name: str, subscription: SubscriptionProperties | Mapping[str, Any], **kwargs: Any) -> None
Parametry
- subscription
- SubscriptionProperties
Předplatné, které se vrací z get_subscription, update_subscription nebo list_subscription a má aktualizované vlastnosti.
Návratový typ
update_topic
Aktualizujte téma.
Před voláním této metody byste měli použít get_topic, create_topic nebo list_topics k získání instance TopicProperties a pak aktualizovat vlastnosti. Aktualizovat lze pouze část vlastností. Projděte si https://docs.microsoft.com/en-us/rest/api/servicebus/update-topictéma . Můžete také předat argumenty klíčových slov pro aktualizaci vlastností ve formě <property_name>=<property_value> , které přepíší vše, co bylo zadáno v instanci TopicProperties . Názvy vlastností najdete v tématu ~azure.servicebus.management.TopicProperties.
update_topic(topic: TopicProperties | Mapping[str, Any], **kwargs: Any) -> None
Parametry
- topic
- TopicProperties
Téma, které je vráceno z get_topic, create_topic nebo list_topics a obsahuje aktualizované vlastnosti.
Návratový typ
Azure SDK for Python
Váš názor
https://aka.ms/ContentUserFeedback.
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu:Odeslat a zobrazit názory pro