SBQueue interface

パッケージ:

@azure/arm-servicebus

キュー リソースの説明。

Extends

ProxyResource

プロパティ

accessedAt	メッセージが最後に送信されたとき、またはこのキューへの受信要求が最後に発生した時刻。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
autoDeleteOnIdle	ISO 8061 timeSpan アイドル間隔。その後、キューが自動的に削除されます。 最小時間は、5 分です。
countDetails	メッセージ数の詳細。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
createdAt	メッセージが作成された正確な時刻。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
deadLetteringOnMessageExpiration	メッセージの有効期限が切れたときに、このキューで配信不能がサポートされているかどうかを示す値。
defaultMessageTimeToLive	ISO 8601 の既定のメッセージ期間からライブ値。 これは、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。 これは、メッセージ自体に TimeToLive が設定されていない場合に使用される既定値です。
duplicateDetectionHistoryTimeWindow	重複検出履歴の期間を定義する ISO 8601 timeSpan 構造体。 既定値は 10 分です。
enableBatchedOperations	サーバー側のバッチ処理操作が有効かどうかを示す値。
enableExpress	Express エンティティが有効かどうかを示す値。 高速キューは、永続ストレージに書き込む前に、メッセージを一時的にメモリに保持します。
enablePartitioning	キューを複数のメッセージ ブローカー間でパーティション分割するかどうかを示す値。
forwardDeadLetteredMessagesTo	配信不能メッセージを転送するキュー/トピック名
forwardTo	メッセージを転送するためのキュー/トピック名
lockDuration	ピーク ロックの ISO 8601 期間。つまり、メッセージが他の受信者に対してロックされている時間です。 LockDuration の最大値は 5 分です。既定値は 1 分です。
maxDeliveryCount	配信の最大数。 この数の配信後、メッセージは自動的に配信不能になります。 既定値は 10 です。
maxMessageSizeInKilobytes	キューで受け入れ可能なメッセージ ペイロードの最大サイズ (KB 単位)。 このプロパティは現在 Premium でのみ使用され、既定値は 1024 です。
maxSizeInMegabytes	キューの最大サイズ (MB 単位)。 これは、キューに割り当てられたメモリのサイズです。 既定値は 1024 です。
messageCount	キュー内のメッセージの数。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
requiresDuplicateDetection	このキューで重複検出が必要かどうかを示す値。
requiresSession	キューがセッションの概念をサポートしているかどうかを示す値。
sizeInBytes	キューのサイズ (バイト単位)。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
status	メッセージング エンティティの状態に使用できる値を列挙します。
systemData	このリソースに関連するシステム メタデータ。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
updatedAt	メッセージが更新された正確な時刻。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

継承されたプロパティ

id	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
location	リソースが存在する地理的な場所注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
name	リソースの名前注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
type	リソースの型。 例: "Microsoft.EventHub/Namespaces" または "Microsoft.EventHub/Namespaces/EventHubs" 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

プロパティの詳細

accessedAt

メッセージが最後に送信されたとき、またはこのキューへの受信要求が最後に発生した時刻。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

accessedAt?: Date

プロパティ値

Date

autoDeleteOnIdle

ISO 8061 timeSpan アイドル間隔。その後、キューが自動的に削除されます。 最小時間は、5 分です。

autoDeleteOnIdle?: string

プロパティ値

string

countDetails

メッセージ数の詳細。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

countDetails?: MessageCountDetails

プロパティ値

MessageCountDetails

createdAt

メッセージが作成された正確な時刻。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

createdAt?: Date

プロパティ値

Date

deadLetteringOnMessageExpiration

メッセージの有効期限が切れたときに、このキューで配信不能がサポートされているかどうかを示す値。

deadLetteringOnMessageExpiration?: boolean

プロパティ値

boolean

defaultMessageTimeToLive

ISO 8601 の既定のメッセージ期間からライブ値。 これは、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。 これは、メッセージ自体に TimeToLive が設定されていない場合に使用される既定値です。

defaultMessageTimeToLive?: string

プロパティ値

string

duplicateDetectionHistoryTimeWindow

重複検出履歴の期間を定義する ISO 8601 timeSpan 構造体。 既定値は 10 分です。

duplicateDetectionHistoryTimeWindow?: string

プロパティ値

string

enableBatchedOperations

サーバー側のバッチ処理操作が有効かどうかを示す値。

enableBatchedOperations?: boolean

プロパティ値

boolean

enableExpress

Express エンティティが有効かどうかを示す値。 高速キューは、永続ストレージに書き込む前に、メッセージを一時的にメモリに保持します。

enableExpress?: boolean

プロパティ値

boolean

enablePartitioning

キューを複数のメッセージ ブローカー間でパーティション分割するかどうかを示す値。

enablePartitioning?: boolean

プロパティ値

boolean

forwardDeadLetteredMessagesTo

配信不能メッセージを転送するキュー/トピック名

forwardDeadLetteredMessagesTo?: string

プロパティ値

string

forwardTo

メッセージを転送するためのキュー/トピック名

forwardTo?: string

プロパティ値

string

lockDuration

ピーク ロックの ISO 8601 期間。つまり、メッセージが他の受信者に対してロックされている時間です。 LockDuration の最大値は 5 分です。既定値は 1 分です。

lockDuration?: string

プロパティ値

string

maxDeliveryCount

配信の最大数。 この数の配信後、メッセージは自動的に配信不能になります。 既定値は 10 です。

maxDeliveryCount?: number

プロパティ値

number

maxMessageSizeInKilobytes

キューで受け入れ可能なメッセージ ペイロードの最大サイズ (KB 単位)。 このプロパティは現在 Premium でのみ使用され、既定値は 1024 です。

maxMessageSizeInKilobytes?: number

プロパティ値

number

maxSizeInMegabytes

キューの最大サイズ (MB 単位)。 これは、キューに割り当てられたメモリのサイズです。 既定値は 1024 です。

maxSizeInMegabytes?: number

プロパティ値

number

messageCount

キュー内のメッセージの数。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

messageCount?: number

プロパティ値

number

requiresDuplicateDetection

このキューで重複検出が必要かどうかを示す値。

requiresDuplicateDetection?: boolean

プロパティ値

boolean

requiresSession

キューがセッションの概念をサポートしているかどうかを示す値。

requiresSession?: boolean

プロパティ値

boolean

sizeInBytes

キューのサイズ (バイト単位)。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

sizeInBytes?: number

プロパティ値

number

status

メッセージング エンティティの状態に使用できる値を列挙します。

status?: EntityStatus

プロパティ値

EntityStatus

systemData

このリソースに関連するシステム メタデータ。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

systemData?: SystemData

プロパティ値

SystemData

updatedAt

メッセージが更新された正確な時刻。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

updatedAt?: Date

プロパティ値

Date

継承されたプロパティの詳細

id

リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

id?: string

プロパティ値

string

継承されたProxyResource.id

location

リソースが存在する地理的な場所注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

location?: string

プロパティ値

string

proxyResource.location から継承

name

リソースの名前注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

name?: string

プロパティ値

string

ProxyResource.name から継承された

type

リソースの型。 例: "Microsoft.EventHub/Namespaces" または "Microsoft.EventHub/Namespaces/EventHubs" 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

type?: string

プロパティ値

string

proxyResource.type から継承