你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.ServiceBus 命名空间
Bicep 资源定义
可以使用目标操作部署命名空间资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ServiceBus/namespaces 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.ServiceBus/namespaces@2024-01-01' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
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'
}
tags: {
{customized property}: 'string'
}
}
属性值
ConnectionState
| 名字 | 描述 | 价值 |
|---|---|---|
| 描述 | 连接状态的说明。 | 字符串 |
| 地位 | 连接状态。 | “已批准” “Disconnected” “Pending” “已拒绝” |
加密
| 名字 | 描述 | 价值 |
|---|---|---|
| keySource | 枚举 KeySource for Encryption 的可能值 | “Microsoft.KeyVault” |
| keyVaultProperties | KeyVault 的属性 | KeyVaultProperties[] |
| requireInfrastructureEncryption | 启用基础结构加密（双重加密） | bool |
身份
| 名字 | 描述 | 价值 |
|---|---|---|
| 类型 | 托管服务标识的类型。 | “None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned” |
| userAssignedIdentities | 用户分配标识的属性 | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| 名字 | 描述 | 价值 |
|---|
KeyVaultProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 身份 | UserAssignedIdentityProperties | |
| keyName | KeyVault 中密钥的名称 | 字符串 |
| keyVaultUri | KeyVault 的 URI | 字符串 |
| keyVersion | KeyVault 版本 | 字符串 |
Microsoft.ServiceBus/namespaces
| 名字 | 描述 | 价值 |
|---|---|---|
| 身份 | BYOK 标识说明的属性 | 标识 |
| 位置 | 资源所在的地理位置 | string （必需） |
| 名字 | 资源名称 | string （必需） |
| 性能 | 命名空间的属性。 | SBNamespaceProperties |
| sku | SKU 的属性 | SBSku |
| 标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
PrivateEndpoint
| 名字 | 描述 | 价值 |
|---|---|---|
| id | 专用终结点的 ARM 标识符。 | 字符串 |
PrivateEndpointConnection
| 名字 | 描述 | 价值 |
|---|---|---|
| 性能 | PrivateEndpointConnection 的属性。 | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| privateEndpoint | 此连接的专用终结点资源。 | PrivateEndpoint |
| privateLinkServiceConnectionState | 有关连接状态的详细信息。 | ConnectionState |
| provisioningState | 专用终结点连接的预配状态。 | “Canceled” “创建” “删除” “Failed” “Succeeded” “正在更新” |
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 |
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” “标准”（必需） |
| 层 | 此特定 SKU 的计费层。 | “Basic” “Premium” “Standard” |
TrackedResourceTags
| 名字 | 描述 | 价值 |
|---|
UserAssignedIdentity
| 名字 | 描述 | 价值 |
|---|
UserAssignedIdentityProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| userAssignedIdentity | 为加密选择的用户标识的 ARM ID | 字符串 |
快速入门示例
以下快速入门示例部署此资源类型。
| Bicep 文件 | 描述 |
|---|---|
| 创建服务总线命名空间和队列 | 使用此模板可以部署服务总线标准命名空间和队列。 |
| 创建服务总线命名空间虚拟网络规则 | 使用此模板，可以使用虚拟网络规则部署服务总线高级命名空间 |
| 创建 Azure 事件网格自定义主题和队列订阅 | 创建 Azure 事件网格自定义主题和服务总线队列订阅。 模板最初由 Markus Meyer 创作。 |
| 使用容器应用创建 Dapr 微服务应用 | 使用容器应用创建 Dapr 微服务应用。 |
| 使用容器应用创建 Dapr pub-sub servicebus 应用 | 使用容器应用创建 Dapr pub-sub servicebus 应用。 |
ARM 模板资源定义
可以使用目标操作部署命名空间资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ServiceBus/namespaces 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.ServiceBus/namespaces",
"apiVersion": "2024-01-01",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"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"
},
"tags": {
"{customized property}": "string"
}
}
属性值
ConnectionState
| 名字 | 描述 | 价值 |
|---|---|---|
| 描述 | 连接状态的说明。 | 字符串 |
| 地位 | 连接状态。 | “已批准” “Disconnected” “Pending” “已拒绝” |
加密
| 名字 | 描述 | 价值 |
|---|---|---|
| keySource | 枚举 KeySource for Encryption 的可能值 | “Microsoft.KeyVault” |
| keyVaultProperties | KeyVault 的属性 | KeyVaultProperties[] |
| requireInfrastructureEncryption | 启用基础结构加密（双重加密） | bool |
身份
| 名字 | 描述 | 价值 |
|---|---|---|
| 类型 | 托管服务标识的类型。 | “None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned” |
| userAssignedIdentities | 用户分配标识的属性 | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| 名字 | 描述 | 价值 |
|---|
KeyVaultProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 身份 | UserAssignedIdentityProperties | |
| keyName | KeyVault 中密钥的名称 | 字符串 |
| keyVaultUri | KeyVault 的 URI | 字符串 |
| keyVersion | KeyVault 版本 | 字符串 |
Microsoft.ServiceBus/namespaces
| 名字 | 描述 | 价值 |
|---|---|---|
| apiVersion | API 版本 | '2024-01-01' |
| 身份 | BYOK 标识说明的属性 | 标识 |
| 位置 | 资源所在的地理位置 | string （必需） |
| 名字 | 资源名称 | string （必需） |
| 性能 | 命名空间的属性。 | SBNamespaceProperties |
| sku | SKU 的属性 | SBSku |
| 标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
| 类型 | 资源类型 | “Microsoft.ServiceBus/namespaces” |
PrivateEndpoint
| 名字 | 描述 | 价值 |
|---|---|---|
| id | 专用终结点的 ARM 标识符。 | 字符串 |
PrivateEndpointConnection
| 名字 | 描述 | 价值 |
|---|---|---|
| 性能 | PrivateEndpointConnection 的属性。 | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| privateEndpoint | 此连接的专用终结点资源。 | PrivateEndpoint |
| privateLinkServiceConnectionState | 有关连接状态的详细信息。 | ConnectionState |
| provisioningState | 专用终结点连接的预配状态。 | “Canceled” “创建” “删除” “Failed” “Succeeded” “正在更新” |
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 |
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” “标准”（必需） |
| 层 | 此特定 SKU 的计费层。 | “Basic” “Premium” “Standard” |
TrackedResourceTags
| 名字 | 描述 | 价值 |
|---|
UserAssignedIdentity
| 名字 | 描述 | 价值 |
|---|
UserAssignedIdentityProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| userAssignedIdentity | 为加密选择的用户标识的 ARM ID | 字符串 |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 描述 |
|---|---|
通过专用终结点连接到服务总线命名空间
|
此示例演示如何使用配置虚拟网络和专用 DNS 区域通过专用终结点访问服务总线命名空间。 |
| 使用服务总线
|
其中显示了如何使用 Azure 服务总线将消息与逻辑应用相关联 |
|
创建服务总线异地恢复
|
此模板允许你在高级 SKU 命名空间上配置服务总线异地灾难恢复别名。 |
|
创建服务总线命名空间
|
使用此模板，可以使用基本/标准 SKU 部署服务总线命名空间。 |
|
创建服务总线命名空间和队列
|
使用此模板可以部署服务总线标准命名空间和队列。 |
|
创建服务总线命名空间和队列授权规则
|
使用此模板可以部署服务总线标准命名空间，以及命名空间和队列的授权规则。 |
|
创建服务总线命名空间和主题
|
此模板创建服务总线Namespace和主题。 |
|
创建服务总线命名空间 IP 筛选器规则
|
使用此模板，可以使用 IP 筛选器规则部署服务总线高级命名空间 |
|
创建服务总线命名空间虚拟网络规则
|
使用此模板，可以使用虚拟网络规则部署服务总线高级命名空间 |
|
创建服务总线命名空间、主题和订阅
|
使用此模板可以部署服务总线标准命名空间、主题和订阅。 |
|
创建服务总线命名空间、主题、订阅和规则
|
使用此模板可以部署服务总线标准命名空间、主题、订阅和规则。 |
|
创建服务总线高级命名空间和 AuthorizationRule
|
此模板创建服务总线高级版Namespace和命名空间 AuthorizationRule |
|
使用订阅和 SQL 筛选器 创建服务总线主题
|
此模板使用 SQL 筛选器表达式创建服务总线Namespace和主题，以仅接收与定义的 SQL 筛选器表达式匹配的消息。 |
|
创建 Azure 事件网格自定义主题和队列订阅
|
创建 Azure 事件网格自定义主题和服务总线队列订阅。 模板最初由 Markus Meyer 创作。 |
|
创建 Azure 事件网格自定义主题订阅
|
创建 Azure 事件网格自定义主题和服务总线主题订阅。 模板最初由 Markus Meyer 创作。 |
|
使用容器应用创建 Dapr 微服务应用
|
使用容器应用创建 Dapr 微服务应用。 |
|
使用容器应用创建 Dapr pub-sub servicebus 应用
|
使用容器应用创建 Dapr pub-sub servicebus 应用。 |
| 在 Azure 中
|
使用此模板，可以在 Azure 中创建 EpiServerCMS 部署所需的资源 |
|
集成模式 - 消息路由器 - 服务总线
|
演示如何使用服务总线主题设置消息路由器模式的解决方案 |
Terraform （AzAPI 提供程序）资源定义
可以使用目标操作部署命名空间资源类型：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ServiceBus/namespaces 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ServiceBus/namespaces@2024-01-01"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
sku = {
capacity = int
name = "string"
tier = "string"
}
tags = {
{customized property} = "string"
}
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
}
})
}
属性值
ConnectionState
| 名字 | 描述 | 价值 |
|---|---|---|
| 描述 | 连接状态的说明。 | 字符串 |
| 地位 | 连接状态。 | “已批准” “Disconnected” “Pending” “已拒绝” |
加密
| 名字 | 描述 | 价值 |
|---|---|---|
| keySource | 枚举 KeySource for Encryption 的可能值 | “Microsoft.KeyVault” |
| keyVaultProperties | KeyVault 的属性 | KeyVaultProperties[] |
| requireInfrastructureEncryption | 启用基础结构加密（双重加密） | bool |
身份
| 名字 | 描述 | 价值 |
|---|---|---|
| 类型 | 托管服务标识的类型。 | “None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned” |
| userAssignedIdentities | 用户分配标识的属性 | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| 名字 | 描述 | 价值 |
|---|
KeyVaultProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| 身份 | UserAssignedIdentityProperties | |
| keyName | KeyVault 中密钥的名称 | 字符串 |
| keyVaultUri | KeyVault 的 URI | 字符串 |
| keyVersion | KeyVault 版本 | 字符串 |
Microsoft.ServiceBus/namespaces
| 名字 | 描述 | 价值 |
|---|---|---|
| 身份 | BYOK 标识说明的属性 | 标识 |
| 位置 | 资源所在的地理位置 | string （必需） |
| 名字 | 资源名称 | string （必需） |
| 性能 | 命名空间的属性。 | SBNamespaceProperties |
| sku | SKU 的属性 | SBSku |
| 标签 | 资源标记 | 标记名称和值的字典。 |
| 类型 | 资源类型 | “Microsoft.ServiceBus/namespaces@2024-01-01” |
PrivateEndpoint
| 名字 | 描述 | 价值 |
|---|---|---|
| id | 专用终结点的 ARM 标识符。 | 字符串 |
PrivateEndpointConnection
| 名字 | 描述 | 价值 |
|---|---|---|
| 性能 | PrivateEndpointConnection 的属性。 | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| privateEndpoint | 此连接的专用终结点资源。 | PrivateEndpoint |
| privateLinkServiceConnectionState | 有关连接状态的详细信息。 | ConnectionState |
| provisioningState | 专用终结点连接的预配状态。 | “Canceled” “创建” “删除” “Failed” “Succeeded” “正在更新” |
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 |
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” “标准”（必需） |
| 层 | 此特定 SKU 的计费层。 | “Basic” “Premium” “Standard” |
TrackedResourceTags
| 名字 | 描述 | 价值 |
|---|
UserAssignedIdentity
| 名字 | 描述 | 价值 |
|---|
UserAssignedIdentityProperties
| 名字 | 描述 | 价值 |
|---|---|---|
| userAssignedIdentity | 为加密选择的用户标识的 ARM ID | 字符串 |