次の方法で共有

SubscriptionProperties interface

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

updateSubscription の入力を表します。

プロパティ

autoDeleteOnIdle

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

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

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

サブスクリプションのフィルター評価中に例外を引き起こすメッセージを Service Bus が処理する方法を決定します。 値が true に設定されている場合、例外の原因となったメッセージはサブスクリプションの配信不能サブキューに移動されます。 それ以外の場合は破棄されます。 既定では、このパラメーターは true に設定されているため、ユーザーは例外の原因を調査できます。 不正な形式のメッセージや、メッセージの形式に関するフィルターで誤った想定が行われた場合に発生する可能性があります。 トピック作成時にのみ設定できます。
deadLetteringOnMessageExpiration

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

メッセージがサブスクリプションに存在する期間を決定します。 配信不能が有効になっているかどうかに基づいて、TTL の有効期限が切れたメッセージは、サブスクリプションの関連付けられている DeadLtterQueue に移動されるか、完全に削除されます。 これは、ISO-8601 の期間形式 (1 分間は "PT1M"、5 秒間は "PT5S" など) で指定されます。

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

バッチ処理操作を許可するかどうかを指定します。
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

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

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

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

サブスクリプションの名前
topicName

トピックの名前
userMetadata

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

プロパティの詳細

autoDeleteOnIdle

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

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

autoDeleteOnIdle: string

プロパティ値

string

availabilityStatus

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

availabilityStatus?: EntityAvailabilityStatus

プロパティ値

EntityAvailabilityStatus

deadLetteringOnFilterEvaluationExceptions

サブスクリプションのフィルター評価中に例外を引き起こすメッセージを Service Bus が処理する方法を決定します。 値が true に設定されている場合、例外の原因となったメッセージはサブスクリプションの配信不能サブキューに移動されます。 それ以外の場合は破棄されます。 既定では、このパラメーターは true に設定されているため、ユーザーは例外の原因を調査できます。 不正な形式のメッセージや、メッセージの形式に関するフィルターで誤った想定が行われた場合に発生する可能性があります。 トピック作成時にのみ設定できます。

deadLetteringOnFilterEvaluationExceptions: boolean

プロパティ値

boolean

deadLetteringOnMessageExpiration

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

deadLetteringOnMessageExpiration: boolean

プロパティ値

boolean

defaultMessageTimeToLive

メッセージがサブスクリプションに存在する期間を決定します。 配信不能が有効になっているかどうかに基づいて、TTL の有効期限が切れたメッセージは、サブスクリプションの関連付けられている DeadLtterQueue に移動されるか、完全に削除されます。 これは、ISO-8601 の期間形式 (1 分間は "PT1M"、5 秒間は "PT5S" など) で指定されます。

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

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

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

status: EntityStatus

プロパティ値

EntityStatus

subscriptionName

サブスクリプションの名前

subscriptionName: string

プロパティ値

string

topicName

トピックの名前

topicName: string

プロパティ値

string

userMetadata

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

userMetadata?: string

プロパティ値

string