Microsoft.ServiceBus 命名空間

發行項
02/01/2024

Bicep 資源定義

命名空間資源類型可以部署到：

資源群組 - 請參閱資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄。

資源格式

若要建立 Microsoft.ServiceBus/namespaces 資源，請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.ServiceBus/namespaces@2022-01-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    alternateName: 'string'
    disableLocalAuth: bool
    encryption: {
      keySource: 'Microsoft.KeyVault'
      keyVaultProperties: [
        {
          identity: {
            userAssignedIdentity: 'string'
          }
          keyName: 'string'
          keyVaultUri: 'string'
          keyVersion: 'string'
        }
      ]
      requireInfrastructureEncryption: bool
    }
    minimumTlsVersion: 'string'
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {
            id: 'string'
          }
          privateLinkServiceConnectionState: {
            description: 'string'
            status: 'string'
          }
          provisioningState: 'string'
        }
      }
    ]
    publicNetworkAccess: 'string'
    zoneRedundant: bool
  }
}

屬性值

命名空間

名稱	描述	值
NAME	資源名稱	字串 (必要) 字元限制：6-50 有效字元：英數字元和連字號。以字母開頭。以字母或數字結尾。如需詳細資訊，請參閱建立命名空間。資源名稱在 Azure 中必須是唯一的。
location	資源所在的地理位置	字串 (必要)
tags	資源標籤	標記名稱和值的字典。請參閱範本中的標記
sku	SKU 的屬性	SBSku
身分識別	BYOK 身分識別描述的屬性	身分識別
properties	命名空間的屬性。	SBNamespaceProperties

Identity

名称	描述	值
type	受控服務識別的類型。	'None' 'SystemAssigned' 'SystemAssigned，UserAssigned' 'UserAssigned'
userAssignedIdentities	使用者指派身分識別的屬性	object

SBNamespaceProperties

名稱	描述	值
alternateName	命名空間的替代名稱	字串
disableLocalAuth	此屬性會停用服務匯流排命名空間的 SAS 驗證。	bool
加密	BYOK 加密描述的屬性	加密
minimumTlsVersion	叢集支援的最低 TLS 版本，例如 '1.2'	'1.0' '1.1' '1.2'
privateEndpointConnections	私人端點連線的清單。	PrivateEndpointConnection[]
publicNetworkAccess	這會判斷是否允許透過公用網路流量。預設會啟用它。	'Disabled' 'Enabled' 'SecuredByPerimeter'
zoneRedundant	啟用此屬性會在支援的可用性區域中建立進階服務匯流排命名空間。	bool

加密

名稱	描述	值
keySource	列舉 KeySource for Encryption 的可能值	'Microsoft.KeyVault'
keyVaultProperties	KeyVault 的屬性	KeyVaultProperties[]
requireInfrastructureEncryption	啟用基礎結構加密 (雙重加密)	bool

KeyVaultProperties

名稱	描述	值
身分識別		UserAssignedIdentityProperties
keyName	KeyVault 中的金鑰名稱	字串
keyVaultUri	KeyVault 的 URI	字串
keyVersion	KeyVault 的版本	字串

UserAssignedIdentityProperties

名稱	描述	值
userAssignedIdentity	針對加密選取的使用者身分識別 ARM 識別碼	字串

PrivateEndpointConnection

名稱	描述	值
properties	PrivateEndpointConnection 的屬性。	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名稱	描述	值
privateEndpoint	此連線的私人端點資源。	PrivateEndpoint
privateLinkServiceConnectionState	線上狀態的詳細資料。	ConnectionState
provisioningState	私人端點連線的布建狀態。	'Canceled' 'Creating' '刪除' 'Failed' 'Succeeded' 'Updateing'

PrivateEndpoint

名稱	描述	值
id	私人端點的 ARM 識別碼。	字串

ConnectionState

名稱	描述	值
description	線上狀態的描述。	字串
status	連線的狀態。	「已核准」 'Disconnected' 'Pending' 「已拒絕」

SBSku

名稱	描述	值
處理能力	層的指定傳訊單位。針對進階層，容量為 1，2 和 4。	int
NAME	此 SKU 的名稱。	'Basic' 'Premium' 必要) 的「標準」 (
tier	此特定 SKU 的計費層。	'Basic' 'Premium' 'Standard'

快速入門範本

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

[範本]	描述
Azure 中的 EPiserverCMS	此範本可讓您在 Azure 中建立 EpiServerCMS 部署所需的資源
整合模式 - 訊息路由器 - 服務匯流排	顯示如何使用服務匯流排主題設定訊息路由器模式的解決方案
建立Azure 事件方格自訂主題和佇列訂用帳戶	建立Azure 事件方格自訂主題和服務匯流排佇列訂用帳戶。最初由 Markus Meyer 撰寫的範本。
建立Azure 事件方格自訂主題訂用帳戶	建立Azure 事件方格自訂主題和服務匯流排主題訂用帳戶。最初由 Markus Meyer 撰寫的範本。
使用服務匯流排將訊息與 Logic Apps 相互關聯	其中顯示如何使用 Azure 服務匯流排將訊息與 Logic Apps 相互關聯
建立服務匯流排命名空間和佇列授權規則	此範本可讓您部署服務匯流排標準命名空間，以及命名空間和佇列的授權規則。
建立服務匯流排命名空間	此範本可讓您部署具有基本/標準 SKU 的服務匯流排命名空間。
建立服務匯流排異地復原	此範本可讓您在進階 SKU 命名空間上設定服務匯流排異地災害復原別名。
建立服務匯流排命名空間和佇列	此範本可讓您部署服務匯流排標準命名空間和佇列。
建立服務匯流排命名空間、主題和訂用帳戶	此範本可讓您部署服務匯流排標準命名空間、主題和訂用帳戶。
建立服務匯流排命名空間、主題、訂用帳戶和規則	此範本可讓您部署服務匯流排標準命名空間、主題、訂用帳戶和規則。
建立服務匯流排命名空間 IP 篩選規則	此範本可讓您使用 IP 篩選規則部署服務匯流排進階命名空間
建立服務匯流排命名空間虛擬網路規則	此範本可讓您部署具有虛擬網路規則的服務匯流排進階命名空間
建立服務匯流排進階命名空間和 AuthorizationRule	此範本會建立服務匯流排進階命名空間和命名空間 AuthorizationRule
透過私人端點連線到服務匯流排命名空間	此範例示範如何使用設定虛擬網路和私人 DNS 區域，透過私人端點存取服務匯流排命名空間。
建立服務匯流排命名空間和主題	此範本會建立服務匯流排命名空間和主題。
使用訂用帳戶和 SQL 篩選器建立服務匯流排主題	此範本會使用 SQL 篩選運算式建立服務匯流排命名空間和主題與訂用帳戶，只接收符合所定義 SQL 篩選運算式的訊息。

ARM 範本資源定義

命名空間資源類型可以部署到：

資源群組 - 請參閱資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.ServiceBus/namespaces 資源，請將下列 JSON 新增至您的範本。

{
  "type": "Microsoft.ServiceBus/namespaces",
  "apiVersion": "2022-01-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  },
  "properties": {
    "alternateName": "string",
    "disableLocalAuth": "bool",
    "encryption": {
      "keySource": "Microsoft.KeyVault",
      "keyVaultProperties": [
        {
          "identity": {
            "userAssignedIdentity": "string"
          },
          "keyName": "string",
          "keyVaultUri": "string",
          "keyVersion": "string"
        }
      ],
      "requireInfrastructureEncryption": "bool"
    },
    "minimumTlsVersion": "string",
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {
            "id": "string"
          },
          "privateLinkServiceConnectionState": {
            "description": "string",
            "status": "string"
          },
          "provisioningState": "string"
        }
      }
    ],
    "publicNetworkAccess": "string",
    "zoneRedundant": "bool"
  }
}

屬性值

命名空間

名稱	描述	值
type	資源類型	'Microsoft.ServiceBus/namespaces'
apiVersion	資源 API 版本	'2022-01-01-preview'
NAME	資源名稱	需要字串 () 字元限制：6-50 有效字元：英數字元和連字號。以字母開頭。以字母或數字結尾。如需詳細資訊，請參閱建立命名空間。資源名稱在整個 Azure 中必須是唯一的。
location	資源所在的地理位置	需要字串 ()
tags	資源標籤	標記名稱和值的字典。請參閱範本中的標籤
sku	SKU 的屬性	SBSku
身分識別	BYOK 身分識別描述的屬性	身分識別
properties	命名空間的屬性。	SBNamespaceProperties

Identity

名称	描述	值
type	受控服務識別的類型。	'None' 'SystemAssigned' 'SystemAssigned， UserAssigned' 'UserAssigned'
userAssignedIdentities	使用者指派身分識別的屬性	object

SBNamespaceProperties

名稱	描述	值
alternateName	命名空間的替代名稱	字串
disableLocalAuth	此屬性會停用服務匯流排命名空間的 SAS 驗證。	bool
加密	BYOK 加密描述的屬性	加密
minimumTlsVersion	叢集支援的最低 TLS 版本，例如 '1.2'	'1.0' '1.1' '1.2'
privateEndpointConnections	私人端點連線的清單。	PrivateEndpointConnection[]
publicNetworkAccess	這會判斷是否允許透過公用網路流量。預設會啟用它。	'Disabled' 'Enabled' 'SecuredByPerimeter'
zoneRedundant	啟用此屬性會在支援的可用性區域中建立進階服務匯流排命名空間。	bool

加密

名稱	描述	值
keySource	列舉 KeySource for Encryption 的可能值	'Microsoft.KeyVault'
keyVaultProperties	KeyVault 的屬性	KeyVaultProperties[]
requireInfrastructureEncryption	啟用基礎結構加密 (雙重加密)	bool

KeyVaultProperties

名稱	描述	值
身分識別		UserAssignedIdentityProperties
keyName	KeyVault 中的金鑰名稱	字串
keyVaultUri	KeyVault 的 URI	字串
keyVersion	KeyVault 的版本	字串

UserAssignedIdentityProperties

名稱	描述	值
userAssignedIdentity	針對加密選取的使用者身分識別 ARM 識別碼	字串

PrivateEndpointConnection

名稱	描述	值
properties	PrivateEndpointConnection 的屬性。	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名稱	描述	值
privateEndpoint	此連線的私人端點資源。	PrivateEndpoint
privateLinkServiceConnectionState	線上狀態的詳細資料。	ConnectionState
provisioningState	私人端點連線的布建狀態。	'Canceled' 'Creating' '刪除' 'Failed' 'Succeeded' 'Updateing'

PrivateEndpoint

名稱	描述	值
id	私人端點的 ARM 識別碼。	字串

ConnectionState

名稱	描述	值
description	線上狀態的描述。	字串
status	連線的狀態。	'Approved' 'Disconnected' 'Pending' 「已拒絕」

SBSku

名稱	描述	值
處理能力	階層的指定傳訊單位。針對進階層，容量為 1、2 和 4。	int
NAME	此 SKU 的名稱。	'Basic' 'Premium' 「標準」 (必要)
tier	此特定 SKU 的計費層。	'Basic' 'Premium' 'Standard'

快速入門範本

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

[範本]	描述
Azure 中的 EPiserverCMS	此範本可讓您在 Azure 中建立 EpiServerCMS 部署所需的資源
整合模式 - 訊息路由器 - 服務匯流排	示範如何使用服務匯流排主題設定訊息路由器模式的解決方案
建立Azure 事件方格自訂主題和佇列訂用帳戶	建立Azure 事件方格自訂主題和服務匯流排佇列訂用帳戶。最初由 Markus Meyer 撰寫的範本。
建立Azure 事件方格自訂主題訂用帳戶	建立Azure 事件方格自訂主題和服務匯流排主題訂用帳戶。最初由 Markus Meyer 撰寫的範本。
使用服務匯流排將訊息與 Logic Apps 相互關聯	其中顯示如何使用 Azure 服務匯流排將訊息與 Logic Apps 相互關聯
建立服務匯流排命名空間和佇列授權規則	此範本可讓您部署服務匯流排標準命名空間，以及命名空間和佇列的授權規則。
建立服務匯流排命名空間	此範本可讓您部署具有基本/標準 SKU 的服務匯流排命名空間。
建立服務匯流排異地復原	此範本可讓您在進階 SKU 命名空間上設定服務匯流排異地災害復原別名。
建立服務匯流排命名空間和佇列	此範本可讓您部署服務匯流排標準命名空間和佇列。
建立服務匯流排命名空間、主題和訂用帳戶	此範本可讓您部署服務匯流排標準命名空間、主題和訂用帳戶。
建立服務匯流排命名空間、主題、訂用帳戶和規則	此範本可讓您部署服務匯流排標準命名空間、主題、訂用帳戶和規則。
建立服務匯流排命名空間 IP 篩選規則	此範本可讓您使用 IP 篩選規則部署服務匯流排進階命名空間
建立服務匯流排命名空間虛擬網路規則	此範本可讓您部署具有虛擬網路規則的服務匯流排進階命名空間
建立服務匯流排進階命名空間和 AuthorizationRule	此範本會建立服務匯流排進階命名空間和命名空間 AuthorizationRule
透過私人端點連線到服務匯流排命名空間	此範例示範如何使用設定虛擬網路和私人 DNS 區域，透過私人端點存取服務匯流排命名空間。
建立服務匯流排命名空間和主題	此範本會建立服務匯流排命名空間和主題。
使用訂用帳戶和 SQL 篩選器建立服務匯流排主題	此範本會使用 SQL 篩選運算式建立服務匯流排命名空間和主題與訂用帳戶，只接收符合所定義 SQL 篩選運算式的訊息。

Terraform (AzAPI 提供者) 資源定義

命名空間資源類型可以部署到：

資源群組

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.ServiceBus/namespaces 資源，請將下列 Terraform 新增至您的範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ServiceBus/namespaces@2022-01-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      alternateName = "string"
      disableLocalAuth = bool
      encryption = {
        keySource = "Microsoft.KeyVault"
        keyVaultProperties = [
          {
            identity = {
              userAssignedIdentity = "string"
            }
            keyName = "string"
            keyVaultUri = "string"
            keyVersion = "string"
          }
        ]
        requireInfrastructureEncryption = bool
      }
      minimumTlsVersion = "string"
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {
              id = "string"
            }
            privateLinkServiceConnectionState = {
              description = "string"
              status = "string"
            }
            provisioningState = "string"
          }
        }
      ]
      publicNetworkAccess = "string"
      zoneRedundant = bool
    }
    sku = {
      capacity = int
      name = "string"
      tier = "string"
    }
  })
}

屬性值

命名空間

名稱	描述	值
type	資源類型	「Microsoft.ServiceBus/namespaces@2022-01-01-preview」
NAME	資源名稱	字串 (必要) 字元限制：6-50 有效字元：英數字元和連字號。以字母開頭。以字母或數字結尾。如需詳細資訊，請參閱建立命名空間。資源名稱在 Azure 中必須是唯一的。
location	資源所在的地理位置	字串 (必要)
parent_id	若要部署至資源群組，請使用該資源群組的識別碼。	字串 (必要)
tags	資源標籤	標記名稱和值的字典。
sku	SKU 的屬性	SBSku
身分識別	BYOK 身分識別描述的屬性	身分識別
properties	命名空間的屬性。	SBNamespaceProperties

Identity

名称	描述	值
type	受控服務識別的類型。	「SystemAssigned」「SystemAssigned， UserAssigned」「UserAssigned」
identity_ids	使用者指派身分識別的屬性	使用者身分識別識別碼的陣列。

SBNamespaceProperties

名稱	描述	值
alternateName	命名空間的替代名稱	字串
disableLocalAuth	此屬性會停用服務匯流排命名空間的 SAS 驗證。	bool
加密	BYOK 加密描述的屬性	加密
minimumTlsVersion	叢集支援的最低 TLS 版本，例如 '1.2'	"1.0" "1.1" "1.2"
privateEndpointConnections	私人端點連線的清單。	PrivateEndpointConnection[]
publicNetworkAccess	這會判斷是否允許透過公用網路流量。預設會啟用它。	「Disabled」「Enabled」「SecuredByPerimeter」
zoneRedundant	啟用此屬性會在支援的可用性區域中建立進階服務匯流排命名空間。	bool

加密

名稱	描述	值
keySource	列舉 KeySource for Encryption 的可能值	「Microsoft.KeyVault」
keyVaultProperties	KeyVault 的屬性	KeyVaultProperties[]
requireInfrastructureEncryption	啟用基礎結構加密 (雙重加密)	bool

KeyVaultProperties

名稱	描述	值
身分識別		UserAssignedIdentityProperties
keyName	KeyVault 中的金鑰名稱	字串
keyVaultUri	KeyVault 的 URI	字串
keyVersion	KeyVault 的版本	字串

UserAssignedIdentityProperties

名稱	描述	值
userAssignedIdentity	針對加密選取的使用者身分識別 ARM 識別碼	字串

PrivateEndpointConnection

名稱	描述	值
properties	PrivateEndpointConnection 的屬性。	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名稱	描述	值
privateEndpoint	此連線的私人端點資源。	PrivateEndpoint
privateLinkServiceConnectionState	線上狀態的詳細資料。	ConnectionState
provisioningState	私人端點連線的布建狀態。	「Canceled」「建立」「刪除」「Failed」「成功」「Updateing」

PrivateEndpoint

名稱	描述	值
id	私人端點的 ARM 識別碼。	字串

ConnectionState

名稱	描述	值
description	線上狀態的描述。	字串
status	連線的狀態。	「已核准」「Disconnected」「Pending」「已拒絕」

SBSku

名稱	描述	值
處理能力	階層的指定傳訊單位。針對進階層，容量為 1、2 和 4。	int
NAME	此 SKU 的名稱。	"Basic" 「Premium」「標準」 (必要)
tier	此特定 SKU 的計費層。	"Basic" 「Premium」「標準」

Microsoft.ServiceBus 命名空間

Bicep 資源定義

資源格式

屬性值

命名空間

Identity

SBNamespaceProperties

加密

KeyVaultProperties

UserAssignedIdentityProperties

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateEndpoint

ConnectionState

SBSku

快速入門範本

ARM 範本資源定義

資源格式

屬性值

命名空間

Identity

SBNamespaceProperties

加密

KeyVaultProperties

UserAssignedIdentityProperties

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateEndpoint

ConnectionState

SBSku

快速入門範本

Terraform (AzAPI 提供者) 資源定義

資源格式

屬性值

命名空間

Identity

SBNamespaceProperties

加密

KeyVaultProperties

UserAssignedIdentityProperties

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateEndpoint

ConnectionState

SBSku

意見反應

意見反應

其他資源