ServiceBusAdministrationClient クラス
このクライアントを使用して、ServiceBus 名前空間のリソースを作成、更新、一覧表示、および削除します。
- 継承
-
builtins.objectServiceBusAdministrationClient
コンストラクター
ServiceBusAdministrationClient(fully_qualified_namespace: str, credential: TokenCredential, *, api_version: str | ApiVersion = ApiVersion.V2021_05, **kwargs: Any)
パラメーター
- credential
- <xref:TokenCredential>
ServiceBus 名前空間のエンティティを管理するための認証。
- api_version
- str または ApiVersion
要求に使用する Service Bus API バージョン。 既定値は、現在の SDK と互換性のある最新のサービス バージョンです。 古いバージョンに設定すると、機能の互換性が低下する可能性があります。
メソッド
close | |
create_queue |
キューを作成します。 |
create_rule |
トピック サブスクリプションのルールを作成します。 |
create_subscription |
トピック サブスクリプションを作成します。 |
create_topic |
トピックを作成します。 |
delete_queue |
キューを削除します。 |
delete_rule |
トピックサブスクリプションルールを削除します。 |
delete_subscription |
トピック サブスクリプションを削除します。 |
delete_topic |
トピックを削除します。 |
from_connection_string |
接続文字列からクライアントを作成します。 |
get_namespace_properties |
名前空間のプロパティを取得する |
get_queue |
キューのプロパティを取得します。 |
get_queue_runtime_properties |
キューのランタイム情報を取得します。 |
get_rule |
トピック サブスクリプション ルールのプロパティを取得します。 |
get_subscription |
トピック サブスクリプションのプロパティを取得します。 |
get_subscription_runtime_properties |
トピック サブスクリプションランタイム情報を取得します。 |
get_topic |
トピックのプロパティを取得します。 |
get_topic_runtime_properties |
トピックのランタイム情報を取得します。 |
list_queues |
ServiceBus 名前空間のキューを一覧表示します。 |
list_queues_runtime_properties |
ServiceBus 名前空間内のキューのランタイム情報を一覧表示します。 |
list_rules |
トピック サブスクリプションのルールを一覧表示します。 |
list_subscriptions |
ServiceBus トピックのサブスクリプションを一覧表示します。 |
list_subscriptions_runtime_properties |
ServiceBus トピックのサブスクリプション ランタイム情報を一覧表示します。 |
list_topics |
ServiceBus 名前空間のトピックを一覧表示します。 |
list_topics_runtime_properties |
ServiceBus 名前空間のトピック ランタイム情報を一覧表示します。 |
update_queue |
キューを更新します。 このメソッドを呼び出す前に、 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_rule |
ルールを更新します。 このメソッドを呼び出す前に、 get_rule、 create_rule 、または list_rules を使用して RuleProperties インスタンスを取得し、プロパティを更新する必要があります。 また、キーワード (keyword)引数を渡してプロパティをproperty_name=<property_value>>形式<で更新することもできます。この引数は、RuleProperties インスタンスで指定されたものをオーバーライドします。 プロパティの名前については、~azure.servicebus.management.RuleProperties を参照してください。 |
update_subscription |
サブスクリプションを更新します。 このメソッドを呼び出す前に、 get_subscription、 update_subscription 、または list_subscription を使用して SubscriptionProperties インスタンスを取得し、プロパティを更新する必要があります。 SubscriptionProperties インスタンスで指定されたものをオーバーライドするproperty_name=<property_value>の<形式でプロパティを>更新するためのキーワード (keyword)引数を渡すこともできます。 プロパティの名前については、~azure.servicebus.management.SubscriptionProperties を参照してください。 |
update_topic |
トピックを更新します。 このメソッドを呼び出す前に、 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 を参照してください。 |
close
close() -> None
create_queue
キューを作成します。
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
パラメーター
- authorization_rules
- list[AuthorizationRule]
リソースの承認規則。
ISO 8601 timeSpan アイドル間隔の後、キューが自動的に削除されます。 最小時間は、5 分です。 ~datetime.timedelta 型または "PT300S" のような ISO 8601 期間形式の文字列の入力値が受け入れられます。
- dead_lettering_on_message_expiration
- bool
メッセージの有効期限が切れたときに、このキューに配信不能のサポートがあるかどうかを示す 値。
ISO 8601 の既定のメッセージの期間はライブ値です。 これは、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。 これは、メッセージ自体に TimeToLive が設定されていない場合に使用される既定値です。 ~datetime.timedelta 型または "PT300S" のような ISO 8601 期間形式の文字列の入力値が受け入れられます。
重複検出履歴の期間を定義する ISO 8601 timeSpan 構造体。 既定値は 10 分です。 ~datetime.timedelta 型または "PT300S" のような ISO 8601 期間形式の文字列の入力値が受け入れられます。
- enable_batched_operations
- bool
サーバー側のバッチ処理操作が有効かどうかを示す値。
- enable_express
- bool
Express Entities が有効かどうかを示す値。 高速キューは、永続ストレージに書き込む前に、メッセージを一時的にメモリーに保持します。
- enable_partitioning
- bool
キューを複数のメッセージ ブローカー間でパーティション分割するかどうかを示す 値。
ピークロックの ISO 8601 期間;つまり、メッセージが他の受信者に対してロックされている時間です。 LockDuration の最大値は 5 分です。既定値は 1 分です。 ~datetime.timedelta 型または "PT300S" のような ISO 8601 期間形式の文字列の入力値が受け入れられます。
- max_delivery_count
- int
最大配信数。 この配信数を越えた後のメッセージは自動的に配信不能になります。 既定値は 10 です。
- max_size_in_megabytes
- int
キューの最大サイズ (メガバイト単位)。 これは、キューに割り当てられたメモリのサイズです。
- requires_duplicate_detection
- bool
このキューに重複検出が必要かどうかを示す値。
- requires_session
- bool
キューがセッションの概念をサポートしているかどうかを示す 値。
- forward_to
- str
キューに送信されるすべてのメッセージの転送先となる受信者エンティティの名前。
- user_metadata
- str
ユーザーが説明に関連付けることができるカスタム metdata。 最大長は 1024 文字です。
- forward_dead_lettered_messages_to
- str
このサブスクリプションのすべての配信不能メッセージの転送先となる受信者エンティティの名前。
- max_message_size_in_kilobytes
- int
キューで受け入れられるメッセージ ペイロードの最大サイズ (キロバイト)。 この機能は、Premium 名前空間と Service Bus API バージョン "2021-05" 以降を使用している場合にのみ使用できます。 最小値は 1024 で、最大値は 102400 です。 既定値は 1024 です。
の戻り値の型 :
create_rule
トピック サブスクリプションのルールを作成します。
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
パラメーター
- filter
- Union[CorrelationRuleFilter, SqlRuleFilter]
ルールのフィルター。 既定値は ~azure.servicebus.management.TrueRuleFilter です
- action
- Optional[SqlRuleAction]
ルールのアクション。
の戻り値の型 :
create_subscription
トピック サブスクリプションを作成します。
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
パラメーター
ピークロックの ISO 8601 期間;つまり、メッセージが他の受信者に対してロックされている時間です。 LockDuration の最大値は 5 分です。既定値は 1 分です。 ~datetime.timedelta 型または "PT300S" のような ISO 8601 期間形式の文字列の入力値が受け入れられます。
- requires_session
- bool
キューがセッションの概念をサポートしているかどうかを示す 値。
ISO 8601 の既定のメッセージの期間はライブ値です。 これは、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。 これは、メッセージ自体に TimeToLive が設定されていない場合に使用される既定値です。 ~datetime.timedelta 型または "PT300S" のような ISO 8601 期間形式の文字列の入力値が受け入れられます。
- dead_lettering_on_message_expiration
- bool
メッセージの有効期限が切れたときに、このサブスクリプションに配信不能サポートがあるかどうかを示す 値。
- dead_lettering_on_filter_evaluation_exceptions
- bool
メッセージの有効期限が切れたときに、このサブスクリプションに配信不能サポートがあるかどうかを示す 値。
- max_delivery_count
- int
最大配信数。 この配信数を越えた後のメッセージは自動的に配信不能になります。 既定値は 10 です。
- enable_batched_operations
- bool
サーバー側のバッチ処理操作が有効かどうかを示す値。
- forward_to
- str
サブスクリプションに送信されたすべてのメッセージの転送先となる受信者エンティティの名前。
- user_metadata
- str
サブスクリプションに関連付けられているメタデータ。 最大文字数は 1024 文字です。
- forward_dead_lettered_messages_to
- str
サブスクリプションに送信されたすべてのメッセージの転送先となる受信者エンティティの名前。
ISO 8601 timeSpan アイドル間隔。その後、サブスクリプションが自動的に削除されます。 最小時間は、5 分です。 ~datetime.timedelta 型または "PT300S" のような ISO 8601 期間形式の文字列の入力値が受け入れられます。
の戻り値の型 :
create_topic
トピックを作成します。
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
パラメーター
ISO 8601 の既定のメッセージの期間はライブ値です。 これは、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。 これは、メッセージ自体に TimeToLive が設定されていない場合に使用される既定値です。 ~datetime.timedelta 型または "PT300S" のような ISO 8601 期間形式の文字列の入力値が受け入れられます。
- max_size_in_megabytes
- int
トピックの最大サイズ (メガバイト単位)。 これは、トピックに割り当てられたメモリのサイズです。
- requires_duplicate_detection
- bool
このトピックで重複検出が必要かどうかを示す値。
重複検出履歴の期間を定義する ISO 8601 timeSpan 構造体。 既定値は 10 分です。 ~datetime.timedelta 型または "PT300S" のような ISO 8601 期間形式の文字列の入力値が受け入れられます。
- enable_batched_operations
- bool
サーバー側のバッチ処理操作が有効かどうかを示す値。
- size_in_bytes
- int
トピックのサイズ (バイト単位)。
- filtering_messages_before_publishing
- bool
発行する前にメッセージをフィルター処理します。
- authorization_rules
- list[AuthorizationRule]
リソースの承認規則。
- support_ordering
- bool
トピックが順序付けをサポートしているかどうかを示す 値。
ISO 8601 timeSpan アイドル間隔以降、トピックは自動的に削除されます。 最小時間は、5 分です。 ~datetime.timedelta 型または "PT300S" のような ISO 8601 期間形式の文字列の入力値が受け入れられます。
- enable_partitioning
- bool
トピックを複数のメッセージ ブローカー間でパーティション分割するかどうかを示す 値。
- enable_express
- bool
Express Entities が有効かどうかを示す値。 高速キューは、永続ストレージに書き込む前に、メッセージを一時的にメモリーに保持します。
- user_metadata
- str
トピックに関連付けられているメタデータ。
- max_message_size_in_kilobytes
- int
キューで受け入れられるメッセージ ペイロードの最大サイズ (キロバイト)。 この機能は、Premium 名前空間と Service Bus API バージョン "2021-05" 以降を使用している場合にのみ使用できます。 最小値は 1024 で、最大値は 102400 です。 既定値は 1024 です。
の戻り値の型 :
delete_queue
キューを削除します。
delete_queue(queue_name: str, **kwargs: Any) -> None
パラメーター
の戻り値の型 :
delete_rule
トピックサブスクリプションルールを削除します。
delete_rule(topic_name: str, subscription_name: str, rule_name: str, **kwargs: Any) -> None
パラメーター
の戻り値の型 :
delete_subscription
トピック サブスクリプションを削除します。
delete_subscription(topic_name: str, subscription_name: str, **kwargs: Any) -> None
パラメーター
の戻り値の型 :
delete_topic
トピックを削除します。
delete_topic(topic_name: str, **kwargs: Any) -> None
パラメーター
の戻り値の型 :
from_connection_string
接続文字列からクライアントを作成します。
from_connection_string(conn_str: str, *, api_version: str | ApiVersion = ApiVersion.V2021_05, **kwargs: Any) -> ServiceBusAdministrationClient
パラメーター
- api_version
- str または ApiVersion
要求に使用する Service Bus API バージョン。 既定値は、現在の SDK と互換性のある最新のサービス バージョンです。 古いバージョンに設定すると、機能の互換性が低下する可能性があります。
の戻り値の型 :
get_namespace_properties
名前空間のプロパティを取得する
get_namespace_properties(**kwargs: Any) -> NamespaceProperties
戻り値
名前空間のプロパティ。
の戻り値の型 :
get_queue
キューのプロパティを取得します。
get_queue(queue_name: str, **kwargs: Any) -> QueueProperties
パラメーター
戻り値
キューのプロパティ。
の戻り値の型 :
get_queue_runtime_properties
キューのランタイム情報を取得します。
get_queue_runtime_properties(queue_name: str, **kwargs: Any) -> QueueRuntimeProperties
パラメーター
戻り値
キューのランタイム情報。
の戻り値の型 :
get_rule
トピック サブスクリプション ルールのプロパティを取得します。
get_rule(topic_name: str, subscription_name: str, rule_name: str, **kwargs: Any) -> RuleProperties
パラメーター
戻り値
指定した規則のプロパティ。
の戻り値の型 :
get_subscription
トピック サブスクリプションのプロパティを取得します。
get_subscription(topic_name: str, subscription_name: str, **kwargs: Any) -> SubscriptionProperties
パラメーター
戻り値
SubscriptionProperties のインスタンス
の戻り値の型 :
get_subscription_runtime_properties
トピック サブスクリプションランタイム情報を取得します。
get_subscription_runtime_properties(topic_name: str, subscription_name: str, **kwargs: Any) -> SubscriptionRuntimeProperties
パラメーター
戻り値
SubscriptionRuntimeProperties のインスタンス
の戻り値の型 :
get_topic
トピックのプロパティを取得します。
get_topic(topic_name: str, **kwargs: Any) -> TopicProperties
パラメーター
戻り値
トピックのプロパティ。
の戻り値の型 :
get_topic_runtime_properties
トピックのランタイム情報を取得します。
get_topic_runtime_properties(topic_name: str, **kwargs: Any) -> TopicRuntimeProperties
パラメーター
戻り値
トピックのランタイム情報。
の戻り値の型 :
list_queues
ServiceBus 名前空間のキューを一覧表示します。
list_queues(**kwargs: Any) -> ItemPaged[QueueProperties]
戻り値
QueueProperties の iterable (自動ページング) 応答。
の戻り値の型 :
list_queues_runtime_properties
ServiceBus 名前空間内のキューのランタイム情報を一覧表示します。
list_queues_runtime_properties(**kwargs: Any) -> ItemPaged[QueueRuntimeProperties]
戻り値
QueueRuntimeProperties の iterable (自動ページング) 応答。
の戻り値の型 :
list_rules
トピック サブスクリプションのルールを一覧表示します。
list_rules(topic_name: str, subscription_name: str, **kwargs: Any) -> ItemPaged[RuleProperties]
パラメーター
戻り値
RuleProperties の iterable (自動ページング) 応答。
の戻り値の型 :
list_subscriptions
ServiceBus トピックのサブスクリプションを一覧表示します。
list_subscriptions(topic_name: str, **kwargs: Any) -> ItemPaged[SubscriptionProperties]
パラメーター
戻り値
SubscriptionProperties の iterable (自動ページング) 応答。
の戻り値の型 :
list_subscriptions_runtime_properties
ServiceBus トピックのサブスクリプション ランタイム情報を一覧表示します。
list_subscriptions_runtime_properties(topic_name: str, **kwargs: Any) -> ItemPaged[SubscriptionRuntimeProperties]
パラメーター
戻り値
SubscriptionRuntimeProperties の iterable (自動ページング) 応答。
の戻り値の型 :
list_topics
ServiceBus 名前空間のトピックを一覧表示します。
list_topics(**kwargs: Any) -> ItemPaged[TopicProperties]
戻り値
TopicProperties の iterable (自動ページング) 応答。
の戻り値の型 :
list_topics_runtime_properties
ServiceBus 名前空間のトピック ランタイム情報を一覧表示します。
list_topics_runtime_properties(**kwargs: Any) -> ItemPaged[TopicRuntimeProperties]
戻り値
TopicRuntimeProperties の iterable (自動ページング) 応答。
の戻り値の型 :
update_queue
キューを更新します。
このメソッドを呼び出す前に、 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
パラメーター
の戻り値の型 :
update_rule
ルールを更新します。
このメソッドを呼び出す前に、 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
パラメーター
の戻り値の型 :
update_subscription
サブスクリプションを更新します。
このメソッドを呼び出す前に、 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
パラメーター
- subscription
- SubscriptionProperties
get_subscription、update_subscription、またはlist_subscriptionから返され、更新されたプロパティを持つサブスクリプション。
の戻り値の型 :
update_topic
トピックを更新します。
このメソッドを呼び出す前に、 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
パラメーター
の戻り値の型 :
Azure SDK for Python