CreateSubscriptionOptions interface
サブスクリプションの設定可能なオプションを表します
- Extends
プロパティ
| 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 |
| default |
サブスクリプションの既定の規則を作成するオプションを表します。 |
| 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 | メッセージング エンティティの状態。 |
| user |
ユーザーがサブスクリプションに関連付けられているメタデータ情報を提供しました。 タグ、ラベルなどのテキスト コンテンツを指定するために使用します。utf-8 でエンコードされた 1024 バイトを超えてはなりません。 |
継承されたプロパティ
| abort |
要求を中止するために使用できるシグナル。 |
| on |
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。 |
| request |
この操作の HTTP 要求を作成および送信するときに使用されるオプション。 |
| serializer |
シリアル化/シリアル化解除の動作をオーバーライドするオプション。 |
| tracing |
トレースが有効な場合に使用されるオプション。 |
プロパティの詳細
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
defaultRuleOptions
サブスクリプションの既定の規則を作成するオプションを表します。
defaultRuleOptions?: { action?: SqlRuleAction, filter?: CorrelationRuleFilter | SqlRuleFilter, name: string }プロパティ値
{ action?: SqlRuleAction, filter?: CorrelationRuleFilter | SqlRuleFilter, name: 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
userMetadata
ユーザーがサブスクリプションに関連付けられているメタデータ情報を提供しました。 タグ、ラベルなどのテキスト コンテンツを指定するために使用します。utf-8 でエンコードされた 1024 バイトを超えてはなりません。
userMetadata?: stringプロパティ値
string
継承されたプロパティの詳細
abortSignal
要求を中止するために使用できるシグナル。
abortSignal?: AbortSignalLikeプロパティ値
onResponse
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
onResponse?: RawResponseCallbackプロパティ値
requestOptions
この操作の HTTP 要求を作成および送信するときに使用されるオプション。
requestOptions?: OperationRequestOptionsプロパティ値
serializerOptions
シリアル化/シリアル化解除の動作をオーバーライドするオプション。
serializerOptions?: SerializerOptionsプロパティ値
tracingOptions
トレースが有効な場合に使用されるオプション。
tracingOptions?: OperationTracingOptions