CreateTopicOptions interface
トピックの設定可能なオプションを表します
- Extends
プロパティ
| authorization |
トピックの承認規則 |
| auto |
エンティティが削除されるまでの最大アイドル時間。 これは、ISO-8601 の期間形式 ("PT1M" など) で 1 分間指定し、"PT5S" を 5 秒間指定します。 ISO-8601 期間形式の詳細: https://en.wikipedia.org/wiki/ISO_8601#Durations |
| availability |
メッセージング エンティティの可用性の状態。 |
| default |
メッセージが、関連するサブスクリプション内に存在する期間を決定します。 より短い 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 |
トピックをパーティション分割するかどうかを指定します |
| max |
このトピックに送信されるメッセージの最大メッセージ サイズ (キロバイト単位)。 (Premium レベルの Service Bus 名前空間に対してのみ構成できます)。 |
| max |
トピックの最大サイズ (MB 単位) を指定します。 トピックがこの値を超えるメッセージをエンキューしようとすると、失敗します。 トピックまたはトピックのサブスクリプションに保存されたすべてのメッセージは、この値になるまでカウントされます。 1 つまたは複数のサブスクリプションに存在するメッセージの複数のコピーは、1 つのメッセージとしてカウントされます。 たとえば、サブスクリプション s1 にメッセージ m が 1 回存在し、サブスクリプション s2 に 2 回存在する場合、m は 1 つのメッセージとしてカウントされます。 |
| requires |
有効にすると、トピックは DuplicateDetectionHistoryTimeWindow プロパティで指定された期間内に重複するメッセージを検出します。 トピックの作成時にのみ設定可能です。 |
| status | メッセージング エンティティの状態。 |
| support |
トピックがメッセージの順序付けをサポートするかどうかを指定します。 |
| 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プロパティ値
defaultMessageTimeToLive
メッセージが、関連するサブスクリプション内に存在する期間を決定します。 より短い 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
maxMessageSizeInKilobytes
このトピックに送信されるメッセージの最大メッセージ サイズ (キロバイト単位)。
(Premium レベルの Service Bus 名前空間に対してのみ構成できます)。
maxMessageSizeInKilobytes?: numberプロパティ値
number
maxSizeInMegabytes
トピックの最大サイズ (MB 単位) を指定します。 トピックがこの値を超えるメッセージをエンキューしようとすると、失敗します。 トピックまたはトピックのサブスクリプションに保存されたすべてのメッセージは、この値になるまでカウントされます。 1 つまたは複数のサブスクリプションに存在するメッセージの複数のコピーは、1 つのメッセージとしてカウントされます。 たとえば、サブスクリプション s1 にメッセージ m が 1 回存在し、サブスクリプション s2 に 2 回存在する場合、m は 1 つのメッセージとしてカウントされます。
maxSizeInMegabytes?: numberプロパティ値
number
requiresDuplicateDetection
有効にすると、トピックは DuplicateDetectionHistoryTimeWindow プロパティで指定された期間内に重複するメッセージを検出します。 トピックの作成時にのみ設定可能です。
requiresDuplicateDetection?: booleanプロパティ値
boolean
status
supportOrdering
トピックがメッセージの順序付けをサポートするかどうかを指定します。
supportOrdering?: booleanプロパティ値
boolean
userMetadata
ユーザーがトピックに関連付けられているメタデータ情報を提供しました。 タグ、ラベルなどのテキスト コンテンツを指定するために使用されます。値は utf-8 でエンコードされた 1024 バイトを超えてはなりません。
userMetadata?: stringプロパティ値
string
継承されたプロパティの詳細
abortSignal
要求を中止するために使用できるシグナル。
abortSignal?: AbortSignalLikeプロパティ値
onResponse
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
onResponse?: RawResponseCallbackプロパティ値
requestOptions
この操作の HTTP 要求を作成および送信するときに使用されるオプション。
requestOptions?: OperationRequestOptionsプロパティ値
serializerOptions
シリアル化/シリアル化解除の動作をオーバーライドするオプション。
serializerOptions?: SerializerOptionsプロパティ値
tracingOptions
トレースが有効な場合に使用されるオプション。
tracingOptions?: OperationTracingOptions