Microsoft.ServiceBus 命名空間/佇列

  • 發行項

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 中設定子資源的名稱和類型。		 字串 （必要）

字元限制：1-260

合法字元：
英數位元、句號、連字元、底線和斜線。

以英數位元開頭和結尾。
父母 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。

如需詳細資訊，請參閱 父資源外部的子資源。		 類型的資源符號名稱：命名空間
性能 佇列屬性 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
地位 列舉傳訊實體狀態的可能值。 'Active'
'Creating'
'刪除'
'Disabled'
'ReceiveDisabled'
'Renaming'
'還原'
'SendDisabled'
'Unknown'

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
建立 Azure 事件方格自定義主題和佇列訂用帳戶

部署至 Azure 		建立 Azure 事件方格自定義主題和服務總線佇列訂用帳戶。 範本最初由 Markus Meyer 撰寫。
建立服務總線命名空間和佇列授權規則

部署至 Azure 		此範本可讓您部署服務總線標準命名空間，以及命名空間和佇列的授權規則。
建立服務總線命名空間和佇列

部署至 Azure 		此範本可讓您部署服務總線標準命名空間和佇列。

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 範本中設定子資源的名稱和類型。		 字串 （必要）

字元限制：1-260

合法字元：
英數位元、句號、連字元、底線和斜線。

以英數位元開頭和結尾。
性能 佇列屬性 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
地位 列舉傳訊實體狀態的可能值。 'Active'
'Creating'
'刪除'
'Disabled'
'ReceiveDisabled'
'Renaming'
'還原'
'SendDisabled'
'Unknown'

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
建立 Azure 事件方格自定義主題和佇列訂用帳戶

部署至 Azure 		建立 Azure 事件方格自定義主題和服務總線佇列訂用帳戶。 範本最初由 Markus Meyer 撰寫。
建立服務總線命名空間和佇列授權規則

部署至 Azure 		此範本可讓您部署服務總線標準命名空間，以及命名空間和佇列的授權規則。
建立服務總線命名空間和佇列

部署至 Azure 		此範本可讓您部署服務總線標準命名空間和佇列。

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”
名字 資源名稱 字串 （必要）

字元限制：1-260

合法字元：
英數位元、句號、連字元、底線和斜線。

以英數位元開頭和結尾。
parent_id 此資源為父系之資源的標識碼。 類型的資源標識碼：命名空間
性能 佇列屬性 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
地位 列舉傳訊實體狀態的可能值。 “Active”
“建立”
“刪除”
“Disabled”
“ReceiveDisabled”
“重新命名”
“還原”
“SendDisabled”
“Unknown”