Microsoft.ServiceBus 名前空間/topics/subscriptions
Bicep リソース定義
名前空間/トピック/サブスクリプションリソースの種類は、次の場合にデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ServiceBus/namespaces/topics/subscriptions リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.ServiceBus/namespaces/topics/subscriptions@2022-01-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
autoDeleteOnIdle: 'string'
clientAffineProperties: {
clientId: 'string'
isDurable: bool
isShared: bool
}
deadLetteringOnFilterEvaluationExceptions: bool
deadLetteringOnMessageExpiration: bool
defaultMessageTimeToLive: 'string'
duplicateDetectionHistoryTimeWindow: 'string'
enableBatchedOperations: bool
forwardDeadLetteredMessagesTo: 'string'
forwardTo: 'string'
isClientAffine: bool
lockDuration: 'string'
maxDeliveryCount: int
requiresSession: bool
status: 'string'
}
}
プロパティの値
namespaces/topics/subscriptions
| 名前 | 説明 | 値 |
|---|---|---|
| name | リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。 |
string (必須) 文字制限: 1 から 50 有効な文字: 英数字、ピリオド、ハイフン、およびアンダースコア。 先頭と末尾には英数字を使用します。 |
| parent | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「 親リソースの外部の子リソース」を参照してください。 |
種類のリソースのシンボル名: トピック |
| properties | サブスクリプション リソースのプロパティ。 | SBSubscriptionProperties |
SBSubscriptionProperties
| 名前 | 説明 | 値 |
|---|---|---|
| autoDeleteOnIdle | ISO 8061 timeSpan アイドル間隔以降、トピックは自動的に削除されます。 最小時間は、5 分です。 | string |
| clientAffineProperties | クライアント アフィン サブスクリプションに固有のプロパティ。 | SBClientAffineProperties |
| deadLetteringOnFilterEvaluationExceptions | フィルター評価例外に対してサブスクリプションが配信不能サポートを持っているかどうかを示す値。 | [bool] |
| deadLetteringOnMessageExpiration | メッセージの有効期限が切れたときにサブスクリプションに配信不能のサポートがあるかどうかを示す値。 | [bool] |
| defaultMessageTimeToLive | ISO 8061 既定のメッセージの期間はライブ値です。 これは、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。 これは、メッセージ自体に TimeToLive が設定されていない場合に使用される既定値です。 | string |
| duplicateDetectionHistoryTimeWindow | 重複検出履歴の期間を定義する ISO 8601 timeSpan 構造体。 既定値は 10 分です。 | string |
| enableBatchedOperations | サーバー側のバッチ処理操作が有効かどうかを示す値。 | [bool] |
| forwardDeadLetteredMessagesTo | 配信不能メッセージを転送するキュー/トピック名 | string |
| forwardTo | メッセージを転送するためのキュー/トピック名 | string |
| isClientAffine | サブスクリプションがクライアント ID とアフィニティを持っているかどうかを示す値。 | [bool] |
| lockDuration | サブスクリプションの ISO 8061 ロック期間期間。 既定値は 1 分です。 | string |
| maxDeliveryCount | 配信の最大数。 | INT |
| requiresSession | サブスクリプションがセッションの概念をサポートしているかどうかを示す値。 | [bool] |
| status | メッセージング エンティティの状態に使用できる値を列挙します。 | 'Active' 'Creating' '削除中' 'Disabled' 'ReceiveDisabled' '名前の変更' '復元中' 'SendDisabled' '不明' |
SBClientAffineProperties
| 名前 | 説明 | 値 |
|---|---|---|
| clientId | client-affine サブスクリプションを作成したアプリケーションのクライアント ID を示します。 | string |
| isDurable | クライアント アフィン サブスクリプションの場合、この値はサブスクリプションが永続的かどうかを示します。 | [bool] |
| Isshared | client-affine サブスクリプションの場合、この値はサブスクリプションが共有されているかどうかを示します。 | [bool] |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| テンプレート | 説明 |
|---|---|
統合パターン - メッセージ ルーター - Service Bus |
Service Bus トピックを使用してメッセージ ルーター パターンを設定する方法を示すソリューション |
| Service Bus を使用した Logic Apps でのメッセージの関連付け |
を使用して Logic Apps にメッセージを関連付ける方法を示Azure Service Bus |
ARM テンプレート リソース定義
namespaces/topics/subscriptions リソースの種類は、次のようにデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ServiceBus/namespaces/topics/subscriptions リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.ServiceBus/namespaces/topics/subscriptions",
"apiVersion": "2022-01-01-preview",
"name": "string",
"properties": {
"autoDeleteOnIdle": "string",
"clientAffineProperties": {
"clientId": "string",
"isDurable": "bool",
"isShared": "bool"
},
"deadLetteringOnFilterEvaluationExceptions": "bool",
"deadLetteringOnMessageExpiration": "bool",
"defaultMessageTimeToLive": "string",
"duplicateDetectionHistoryTimeWindow": "string",
"enableBatchedOperations": "bool",
"forwardDeadLetteredMessagesTo": "string",
"forwardTo": "string",
"isClientAffine": "bool",
"lockDuration": "string",
"maxDeliveryCount": "int",
"requiresSession": "bool",
"status": "string"
}
}
プロパティの値
namespaces/topics/subscriptions
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | 'Microsoft.ServiceBus/namespaces/topics/subscriptions' |
| apiVersion | リソース API のバージョン | '2022-01-01-preview' |
| name | リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。 |
string (必須) 文字数制限: 1 から 50 有効な文字: 英数字、ピリオド、ハイフン、およびアンダースコア。 先頭と末尾には英数字を使用します。 |
| properties | サブスクリプション リソースのプロパティ。 | SBSubscriptionProperties |
SBSubscriptionProperties
| 名前 | 説明 | 値 |
|---|---|---|
| autoDeleteOnIdle | ISO 8061 timeSpan アイドル間隔以降、トピックは自動的に削除されます。 最小時間は、5 分です。 | string |
| clientAffineProperties | クライアント アフィン サブスクリプションに固有のプロパティ。 | SBClientAffineProperties |
| deadLetteringOnFilterEvaluationExceptions | フィルター評価例外でサブスクリプションが配信不能サポートを持っているかどうかを示す値。 | [bool] |
| deadLetteringOnMessageExpiration | メッセージの有効期限が切れたときにサブスクリプションが配信不能サポートを持っているかどうかを示す値。 | [bool] |
| defaultMessageTimeToLive | ISO 8061 メッセージの既定の期間をライブ値にします。 これは、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。 これは、メッセージ自体に TimeToLive が設定されていない場合に使用される既定値です。 | string |
| duplicateDetectionHistoryTimeWindow | 重複検出履歴の期間を定義する ISO 8601 timeSpan 構造体。 既定値は 10 分です。 | string |
| enableBatchedOperations | サーバー側のバッチ処理操作が有効かどうかを示す値。 | [bool] |
| forwardDeadLetteredMessagesTo | 配信不能メッセージを転送するキュー/トピック名 | string |
| forwardTo | メッセージを転送するキュー/トピック名 | string |
| isClientAffine | サブスクリプションがクライアント ID とアフィニティを持っているかどうかを示す値。 | [bool] |
| lockDuration | サブスクリプションの ISO 8061 ロック期間。 既定値は 1 分です。 | string |
| maxDeliveryCount | 配信の最大数。 | INT |
| requiresSession | サブスクリプションがセッションの概念をサポートしているかどうかを示す値。 | [bool] |
| status | メッセージング エンティティの状態に使用できる値を列挙します。 | 'Active' 'Creating' '削除中' 'Disabled' 'ReceiveDisabled' '名前の変更' '復元中' 'SendDisabled' '不明' |
SBClientAffineProperties
| 名前 | 説明 | 値 |
|---|---|---|
| clientId | client-affine サブスクリプションを作成したアプリケーションのクライアント ID を示します。 | string |
| isDurable | client-affine サブスクリプションの場合、この値はサブスクリプションが永続的かどうかを示します。 | [bool] |
| Isshared | client-affine サブスクリプションの場合、この値はサブスクリプションが共有されているかどうかを示します。 | [bool] |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| テンプレート | 説明 |
|---|---|
| 統合パターン - メッセージ ルーター - Service Bus |
Service Bus トピックを使用してメッセージ ルーター パターンを設定する方法を示すソリューション |
| Service Bus を使用した Logic Apps でのメッセージの関連付け |
これは、Azure Service Busを使用して Logic Apps にメッセージを関連付ける方法を示しています |
Terraform (AzAPI プロバイダー) リソース定義
名前空間/トピック/サブスクリプションリソースの種類は、次の場合にデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ServiceBus/namespaces/topics/subscriptions リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ServiceBus/namespaces/topics/subscriptions@2022-01-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
autoDeleteOnIdle = "string"
clientAffineProperties = {
clientId = "string"
isDurable = bool
isShared = bool
}
deadLetteringOnFilterEvaluationExceptions = bool
deadLetteringOnMessageExpiration = bool
defaultMessageTimeToLive = "string"
duplicateDetectionHistoryTimeWindow = "string"
enableBatchedOperations = bool
forwardDeadLetteredMessagesTo = "string"
forwardTo = "string"
isClientAffine = bool
lockDuration = "string"
maxDeliveryCount = int
requiresSession = bool
status = "string"
}
})
}
プロパティの値
namespaces/topics/subscriptions
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | "Microsoft.ServiceBus/namespaces/topics/subscriptions@2022-01-01-preview" |
| name | リソース名 | string (必須) 文字制限: 1 から 50 有効な文字: 英数字、ピリオド、ハイフン、およびアンダースコア。 先頭と末尾には英数字を使用します。 |
| parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: トピック |
| properties | サブスクリプション リソースのプロパティ。 | SBSubscriptionProperties |
SBSubscriptionProperties
| 名前 | 説明 | 値 |
|---|---|---|
| autoDeleteOnIdle | ISO 8061 timeSpan アイドル間隔以降、トピックは自動的に削除されます。 最小時間は、5 分です。 | string |
| clientAffineProperties | クライアント アフィン サブスクリプションに固有のプロパティ。 | SBClientAffineProperties |
| deadLetteringOnFilterEvaluationExceptions | フィルター評価例外に対してサブスクリプションが配信不能サポートを持っているかどうかを示す値。 | [bool] |
| deadLetteringOnMessageExpiration | メッセージの有効期限が切れたときにサブスクリプションに配信不能のサポートがあるかどうかを示す値。 | [bool] |
| defaultMessageTimeToLive | ISO 8061 既定のメッセージの期間はライブ値です。 これは、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。 これは、メッセージ自体に TimeToLive が設定されていない場合に使用される既定値です。 | string |
| duplicateDetectionHistoryTimeWindow | 重複検出履歴の期間を定義する ISO 8601 timeSpan 構造体。 既定値は 10 分です。 | string |
| enableBatchedOperations | サーバー側のバッチ処理操作が有効かどうかを示す値。 | [bool] |
| forwardDeadLetteredMessagesTo | 配信不能メッセージを転送するキュー/トピック名 | string |
| forwardTo | メッセージを転送するためのキュー/トピック名 | string |
| isClientAffine | サブスクリプションがクライアント ID とアフィニティを持っているかどうかを示す値。 | [bool] |
| lockDuration | サブスクリプションの ISO 8061 ロック期間期間。 既定値は 1 分です。 | string |
| maxDeliveryCount | 配信の最大数。 | INT |
| requiresSession | サブスクリプションがセッションの概念をサポートしているかどうかを示す値。 | [bool] |
| status | メッセージング エンティティの状態に使用できる値を列挙します。 | "アクティブ" "作成中" "削除中" "無効" "ReceiveDisabled" "名前の変更" "復元中" "SendDisabled" "Unknown" |
SBClientAffineProperties
| 名前 | 説明 | 値 |
|---|---|---|
| clientId | client-affine サブスクリプションを作成したアプリケーションのクライアント ID を示します。 | string |
| isDurable | クライアント アフィン サブスクリプションの場合、この値はサブスクリプションが永続的かどうかを示します。 | [bool] |
| Isshared | client-affine サブスクリプションの場合、この値はサブスクリプションが共有されているかどうかを示します。 | [bool] |