ServiceBusAdministrationClient クラス

close() -> None

キューを作成します。

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

パラメーター

の戻り値の型 :

トピック サブスクリプションのルールを作成します。

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

パラメーター

の戻り値の型 :

トピック サブスクリプションを作成します。

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

パラメーター

の戻り値の型 :

トピックを作成します。

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

パラメーター

の戻り値の型 :

キューを削除します。

delete_queue(queue_name: str, **kwargs: Any) -> None

パラメーター

の戻り値の型 :

トピックサブスクリプションルールを削除します。

delete_rule(topic_name: str, subscription_name: str, rule_name: str, **kwargs: Any) -> None

パラメーター

の戻り値の型 :

トピック サブスクリプションを削除します。

delete_subscription(topic_name: str, subscription_name: str, **kwargs: Any) -> None

パラメーター

の戻り値の型 :

トピックを削除します。

delete_topic(topic_name: str, **kwargs: Any) -> None

パラメーター

の戻り値の型 :

接続文字列からクライアントを作成します。

from_connection_string(conn_str: str, *, api_version: str | ApiVersion = ApiVersion.V2021_05, **kwargs: Any) -> ServiceBusAdministrationClient

パラメーター

の戻り値の型 :

名前空間のプロパティを取得する

get_namespace_properties(**kwargs: Any) -> NamespaceProperties

戻り値

名前空間のプロパティ。

の戻り値の型 :

キューのプロパティを取得します。

get_queue(queue_name: str, **kwargs: Any) -> QueueProperties

パラメーター

戻り値

キューのプロパティ。

の戻り値の型 :

キューのランタイム情報を取得します。

get_queue_runtime_properties(queue_name: str, **kwargs: Any) -> QueueRuntimeProperties

パラメーター

戻り値

キューのランタイム情報。

の戻り値の型 :

トピック サブスクリプション ルールのプロパティを取得します。

get_rule(topic_name: str, subscription_name: str, rule_name: str, **kwargs: Any) -> RuleProperties

パラメーター

戻り値

指定した規則のプロパティ。

の戻り値の型 :

トピック サブスクリプションのプロパティを取得します。

get_subscription(topic_name: str, subscription_name: str, **kwargs: Any) -> SubscriptionProperties

パラメーター

戻り値

SubscriptionProperties のインスタンス

の戻り値の型 :

トピック サブスクリプションランタイム情報を取得します。

get_subscription_runtime_properties(topic_name: str, subscription_name: str, **kwargs: Any) -> SubscriptionRuntimeProperties

パラメーター

戻り値

SubscriptionRuntimeProperties のインスタンス

の戻り値の型 :

トピックのプロパティを取得します。

get_topic(topic_name: str, **kwargs: Any) -> TopicProperties

パラメーター

戻り値

トピックのプロパティ。

の戻り値の型 :

トピックのランタイム情報を取得します。

get_topic_runtime_properties(topic_name: str, **kwargs: Any) -> TopicRuntimeProperties

パラメーター

戻り値

トピックのランタイム情報。

の戻り値の型 :

ServiceBus 名前空間のキューを一覧表示します。

list_queues(**kwargs: Any) -> ItemPaged[QueueProperties]

戻り値

QueueProperties の iterable (自動ページング) 応答。

の戻り値の型 :

ServiceBus 名前空間内のキューのランタイム情報を一覧表示します。

list_queues_runtime_properties(**kwargs: Any) -> ItemPaged[QueueRuntimeProperties]

戻り値

QueueRuntimeProperties の iterable (自動ページング) 応答。

の戻り値の型 :

トピック サブスクリプションのルールを一覧表示します。

list_rules(topic_name: str, subscription_name: str, **kwargs: Any) -> ItemPaged[RuleProperties]

パラメーター

戻り値

RuleProperties の iterable (自動ページング) 応答。

の戻り値の型 :

ServiceBus トピックのサブスクリプションを一覧表示します。

list_subscriptions(topic_name: str, **kwargs: Any) -> ItemPaged[SubscriptionProperties]

パラメーター

戻り値

SubscriptionProperties の iterable (自動ページング) 応答。

の戻り値の型 :

ServiceBus トピックのサブスクリプション ランタイム情報を一覧表示します。

list_subscriptions_runtime_properties(topic_name: str, **kwargs: Any) -> ItemPaged[SubscriptionRuntimeProperties]

パラメーター

戻り値

SubscriptionRuntimeProperties の iterable (自動ページング) 応答。

の戻り値の型 :

ServiceBus 名前空間のトピックを一覧表示します。

list_topics(**kwargs: Any) -> ItemPaged[TopicProperties]

戻り値

TopicProperties の iterable (自動ページング) 応答。

の戻り値の型 :

ServiceBus 名前空間のトピック ランタイム情報を一覧表示します。

list_topics_runtime_properties(**kwargs: Any) -> ItemPaged[TopicRuntimeProperties]

戻り値

TopicRuntimeProperties の iterable (自動ページング) 応答。

の戻り値の型 :

キューを更新します。

このメソッドを呼び出す前に、 get_queue、 create_queue 、または list_queues を使用して QueueProperties インスタンスを取得し、プロパティを更新する必要があります。 プロパティの一部のみを更新できます。 [https://aka.ms/classiciaasmigrationfaqs](https://docs.microsoft.com/en-us/rest/api/servicebus/update-queue ) を参照してください。 また、queueProperties インスタンスで指定されたものをオーバーライドするproperty_name>=<property_value>の<形式でプロパティを更新するためのキーワード (keyword)引数を渡すこともできます。 プロパティの名前については、~azure.servicebus.management.QueueProperties を参照してください。

update_queue(queue: QueueProperties | Mapping[str, Any], **kwargs: Any) -> None

パラメーター

の戻り値の型 :

ルールを更新します。

このメソッドを呼び出す前に、 get_rule、 create_rule 、または list_rules を使用して RuleProperties インスタンスを取得し、プロパティを更新する必要があります。 また、キーワード (keyword)引数を渡してプロパティをproperty_name=<property_value>>形式<で更新することもできます。この引数は、RuleProperties インスタンスで指定されたものをオーバーライドします。 プロパティの名前については、~azure.servicebus.management.RuleProperties を参照してください。

update_rule(topic_name: str, subscription_name: str, rule: RuleProperties | Mapping[str, Any], **kwargs: Any) -> None

パラメーター

の戻り値の型 :

サブスクリプションを更新します。

このメソッドを呼び出す前に、 get_subscription、 update_subscription 、または list_subscription を使用して SubscriptionProperties インスタンスを取得し、プロパティを更新する必要があります。 SubscriptionProperties インスタンスで指定されたものをオーバーライドするproperty_name=<property_value>の<形式でプロパティを>更新するためのキーワード (keyword)引数を渡すこともできます。 プロパティの名前については、~azure.servicebus.management.SubscriptionProperties を参照してください。

update_subscription(topic_name: str, subscription: SubscriptionProperties | Mapping[str, Any], **kwargs: Any) -> None

パラメーター

の戻り値の型 :

トピックを更新します。

このメソッドを呼び出す前に、 get_topic、 create_topic 、または list_topics を使用して TopicProperties インスタンスを取得し、プロパティを更新する必要があります。 プロパティの一部のみを更新できます。 [https://aka.ms/classiciaasmigrationfaqs](https://docs.microsoft.com/en-us/rest/api/servicebus/update-topic ) を参照してください。 また、property_name=<>property_value の<形式でプロパティを更新するためのキーワード (keyword)>引数を渡すこともできます。この引数は、TopicProperties インスタンスで指定されたものをオーバーライドします。 プロパティの名前については、~azure.servicebus.management.TopicProperties を参照してください。

update_topic(topic: TopicProperties | Mapping[str, Any], **kwargs: Any) -> None

パラメーター

の戻り値の型 :