SubscriptionProperties interface
updateSubscription の入力を表します。
プロパティ
auto |
エンティティが削除されるまでの最大アイドル時間。 これは、ISO-8601 の期間形式 ("PT1M" など) で 1 分間指定し、"PT5S" を 5 秒間指定します。 ISO-8601 期間形式の詳細: https://en.wikipedia.org/wiki/ISO_8601#Durations |
availability |
メッセージング エンティティの可用性の状態。 |
dead |
サブスクリプションのフィルター評価中に例外を発生させるメッセージを Service Bus で処理する方法を決定します。 値が true に設定されている場合、例外の原因となったメッセージはサブスクリプションの配信不能サブキューに移動されます。 それ以外の場合は、破棄されます。 既定では、このパラメーターは true に設定されているため、ユーザーは例外の原因を調査できます。 これは、誤った形式のメッセージ、またはメッセージの形式に関するフィルターで行われたいくつかの不適切な想定から発生します。 トピックの作成時にのみ設定可能です。 |
dead |
メッセージが有効で、メッセージの有効期限が切れた場合、Service Bus はメッセージをキューからサブスクリプションの配信不能サブキューに移動します。 無効にした場合、メッセージはサブスクリプションのメイン キューから完全に削除されます。 サブスクリプション作成時にのみ設定可能です。 |
default |
メッセージが、サブスクリプション内に存在する期間を決定します。 配信不能が有効になっているかどうかに基づいて、TTL の有効期限が切れたメッセージは、サブスクリプションに関連付けられている DeadLtterQueue に移動されるか、完全に削除されます。 これは、ISO-8601 の期間形式 ("PT1M" など) で 1 分間指定し、"PT5S" を 5 秒間指定します。 ISO-8601 期間形式の詳細: https://en.wikipedia.org/wiki/ISO_8601#Durations |
enable |
バッチ処理操作を許可するかどうかを指定します。 |
forward |
配信不能メッセージを転送するキューまたはトピックの絶対 URL または名前。
たとえば、絶対 URL 入力は 次の形式になります。 |
forward |
メッセージの転送先の絶対 URL またはキューまたはトピックの名前。
たとえば、絶対 URL 入力は 次の形式になります。 |
lock |
既定のロック期間は、ロック期間を定義しないサブスクリプションに適用されます。 (セッションが有効になっている場合、このロック期間はメッセージではなくセッションに適用されます)。 これは、ISO-8601 の期間形式 ("PT1M" など) で 1 分間指定し、"PT5S" を 5 秒間指定します。 ISO-8601 期間形式の詳細: https://en.wikipedia.org/wiki/ISO_8601#Durations |
max |
メッセージが解決されない場合は配信不能サブキューに移動されるメッセージの最大配信数。 |
requires |
true に設定すると、サブスクリプションはセッション対応になり、SessionReceiver のみがサポートされます。 セッション対応サブスクリプションは、REST ではサポートされていません。 サブスクリプション作成時にのみ設定可能です。 |
status | メッセージング エンティティの状態。 |
subscription |
サブスクリプションの名前 |
topic |
トピックの名前 |
user |
ユーザーがサブスクリプションに関連付けられているメタデータ情報を提供しました。 タグ、ラベルなどのテキスト コンテンツを指定するために使用されます。値は utf-8 でエンコードされた 1024 バイトを超えてはなりません。 |
プロパティの詳細
autoDeleteOnIdle
エンティティが削除されるまでの最大アイドル時間。 これは、ISO-8601 の期間形式 ("PT1M" など) で 1 分間指定し、"PT5S" を 5 秒間指定します。
ISO-8601 期間形式の詳細: https://en.wikipedia.org/wiki/ISO_8601#Durations
autoDeleteOnIdle: string
プロパティ値
string
availabilityStatus
メッセージング エンティティの可用性の状態。
availabilityStatus?: EntityAvailabilityStatus
プロパティ値
deadLetteringOnFilterEvaluationExceptions
サブスクリプションのフィルター評価中に例外を発生させるメッセージを Service Bus で処理する方法を決定します。 値が true に設定されている場合、例外の原因となったメッセージはサブスクリプションの配信不能サブキューに移動されます。 それ以外の場合は、破棄されます。 既定では、このパラメーターは true に設定されているため、ユーザーは例外の原因を調査できます。 これは、誤った形式のメッセージ、またはメッセージの形式に関するフィルターで行われたいくつかの不適切な想定から発生します。 トピックの作成時にのみ設定可能です。
deadLetteringOnFilterEvaluationExceptions: boolean
プロパティ値
boolean
deadLetteringOnMessageExpiration
メッセージが有効で、メッセージの有効期限が切れた場合、Service Bus はメッセージをキューからサブスクリプションの配信不能サブキューに移動します。 無効にした場合、メッセージはサブスクリプションのメイン キューから完全に削除されます。 サブスクリプション作成時にのみ設定可能です。
deadLetteringOnMessageExpiration: boolean
プロパティ値
boolean
defaultMessageTimeToLive
メッセージが、サブスクリプション内に存在する期間を決定します。 配信不能が有効になっているかどうかに基づいて、TTL の有効期限が切れたメッセージは、サブスクリプションに関連付けられている DeadLtterQueue に移動されるか、完全に削除されます。 これは、ISO-8601 の期間形式 ("PT1M" など) で 1 分間指定し、"PT5S" を 5 秒間指定します。
ISO-8601 期間形式の詳細: https://en.wikipedia.org/wiki/ISO_8601#Durations
defaultMessageTimeToLive: string
プロパティ値
string
enableBatchedOperations
バッチ処理操作を許可するかどうかを指定します。
enableBatchedOperations: 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
requiresSession
true に設定すると、サブスクリプションはセッション対応になり、SessionReceiver のみがサポートされます。 セッション対応サブスクリプションは、REST ではサポートされていません。 サブスクリプション作成時にのみ設定可能です。
requiresSession: boolean
プロパティ値
boolean
status
subscriptionName
サブスクリプションの名前
subscriptionName: string
プロパティ値
string
topicName
トピックの名前
topicName: string
プロパティ値
string
userMetadata
ユーザーがサブスクリプションに関連付けられているメタデータ情報を提供しました。 タグ、ラベルなどのテキスト コンテンツを指定するために使用されます。値は utf-8 でエンコードされた 1024 バイトを超えてはなりません。
userMetadata?: string
プロパティ値
string