Microsoft.ServiceBus/namespaces 2022-10-01-preview - Bicep, ARM template & Terraform AzAPI reference

Bicep 資源定義

命名空間資源類型可以使用目標作業來部署：

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

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

資源格式

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

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

屬性值

namespaces

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

身份

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

IdentityUserAssignedIdentities

名字	描述	價值
{自定義屬性}		UserAssignedIdentity

UserAssignedIdentity

此物件不包含在部署期間設定的任何屬性。所有屬性都是 ReadOnly。

SBNamespaceProperties

名字	描述	價值
alternateName	命名空間的替代名稱	字串
disableLocalAuth	此屬性會停用服務總線命名空間的 SAS 驗證。	bool
加密	BYOK 加密描述的屬性	加密
minimumTlsVersion	叢集支援的最低 TLS 版本，例如 '1.2'	'1.0' '1.1' '1.2'
premiumMessagingPartitions	服務總線命名空間的數據分割數目。此屬性僅適用於進階 SKU 命名空間。默認值為 1，可能的值為 1、2 和 4	int
privateEndpointConnections	私人端點連線的清單。	PrivateEndpointConnection[]
publicNetworkAccess	這會判斷是否允許透過公用網路傳輸流量。默認會啟用。	'Disabled' 'Enabled' 'SecuredByPerimeter'
zoneRedundant	啟用此屬性會在支援的可用性區域中建立進階服務總線Namespace。	bool

加密

名字	描述	價值
keySource	列舉 Encryption 的 keySource 可能值	'Microsoft.KeyVault'
keyVaultProperties	KeyVault 的屬性	KeyVaultProperties[]
requireInfrastructureEncryption	開啟基礎結構加密（雙重加密）	bool

KeyVaultProperties

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

UserAssignedIdentityProperties

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

PrivateEndpointConnection

名字	描述	價值
性能	PrivateEndpointConnection 的屬性。	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

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

PrivateEndpoint

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

ConnectionState

名字	描述	價值
描述	連接狀態的描述。	字串
地位	線上的狀態。	「已核准」 'Disconnected' 'Pending' 'Rejected'

SBSku

名字	描述	價值
能力	服務總線進階命名空間的傳訊單位。有效的容量是 {1， 2， 4， 8， 16} 個屬性的倍數。premiumMessagingPartitions 設定。例如，如果 properties.premiumMessagingPartitions 是 1，則可能的容量值為 1、2、4、8 和 16。如果 properties.premiumMessagingPartitions 為 4，則可能的容量值為 4、8、16、32 和 64	int
名字	此 SKU 的名稱。	'Basic' 'Premium' 'Standard' （必要）
層	這個特定 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篩選規則來部署服務總線進階命名空間
建立服務總線命名空間虛擬網路規則	此範本可讓您使用虛擬網路規則部署服務總線進階命名空間
建立服務總線進階Namespace和 AuthorizationRule	此範本會建立服務總線進階Namespace和命名空間 AuthorizationRule
透過私人端點連線到服務總線命名空間	此範例示範如何使用設定虛擬網路和私人 DNS 區域，透過私人端點存取服務總線命名空間。
建立服務總線Namespace和主題	此範本會建立服務總線Namespace和主題。
使用訂用帳戶和 SQL 篩選條件建立服務總線主題	此範本會使用 SQL 篩選表示式建立服務總線Namespace和主題，並搭配訂用帳戶，只接收符合所定義 SQL 篩選表達式的訊息。

ARM 樣本資源定義

命名空間資源類型可以使用目標作業來部署：

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

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

資源格式

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

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

屬性值

namespaces

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

身份

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

IdentityUserAssignedIdentities

名字	描述	價值
{自定義屬性}		UserAssignedIdentity

UserAssignedIdentity

此物件不包含在部署期間設定的任何屬性。所有屬性都是 ReadOnly。

SBNamespaceProperties

名字	描述	價值
alternateName	命名空間的替代名稱	字串
disableLocalAuth	此屬性會停用服務總線命名空間的 SAS 驗證。	bool
加密	BYOK 加密描述的屬性	加密
minimumTlsVersion	叢集支援的最低 TLS 版本，例如 '1.2'	'1.0' '1.1' '1.2'
premiumMessagingPartitions	服務總線命名空間的數據分割數目。此屬性僅適用於進階 SKU 命名空間。默認值為 1，可能的值為 1、2 和 4	int
privateEndpointConnections	私人端點連線的清單。	PrivateEndpointConnection[]
publicNetworkAccess	這會判斷是否允許透過公用網路傳輸流量。默認會啟用。	'Disabled' 'Enabled' 'SecuredByPerimeter'
zoneRedundant	啟用此屬性會在支援的可用性區域中建立進階服務總線Namespace。	bool

加密

名字	描述	價值
keySource	列舉 Encryption 的 keySource 可能值	'Microsoft.KeyVault'
keyVaultProperties	KeyVault 的屬性	KeyVaultProperties[]
requireInfrastructureEncryption	開啟基礎結構加密（雙重加密）	bool

KeyVaultProperties

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

UserAssignedIdentityProperties

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

PrivateEndpointConnection

名字	描述	價值
性能	PrivateEndpointConnection 的屬性。	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

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

PrivateEndpoint

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

ConnectionState

名字	描述	價值
描述	連接狀態的描述。	字串
地位	線上的狀態。	「已核准」 'Disconnected' 'Pending' 'Rejected'

SBSku

名字	描述	價值
能力	服務總線進階命名空間的傳訊單位。有效的容量是 {1， 2， 4， 8， 16} 個屬性的倍數。premiumMessagingPartitions 設定。例如，如果 properties.premiumMessagingPartitions 是 1，則可能的容量值為 1、2、4、8 和 16。如果 properties.premiumMessagingPartitions 為 4，則可能的容量值為 4、8、16、32 和 64	int
名字	此 SKU 的名稱。	'Basic' 'Premium' 'Standard' （必要）
層	這個特定 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篩選規則來部署服務總線進階命名空間
建立服務總線命名空間虛擬網路規則	此範本可讓您使用虛擬網路規則部署服務總線進階命名空間
建立服務總線進階Namespace和 AuthorizationRule	此範本會建立服務總線進階Namespace和命名空間 AuthorizationRule
透過私人端點連線到服務總線命名空間	此範例示範如何使用設定虛擬網路和私人 DNS 區域，透過私人端點存取服務總線命名空間。
建立服務總線Namespace和主題	此範本會建立服務總線Namespace和主題。
使用訂用帳戶和 SQL 篩選條件建立服務總線主題	此範本會使用 SQL 篩選表示式建立服務總線Namespace和主題，並搭配訂用帳戶，只接收符合所定義 SQL 篩選表達式的訊息。

Terraform （AzAPI 提供者）資源定義

命名空間資源類型可以使用目標作業來部署：

資源群組

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

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ServiceBus/namespaces@2022-10-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"
      premiumMessagingPartitions = int
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {
              id = "string"
            }
            privateLinkServiceConnectionState = {
              description = "string"
              status = "string"
            }
            provisioningState = "string"
          }
        }
      ]
      publicNetworkAccess = "string"
      zoneRedundant = bool
    }
    sku = {
      capacity = int
      name = "string"
      tier = "string"
    }
  })
}

屬性值

namespaces

名字	描述	價值
類型	資源類型	“Microsoft.ServiceBus/namespaces@2022-10-01-preview”
名字	資源名稱	字串（必要）字元限制：6-50 合法字元：英數位元和連字元。以字母開頭。以字母或數字結尾。如需詳細資訊，請參閱建立命名空間。資源名稱在整個 Azure 中必須是唯一的。
位置	資源所在的地理位置	字串（必要）
parent_id	若要部署至資源群組，請使用該資源群組的標識碼。	字串（必要）
標籤	資源標籤	標記名稱和值的字典。
sku	SKU 的屬性	SBSku
身份	BYOK 身分識別描述的屬性	身分識別
性能	命名空間的屬性。	SBNamespaceProperties

身份

名字	描述	價值
類型	受控服務識別的類型。	“SystemAssigned” “SystemAssigned， UserAssigned” “UserAssigned”
identity_ids	使用者指派身分識別的屬性	使用者身分識別標識碼的陣列。

IdentityUserAssignedIdentities

名字	描述	價值
{自定義屬性}		UserAssignedIdentity

UserAssignedIdentity

此物件不包含在部署期間設定的任何屬性。所有屬性都是 ReadOnly。

SBNamespaceProperties

名字	描述	價值
alternateName	命名空間的替代名稱	字串
disableLocalAuth	此屬性會停用服務總線命名空間的 SAS 驗證。	bool
加密	BYOK 加密描述的屬性	加密
minimumTlsVersion	叢集支援的最低 TLS 版本，例如 '1.2'	"1.0" "1.1" "1.2"
premiumMessagingPartitions	服務總線命名空間的數據分割數目。此屬性僅適用於進階 SKU 命名空間。默認值為 1，可能的值為 1、2 和 4	int
privateEndpointConnections	私人端點連線的清單。	PrivateEndpointConnection[]
publicNetworkAccess	這會判斷是否允許透過公用網路傳輸流量。默認會啟用。	“Disabled” “Enabled” “SecuredByPerimeter”
zoneRedundant	啟用此屬性會在支援的可用性區域中建立進階服務總線Namespace。	bool

加密

名字	描述	價值
keySource	列舉 Encryption 的 keySource 可能值	“Microsoft.KeyVault”
keyVaultProperties	KeyVault 的屬性	KeyVaultProperties[]
requireInfrastructureEncryption	開啟基礎結構加密（雙重加密）	bool

KeyVaultProperties

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

UserAssignedIdentityProperties

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

PrivateEndpointConnection

名字	描述	價值
性能	PrivateEndpointConnection 的屬性。	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名字	描述	價值
privateEndpoint	此連線的私人端點資源。	PrivateEndpoint
privateLinkServiceConnectionState	線上狀態的詳細數據。	ConnectionState
provisioningState	私人端點聯機的布建狀態。	“Canceled” “建立” “刪除” “Failed” “Succeeded” “Updateing”

PrivateEndpoint

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

ConnectionState

名字	描述	價值
描述	連接狀態的描述。	字串
地位	線上的狀態。	「已核准」 “Disconnected” “Pending” 「已拒絕」

SBSku

名字	描述	價值
能力	服務總線進階命名空間的傳訊單位。有效的容量是 {1， 2， 4， 8， 16} 個屬性的倍數。premiumMessagingPartitions 設定。例如，如果 properties.premiumMessagingPartitions 是 1，則可能的容量值為 1、2、4、8 和 16。如果 properties.premiumMessagingPartitions 為 4，則可能的容量值為 4、8、16、32 和 64	int
名字	此 SKU 的名稱。	“Basic” “Premium” “Standard” （必要）
層	這個特定 SKU 的計費層。	“Basic” “Premium” “Standard”

共用方式為

Microsoft.ServiceBus 命名空間 2022-10-01-preview

Bicep 資源定義

資源格式

屬性值

namespaces

身份

IdentityUserAssignedIdentities

UserAssignedIdentity

SBNamespaceProperties

加密

KeyVaultProperties

UserAssignedIdentityProperties

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateEndpoint

ConnectionState

SBSku

快速入門範本

ARM 樣本資源定義

資源格式

屬性值

namespaces

身份

IdentityUserAssignedIdentities

UserAssignedIdentity

SBNamespaceProperties

加密

KeyVaultProperties

UserAssignedIdentityProperties

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateEndpoint

ConnectionState

SBSku

快速入門範本

Terraform （AzAPI 提供者） 資源定義

資源格式

屬性值

namespaces

身份

IdentityUserAssignedIdentities

UserAssignedIdentity

SBNamespaceProperties

加密

KeyVaultProperties

UserAssignedIdentityProperties

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateEndpoint

ConnectionState

SBSku

意見反應

其他資源

Terraform （AzAPI 提供者）資源定義