Microsoft.ServiceBus 名前空間/キュー

[アーティクル]
07/24/2024

Bicep リソース定義

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

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

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

リソースの形式

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

resource symbolicname 'Microsoft.ServiceBus/namespaces/queues@2023-01-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  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'
  }
}

プロパティ値

namespaces/queues

名前	形容	価値
名前	リソース名 Bicepで子リソースの名前と種類設定する方法を参照してください。	string (必須) 文字制限: 1 ~ 260 有効な文字: 英数字、ピリオド、ハイフン、アンダースコア、およびスラッシュ。開始と終了は英数字で行います。
親	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'

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

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

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

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

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

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

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

リソースの形式

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

{
  "type": "Microsoft.ServiceBus/namespaces/queues",
  "apiVersion": "2023-01-01-preview",
  "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"
  }
}

プロパティ値

namespaces/queues

名前	形容	価値
種類	リソースの種類	'Microsoft.ServiceBus/namespaces/queues'
apiVersion	リソース API のバージョン	'2023-01-01-preview'
名前	リソース名 JSON ARM テンプレートで子リソースの名前と型設定する方法を参照してください。	string (必須) 文字制限: 1 ~ 260 有効な文字: 英数字、ピリオド、ハイフン、アンダースコア、およびスラッシュ。開始と終了は英数字で行います。
プロパティ	キューのプロパティ	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'

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

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

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

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

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

リソースグループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ServiceBus/namespaces/queues@2023-01-01-preview"
  name = "string"
  parent_id = "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"
    }
  })
}

プロパティ値

namespaces/queues

名前	形容	価値
種類	リソースの種類	"Microsoft.ServiceBus/namespaces/queues@2023-01-01-preview"
名前	リソース名	string (必須) 文字制限: 1 ~ 260 有効な文字: 英数字、ピリオド、ハイフン、アンダースコア、およびスラッシュ。開始と終了は英数字で行います。
parent_id	このリソースの親であるリソースの ID。	種類のリソースの ID: 名前空間
プロパティ	キューのプロパティ	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
地位	メッセージングエンティティの状態に使用できる値を列挙します。	"アクティブ" "作成中" "削除中" "無効" "ReceiveDisabled" "名前の変更" "復元中" "SendDisabled" "不明"

次の方法で共有

Microsoft.ServiceBus 名前空間/キュー

Bicep リソース定義

リソースの形式

プロパティ値

namespaces/queues

SBQueueProperties

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

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

リソースの形式

プロパティ値

namespaces/queues

SBQueueProperties

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

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

リソースの形式

プロパティ値

namespaces/queues

SBQueueProperties

フィードバック

その他のリソース

次の方法で共有

Microsoft.ServiceBus 名前空間/キュー

Bicep リソース定義

リソースの形式

プロパティ値

namespaces/queues

SBQueueProperties

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

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

リソースの形式

プロパティ値

namespaces/queues

SBQueueProperties

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

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

リソースの形式

プロパティ値

namespaces/queues

SBQueueProperties

フィードバック

その他のリソース

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

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

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