CreateQueueOptions interface

キューの承認規則

authorizationRules?: AuthorizationRule[]

プロパティ値

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

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

autoDeleteOnIdle?: string

プロパティ値

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

availabilityStatus?: EntityAvailabilityStatus

プロパティ値

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

deadLetteringOnMessageExpiration?: boolean

プロパティ値

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

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

defaultMessageTimeToLive?: string

プロパティ値

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

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

duplicateDetectionHistoryTimeWindow?: string

プロパティ値

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

enableBatchedOperations?: boolean

プロパティ値

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

enableExpress?: boolean

プロパティ値

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

enablePartitioning?: boolean

プロパティ値

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

forwardDeadLetteredMessagesTo?: string

プロパティ値

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

forwardTo?: string

プロパティ値

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

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

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

lockDuration?: string

プロパティ値

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

maxDeliveryCount?: number

プロパティ値

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

(Premium レベルの Service Bus 名前空間に対してのみ構成できます)。

maxMessageSizeInKilobytes?: number

プロパティ値

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

maxSizeInMegabytes?: number

プロパティ値

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

requiresDuplicateDetection?: boolean

プロパティ値

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

requiresSession?: boolean

プロパティ値

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

status?: EntityStatus

プロパティ値

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

userMetadata?: string

プロパティ値

要求を中止するために使用できるシグナル。

abortSignal?: AbortSignalLike

プロパティ値

OperationOptions.abortSignalから継承

要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。

onResponse?: RawResponseCallback

プロパティ値

OperationOptions.onResponseから継承

この操作の HTTP 要求を作成および送信するときに使用されるオプション。

requestOptions?: OperationRequestOptions

プロパティ値

OperationOptions.requestOptionsから継承

シリアル化/シリアル化解除の動作をオーバーライドするオプション。

serializerOptions?: SerializerOptions

プロパティ値

OperationOptions.serializerOptionsから継承

トレースが有効な場合に使用されるオプション。

tracingOptions?: OperationTracingOptions

プロパティ値

OperationOptions.tracingOptionsから継承