SBQueueProperties interface
Queue プロパティの定義。
プロパティ
| accessed |
メッセージが最後に送信されたとき、またはこのキューへの受信要求が最後に発生した時刻。 |
| auto |
ISO 8061 timeSpan アイドル間隔。その後、キューが自動的に削除されます。 最小時間は、5 分です。 |
| count |
メッセージ数の詳細。 |
| created |
メッセージが作成された正確な時刻。 |
| dead |
メッセージの有効期限が切れたときに、このキューで配信不能がサポートされているかどうかを示す値。 |
| default |
ISO 8601 の既定のメッセージ期間からライブ値。 これは、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。 これは、メッセージ自体に TimeToLive が設定されていない場合に使用される既定値です。 |
| duplicate |
重複検出履歴の期間を定義する ISO 8601 timeSpan 構造体。 既定値は 10 分です。 |
| enable |
サーバー側のバッチ処理操作が有効かどうかを示す値。 |
| enable |
Express エンティティが有効かどうかを示す値。 高速キューは、永続ストレージに書き込む前に、メッセージを一時的にメモリに保持します。 |
| enable |
キューを複数のメッセージ ブローカー間でパーティション分割するかどうかを示す値。 |
| forward |
配信不能メッセージを転送するキュー/トピック名 |
| forward |
メッセージを転送するためのキュー/トピック名 |
| lock |
ピーク ロックの ISO 8601 期間。つまり、メッセージが他の受信者に対してロックされている時間です。 LockDuration の最大値は 5 分です。既定値は 1 分です。 |
| max |
配信の最大数。 この数の配信後、メッセージは自動的に配信不能になります。 既定値は 10 です。 |
| max |
キューで受け入れ可能なメッセージ ペイロードの最大サイズ (KB 単位)。 このプロパティは現在 Premium でのみ使用され、既定値は 1024 です。 |
| max |
キューの最大サイズ (MB 単位)。 これは、キューに割り当てられたメモリのサイズです。 既定値は 1024 です。 |
| message |
キュー内のメッセージの数。 |
| requires |
このキューで重複検出が必要かどうかを示す値。 |
| requires |
キューがセッションの概念をサポートしているかどうかを示す値。 |
| size |
キューのサイズ (バイト単位)。 |
| status | メッセージング エンティティの状態に使用できる値を列挙します。 |
| updated |
メッセージが更新された正確な時刻。 |
| user |
ユーザーのメタデータを取得および設定します。 |
プロパティの詳細
accessedAt
メッセージが最後に送信されたとき、またはこのキューへの受信要求が最後に発生した時刻。
accessedAt?: Dateプロパティ値
Date
autoDeleteOnIdle
ISO 8061 timeSpan アイドル間隔。その後、キューが自動的に削除されます。 最小時間は、5 分です。
autoDeleteOnIdle?: stringプロパティ値
string
countDetails
createdAt
メッセージが作成された正確な時刻。
createdAt?: Dateプロパティ値
Date
deadLetteringOnMessageExpiration
メッセージの有効期限が切れたときに、このキューで配信不能がサポートされているかどうかを示す値。
deadLetteringOnMessageExpiration?: booleanプロパティ値
boolean
defaultMessageTimeToLive
ISO 8601 の既定のメッセージ期間からライブ値。 これは、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。 これは、メッセージ自体に TimeToLive が設定されていない場合に使用される既定値です。
defaultMessageTimeToLive?: stringプロパティ値
string
duplicateDetectionHistoryTimeWindow
重複検出履歴の期間を定義する ISO 8601 timeSpan 構造体。 既定値は 10 分です。
duplicateDetectionHistoryTimeWindow?: stringプロパティ値
string
enableBatchedOperations
サーバー側のバッチ処理操作が有効かどうかを示す値。
enableBatchedOperations?: booleanプロパティ値
boolean
enableExpress
Express エンティティが有効かどうかを示す値。 高速キューは、永続ストレージに書き込む前に、メッセージを一時的にメモリに保持します。
enableExpress?: booleanプロパティ値
boolean
enablePartitioning
キューを複数のメッセージ ブローカー間でパーティション分割するかどうかを示す値。
enablePartitioning?: booleanプロパティ値
boolean
forwardDeadLetteredMessagesTo
配信不能メッセージを転送するキュー/トピック名
forwardDeadLetteredMessagesTo?: stringプロパティ値
string
forwardTo
メッセージを転送するためのキュー/トピック名
forwardTo?: stringプロパティ値
string
lockDuration
ピーク ロックの ISO 8601 期間。つまり、メッセージが他の受信者に対してロックされている時間です。 LockDuration の最大値は 5 分です。既定値は 1 分です。
lockDuration?: stringプロパティ値
string
maxDeliveryCount
配信の最大数。 この数の配信後、メッセージは自動的に配信不能になります。 既定値は 10 です。
maxDeliveryCount?: numberプロパティ値
number
maxMessageSizeInKilobytes
キューで受け入れ可能なメッセージ ペイロードの最大サイズ (KB 単位)。 このプロパティは現在 Premium でのみ使用され、既定値は 1024 です。
maxMessageSizeInKilobytes?: numberプロパティ値
number
maxSizeInMegabytes
キューの最大サイズ (MB 単位)。 これは、キューに割り当てられたメモリのサイズです。 既定値は 1024 です。
maxSizeInMegabytes?: numberプロパティ値
number
messageCount
キュー内のメッセージの数。
messageCount?: numberプロパティ値
number
requiresDuplicateDetection
このキューで重複検出が必要かどうかを示す値。
requiresDuplicateDetection?: booleanプロパティ値
boolean
requiresSession
キューがセッションの概念をサポートしているかどうかを示す値。
requiresSession?: booleanプロパティ値
boolean
sizeInBytes
キューのサイズ (バイト単位)。
sizeInBytes?: numberプロパティ値
number
status
updatedAt
メッセージが更新された正確な時刻。
updatedAt?: Dateプロパティ値
Date
userMetadata
ユーザーのメタデータを取得および設定します。
userMetadata?: stringプロパティ値
string