ServiceBusAdministrationClient 類別

使用此用戶端來建立、更新、列出和刪除 ServiceBus 命名空間的資源。

繼承

builtins.object

ServiceBusAdministrationClient

建構函式

ServiceBusAdministrationClient(fully_qualified_namespace: str, credential: TokenCredential, *, api_version: str | ApiVersion = ApiVersion.V2021_05, **kwargs: Any)

參數

fully_qualified_namespace

str

必要

服務匯流排命名空間的完整主機名稱。

credential

<xref:TokenCredential>

必要

若要驗證以管理 ServiceBus 命名空間的實體。

api_version

str 或 ApiVersion

要用於要求的服務匯流排 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://docs.microsoft.com/en-us/rest/api/servicebus/update-queue。 您也可以傳遞關鍵字引數，以property_name > = < property_value > 的形式 <更新屬性，這會覆寫QueueProperties實例中指定的任何內容。 如需屬性的名稱，請參閱 ~azure.servicebus.management.QueueProperties。
update_rule	更新規則。 呼叫此方法之前，您應該先使用 get_rule、 create_rule 或 list_rules 來取得 RuleProperties 實例，然後更新屬性。 您也可以傳遞關鍵字引數，以property_name > = < property_value > 的形式 <更新屬性，這會覆寫RuleProperties實例中指定的任何內容。 如需屬性的名稱，請參閱 ~azure.servicebus.management.RuleProperties。
update_subscription	更新訂用帳戶。 呼叫此方法之前，您應該先使用 get_subscription、 update_subscription 或 list_subscription 來取得 SubscriptionProperties 實例，然後更新屬性。 您也可以傳遞關鍵字引數，以property_name > = < property_value > 的形式 <更新屬性，這會覆寫SubscriptionProperties實例中指定的任何內容。 如需屬性的名稱，請參閱 ~azure.servicebus.management.SubscriptionProperties。
update_topic	更新主題。 呼叫此方法之前，您應該先使用 get_topic、 create_topic 或 list_topics 來取得 TopicProperties 實例，然後更新屬性。 只有一部分的屬性可以更新。 請參閱 https://docs.microsoft.com/en-us/rest/api/servicebus/update-topic。 您也可以傳遞關鍵字引數，以property_name > = < property_value > 的形式 <更新屬性，這會覆寫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

參數

queue_name

str

必要

佇列的名稱。

authorization_rules

list[AuthorizationRule]

資源的授權規則。

auto_delete_on_idle

Union[timedelta, str]

ISO 8601 timeSpan 閒置間隔之後，佇列會自動刪除。 最短持續時間為 5 分鐘。 接受類型 ~datetime.timedelta 或 ISO 8601 持續時間格式的字串輸入值，例如 「PT300S」。

dead_lettering_on_message_expiration

bool

值，指出當訊息到期時，此佇列是否具有寄不出的信件支援。

default_message_time_to_live

Union[timedelta, str]

ISO 8601 預設訊息時間範圍到即時值。 這是訊息到期的持續時間，從訊息傳送至服務匯流排時開始。 這是在訊息本身未設定 TimeToLive 時所使用的預設值。 接受類型 ~datetime.timedelta 或 ISO 8601 持續時間格式的字串輸入值，例如 「PT300S」。

duplicate_detection_history_time_window

Union[timedelta, str]

定義重複偵測歷程記錄持續時間的 ISO 8601 timeSpan 結構。 預設值是 10 分鐘。 接受類型 ~datetime.timedelta 或 ISO 8601 持續時間格式的字串輸入值，例如 「PT300S」。

enable_batched_operations

bool

值，指出是否啟用伺服器端批次處理作業。

enable_express

bool

值，指出是否啟用 Express Entities。 快速佇列會在將訊息寫入永續性儲存體之前，暫時將訊息儲存在記憶體中。

enable_partitioning

bool

值，指出佇列是否要跨多個訊息代理程式進行分割。

lock_duration

Union[timedelta, str]

預覽鎖定的 ISO 8601 時間範圍持續時間;也就是說，訊息鎖定給其他接收者的時間量。 LockDuration 的最大值為 5 分鐘;預設值為 1 分鐘。 接受類型 ~datetime.timedelta 或 ISO 8601 持續時間格式的字串輸入值，例如 「PT300S」。

max_delivery_count

int

傳遞計數上限。 經過這個傳遞次數後，訊息就會自動成為無效訊息。 預設值為 10。

max_size_in_megabytes

int

佇列的大小上限，以 MB 為單位，這是為佇列配置的記憶體大小。

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

佇列可接受的訊息承載大小上限。 只有在使用進階命名空間和服務匯流排 API 版本 「2021-05」 或更新版本時，才能使用此功能。 允許的最小值為 1024，而允許的最大值為 102400。 預設值為 1024。

傳回類型

QueueProperties

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

參數

topic_name

str

必要

將擁有要建立之訂用帳戶規則的主題。

subscription_name

str

必要

將擁有要建立之規則的訂用帳戶。

rule_name

str

必要

規則的名稱。

filter

Union[CorrelationRuleFilter, SqlRuleFilter]

規則的篩選。 預設值為 ~azure.servicebus.management.TrueRuleFilter

action

Optional[SqlRuleAction]

規則的動作。

傳回類型

RuleProperties

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

參數

topic_name

str

必要

將擁有要建立之訂用帳戶的主題。

subscription_name

str

必要

訂閱的名稱。

lock_duration

Union[timedelta, str]

預覽鎖定的 ISO 8601 時間範圍持續時間;也就是說，訊息鎖定給其他接收者的時間量。 LockDuration 的最大值為 5 分鐘;預設值為 1 分鐘。 接受類型 ~datetime.timedelta 或 ISO 8601 持續時間格式的字串輸入值，例如 「PT300S」。

requires_session

bool

值，指出佇列是否支援會話的概念。

default_message_time_to_live

Union[timedelta, str]

ISO 8601 預設訊息時間範圍到即時值。 這是訊息到期的持續時間，從訊息傳送至服務匯流排時開始。 這是在訊息本身未設定 TimeToLive 時所使用的預設值。 接受類型 ~datetime.timedelta 或 ISO 8601 持續時間格式的字串輸入值，例如 「PT300S」。

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

傳送至訂用帳戶之所有訊息的收件者機構名稱。

auto_delete_on_idle

Union[timedelta, str]

ISO 8601 timeSpan 閒置間隔之後，訂用帳戶會自動刪除。 最短持續時間為 5 分鐘。 接受類型 ~datetime.timedelta 或 ISO 8601 持續時間格式的字串輸入值，例如 「PT300S」。

傳回類型

SubscriptionProperties

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

參數

topic_name

str

必要

主題的名稱。

default_message_time_to_live

Union[timedelta, str]

ISO 8601 預設訊息時間範圍到即時值。 這是訊息到期的持續時間，從訊息傳送至服務匯流排時開始。 這是在訊息本身未設定 TimeToLive 時所使用的預設值。 接受類型 ~datetime.timedelta 或 ISO 8601 持續時間格式的字串輸入值，例如 「PT300S」。

max_size_in_megabytes

int

主題的大小上限，以 MB 為單位，這是為主題配置的記憶體大小。

requires_duplicate_detection

bool

值，指出本主題是否需要重複偵測。

duplicate_detection_history_time_window

Union[timedelta, str]

定義重複偵測歷程記錄持續時間的 ISO 8601 timeSpan 結構。 預設值是 10 分鐘。 接受類型 ~datetime.timedelta 或 ISO 8601 持續時間格式的字串輸入值，例如 「PT300S」。

enable_batched_operations

bool

值，指出是否啟用伺服器端批次處理作業。

size_in_bytes

int

主題的大小，以位元組為單位。

filtering_messages_before_publishing

bool

在發佈之前先篩選訊息。

authorization_rules

list[AuthorizationRule]

資源的授權規則。

support_ordering

bool

值，指出主題是否支援排序。

auto_delete_on_idle

Union[timedelta, str]

ISO 8601 timeSpan 閒置間隔之後，主題會自動刪除。 最短持續時間為 5 分鐘。 接受類型 ~datetime.timedelta 或 ISO 8601 持續時間格式的字串輸入值，例如 「PT300S」。

enable_partitioning

bool

值，指出主題是否要跨多個訊息代理程式進行分割。

enable_express

bool

值，指出是否啟用 Express Entities。 快速佇列會在將訊息寫入永續性儲存體之前，暫時將訊息儲存在記憶體中。

user_metadata

str

與主題相關聯的中繼資料。

max_message_size_in_kilobytes

int

佇列可接受的訊息承載大小上限。 只有在使用進階命名空間和服務匯流排 API 版本 「2021-05」 或更新版本時，才能使用此功能。 允許的最小值為 1024，而允許的最大值為 102400。 預設值為 1024。

傳回類型

TopicProperties

delete_queue

刪除佇列。

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

參數

queue_name

str

必要

佇列的名稱或具有名稱的 QueueProperties 。

傳回類型

None

delete_rule

刪除主題訂用帳戶規則。

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

參數

topic_name

str

必要

擁有訂用帳戶的主題。

subscription_name

str

必要

擁有主題的訂用帳戶。

rule_name

str

必要

要刪除的規則。

傳回類型

None

delete_subscription

刪除主題訂用帳戶。

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

參數

topic_name

str

必要

擁有訂用帳戶的主題。

subscription_name

str

必要

要刪除的訂用帳戶。

傳回類型

None

delete_topic

刪除主題。

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

參數

topic_name

str

必要

要刪除的主題。

傳回類型

None

from_connection_string

從連接字串建立用戶端。

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

參數

conn_str

str

必要

服務匯流排命名空間的連接字串。

api_version

str 或 ApiVersion

要用於要求的服務匯流排 API 版本。 預設值是與目前 SDK 相容的最新服務版本。 將 設定為較舊版本可能會導致功能相容性降低。

傳回類型

ServiceBusAdministrationClient

get_namespace_properties

取得命名空間屬性

get_namespace_properties(**kwargs: Any) -> NamespaceProperties

傳回

命名空間屬性。

傳回類型

NamespaceProperties

get_queue

取得佇列的屬性。

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

參數

queue_name

str

必要

佇列的名稱。

傳回

佇列的屬性。

傳回類型

QueueProperties

get_queue_runtime_properties

取得佇列的執行時間資訊。

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

參數

queue_name

str

必要

佇列的名稱。

傳回

佇列的執行時間資訊。

傳回類型

QueueRuntimeProperties

get_rule

取得主題訂閱規則的屬性。

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

參數

topic_name

str

必要

擁有訂用帳戶的主題。

subscription_name

str

必要

擁有規則的訂用帳戶。

rule_name

str

必要

規則的名稱。

傳回

指定規則的屬性。

傳回類型

RuleProperties

get_subscription

取得主題訂閱的屬性。

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

參數

topic_name

str

必要

擁有訂用帳戶的主題。

subscription_name

str

必要

訂閱的名稱。

傳回

SubscriptionProperties 的實例

傳回類型

SubscriptionProperties

get_subscription_runtime_properties

取得主題訂用帳戶執行時間資訊。

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

參數

topic_name

str

必要

擁有訂用帳戶的主題。

subscription_name

str

必要

訂閱的名稱。

傳回

SubscriptionRuntimeProperties 的實例

傳回類型

SubscriptionRuntimeProperties

get_topic

取得主題的屬性。

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

參數

topic_name

str

必要

主題名稱。

傳回

主題的屬性。

傳回類型

TopicProperties

get_topic_runtime_properties

取得主題的執行時間資訊。

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

參數

topic_name

str

必要

主題名稱。

傳回

主題的執行時間資訊。

傳回類型

TopicRuntimeProperties

list_queues

列出 ServiceBus 命名空間的佇列。

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

傳回

QueueProperties 的可反覆運算 (自動分頁) 回應。

傳回類型

ItemPaged[QueueProperties]

list_queues_runtime_properties

列出 ServiceBus 命名空間中佇列的執行時間資訊。

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

傳回

可反覆運算 (QueueRuntimeProperties 的自動分頁) 回應。

傳回類型

ItemPaged[QueueRuntimeProperties]

list_rules

列出主題訂用帳戶的規則。

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

參數

topic_name

str

必要

擁有訂用帳戶的主題。

subscription_name

str

必要

擁有規則的訂用帳戶。

傳回

RuleProperties 的可反覆運算 (自動分頁) 回應。

傳回類型

ItemPaged[RuleProperties]

list_subscriptions

列出 ServiceBus 主題的訂用帳戶。

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

參數

topic_name

str

必要

擁有訂用帳戶的主題。

傳回

SubscriptionProperties 的可反覆運算 (自動分頁) 回應。

傳回類型

ItemPaged[SubscriptionProperties]

list_subscriptions_runtime_properties

列出 ServiceBus 主題的訂用帳戶執行時間資訊。

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

參數

topic_name

str

必要

擁有訂用帳戶的主題。

傳回

可反覆運算 (SubscriptionRuntimeProperties 的自動分頁) 回應。

傳回類型

ItemPaged[SubscriptionRuntimeProperties]

list_topics

列出 ServiceBus 命名空間的主題。

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

傳回

可反覆運算 (TopicProperties 的自動分頁) 回應。

傳回類型

ItemPaged[TopicProperties]

list_topics_runtime_properties

列出 ServiceBus 命名空間的主題執行時間資訊。

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

傳回

可反覆運算 (TopicRuntimeProperties 的自動分頁) 回應。

傳回類型

ItemPaged[TopicRuntimeProperties]

update_queue

更新佇列。

呼叫此方法之前，您應該先使用 get_queue、 create_queue 或 list_queues 來取得 QueueProperties 實例，然後更新屬性。 只有一部分的屬性可以更新。 請參閱 https://docs.microsoft.com/en-us/rest/api/servicebus/update-queue。 您也可以傳遞關鍵字引數，以property_name > = < property_value > 的形式 <更新屬性，這會覆寫QueueProperties實例中指定的任何內容。 如需屬性的名稱，請參閱 ~azure.servicebus.management.QueueProperties。

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

參數

queue

QueueProperties

必要

從 get_queue、 create_queue 或 list_queues 傳回且具有更新屬性的佇列。

傳回類型

None

update_rule

更新規則。

呼叫此方法之前，您應該先使用 get_rule、 create_rule 或 list_rules 來取得 RuleProperties 實例，然後更新屬性。 您也可以傳遞關鍵字引數，以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

參數

topic_name

str

必要

擁有訂用帳戶的主題。

subscription_name

str

必要

擁有此規則的訂用帳戶。

rule

RuleProperties

必要

從 get_rule、 create_rule或 list_rules 傳回的規則，且具有更新的屬性。

傳回類型

None

update_subscription

更新訂用帳戶。

呼叫此方法之前，您應該先使用 get_subscription、 update_subscription 或 list_subscription 來取得 SubscriptionProperties 實例，然後更新屬性。 您也可以傳遞關鍵字引數，以property_name > = < property_value > 的形式 <更新屬性，這會覆寫SubscriptionProperties實例中指定的任何內容。 如需屬性的名稱，請參閱 ~azure.servicebus.management.SubscriptionProperties。

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

參數

topic_name

str

必要

擁有訂用帳戶的主題。

subscription

SubscriptionProperties

必要

從 get_subscription、 update_subscription 或 list_subscription 傳回且具有更新屬性的訂用帳戶。

傳回類型

None

update_topic

更新主題。

呼叫此方法之前，您應該先使用 get_topic、 create_topic 或 list_topics 來取得 TopicProperties 實例，然後更新屬性。 只有一部分的屬性可以更新。 請參閱 https://docs.microsoft.com/en-us/rest/api/servicebus/update-topic。 您也可以傳遞關鍵字引數，以property_name > = < property_value > 的形式 <更新屬性，這會覆寫TopicProperties實例中指定的任何內容。 如需屬性的名稱，請參閱 ~azure.servicebus.management.TopicProperties。

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

參數

topic

TopicProperties

必要

從 get_topic、 create_topic或 list_topics 傳回且具有更新屬性的主題。

傳回類型

None