你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.ServiceBus 命名空间
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
}
}
属性值
namespaces
| 名称 | 说明 | 值 |
|---|---|---|
| name | 资源名称 | 字符串 (必需) 字符限制：6-50 有效字符： 字母数字和连字符。 以字母开头。 以字母或数字结尾。 有关详细信息，请参阅创建命名空间。 资源名称在 Azure 中必须是唯一的。 |
| location | 资源所在的地理位置 | 字符串 (必需) |
| 标记 | 资源标记 | 标记名称和值的字典。 请参阅 模板中的标记 |
| sku | SKU 的属性 | SBSku |
| identity | BYOK 标识说明的属性 | 标识 |
| properties | 命名空间的属性。 | SBNamespaceProperties |
标识
| 名称 | 说明 | Value |
|---|---|---|
| type | 托管服务标识的类型。 | “None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned” |
| userAssignedIdentities | 用户分配标识的属性 | object |
SBNamespaceProperties
| 名称 | 说明 | 值 |
|---|---|---|
| alternateName | 命名空间的备用名称 | 字符串 |
| disableLocalAuth | 此属性禁用服务总线命名空间的 SAS 身份验证。 | bool |
| 加密 | BYOK 加密说明的属性 | 加密 |
| minimumTlsVersion | 群集支持的最低 TLS 版本，例如“1.2” | '1.0' '1.1' '1.2' |
| 专用终结点 | 专用终结点连接列表。 | PrivateEndpointConnection[] |
| publicNetworkAccess | 这确定是否允许通过公用网络流量。 默认情况下，它处于启用状态。 | “Disabled” “已启用” “SecuredByPerimeter” |
| zoneRedundant | 启用此属性会在区域支持的可用性区域中创建高级服务总线命名空间。 | bool |
加密
| 名称 | 说明 | 值 |
|---|---|---|
| keySource | 枚举 KeySource for Encryption 的可能值 | “Microsoft.KeyVault” |
| keyVaultProperties | KeyVault 的属性 | KeyVaultProperties[] |
| requireInfrastructureEncryption | 启用基础结构加密 (双重加密) | bool |
KeyVaultProperties
| 名称 | 说明 | 值 |
|---|---|---|
| identity | UserAssignedIdentityProperties | |
| keyName | KeyVault 中的密钥的名称 | 字符串 |
| keyVaultUri | KeyVault 的 URI | 字符串 |
| keyVersion | KeyVault 的版本 | 字符串 |
UserAssignedIdentityProperties
| 名称 | 说明 | 值 |
|---|---|---|
| userAssignedIdentity | 选择用于加密的用户标识的 ARM ID | 字符串 |
PrivateEndpointConnection
| 名称 | 说明 | 值 |
|---|---|---|
| properties | PrivateEndpointConnection 的属性。 | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
| 名称 | 说明 | 值 |
|---|---|---|
| privateEndpoint | 此连接的专用终结点资源。 | PrivateEndpoint |
| privateLinkServiceConnectionState | 有关连接状态的详细信息。 | ConnectionState |
| provisioningState | 专用终结点连接的预配状态。 | “已取消” “正在创建” “正在删除” “失败” “成功” “正在更新” |
PrivateEndpoint
| 名称 | 说明 | Value |
|---|---|---|
| id | 专用终结点的 ARM 标识符。 | 字符串 |
ConnectionState
| 名称 | 说明 | 值 |
|---|---|---|
| description | 连接状态的说明。 | 字符串 |
| 状态 | 连接的状态。 | “已批准” “Disconnected” “挂起” “Rejected” |
SBSku
| 名称 | 说明 | 值 |
|---|---|---|
| 容量 | 层的指定消息传送单位。 对于高级层，容量为 1、2 和 4。 | int |
| name | 此 SKU 的名称。 | “Basic” “Premium” “标准” (必需) |
| 层 | 此特定 SKU 的计费层。 | “Basic” “Premium” “Standard” |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 说明 |
|---|---|
Azure 中的 EPiserverCMS |
此模板允许你在 Azure 中创建 EpiServerCMS 部署所需的资源 |
| 集成模式 - 消息路由器 - 服务总线 |
显示如何使用服务总线主题设置消息路由器模式的解决方案 |
| 创建自定义主题和队列订阅Azure 事件网格 |
创建Azure 事件网格自定义主题和服务总线队列订阅。 模板最初由 Markus Meyer 创作。 |
| 创建自定义主题订阅Azure 事件网格 |
创建Azure 事件网格自定义主题和服务总线主题订阅。 模板最初由 Markus Meyer 创作。 |
| 使用服务总线通过逻辑应用关联消息 |
其中显示了如何使用 Azure 服务总线 |
| 创建服务总线命名空间和队列授权规则 |
通过此模板，可以部署服务总线标准命名空间以及命名空间和队列的授权规则。 |
| 创建服务总线命名空间 |
通过此模板，可以使用基本/标准 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"
}
}
属性值
namespaces
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.ServiceBus/namespaces” |
| apiVersion | 资源 API 版本 | “2022-01-01-preview” |
| name | 资源名称 | 字符串 (必需) 字符限制：6-50 有效字符： 字母数字和连字符。 以字母开头。 以字母或数字结尾。 有关详细信息，请参阅创建命名空间。 资源名称在 Azure 中必须是唯一的。 |
| location | 资源所在的地理位置 | 字符串 (必需) |
| 标记 | 资源标记 | 标记名称和值的字典。 请参阅 模板中的标记 |
| sku | SKU 的属性 | SBSku |
| identity | BYOK 标识说明的属性 | 标识 |
| properties | 命名空间的属性。 | SBNamespaceProperties |
标识
| 名称 | 说明 | Value |
|---|---|---|
| type | 托管服务标识的类型。 | “None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned” |
| userAssignedIdentities | 用户分配标识的属性 | object |
SBNamespaceProperties
| 名称 | 说明 | 值 |
|---|---|---|
| alternateName | 命名空间的备用名称 | 字符串 |
| disableLocalAuth | 此属性禁用服务总线命名空间的 SAS 身份验证。 | bool |
| 加密 | BYOK 加密说明的属性 | 加密 |
| minimumTlsVersion | 群集支持的最低 TLS 版本，例如“1.2” | '1.0' '1.1' '1.2' |
| 专用终结点 | 专用终结点连接列表。 | PrivateEndpointConnection[] |
| publicNetworkAccess | 这确定是否允许通过公用网络流量。 默认情况下，它处于启用状态。 | “Disabled” “已启用” “SecuredByPerimeter” |
| zoneRedundant | 启用此属性会在区域支持的可用性区域中创建高级服务总线命名空间。 | bool |
加密
| 名称 | 说明 | 值 |
|---|---|---|
| keySource | 枚举 KeySource for Encryption 的可能值 | “Microsoft.KeyVault” |
| keyVaultProperties | KeyVault 的属性 | KeyVaultProperties[] |
| requireInfrastructureEncryption | 启用基础结构加密 (双重加密) | bool |
KeyVaultProperties
| 名称 | 说明 | 值 |
|---|---|---|
| identity | UserAssignedIdentityProperties | |
| keyName | KeyVault 中的密钥的名称 | 字符串 |
| keyVaultUri | KeyVault 的 URI | 字符串 |
| keyVersion | KeyVault 的版本 | 字符串 |
UserAssignedIdentityProperties
| 名称 | 说明 | 值 |
|---|---|---|
| userAssignedIdentity | 选择用于加密的用户标识的 ARM ID | 字符串 |
PrivateEndpointConnection
| 名称 | 说明 | 值 |
|---|---|---|
| properties | PrivateEndpointConnection 的属性。 | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
| 名称 | 说明 | 值 |
|---|---|---|
| privateEndpoint | 此连接的专用终结点资源。 | PrivateEndpoint |
| privateLinkServiceConnectionState | 有关连接状态的详细信息。 | ConnectionState |
| provisioningState | 专用终结点连接的预配状态。 | “已取消” “正在创建” “正在删除” “失败” “成功” “正在更新” |
PrivateEndpoint
| 名称 | 说明 | Value |
|---|---|---|
| id | 专用终结点的 ARM 标识符。 | 字符串 |
ConnectionState
| 名称 | 说明 | 值 |
|---|---|---|
| description | 连接状态的说明。 | 字符串 |
| 状态 | 连接的状态。 | “已批准” “Disconnected” “挂起” “Rejected” |
SBSku
| 名称 | 说明 | 值 |
|---|---|---|
| 容量 | 层的指定消息传送单位。 对于高级层，容量为 1、2 和 4。 | int |
| name | 此 SKU 的名称。 | “Basic” “Premium” “标准” (必需) |
| 层 | 此特定 SKU 的计费层。 | “Basic” “Premium” “Standard” |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 说明 |
|---|---|
| Azure 中的 EPiserverCMS |
此模板允许你在 Azure 中创建 EpiServerCMS 部署所需的资源 |
| 集成模式 - 消息路由器 - 服务总线 |
显示如何使用服务总线主题设置消息路由器模式的解决方案 |
| 创建自定义主题和队列订阅Azure 事件网格 |
创建Azure 事件网格自定义主题和服务总线队列订阅。 模板最初由 Markus Meyer 创作。 |
| 创建自定义主题订阅Azure 事件网格 |
创建Azure 事件网格自定义主题和服务总线主题订阅。 模板最初由 Markus Meyer 创作。 |
| 使用服务总线通过逻辑应用关联消息 |
其中显示了如何使用 Azure 服务总线 |
| 创建服务总线命名空间和队列授权规则 |
通过此模板，可以部署服务总线标准命名空间以及命名空间和队列的授权规则。 |
| 创建服务总线命名空间 |
通过此模板，可以使用基本/标准 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"
}
})
}
属性值
namespaces
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.ServiceBus/namespaces@2022-01-01-preview” |
| name | 资源名称 | 字符串 (必需) 字符限制：6-50 有效字符： 字母数字和连字符。 以字母开头。 以字母或数字结尾。 有关详细信息，请参阅创建命名空间。 资源名称在 Azure 中必须是唯一的。 |
| location | 资源所在的地理位置 | 字符串 (必需) |
| parent_id | 若要部署到资源组，请使用该资源组的 ID。 | 字符串 (必需) |
| 标记 | 资源标记 | 标记名称和值的字典。 |
| sku | SKU 的属性 | SBSku |
| identity | BYOK 标识说明的属性 | 标识 |
| properties | 命名空间的属性。 | SBNamespaceProperties |
标识
| 名称 | 说明 | Value |
|---|---|---|
| type | 托管服务标识的类型。 | “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned” |
| identity_ids | 用户分配标识的属性 | 用户标识 ID 数组。 |
SBNamespaceProperties
| 名称 | 说明 | 值 |
|---|---|---|
| alternateName | 命名空间的备用名称 | 字符串 |
| disableLocalAuth | 此属性禁用服务总线命名空间的 SAS 身份验证。 | bool |
| 加密 | BYOK 加密说明的属性 | 加密 |
| minimumTlsVersion | 群集支持的最低 TLS 版本，例如“1.2” | "1.0" "1.1" "1.2" |
| 专用终结点 | 专用终结点连接列表。 | PrivateEndpointConnection[] |
| publicNetworkAccess | 这确定是否允许通过公用网络流量。 默认情况下，它处于启用状态。 | “Disabled” “已启用” “SecuredByPerimeter” |
| zoneRedundant | 启用此属性会在区域支持的可用性区域中创建高级服务总线命名空间。 | bool |
加密
| 名称 | 说明 | 值 |
|---|---|---|
| keySource | 枚举 KeySource for Encryption 的可能值 | “Microsoft.KeyVault” |
| keyVaultProperties | KeyVault 的属性 | KeyVaultProperties[] |
| requireInfrastructureEncryption | 启用基础结构加密 (双重加密) | bool |
KeyVaultProperties
| 名称 | 说明 | 值 |
|---|---|---|
| identity | UserAssignedIdentityProperties | |
| keyName | KeyVault 中的密钥的名称 | 字符串 |
| keyVaultUri | KeyVault 的 URI | 字符串 |
| keyVersion | KeyVault 的版本 | 字符串 |
UserAssignedIdentityProperties
| 名称 | 说明 | 值 |
|---|---|---|
| userAssignedIdentity | 选择用于加密的用户标识的 ARM ID | 字符串 |
PrivateEndpointConnection
| 名称 | 说明 | 值 |
|---|---|---|
| properties | PrivateEndpointConnection 的属性。 | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
| 名称 | 说明 | 值 |
|---|---|---|
| privateEndpoint | 此连接的专用终结点资源。 | PrivateEndpoint |
| privateLinkServiceConnectionState | 有关连接状态的详细信息。 | ConnectionState |
| provisioningState | 专用终结点连接的预配状态。 | “已取消” “正在创建” “正在删除” “失败” “成功” “正在更新” |
PrivateEndpoint
| 名称 | 说明 | Value |
|---|---|---|
| id | 专用终结点的 ARM 标识符。 | 字符串 |
ConnectionState
| 名称 | 说明 | 值 |
|---|---|---|
| description | 连接状态的说明。 | 字符串 |
| 状态 | 连接的状态。 | “已批准” “已断开连接” “挂起” “已拒绝” |
SBSku
| 名称 | 说明 | 值 |
|---|---|---|
| 容量 | 层的指定消息传送单位。 对于高级层，容量为 1、2 和 4。 | int |
| name | 此 SKU 的名称。 | "Basic" “Premium” “标准” (必需) |
| 层 | 此特定 SKU 的计费层。 | "Basic" “Premium” “标准” |
反馈
即将发布：在整个 2024 年，我们将逐步淘汰作为内容反馈机制的“GitHub 问题”，并将其取代为新的反馈系统。 有关详细信息，请参阅：https://aka.ms/ContentUserFeedback。
提交和查看相关反馈