QueueProperties クラス

  • リファレンス

Service Bus キュー リソースのプロパティ。

継承
azure.servicebus.management._models.DictMixin
QueueProperties

コンストラクター

QueueProperties(name: str, **kwargs: Any)

パラメーター

name
必須

変数

name

キューの名前。

authorization_rules

リソースの承認規則。

auto_delete_on_idle

ISO 8601 timeSpan アイドル間隔後、キューは自動的に削除されます。 最小時間は、5 分です。

dead_lettering_on_message_expiration

メッセージの有効期限が切れたときに、このキューが配信不能サポートを持っているかどうかを示す 値。

default_message_time_to_live

ISO 8601 の既定のメッセージ時間スパンがライブ値になります。 これは、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。 これは、メッセージ自体に TimeToLive が設定されていない場合に使用される既定値です。

duplicate_detection_history_time_window

重複検出履歴の期間を定義する ISO 8601 timeSpan 構造体。 既定値は 10 分です。

availability_status

エンティティの可用性の状態。 使用可能な値は、"Available"、"Limited"、"Renaming"、"Restoring"、"Unknown" です。

enable_batched_operations

サーバー側のバッチ処理操作が有効かどうかを示す値。

enable_express

Express Entities が有効かどうかを示す 値。 高速キューは、永続ストレージに書き込む前に、メッセージを一時的にメモリに保持します。

enable_partitioning

キューを複数のメッセージ ブローカー間でパーティション分割するかどうかを示す 値。

lock_duration

ピーク ロックの ISO 8601 期間。つまり、メッセージが他の受信者に対してロックされている時間です。 LockDuration の最大値は 5 分です。既定値は 1 分です。

max_delivery_count

配信の最大数。 この配信数を越えた後のメッセージは自動的に配信不能になります。 既定値は 10 です。

max_size_in_megabytes

キューの最大サイズ (MB 単位)。 これは、キューに割り当てられたメモリのサイズです。

requires_duplicate_detection

このキューで重複検出が必要かどうかを示す 値。

requires_session

キューがセッションの概念をサポートしているかどうかを示す 値。

status

Service Bus リソースの状態。 指定できる値は、"Active"、"Creating"、"Removeing"、"Disabled"、"ReceiveDisabled"、"Renaming"、"Restoring"、"SendDisabled"、"Unknown" です。

forward_to

キューに送信されたすべてのメッセージの転送先となる受信者エンティティの名前。

user_metadata

ユーザーが説明に関連付けることができるカスタム metdata。 最大長は 1024 文字です。

forward_dead_lettered_messages_to

このサブスクリプションのすべての配信不能メッセージの転送先となる受信者エンティティの名前。

max_message_size_in_kilobytes

キューで受け入れられるメッセージ ペイロードの最大サイズ (キロバイト単位)。 この機能は、Premium 名前空間と Service Bus API バージョン "2021-05" 以降を使用している場合にのみ使用できます。

メソッド

get
has_key
items
keys
update
values

get 

get(key: str, default: Any | None = None) -> Any

パラメーター

key
必須
default
既定値: None

has_key 

has_key(k: str) -> bool

パラメーター

k
必須

items 

items() -> List[Tuple[str, Any]]

keys 

keys() -> List[str]

update 

update(*args: Any, **kwargs: Any) -> None

values 

values() -> List