Microsoft.ServiceBus 命名空間/佇列
Bicep 資源定義
命名空間/佇列資源類型可以部署到：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 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中設定子資源的名稱和類型。 |
字串 (必要) 字元限制：1-260 有效字元： 英數字元、句號、連字號、底線和斜線。 以英數字元開頭及結尾。 |
| 父系 (parent) | 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源之外宣告子資源時，才需要新增這個屬性。 如需詳細資訊，請參閱 父資源外部的子資源。 |
類型資源的符號名稱： 命名空間 |
| properties | 佇列屬性 | SBQueueProperties |
SBQueueProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| autoDeleteOnIdle | ISO 8061 timeSpan 閒置間隔之後，佇列會自動刪除。 最短持續時間為 5 分鐘。 | 字串 |
| deadLetteringOnMessageExpiration | 值，指出當訊息到期時，此佇列是否支援寄不出的信件。 | bool |
| defaultMessageTimeToLive | ISO 8601 預設訊息時間範圍移至即時值。 這是訊息到期後的持續時間，從訊息傳送至服務匯流排時開始。 這是在訊息本身未設定 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 |
| status | 列舉訊息實體狀態的可能值。 | 'Active' 'Creating' '刪除' 'Disabled' 'ReceiveDisabled' 'Renaming' '還原' 'SendDisabled' 'Unknown' |
快速入門範本
下列快速入門範本會部署此資源類型。
| [範本] | 描述 |
|---|---|
建立Azure 事件方格自訂主題和佇列訂用帳戶 |
建立Azure 事件方格自訂主題和服務匯流排佇列訂用帳戶。 最初由 Markus Meyer 撰寫的範本。 |
| 建立服務匯流排命名空間和佇列授權規則 |
此範本可讓您部署服務匯流排標準命名空間，以及命名空間和佇列的授權規則。 |
| 建立服務匯流排命名空間和佇列 |
此範本可讓您部署服務匯流排標準命名空間和佇列。 |
ARM 範本資源定義
命名空間/佇列資源類型可以部署到：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 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 範本中設定子資源的名稱和類型。 |
需要字串 () 字元限制：1-260 有效字元： 英數字元、句號、連字號、底線和斜線。 以英數字元開頭及結尾。 |
| properties | 佇列屬性 | SBQueueProperties |
SBQueueProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| autoDeleteOnIdle | ISO 8061 timeSpan 閒置間隔之後，佇列會自動刪除。 最短持續時間為 5 分鐘。 | 字串 |
| deadLetteringOnMessageExpiration | 值，指出當訊息到期時，此佇列是否具有寄不出的信件支援。 | bool |
| defaultMessageTimeToLive | ISO 8601 預設訊息時間範圍到即時值。 這是訊息到期的持續時間，從訊息傳送至服務匯流排時開始。 這是在訊息本身未設定 TimeToLive 時所使用的預設值。 | 字串 |
| duplicateDetectionHistoryTimeWindow | 定義重複偵測歷程記錄持續時間的 ISO 8601 timeSpan 結構。 預設值是 10 分鐘。 | 字串 |
| enableBatchedOperations | 值，指出是否啟用伺服器端批次處理作業。 | bool |
| enableExpress | 值，指出是否啟用 Express Entities。 快速佇列會在將訊息寫入永續性儲存體之前，暫時將訊息儲存在記憶體中。 | 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 |
| status | 列舉訊息實體狀態的可能值。 | 'Active' 'Creating' '刪除' 'Disabled' 'ReceiveDisabled' 'Renaming' '還原' 'SendDisabled' 'Unknown' |
快速入門範本
下列快速入門範本會部署此資源類型。
| [範本] | 描述 |
|---|---|
| 建立Azure 事件方格自訂主題和佇列訂用帳戶 |
建立Azure 事件方格自訂主題和服務匯流排佇列訂用帳戶。 最初由 Markus Meyer 撰寫的範本。 |
| 建立服務匯流排命名空間和佇列授權規則 |
此範本可讓您部署服務匯流排標準命名空間，以及命名空間和佇列的授權規則。 |
| 建立服務匯流排命名空間和佇列 |
此範本可讓您部署服務匯流排標準命名空間和佇列。 |
Terraform (AzAPI 提供者) 資源定義
命名空間/佇列資源類型可以部署到：
- 資源群組
如需每個 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 | 資源名稱 | 需要字串 () 字元限制：1-260 有效字元： 英數字元、句號、連字號、底線和斜線。 以英數字元開頭及結尾。 |
| parent_id | 此資源父系之資源的識別碼。 | 類型資源的識別碼： 命名空間 |
| properties | 佇列屬性 | SBQueueProperties |
SBQueueProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| autoDeleteOnIdle | ISO 8061 timeSpan 閒置間隔之後，佇列會自動刪除。 最短持續時間為 5 分鐘。 | 字串 |
| deadLetteringOnMessageExpiration | 值，指出當訊息到期時，此佇列是否具有寄不出的信件支援。 | bool |
| defaultMessageTimeToLive | ISO 8601 預設訊息時間範圍到即時值。 這是訊息到期的持續時間，從訊息傳送至服務匯流排時開始。 這是在訊息本身未設定 TimeToLive 時所使用的預設值。 | 字串 |
| duplicateDetectionHistoryTimeWindow | 定義重複偵測歷程記錄持續時間的 ISO 8601 timeSpan 結構。 預設值是 10 分鐘。 | 字串 |
| enableBatchedOperations | 值，指出是否啟用伺服器端批次處理作業。 | bool |
| enableExpress | 值，指出是否啟用 Express Entities。 快速佇列會在將訊息寫入永續性儲存體之前，暫時將訊息儲存在記憶體中。 | 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 |
| status | 列舉訊息實體狀態的可能值。 | 「Active」 「建立」 「刪除」 「Disabled」 「ReceiveDisabled」 「重新命名」 「還原」 「SendDisabled」 「Unknown」 |