CreateQueueOptions interface
キューの設定可能なオプションを表します
- Extends
プロパティ
| authorization |
キューの承認規則 |
| auto |
エンティティが削除されるまでの最大アイドル時間。 これは、ISO-8601 の期間形式 ("PT1M" など) で 1 分間指定し、"PT5S" を 5 秒間指定します。 ISO-8601 期間形式の詳細: https://en.wikipedia.org/wiki/ISO_8601#Durations |
| availability |
メッセージング エンティティの可用性の状態。 |
| dead |
メッセージが有効で、メッセージの有効期限が切れた場合、Service Bus はメッセージをキューからキューの配信不能サブキューに移動します。 無効にした場合、メッセージはキューから完全に削除されます。 キュー作成時にのみ設定可能です。 |
| default |
DeadLettering が有効になっているかどうかに応じて、メッセージは配信不能サブキューに自動的に移動されるか、指定された時間よりも長くキューに格納されている場合は削除されます。 メッセージの TTL がキューに設定された TTL より小さい場合に限り、この値はメッセージに指定された TTL によって上書きされます。 キューが作成された後、この値は変更できません。 これは、ISO-8601 の期間形式 ("PT1M" など) で 1 分間指定し、"PT5S" を 5 秒間指定します。 ISO-8601 期間形式の詳細: https://en.wikipedia.org/wiki/ISO_8601#Durations |
| duplicate |
Service Bus がメッセージの重複を検出する期間を指定します。 これは、ISO-8601 の期間形式 ("PT1M" など) で 1 分間指定し、"PT5S" を 5 秒間指定します。 ISO-8601 期間形式の詳細: https://en.wikipedia.org/wiki/ISO_8601#Durations |
| enable |
バッチ処理を許可するかどうかを指定します。 |
| enable |
キューで高速エンティティを有効にするかどうかを指定します。 |
| 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 |
メッセージの最大配信数。その後、メッセージがまだ解決されない場合は、配信不能サブキューに移動されます。 |
| max |
このキューに送信されるメッセージの最大メッセージ サイズ (キロバイト単位)。 (Premium レベルの Service Bus 名前空間に対してのみ構成できます)。 |
| max |
最大キュー サイズ (MB) を指定します。 キューがこの値を超えるようにメッセージをエンキューする試みは失敗します。 |
| requires |
有効にすると、DuplicateDetectionHistoryTimeWindow プロパティで指定された期間内に重複するメッセージが検出されます。 キュー作成時にのみ設定可能です。 |
| requires |
true に設定すると、キューはセッション対応になり、SessionReceiver のみがサポートされます。 セッション対応のキューは REST 経由ではサポートされません。 キュー作成時にのみ設定可能です。 |
| status | メッセージング エンティティの状態。 |
| user |
ユーザーは、キューに関連付けられているメタデータ情報を提供しました。 タグ、ラベルなどのテキスト コンテンツを指定するために使用します。utf-8 でエンコードされた 1024 バイトを超えてはなりません。 |
継承されたプロパティ
| abort |
要求を中止するために使用できるシグナル。 |
| on |
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。 |
| request |
この操作の HTTP 要求を作成および送信するときに使用されるオプション。 |
| serializer |
シリアル化/シリアル化解除の動作をオーバーライドするオプション。 |
| tracing |
トレースが有効な場合に使用されるオプション。 |
プロパティの詳細
authorizationRules
autoDeleteOnIdle
エンティティが削除されるまでの最大アイドル時間。 これは、ISO-8601 の期間形式 ("PT1M" など) で 1 分間指定し、"PT5S" を 5 秒間指定します。
ISO-8601 期間形式の詳細: https://en.wikipedia.org/wiki/ISO_8601#Durations
autoDeleteOnIdle?: stringプロパティ値
string
availabilityStatus
メッセージング エンティティの可用性の状態。
availabilityStatus?: EntityAvailabilityStatusプロパティ値
deadLetteringOnMessageExpiration
メッセージが有効で、メッセージの有効期限が切れた場合、Service Bus はメッセージをキューからキューの配信不能サブキューに移動します。 無効にした場合、メッセージはキューから完全に削除されます。 キュー作成時にのみ設定可能です。
deadLetteringOnMessageExpiration?: booleanプロパティ値
boolean
defaultMessageTimeToLive
DeadLettering が有効になっているかどうかに応じて、メッセージは配信不能サブキューに自動的に移動されるか、指定された時間よりも長くキューに格納されている場合は削除されます。 メッセージの TTL がキューに設定された TTL より小さい場合に限り、この値はメッセージに指定された TTL によって上書きされます。 キューが作成された後、この値は変更できません。 これは、ISO-8601 の期間形式 ("PT1M" など) で 1 分間指定し、"PT5S" を 5 秒間指定します。
ISO-8601 期間形式の詳細: https://en.wikipedia.org/wiki/ISO_8601#Durations
defaultMessageTimeToLive?: stringプロパティ値
string
duplicateDetectionHistoryTimeWindow
Service Bus がメッセージの重複を検出する期間を指定します。 これは、ISO-8601 の期間形式 ("PT1M" など) で 1 分間指定し、"PT5S" を 5 秒間指定します。
ISO-8601 期間形式の詳細: https://en.wikipedia.org/wiki/ISO_8601#Durations
duplicateDetectionHistoryTimeWindow?: stringプロパティ値
string
enableBatchedOperations
バッチ処理を許可するかどうかを指定します。
enableBatchedOperations?: booleanプロパティ値
boolean
enableExpress
キューで高速エンティティを有効にするかどうかを指定します。
enableExpress?: booleanプロパティ値
boolean
enablePartitioning
キューをパーティション分割するかどうかを指定します。
enablePartitioning?: 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
maxMessageSizeInKilobytes
このキューに送信されるメッセージの最大メッセージ サイズ (キロバイト単位)。
(Premium レベルの Service Bus 名前空間に対してのみ構成できます)。
maxMessageSizeInKilobytes?: numberプロパティ値
number
maxSizeInMegabytes
最大キュー サイズ (MB) を指定します。 キューがこの値を超えるようにメッセージをエンキューする試みは失敗します。
maxSizeInMegabytes?: numberプロパティ値
number
requiresDuplicateDetection
有効にすると、DuplicateDetectionHistoryTimeWindow プロパティで指定された期間内に重複するメッセージが検出されます。 キュー作成時にのみ設定可能です。
requiresDuplicateDetection?: booleanプロパティ値
boolean
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