次の方法で共有

QueueProperties interface

  • リファレンス
パッケージ:
@azure/service-bus

updateQueue の入力を表します。

プロパティ

authorizationRules

キューの承認規則
autoDeleteOnIdle

エンティティが削除されるまでの最大アイドル時間。 これは、ISO-8601 の期間形式 ("PT1M" など) で 1 分間指定し、"PT5S" を 5 秒間指定します。

ISO-8601 期間形式の詳細: https://en.wikipedia.org/wiki/ISO_8601#Durations
availabilityStatus

メッセージング エンティティの可用性の状態。
deadLetteringOnMessageExpiration

メッセージが有効で、メッセージの有効期限が切れた場合、Service Bus はメッセージをキューからキューの配信不能サブキューに移動します。 無効にした場合、メッセージはキューから完全に削除されます。 キュー作成時にのみ設定可能です。
defaultMessageTimeToLive

DeadLettering が有効になっているかどうかに応じて、メッセージは配信不能サブキューに自動的に移動されるか、指定された時間よりも長くキューに格納されている場合は削除されます。 メッセージの TTL がキューに設定された TTL より小さい場合に限り、この値はメッセージに指定された TTL によって上書きされます。 キューが作成された後、この値は変更できません。 これは、ISO-8601 の期間形式 ("PT1M" など) で 1 分間指定し、"PT5S" を 5 秒間指定します。

ISO-8601 期間形式の詳細: https://en.wikipedia.org/wiki/ISO_8601#Durations
duplicateDetectionHistoryTimeWindow

Service Bus がメッセージの重複を検出する期間を指定します。 これは、ISO-8601 の期間形式 ("PT1M" など) で 1 分間指定し、"PT5S" を 5 秒間指定します。

ISO-8601 期間形式の詳細: https://en.wikipedia.org/wiki/ISO_8601#Durations
enableBatchedOperations

バッチ処理操作を許可するかどうかを指定します。
enableExpress

キューで高速エンティティを有効にするかどうかを指定します。
enablePartitioning

キューをパーティション分割するかどうかを指定します。
forwardDeadLetteredMessagesTo

配信不能メッセージを転送するキューまたはトピックの絶対 URL または名前。 たとえば、絶対 URL 入力は 次の形式になります。 sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
forwardTo

メッセージの転送先の絶対 URL またはキューまたはトピックの名前。 たとえば、絶対 URL 入力は 次の形式になります。 sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
lockDuration

メッセージが受信者の処理のためにロックされる時間を秒単位で決定します。 この時間の後、メッセージはロック解除され、次の受信者による消費が可能になります。 (セッションが有効になっている場合、このロック期間はメッセージではなくセッションに適用されます)。

これは、ISO-8601 の期間形式 ("PT1M" など) で 1 分間指定し、"PT5S" を 5 秒間指定します。

ISO-8601 期間形式の詳細: https://en.wikipedia.org/wiki/ISO_8601#Durations
maxDeliveryCount

メッセージが解決されない場合は配信不能サブキューに移動されるメッセージの最大配信数。
maxMessageSizeInKilobytes

このキューに送信されるメッセージの最大メッセージ サイズ (キロバイト単位)。

を作成 ServiceBusAdministrationClientするときにサービス バージョン "2017-04" が選択されている場合は適用されません。
maxSizeInMegabytes

最大キュー サイズ (MB) を指定します。 キューがこの値を超えるようにメッセージをエンキューする試みは失敗します。
name

キューの名前
requiresDuplicateDetection

有効にすると、トピックは DuplicateDetectionHistoryTimeWindow プロパティで指定された期間内に重複するメッセージを検出します。 キュー作成時にのみ設定可能です。
requiresSession

true に設定すると、キューはセッション対応になり、SessionReceiver のみがサポートされます。 セッション対応のキューは REST 経由ではサポートされません。 キュー作成時にのみ設定可能です。
status

メッセージング エンティティの状態。
userMetadata

ユーザーがキューに関連付けられているメタデータ情報を提供しました。 タグ、ラベルなどのテキスト コンテンツを指定するために使用されます。値は utf-8 でエンコードされた 1024 バイトを超えてはなりません。

プロパティの詳細

authorizationRules

キューの承認規則

authorizationRules?: AuthorizationRule[]

プロパティ値

AuthorizationRule[]

autoDeleteOnIdle

エンティティが削除されるまでの最大アイドル時間。 これは、ISO-8601 の期間形式 ("PT1M" など) で 1 分間指定し、"PT5S" を 5 秒間指定します。

ISO-8601 期間形式の詳細: https://en.wikipedia.org/wiki/ISO_8601#Durations

autoDeleteOnIdle: string

プロパティ値

string

availabilityStatus

メッセージング エンティティの可用性の状態。

availabilityStatus: EntityAvailabilityStatus

プロパティ値

EntityAvailabilityStatus

deadLetteringOnMessageExpiration

メッセージが有効で、メッセージの有効期限が切れた場合、Service Bus はメッセージをキューからキューの配信不能サブキューに移動します。 無効にした場合、メッセージはキューから完全に削除されます。 キュー作成時にのみ設定可能です。

deadLetteringOnMessageExpiration: boolean

プロパティ値

boolean

defaultMessageTimeToLive

DeadLettering が有効になっているかどうかに応じて、メッセージは配信不能サブキューに自動的に移動されるか、指定された時間よりも長くキューに格納されている場合は削除されます。 メッセージの TTL がキューに設定された TTL より小さい場合に限り、この値はメッセージに指定された TTL によって上書きされます。 キューが作成された後、この値は変更できません。 これは、ISO-8601 の期間形式 ("PT1M" など) で 1 分間指定し、"PT5S" を 5 秒間指定します。

ISO-8601 期間形式の詳細: https://en.wikipedia.org/wiki/ISO_8601#Durations

defaultMessageTimeToLive: string

プロパティ値

string

duplicateDetectionHistoryTimeWindow

Service Bus がメッセージの重複を検出する期間を指定します。 これは、ISO-8601 の期間形式 ("PT1M" など) で 1 分間指定し、"PT5S" を 5 秒間指定します。

ISO-8601 期間形式の詳細: https://en.wikipedia.org/wiki/ISO_8601#Durations

duplicateDetectionHistoryTimeWindow: string

プロパティ値

string

enableBatchedOperations

バッチ処理操作を許可するかどうかを指定します。

enableBatchedOperations: boolean

プロパティ値

boolean

enableExpress

キューで高速エンティティを有効にするかどうかを指定します。

enableExpress: boolean

プロパティ値

boolean

enablePartitioning

キューをパーティション分割するかどうかを指定します。

enablePartitioning: boolean

プロパティ値

boolean

forwardDeadLetteredMessagesTo

配信不能メッセージを転送するキューまたはトピックの絶対 URL または名前。 たとえば、絶対 URL 入力は 次の形式になります。 sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardDeadLetteredMessagesTo?: string

プロパティ値

string

forwardTo

メッセージの転送先の絶対 URL またはキューまたはトピックの名前。 たとえば、絶対 URL 入力は 次の形式になります。 sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardTo?: string

プロパティ値

string

lockDuration

メッセージが受信者の処理のためにロックされる時間を秒単位で決定します。 この時間の後、メッセージはロック解除され、次の受信者による消費が可能になります。 (セッションが有効になっている場合、このロック期間はメッセージではなくセッションに適用されます)。

これは、ISO-8601 の期間形式 ("PT1M" など) で 1 分間指定し、"PT5S" を 5 秒間指定します。

ISO-8601 期間形式の詳細: https://en.wikipedia.org/wiki/ISO_8601#Durations

lockDuration: string

プロパティ値

string

maxDeliveryCount

メッセージが解決されない場合は配信不能サブキューに移動されるメッセージの最大配信数。

maxDeliveryCount: number

プロパティ値

number

maxMessageSizeInKilobytes

このキューに送信されるメッセージの最大メッセージ サイズ (キロバイト単位)。

を作成 ServiceBusAdministrationClientするときにサービス バージョン "2017-04" が選択されている場合は適用されません。

maxMessageSizeInKilobytes?: number

プロパティ値

number

maxSizeInMegabytes

最大キュー サイズ (MB) を指定します。 キューがこの値を超えるようにメッセージをエンキューする試みは失敗します。

maxSizeInMegabytes: number

プロパティ値

number

name

キューの名前

name: string

プロパティ値

string

requiresDuplicateDetection

有効にすると、トピックは DuplicateDetectionHistoryTimeWindow プロパティで指定された期間内に重複するメッセージを検出します。 キュー作成時にのみ設定可能です。

requiresDuplicateDetection: boolean

プロパティ値

boolean

requiresSession

true に設定すると、キューはセッション対応になり、SessionReceiver のみがサポートされます。 セッション対応のキューは REST 経由ではサポートされません。 キュー作成時にのみ設定可能です。

requiresSession: boolean

プロパティ値

boolean

status

メッセージング エンティティの状態。

status: EntityStatus

プロパティ値

EntityStatus

userMetadata

ユーザーがキューに関連付けられているメタデータ情報を提供しました。 タグ、ラベルなどのテキスト コンテンツを指定するために使用されます。値は utf-8 でエンコードされた 1024 バイトを超えてはなりません。

userMetadata: string

プロパティ値

string