Microsoft.ServiceBus 名前空間/topics/subscriptions

Bicep リソース定義

名前空間/トピック/サブスクリプションのリソースの種類は、次をターゲットとする操作でデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.ServiceBus/namespaces/topics/subscriptions リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.ServiceBus/namespaces/topics/subscriptions@2023-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

名前 形容 価値
名前 リソース名

Bicepで子リソースの名前と種類 設定する方法を参照してください。
string (必須)

文字数制限: 1 から 50

有効な文字:
英数字、ピリオド、ハイフン、アンダースコア。

開始と終了を数値で表示します。
Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「親リソースの外部 子リソース」を参照してください。
種類のリソースのシンボリック名: トピック
プロパティ サブスクリプション リソースのプロパティ。 SBSubscriptionProperties

SBSubscriptionProperties

名前 形容 価値
autoDeleteOnIdle ISO 8061 timeSpan アイドル間隔。その後、トピックは自動的に削除されます。 最小期間は 5 分です。
clientAffineProperties クライアント アフィン サブスクリプションに固有のプロパティ。 SBClientAffineProperties の
deadLetteringOnFilterEvaluationExceptions フィルター評価例外でサブスクリプションが配信不能サポートを持っているかどうかを示す値。 bool
deadLetteringOnMessageExpiration メッセージの有効期限が切れたときにサブスクリプションが配信不能サポートを受けるかどうかを示す値。 bool
defaultMessageTimeToLive ISO 8061 既定のメッセージの期間がライブ値になります。 これは、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。 これは、メッセージ自体に TimeToLive が設定されていない場合に使用される既定値です。
duplicateDetectionHistoryTimeWindow 重複検出履歴の期間を定義する ISO 8601 timeSpan 構造体。 既定値は 10 分です。
enableBatchedOperations サーバー側のバッチ処理操作が有効かどうかを示す値。 bool
forwardDeadLetteredMessagesTo 配信不能メッセージを転送するキュー/トピック名
forwardTo メッセージを転送するためのキュー/トピック名
isClientAffine サブスクリプションがクライアント ID とアフィニティを持っているかどうかを示す値。 bool
lockDuration サブスクリプションの ISO 8061 ロック期間。 既定値は 1 分です。
maxDeliveryCount 配信の最大数。 int
requiresSession サブスクリプションがセッションの概念をサポートしているかどうかを示す値。 bool
地位 メッセージング エンティティの状態に使用できる値を列挙します。 'Active'
'Creating'
'削除中'
'Disabled'
'ReceiveDisabled'
'名前の変更'
'復元中'
'SendDisabled'
'Unknown'

SBClientAffineProperties

名前 形容 価値
clientId クライアント アフィン サブスクリプションを作成したアプリケーションのクライアント ID を示します。
isDurable クライアント アフィン サブスクリプションの場合、この値はサブスクリプションが永続的かどうかを示します。 bool
isShared クライアント アフィン サブスクリプションの場合、この値はサブスクリプションが共有されているかどうかを示します。 bool

クイック スタート テンプレート

次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。

テンプレート 形容
統合パターン - メッセージ ルーター - Service Bus

Azure にデプロイする
Service Bus トピックを使用してメッセージ ルーター パターンを設定する方法を示すソリューション
Service Bus を使用した Logic Apps でのメッセージの関連付け

Azure
にデプロイする
Azure Service Bus を使用して Logic Apps 上でメッセージを関連付ける方法を示す

ARM テンプレート リソース定義

名前空間/トピック/サブスクリプションのリソースの種類は、次をターゲットとする操作でデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.ServiceBus/namespaces/topics/subscriptions リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.ServiceBus/namespaces/topics/subscriptions",
  "apiVersion": "2023-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

名前 形容 価値
種類 リソースの種類 'Microsoft.ServiceBus/namespaces/topics/subscriptions'
apiVersion リソース API のバージョン '2023-01-01-preview'
名前 リソース名

JSON ARM テンプレートで子リソースの名前と型 設定する方法を参照してください。
string (必須)

文字数制限: 1 から 50

有効な文字:
英数字、ピリオド、ハイフン、アンダースコア。

開始と終了を数値で表示します。
プロパティ サブスクリプション リソースのプロパティ。 SBSubscriptionProperties

SBSubscriptionProperties

名前 形容 価値
autoDeleteOnIdle ISO 8061 timeSpan アイドル間隔。その後、トピックは自動的に削除されます。 最小期間は 5 分です。
clientAffineProperties クライアント アフィン サブスクリプションに固有のプロパティ。 SBClientAffineProperties の
deadLetteringOnFilterEvaluationExceptions フィルター評価例外でサブスクリプションが配信不能サポートを持っているかどうかを示す値。 bool
deadLetteringOnMessageExpiration メッセージの有効期限が切れたときにサブスクリプションが配信不能サポートを受けるかどうかを示す値。 bool
defaultMessageTimeToLive ISO 8061 既定のメッセージの期間がライブ値になります。 これは、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。 これは、メッセージ自体に TimeToLive が設定されていない場合に使用される既定値です。
duplicateDetectionHistoryTimeWindow 重複検出履歴の期間を定義する ISO 8601 timeSpan 構造体。 既定値は 10 分です。
enableBatchedOperations サーバー側のバッチ処理操作が有効かどうかを示す値。 bool
forwardDeadLetteredMessagesTo 配信不能メッセージを転送するキュー/トピック名
forwardTo メッセージを転送するためのキュー/トピック名
isClientAffine サブスクリプションがクライアント ID とアフィニティを持っているかどうかを示す値。 bool
lockDuration サブスクリプションの ISO 8061 ロック期間。 既定値は 1 分です。
maxDeliveryCount 配信の最大数。 int
requiresSession サブスクリプションがセッションの概念をサポートしているかどうかを示す値。 bool
地位 メッセージング エンティティの状態に使用できる値を列挙します。 'Active'
'Creating'
'削除中'
'Disabled'
'ReceiveDisabled'
'名前の変更'
'復元中'
'SendDisabled'
'Unknown'

SBClientAffineProperties

名前 形容 価値
clientId クライアント アフィン サブスクリプションを作成したアプリケーションのクライアント ID を示します。
isDurable クライアント アフィン サブスクリプションの場合、この値はサブスクリプションが永続的かどうかを示します。 bool
isShared クライアント アフィン サブスクリプションの場合、この値はサブスクリプションが共有されているかどうかを示します。 bool

クイック スタート テンプレート

次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。

テンプレート 形容
統合パターン - メッセージ ルーター - Service Bus

Azure にデプロイする
Service Bus トピックを使用してメッセージ ルーター パターンを設定する方法を示すソリューション
Service Bus を使用した Logic Apps でのメッセージの関連付け

Azure
にデプロイする
Azure Service Bus を使用して Logic Apps 上でメッセージを関連付ける方法を示す

Terraform (AzAPI プロバイダー) リソース定義

名前空間/トピック/サブスクリプションのリソースの種類は、次をターゲットとする操作でデプロイできます。

  • リソース グループの

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.ServiceBus/namespaces/topics/subscriptions リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ServiceBus/namespaces/topics/subscriptions@2023-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

名前 形容 価値
種類 リソースの種類 "Microsoft.ServiceBus/namespaces/topics/subscriptions@2023-01-01-preview"
名前 リソース名 string (必須)

文字数制限: 1 から 50

有効な文字:
英数字、ピリオド、ハイフン、アンダースコア。

開始と終了を数値で表示します。
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: トピック
プロパティ サブスクリプション リソースのプロパティ。 SBSubscriptionProperties

SBSubscriptionProperties

名前 形容 価値
autoDeleteOnIdle ISO 8061 timeSpan アイドル間隔。その後、トピックは自動的に削除されます。 最小期間は 5 分です。
clientAffineProperties クライアント アフィン サブスクリプションに固有のプロパティ。 SBClientAffineProperties の
deadLetteringOnFilterEvaluationExceptions フィルター評価例外でサブスクリプションが配信不能サポートを持っているかどうかを示す値。 bool
deadLetteringOnMessageExpiration メッセージの有効期限が切れたときにサブスクリプションが配信不能サポートを受けるかどうかを示す値。 bool
defaultMessageTimeToLive ISO 8061 既定のメッセージの期間がライブ値になります。 これは、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。 これは、メッセージ自体に TimeToLive が設定されていない場合に使用される既定値です。
duplicateDetectionHistoryTimeWindow 重複検出履歴の期間を定義する ISO 8601 timeSpan 構造体。 既定値は 10 分です。
enableBatchedOperations サーバー側のバッチ処理操作が有効かどうかを示す値。 bool
forwardDeadLetteredMessagesTo 配信不能メッセージを転送するキュー/トピック名
forwardTo メッセージを転送するためのキュー/トピック名
isClientAffine サブスクリプションがクライアント ID とアフィニティを持っているかどうかを示す値。 bool
lockDuration サブスクリプションの ISO 8061 ロック期間。 既定値は 1 分です。
maxDeliveryCount 配信の最大数。 int
requiresSession サブスクリプションがセッションの概念をサポートしているかどうかを示す値。 bool
地位 メッセージング エンティティの状態に使用できる値を列挙します。 "アクティブ"
"作成中"
"削除中"
"無効"
"ReceiveDisabled"
"名前の変更"
"復元中"
"SendDisabled"
"不明"

SBClientAffineProperties

名前 形容 価値
clientId クライアント アフィン サブスクリプションを作成したアプリケーションのクライアント ID を示します。
isDurable クライアント アフィン サブスクリプションの場合、この値はサブスクリプションが永続的かどうかを示します。 bool
isShared クライアント アフィン サブスクリプションの場合、この値はサブスクリプションが共有されているかどうかを示します。 bool