CreateQueueOptions interface

キューの承認規則

authorizationRules?: AuthorizationRule[]

プロパティ値

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

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

autoDeleteOnIdle?: string

プロパティ値

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

availabilityStatus?: EntityAvailabilityStatus

プロパティ値

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

deadLetteringOnMessageExpiration?: boolean

プロパティ値

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

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

defaultMessageTimeToLive?: string

プロパティ値

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

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

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

lockDuration?: string

プロパティ値

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

maxDeliveryCount?: number

プロパティ値

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

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

maxMessageSizeInKilobytes?: number

プロパティ値

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

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から継承