Microsoft.ServiceBus 名前空間/キュー
Bicep リソース定義
namespaces/queues リソースの種類は、次の対象にデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ServiceBus/namespaces/queues リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.ServiceBus/namespaces/queues@2022-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
名前 | 説明 | 値 |
---|---|---|
name | リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。 |
string (必須) 文字数制限: 1 から 260 有効な文字: 英数字、ピリオド、ハイフン、アンダースコア、およびスラッシュ。 先頭と末尾には英数字を使用します。 |
parent | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「 親リソースの外部にある子リソース」を参照してください。 |
型のリソースのシンボル名: 名前空間 |
properties | Queue プロパティ | SBQueueProperties |
SBQueueProperties
名前 | 説明 | 値 |
---|---|---|
autoDeleteOnIdle | ISO 8061 timeSpan アイドル間隔後、キューは自動的に削除されます。 最小時間は、5 分です。 | string |
deadLetteringOnMessageExpiration | メッセージの有効期限が切れたときに、このキューが配信不能サポートを持っているかどうかを示す 値。 | [bool] |
defaultMessageTimeToLive | ISO 8601 の既定のメッセージ時間スパンがライブ値になります。 これは、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。 これは、メッセージ自体に TimeToLive が設定されていない場合に使用される既定値です。 | string |
duplicateDetectionHistoryTimeWindow | 重複検出履歴の期間を定義する ISO 8601 timeSpan 構造体。 既定値は 10 分です。 | string |
enableBatchedOperations | サーバー側のバッチ処理操作が有効かどうかを示す値。 | [bool] |
enableExpress | Express Entities が有効かどうかを示す 値。 高速キューは、永続ストレージに書き込む前に、メッセージを一時的にメモリに保持します。 | [bool] |
enablePartitioning | キューを複数のメッセージ ブローカー間でパーティション分割するかどうかを示す 値。 | [bool] |
forwardDeadLetteredMessagesTo | 配信不能メッセージを転送するキュー/トピック名 | string |
forwardTo | メッセージを転送するキュー/トピック名 | string |
lockDuration | ピーク ロックの ISO 8601 期間。つまり、メッセージが他の受信者に対してロックされている時間です。 LockDuration の最大値は 5 分です。既定値は 1 分です。 | string |
maxDeliveryCount | 配信の最大数。 この配信数を越えた後のメッセージは自動的に配信不能になります。 既定値は 10 です。 | INT |
maxMessageSizeInKilobytes | キューで受け入れられるメッセージ ペイロードの最大サイズ (KB 単位)。 このプロパティは現在 Premium でのみ使用され、既定値は 1024 です。 | INT |
maxSizeInMegabytes | キューの最大サイズ (MB 単位)。 これは、キューに割り当てられたメモリのサイズです。 既定値は 1024 です。 | INT |
requiresDuplicateDetection | このキューで重複検出が必要かどうかを示す 値。 | [bool] |
requiresSession | キューがセッションの概念をサポートしているかどうかを示す 値。 | [bool] |
status | メッセージング エンティティの状態に使用できる値を列挙します。 | 'Active' 'Creating' '削除中' 'Disabled' 'ReceiveDisabled' '名前の変更' '復元中' 'SendDisabled' '不明' |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
Template | 説明 |
---|---|
カスタム トピックとキュー サブスクリプションAzure Event Grid作成する |
Azure Event Gridカスタム トピックと Service Bus キュー サブスクリプションを作成します。 テンプレートはもともと Markus Meyer によって作成されました。 |
Service Bus 名前空間とキュー承認規則を作成する |
このテンプレートを使用すると、Service Bus Standard 名前空間と、名前空間とキューの両方の承認規則をデプロイできます。 |
Service Bus の名前空間とキューを作成する |
このテンプレートを使用すると、Service Bus Standard 名前空間とキューをデプロイできます。 |
ARM テンプレート リソース定義
namespaces/queues リソースの種類は、次の対象にデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ServiceBus/namespaces/queues リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.ServiceBus/namespaces/queues",
"apiVersion": "2022-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
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | 'Microsoft.ServiceBus/namespaces/queues' |
apiVersion | リソース API のバージョン | '2022-01-01-preview' |
name | リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。 |
string (必須) 文字数制限: 1 から 260 有効な文字: 英数字、ピリオド、ハイフン、アンダースコア、およびスラッシュ。 先頭と末尾には英数字を使用します。 |
properties | Queue プロパティ | SBQueueProperties |
SBQueueProperties
名前 | 説明 | 値 |
---|---|---|
autoDeleteOnIdle | ISO 8061 timeSpan アイドル間隔後、キューは自動的に削除されます。 最小時間は、5 分です。 | string |
deadLetteringOnMessageExpiration | メッセージの有効期限が切れたときに、このキューが配信不能サポートを持っているかどうかを示す 値。 | [bool] |
defaultMessageTimeToLive | ISO 8601 の既定のメッセージ時間スパンがライブ値になります。 これは、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。 これは、メッセージ自体に TimeToLive が設定されていない場合に使用される既定値です。 | string |
duplicateDetectionHistoryTimeWindow | 重複検出履歴の期間を定義する ISO 8601 timeSpan 構造体。 既定値は 10 分です。 | string |
enableBatchedOperations | サーバー側のバッチ処理操作が有効かどうかを示す値。 | [bool] |
enableExpress | Express Entities が有効かどうかを示す 値。 高速キューは、永続ストレージに書き込む前に、メッセージを一時的にメモリに保持します。 | [bool] |
enablePartitioning | キューを複数のメッセージ ブローカー間でパーティション分割するかどうかを示す 値。 | [bool] |
forwardDeadLetteredMessagesTo | 配信不能メッセージを転送するキュー/トピック名 | string |
forwardTo | メッセージを転送するキュー/トピック名 | string |
lockDuration | ピーク ロックの ISO 8601 期間。つまり、メッセージが他の受信者に対してロックされている時間です。 LockDuration の最大値は 5 分です。既定値は 1 分です。 | string |
maxDeliveryCount | 配信の最大数。 この配信数を越えた後のメッセージは自動的に配信不能になります。 既定値は 10 です。 | INT |
maxMessageSizeInKilobytes | キューで受け入れられるメッセージ ペイロードの最大サイズ (KB 単位)。 このプロパティは現在 Premium でのみ使用され、既定値は 1024 です。 | INT |
maxSizeInMegabytes | キューの最大サイズ (MB 単位)。 これは、キューに割り当てられたメモリのサイズです。 既定値は 1024 です。 | INT |
requiresDuplicateDetection | このキューで重複検出が必要かどうかを示す 値。 | [bool] |
requiresSession | キューがセッションの概念をサポートしているかどうかを示す 値。 | [bool] |
status | メッセージング エンティティの状態に使用できる値を列挙します。 | 'Active' 'Creating' '削除中' 'Disabled' 'ReceiveDisabled' '名前の変更' '復元中' 'SendDisabled' '不明' |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
Template | 説明 |
---|---|
カスタム トピックとキュー サブスクリプションAzure Event Grid作成する |
Azure Event Gridカスタム トピックと Service Bus キュー サブスクリプションを作成します。 テンプレートはもともと Markus Meyer によって作成されました。 |
Service Bus 名前空間とキュー承認規則を作成する |
このテンプレートを使用すると、Service Bus Standard 名前空間と、名前空間とキューの両方の承認規則をデプロイできます。 |
Service Bus の名前空間とキューを作成する |
このテンプレートを使用すると、Service Bus Standard 名前空間とキューをデプロイできます。 |
Terraform (AzAPI プロバイダー) リソース定義
namespaces/queues リソースの種類は、次の対象にデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ServiceBus/namespaces/queues リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ServiceBus/namespaces/queues@2022-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
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | "Microsoft.ServiceBus/namespaces/queues@2022-01-01-preview" |
name | リソース名 | string (必須) 文字数制限: 1 から 260 有効な文字: 英数字、ピリオド、ハイフン、アンダースコア、およびスラッシュ。 先頭と末尾には英数字を使用します。 |
parent_id | このリソースの親であるリソースの ID。 | 型のリソースの ID: 名前空間 |
properties | Queue プロパティ | SBQueueProperties |
SBQueueProperties
名前 | 説明 | 値 |
---|---|---|
autoDeleteOnIdle | ISO 8061 timeSpan アイドル間隔後、キューは自動的に削除されます。 最小時間は、5 分です。 | string |
deadLetteringOnMessageExpiration | メッセージの有効期限が切れたときに、このキューが配信不能サポートを持っているかどうかを示す 値。 | [bool] |
defaultMessageTimeToLive | ISO 8601 の既定のメッセージ時間スパンがライブ値になります。 これは、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。 これは、メッセージ自体に TimeToLive が設定されていない場合に使用される既定値です。 | string |
duplicateDetectionHistoryTimeWindow | 重複検出履歴の期間を定義する ISO 8601 timeSpan 構造体。 既定値は 10 分です。 | string |
enableBatchedOperations | サーバー側のバッチ処理操作が有効かどうかを示す値。 | [bool] |
enableExpress | Express Entities が有効かどうかを示す 値。 高速キューは、永続ストレージに書き込む前に、メッセージを一時的にメモリに保持します。 | [bool] |
enablePartitioning | キューを複数のメッセージ ブローカー間でパーティション分割するかどうかを示す 値。 | [bool] |
forwardDeadLetteredMessagesTo | 配信不能メッセージを転送するキュー/トピック名 | string |
forwardTo | メッセージを転送するキュー/トピック名 | string |
lockDuration | ピーク ロックの ISO 8601 期間。つまり、メッセージが他の受信者に対してロックされている時間です。 LockDuration の最大値は 5 分です。既定値は 1 分です。 | string |
maxDeliveryCount | 配信の最大数。 この配信数を越えた後のメッセージは自動的に配信不能になります。 既定値は 10 です。 | INT |
maxMessageSizeInKilobytes | キューで受け入れられるメッセージ ペイロードの最大サイズ (KB 単位)。 このプロパティは現在 Premium でのみ使用され、既定値は 1024 です。 | INT |
maxSizeInMegabytes | キューの最大サイズ (MB 単位)。 これは、キューに割り当てられたメモリのサイズです。 既定値は 1024 です。 | INT |
requiresDuplicateDetection | このキューで重複検出が必要かどうかを示す 値。 | [bool] |
requiresSession | キューがセッションの概念をサポートしているかどうかを示す 値。 | [bool] |
status | メッセージング エンティティの状態に使用できる値を列挙します。 | "アクティブ" "作成中" "削除中" "無効" "ReceiveDisabled" "名前の変更" "復元中" "SendDisabled" "Unknown" |