Microsoft.ServiceBus 名前空間/キュー

• 最新の を する
• 2024-01-01
• 2023-01-01-preview
• 2022-10-01-preview
• 2022-01-01-preview
• 2021-11-01
• 2021-06-01-preview
• 2021-01-01-preview
• 2018-01-01-preview
• 2017-04-01
• 2015-08-01

Bicep リソース定義

名前空間/キューのリソースの種類は、次を対象とする操作と共にデプロイできます。

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

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

リソースの形式

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

resource symbolicname 'Microsoft.ServiceBus/namespaces/queues@2024-01-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    autoDeleteOnIdle: 'string'
    deadLetteringOnMessageExpiration: bool
    defaultMessageTimeToLive: 'string'
    duplicateDetectionHistoryTimeWindow: 'string'
    enableBatchedOperations: bool
    enableExpress: bool
    enablePartitioning: bool
    forwardDeadLetteredMessagesTo: 'string'
    forwardTo: 'string'
    lockDuration: 'string'
    maxDeliveryCount: int
    maxMessageSizeInKilobytes: int
    maxSizeInMegabytes: int
    requiresDuplicateDetection: bool
    requiresSession: bool
    status: 'string'
  }
}

プロパティ値

Microsoft.ServiceBus/namespaces/queues

名前	形容	価値
名前	リソース名	糸 制約： 最小長 = 1 (必須)
親	Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「親リソースの外部 子リソース」を参照してください。	種類のリソースのシンボリック名: 名前空間
プロパティ	キューのプロパティ	SBQueueProperties の

SBQueueProperties

名前	形容	価値
autoDeleteOnIdle	ISO 8061 timeSpan アイドル間隔。その後、キューが自動的に削除されます。 最小期間は 5 分です。	糸
deadLetteringOnMessageExpiration	メッセージの有効期限が切れたときに、このキューで配信不能がサポートされているかどうかを示す値。	bool
defaultMessageTimeToLive	ISO 8601 の既定のメッセージ期間からライブ値。 これは、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。 これは、メッセージ自体に TimeToLive が設定されていない場合に使用される既定値です。	糸
duplicateDetectionHistoryTimeWindow	重複検出履歴の期間を定義する ISO 8601 timeSpan 構造体。 既定値は 10 分です。	糸
enableBatchedOperations	サーバー側のバッチ処理操作が有効かどうかを示す値。	bool
enableExpress	Express エンティティが有効かどうかを示す値。 高速キューは、永続ストレージに書き込む前に、メッセージを一時的にメモリに保持します。	bool
enablePartitioning	キューを複数のメッセージ ブローカー間でパーティション分割するかどうかを示す値。	bool
forwardDeadLetteredMessagesTo	配信不能メッセージを転送するキュー/トピック名	糸
forwardTo	メッセージを転送するためのキュー/トピック名	糸
lockDuration	ピーク ロックの ISO 8601 期間。つまり、メッセージが他の受信者に対してロックされている時間です。 LockDuration の最大値は 5 分です。既定値は 1 分です。	糸
maxDeliveryCount	配信の最大数。 この数の配信後、メッセージは自動的に配信不能になります。 既定値は 10 です。	int
maxMessageSizeInKilobytes	キューで受け入れ可能なメッセージ ペイロードの最大サイズ (KB 単位)。 このプロパティは現在 Premium でのみ使用され、既定値は 1024 です。	int
maxSizeInMegabytes	キューの最大サイズ (MB 単位)。 これは、キューに割り当てられたメモリのサイズです。 既定値は 1024 です。	int
requiresDuplicateDetection	このキューで重複検出が必要かどうかを示す値。	bool
requiresSession	キューがセッションの概念をサポートしているかどうかを示す値。	bool
地位	メッセージング エンティティの状態に使用できる値を列挙します。	'Active' 'Creating' '削除中' 'Disabled' 'ReceiveDisabled' '名前の変更' '復元中' 'SendDisabled' 'Unknown'

クイック スタートのサンプル

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

Bicep ファイル	形容
Service Bus の名前空間とキューを作成する	このテンプレートを使用すると、Service Bus Standard 名前空間とキューをデプロイできます。
Azure Event Grid カスタム トピックとキュー サブスクリプション を作成する	Azure Event Grid カスタム トピックと Service Bus キュー サブスクリプションを作成します。 テンプレートはもともと Markus Meyer によって作成されました。

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

名前空間/キューのリソースの種類は、次を対象とする操作と共にデプロイできます。

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

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

リソースの形式

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

{
  "type": "Microsoft.ServiceBus/namespaces/queues",
  "apiVersion": "2024-01-01",
  "name": "string",
  "properties": {
    "autoDeleteOnIdle": "string",
    "deadLetteringOnMessageExpiration": "bool",
    "defaultMessageTimeToLive": "string",
    "duplicateDetectionHistoryTimeWindow": "string",
    "enableBatchedOperations": "bool",
    "enableExpress": "bool",
    "enablePartitioning": "bool",
    "forwardDeadLetteredMessagesTo": "string",
    "forwardTo": "string",
    "lockDuration": "string",
    "maxDeliveryCount": "int",
    "maxMessageSizeInKilobytes": "int",
    "maxSizeInMegabytes": "int",
    "requiresDuplicateDetection": "bool",
    "requiresSession": "bool",
    "status": "string"
  }
}

プロパティ値

Microsoft.ServiceBus/namespaces/queues

名前	形容	価値
apiVersion	API のバージョン	'2024-01-01'
名前	リソース名	糸 制約： 最小長 = 1 (必須)
プロパティ	キューのプロパティ	SBQueueProperties の
種類	リソースの種類	'Microsoft.ServiceBus/namespaces/queues'

SBQueueProperties

名前	形容	価値
autoDeleteOnIdle	ISO 8061 timeSpan アイドル間隔。その後、キューが自動的に削除されます。 最小期間は 5 分です。	糸
deadLetteringOnMessageExpiration	メッセージの有効期限が切れたときに、このキューで配信不能がサポートされているかどうかを示す値。	bool
defaultMessageTimeToLive	ISO 8601 の既定のメッセージ期間からライブ値。 これは、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。 これは、メッセージ自体に TimeToLive が設定されていない場合に使用される既定値です。	糸
duplicateDetectionHistoryTimeWindow	重複検出履歴の期間を定義する ISO 8601 timeSpan 構造体。 既定値は 10 分です。	糸
enableBatchedOperations	サーバー側のバッチ処理操作が有効かどうかを示す値。	bool
enableExpress	Express エンティティが有効かどうかを示す値。 高速キューは、永続ストレージに書き込む前に、メッセージを一時的にメモリに保持します。	bool
enablePartitioning	キューを複数のメッセージ ブローカー間でパーティション分割するかどうかを示す値。	bool
forwardDeadLetteredMessagesTo	配信不能メッセージを転送するキュー/トピック名	糸
forwardTo	メッセージを転送するためのキュー/トピック名	糸
lockDuration	ピーク ロックの ISO 8601 期間。つまり、メッセージが他の受信者に対してロックされている時間です。 LockDuration の最大値は 5 分です。既定値は 1 分です。	糸
maxDeliveryCount	配信の最大数。 この数の配信後、メッセージは自動的に配信不能になります。 既定値は 10 です。	int
maxMessageSizeInKilobytes	キューで受け入れ可能なメッセージ ペイロードの最大サイズ (KB 単位)。 このプロパティは現在 Premium でのみ使用され、既定値は 1024 です。	int
maxSizeInMegabytes	キューの最大サイズ (MB 単位)。 これは、キューに割り当てられたメモリのサイズです。 既定値は 1024 です。	int
requiresDuplicateDetection	このキューで重複検出が必要かどうかを示す値。	bool
requiresSession	キューがセッションの概念をサポートしているかどうかを示す値。	bool
地位	メッセージング エンティティの状態に使用できる値を列挙します。	'Active' 'Creating' '削除中' 'Disabled' 'ReceiveDisabled' '名前の変更' '復元中' 'SendDisabled' 'Unknown'

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

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

テンプレート	形容
Service Bus の名前空間とキューを作成する Azure にデプロイする	このテンプレートを使用すると、Service Bus Standard 名前空間とキューをデプロイできます。
Azure Event Grid カスタム トピックとキュー サブスクリプション を作成する Azure にデプロイする	Azure Event Grid カスタム トピックと Service Bus キュー サブスクリプションを作成します。 テンプレートはもともと Markus Meyer によって作成されました。

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

名前空間/キューのリソースの種類は、次を対象とする操作と共にデプロイできます。

• リソース グループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ServiceBus/namespaces/queues@2024-01-01"
  name = "string"
  body = jsonencode({
    properties = {
      autoDeleteOnIdle = "string"
      deadLetteringOnMessageExpiration = bool
      defaultMessageTimeToLive = "string"
      duplicateDetectionHistoryTimeWindow = "string"
      enableBatchedOperations = bool
      enableExpress = bool
      enablePartitioning = bool
      forwardDeadLetteredMessagesTo = "string"
      forwardTo = "string"
      lockDuration = "string"
      maxDeliveryCount = int
      maxMessageSizeInKilobytes = int
      maxSizeInMegabytes = int
      requiresDuplicateDetection = bool
      requiresSession = bool
      status = "string"
    }
  })
}

プロパティ値

Microsoft.ServiceBus/namespaces/queues

名前	形容	価値
名前	リソース名	糸 制約： 最小長 = 1 (必須)
parent_id	このリソースの親であるリソースの ID。	種類のリソースの ID: 名前空間
プロパティ	キューのプロパティ	SBQueueProperties の
種類	リソースの種類	"Microsoft.ServiceBus/namespaces/queues@2024-01-01"

SBQueueProperties

名前	形容	価値
autoDeleteOnIdle	ISO 8061 timeSpan アイドル間隔。その後、キューが自動的に削除されます。 最小期間は 5 分です。	糸
deadLetteringOnMessageExpiration	メッセージの有効期限が切れたときに、このキューで配信不能がサポートされているかどうかを示す値。	bool
defaultMessageTimeToLive	ISO 8601 の既定のメッセージ期間からライブ値。 これは、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。 これは、メッセージ自体に TimeToLive が設定されていない場合に使用される既定値です。	糸
duplicateDetectionHistoryTimeWindow	重複検出履歴の期間を定義する ISO 8601 timeSpan 構造体。 既定値は 10 分です。	糸
enableBatchedOperations	サーバー側のバッチ処理操作が有効かどうかを示す値。	bool
enableExpress	Express エンティティが有効かどうかを示す値。 高速キューは、永続ストレージに書き込む前に、メッセージを一時的にメモリに保持します。	bool
enablePartitioning	キューを複数のメッセージ ブローカー間でパーティション分割するかどうかを示す値。	bool
forwardDeadLetteredMessagesTo	配信不能メッセージを転送するキュー/トピック名	糸
forwardTo	メッセージを転送するためのキュー/トピック名	糸
lockDuration	ピーク ロックの ISO 8601 期間。つまり、メッセージが他の受信者に対してロックされている時間です。 LockDuration の最大値は 5 分です。既定値は 1 分です。	糸
maxDeliveryCount	配信の最大数。 この数の配信後、メッセージは自動的に配信不能になります。 既定値は 10 です。	int
maxMessageSizeInKilobytes	キューで受け入れ可能なメッセージ ペイロードの最大サイズ (KB 単位)。 このプロパティは現在 Premium でのみ使用され、既定値は 1024 です。	int
maxSizeInMegabytes	キューの最大サイズ (MB 単位)。 これは、キューに割り当てられたメモリのサイズです。 既定値は 1024 です。	int
requiresDuplicateDetection	このキューで重複検出が必要かどうかを示す値。	bool
requiresSession	キューがセッションの概念をサポートしているかどうかを示す値。	bool
地位	メッセージング エンティティの状態に使用できる値を列挙します。	'Active' 'Creating' '削除中' 'Disabled' 'ReceiveDisabled' '名前の変更' '復元中' 'SendDisabled' 'Unknown'