次の方法で共有


QueueProperties interface

updateQueue の入力を表します。

プロパティ

authorizationRules

キューの承認規則

autoDeleteOnIdle

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

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

availabilityStatus

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

deadLetteringOnMessageExpiration

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

defaultMessageTimeToLive

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

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

duplicateDetectionHistoryTimeWindow

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

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 の期間形式 (1 分間は "PT1M"、5 秒間は "PT5S" など) で指定されます。

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

maxDeliveryCount

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

maxMessageSizeInKilobytes

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

ServiceBusAdministrationClientの作成時にサービス バージョン "2017-04" を選択した場合は適用されません。

maxSizeInMegabytes

キューの最大サイズをメガバイト単位で指定します。 キューがこの値を超える原因となるメッセージをエンキューしようとすると、失敗します。

name

キューの名前

requiresDuplicateDetection

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

requiresSession

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

status

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

userMetadata

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

プロパティの詳細

authorizationRules

キューの承認規則

authorizationRules?: AuthorizationRule[]

プロパティ値

autoDeleteOnIdle

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

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

autoDeleteOnIdle: string

プロパティ値

string

availabilityStatus

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

availabilityStatus: EntityAvailabilityStatus

プロパティ値

deadLetteringOnMessageExpiration

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

deadLetteringOnMessageExpiration: boolean

プロパティ値

boolean

defaultMessageTimeToLive

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

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

defaultMessageTimeToLive: string

プロパティ値

string

duplicateDetectionHistoryTimeWindow

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

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 の期間形式 (1 分間は "PT1M"、5 秒間は "PT5S" など) で指定されます。

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

キューの最大サイズをメガバイト単位で指定します。 キューがこの値を超える原因となるメッセージをエンキューしようとすると、失敗します。

maxSizeInMegabytes: number

プロパティ値

number

name

キューの名前

name: string

プロパティ値

string

requiresDuplicateDetection

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

requiresDuplicateDetection: boolean

プロパティ値

boolean

requiresSession

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

requiresSession: boolean

プロパティ値

boolean

status

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

status: EntityStatus

プロパティ値

userMetadata

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

userMetadata: string

プロパティ値

string