你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Microsoft.EventGrid 命名空间 2023-06-01-preview

Bicep 资源定义

可以使用面向以下操作部署命名空间资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.EventGrid/namespaces 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.EventGrid/namespaces@2023-06-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'Standard'
  }
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  properties: {
    inboundIpRules: [
      {
        action: 'Allow'
        ipMask: 'string'
      }
    ]
    isZoneRedundant: bool
    minimumTlsVersionAllowed: 'string'
    privateEndpointConnections: [
      {
        properties: {
          groupIds: [
            'string'
          ]
          privateEndpoint: {
            id: 'string'
          }
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
          provisioningState: 'string'
        }
      }
    ]
    publicNetworkAccess: 'string'
    topicsConfiguration: {}
    topicSpacesConfiguration: {
      clientAuthentication: {
        alternativeAuthenticationNameSources: [
          'string'
        ]
      }
      maximumClientSessionsPerAuthenticationName: int
      maximumSessionExpiryInHours: int
      routeTopicResourceId: 'string'
      routingEnrichments: {
        dynamic: [
          {
            key: 'string'
            value: 'string'
          }
        ]
        static: [
          {
            key: 'string'
            valueType: 'String'
          }
        ]
      }
      routingIdentityInfo: {
        type: 'string'
        userAssignedIdentity: 'string'
      }
      state: 'string'
    }
  }
}

属性值

namespaces

名称 说明
name 资源名称 字符串 (必需)
location 资源的位置。 字符串 (必需)
标记 资源的标记。 标记名称和值的字典。 请参阅 模板中的标记
sku 表示可用的 SKU 定价层。 NamespaceSku
标识 命名空间资源的标识信息。 IdentityInfo
properties 命名空间资源的属性。 NamespaceProperties

IdentityInfo

名称 说明
principalId 资源标识的主体 ID。 字符串
tenantId 资源的租户 ID。 字符串
type 使用的托管标识的类型。 类型“SystemAssigned, UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。 “None”
“SystemAssigned”
“SystemAssigned, UserAssigned”
“UserAssigned”
userAssignedIdentities 与资源关联的用户标识列表。 用户标识字典键引用将是采用以下格式的 ARM 资源 ID:
“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。
此属性当前未使用,保留以供将来使用。
IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

名称 说明
{customized property} UserIdentityProperties

UserIdentityProperties

名称 说明
clientId 用户分配标识的客户端 ID。 string
principalId 用户分配标识的主体 ID。 字符串

NamespaceProperties

名称 说明
inboundIpRules 这可用于限制来自特定 IP 而不是所有 IP 的流量。 注意:仅当启用了 PublicNetworkAccess 时,才会考虑这些内容。 InboundIpRule[]
isZoneRedundant 允许用户指定服务是否为区域冗余服务。 这是必需属性,用户需要显式指定此值。
指定后,无法更新此属性。
bool
minimumTlsVersionAllowed 允许发布到此命名空间的发布服务器的最低 TLS 版本。 仅支持 TLS 版本 1.2。 '1.0'
'1.1'
'1.2'
专用终结点 PrivateEndpointConnection[]
publicNetworkAccess 这确定是否允许通过公用网络进行流量。 默认情况下,它处于启用状态。
可以通过配置 {seealso cref=“P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PubSub.NamespaceProperties.InboundIpRules” /} 来进一步限制为特定 IP
'Disabled'
'Enabled'
topicsConfiguration 命名空间资源的主题配置信息 TopicsConfiguration
topicSpacesConfiguration 命名空间资源的主题空间配置信息 TopicSpacesConfiguration

InboundIpRule

名称 说明
action 要根据 IpMask 的匹配项或不匹配执行的操作。 “允许”
ipMask 采用 CIDR 表示法的 IP 地址,例如 10.0.0.0/8。 string

PrivateEndpointConnection

名称 说明
properties PrivateEndpointConnection 的属性。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名称 说明
groupIds 专用链接服务资源的 GroupIds。 string[]
privateEndpoint 此连接的专用终结点资源。 PrivateEndpoint
privateLinkServiceConnectionState 有关连接状态的详细信息。 ConnectionState
provisioningState 专用终结点连接的预配状态。 “已取消”
'Creating'
'正在删除'
“Failed”
'Succeeded'
“正在更新”

PrivateEndpoint

名称 说明 Value
id 专用终结点的 ARM 标识符。 字符串

ConnectionState

名称 说明
actionsRequired 如果有任何) , (所需的操作。 string
description 连接状态的说明。 字符串
status 连接状态。 “已批准”
“Disconnected”
'Pending'
“Rejected”

TopicsConfiguration

此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。

TopicSpacesConfiguration

名称 说明
clientAuthentication 主题空间配置的客户端身份验证设置。 ClientAuthenticationSettings
maximumClientSessionsPerAuthenticationName 每个身份验证名称的最大会话数。 属性默认值为 1。
最小允许值为 1,最大允许值为 100。
int
maximumSessionExpiryInHours 最大会话过期时间(以小时为单位)。 属性默认值为 1 小时。
最小允许值为 1 小时,最大允许值为 8 小时。
int
routeTopicResourceId 事件网格主题的完全限定的 Azure 资源 ID,事件将从命名空间下的 TopicSpaces 路由到该主题。
此属性应采用以下格式'/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft。EventGrid/topics/{topicName}”。
本主题应位于命名空间所在的同一区域。
string
routingEnrichments 主题空间配置的路由扩充 RoutingEnrichments
routingIdentityInfo 主题空间配置的路由标识信息。 RoutingIdentityInfo
state 指示是否为命名空间启用了主题空间配置。 默认值为 Disabled。 “Disabled”
“已启用”

ClientAuthenticationSettings

名称 说明
alternativeAuthenticationNameSources 与命名空间资源的客户端身份验证设置相关的备用身份验证名称源。 包含任意项的字符串数组:
“ClientCertificateDns”
“ClientCertificateEmail”
“ClientCertificateIp”
“ClientCertificateSubject”
“ClientCertificateUri”

RoutingEnrichments

名称 说明
dynamic DynamicRoutingEnrichment[]
static StaticRoutingEnrichment[]

DynamicRoutingEnrichment

名称 说明
动态路由扩充密钥。 string
value 动态路由扩充值。 字符串

StaticRoutingEnrichment

名称 说明
静态路由扩充密钥。 字符串
valueType 静态路由扩充值类型。 例如,此属性值可以是“String”。 “String”

RoutingIdentityInfo

名称 说明 Value
type “None”
“SystemAssigned”
“UserAssigned”
userAssignedIdentity string

NamespaceSku

名称 说明
容量 指定定义命名空间容量的吞吐量单位数。 属性默认值为
1 表示每个命名空间有 1 个吞吐量单位 = 1MB/s 入口和 2MB/s 出口。 最小容量为 1,并且
最大允许容量为 20。
int
name SKU 的名称。 “Standard”

ARM 模板资源定义

命名空间资源类型可以使用面向以下对象的操作进行部署:

有关每个 API 版本中更改的属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.EventGrid/namespaces 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.EventGrid/namespaces",
  "apiVersion": "2023-06-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "Standard"
  },
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "properties": {
    "inboundIpRules": [
      {
        "action": "Allow",
        "ipMask": "string"
      }
    ],
    "isZoneRedundant": "bool",
    "minimumTlsVersionAllowed": "string",
    "privateEndpointConnections": [
      {
        "properties": {
          "groupIds": [ "string" ],
          "privateEndpoint": {
            "id": "string"
          },
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          },
          "provisioningState": "string"
        }
      }
    ],
    "publicNetworkAccess": "string",
    "topicsConfiguration": {},
    "topicSpacesConfiguration": {
      "clientAuthentication": {
        "alternativeAuthenticationNameSources": [ "string" ]
      },
      "maximumClientSessionsPerAuthenticationName": "int",
      "maximumSessionExpiryInHours": "int",
      "routeTopicResourceId": "string",
      "routingEnrichments": {
        "dynamic": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "static": [
          {
            "key": "string",
            "valueType": "String"
          }
        ]
      },
      "routingIdentityInfo": {
        "type": "string",
        "userAssignedIdentity": "string"
      },
      "state": "string"
    }
  }
}

属性值

namespaces

名称 说明 Value
type 资源类型 “Microsoft.EventGrid/namespaces”
apiVersion 资源 API 版本 “2023-06-01-preview”
name 资源名称 字符串 (必需)
location 资源的位置。 字符串 (必需)
标记 资源的标记。 标记名称和值的字典。 请参阅 模板中的标记
sku 表示可用的 SKU 定价层。 NamespaceSku
标识 命名空间资源的标识信息。 IdentityInfo
properties 命名空间资源的属性。 NamespaceProperties

IdentityInfo

名称 说明
principalId 资源标识的主体 ID。 字符串
tenantId 资源的租户 ID。 string
type 使用的托管标识的类型。 类型“SystemAssigned, UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。 “None”
“SystemAssigned”
“SystemAssigned, UserAssigned”
“UserAssigned”
userAssignedIdentities 与资源关联的用户标识列表。 用户标识字典键引用将是采用以下格式的 ARM 资源 ID:
“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。
此属性当前未使用,保留以供将来使用。
IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

名称 说明
{customized property} UserIdentityProperties

UserIdentityProperties

名称 说明
clientId 用户分配标识的客户端 ID。 string
principalId 用户分配标识的主体 ID。 字符串

NamespaceProperties

名称 说明
inboundIpRules 这可用于限制来自特定 IP 而不是所有 IP 的流量。 注意:仅当启用了 PublicNetworkAccess 时,才会考虑这些内容。 InboundIpRule[]
isZoneRedundant 允许用户指定服务是否为区域冗余服务。 这是必需属性,用户需要显式指定此值。
指定后,无法更新此属性。
bool
minimumTlsVersionAllowed 允许发布到此命名空间的发布服务器的最低 TLS 版本。 仅支持 TLS 版本 1.2。 '1.0'
'1.1'
'1.2'
专用终结点 PrivateEndpointConnection[]
publicNetworkAccess 这确定是否允许通过公用网络进行流量。 默认情况下,它处于启用状态。
可以通过配置 {seealso cref=“P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PubSub.NamespaceProperties.InboundIpRules” /} 来进一步限制为特定 IP
'Disabled'
'Enabled'
topicsConfiguration 命名空间资源的主题配置信息 TopicsConfiguration
topicSpacesConfiguration 命名空间资源的主题空间配置信息 TopicSpacesConfiguration

InboundIpRule

名称 说明
action 要根据 IpMask 的匹配项或不匹配执行的操作。 “允许”
ipMask 采用 CIDR 表示法的 IP 地址,例如 10.0.0.0/8。 字符串

PrivateEndpointConnection

名称 说明
properties PrivateEndpointConnection 的属性。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名称 说明
groupIds 专用链接服务资源的 GroupIds。 string[]
privateEndpoint 此连接的专用终结点资源。 PrivateEndpoint
privateLinkServiceConnectionState 有关连接状态的详细信息。 ConnectionState
provisioningState 专用终结点连接的预配状态。 “已取消”
'Creating'
'正在删除'
“Failed”
'Succeeded'
“正在更新”

PrivateEndpoint

名称 说明 Value
id 专用终结点的 ARM 标识符。 string

ConnectionState

名称 说明
actionsRequired 如果有任何) , (所需的操作。 字符串
description 连接状态的说明。 字符串
status 连接状态。 “已批准”
“Disconnected”
'Pending'
“Rejected”

TopicsConfiguration

此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。

TopicSpacesConfiguration

名称 说明
clientAuthentication 主题空间配置的客户端身份验证设置。 ClientAuthenticationSettings
maximumClientSessionsPerAuthenticationName 每个身份验证名称的最大会话数。 属性默认值为 1。
最小允许值为 1,最大允许值为 100。
int
maximumSessionExpiryInHours 最大会话过期时间(以小时为单位)。 属性默认值为 1 小时。
最小允许值为 1 小时,最大允许值为 8 小时。
int
routeTopicResourceId 事件网格主题的完全限定的 Azure 资源 ID,事件将从命名空间下的 TopicSpaces 路由到该主题。
此属性应采用以下格式'/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft。EventGrid/topics/{topicName}”。
本主题应位于命名空间所在的同一区域。
字符串
routingEnrichments 主题空间配置的路由扩充 RoutingEnrichments
routingIdentityInfo 主题空间配置的路由标识信息。 RoutingIdentityInfo
state 指示是否为命名空间启用了主题空间配置。 默认值为 Disabled。 'Disabled'
'Enabled'

ClientAuthenticationSettings

名称 说明
alternativeAuthenticationNameSources 与命名空间资源的客户端身份验证设置相关的备用身份验证名称源。 包含任何一项的字符串数组:
'ClientCertificateDns'
'ClientCertificateEmail'
'ClientCertificateIp'
'ClientCertificateSubject'
“ClientCertificateUri”

RoutingEnrichments

名称 说明
dynamic DynamicRoutingEnrichment[]
static StaticRoutingEnrichment[]

DynamicRoutingEnrichment

名称 说明
动态路由扩充密钥。 string
value 动态路由扩充值。 字符串

StaticRoutingEnrichment

名称 说明
静态路由扩充密钥。 字符串
valueType 静态路由扩充值类型。 例如,此属性值可以是“String”。 'String'

RoutingIdentityInfo

名称 说明 Value
type “None”
“SystemAssigned”
“UserAssigned”
userAssignedIdentity 字符串

NamespaceSku

名称 说明
容量 指定定义命名空间容量的吞吐量单位数。 属性默认值为
1 表示每个命名空间有 1 个吞吐量单位 = 1MB/秒的入口和 2MB/秒的传出量。 最小容量为 1 且
最大允许容量为 20。
int
name SKU 的名称。 'Standard'

Terraform (AzAPI 提供程序) 资源定义

可以使用面向以下操作部署命名空间资源类型:

  • 资源组

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.EventGrid/namespaces 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/namespaces@2023-06-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      inboundIpRules = [
        {
          action = "Allow"
          ipMask = "string"
        }
      ]
      isZoneRedundant = bool
      minimumTlsVersionAllowed = "string"
      privateEndpointConnections = [
        {
          properties = {
            groupIds = [
              "string"
            ]
            privateEndpoint = {
              id = "string"
            }
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
            provisioningState = "string"
          }
        }
      ]
      publicNetworkAccess = "string"
      topicsConfiguration = {}
      topicSpacesConfiguration = {
        clientAuthentication = {
          alternativeAuthenticationNameSources = [
            "string"
          ]
        }
        maximumClientSessionsPerAuthenticationName = int
        maximumSessionExpiryInHours = int
        routeTopicResourceId = "string"
        routingEnrichments = {
          dynamic = [
            {
              key = "string"
              value = "string"
            }
          ]
          static = [
            {
              key = "string"
              valueType = "String"
            }
          ]
        }
        routingIdentityInfo = {
          type = "string"
          userAssignedIdentity = "string"
        }
        state = "string"
      }
    }
    sku = {
      capacity = int
      name = "Standard"
    }
  })
}

属性值

namespaces

名称 说明 Value
type 资源类型 “Microsoft.EventGrid/namespaces@2023-06-01-preview”
name 资源名称 字符串 (必需)
location 资源的位置。 字符串 (必需)
parent_id 若要部署到资源组,请使用该资源组的 ID。 字符串 (必需)
标记 资源的标记。 标记名称和值的字典。
sku 表示可用的 SKU 定价层。 NamespaceSku
标识 命名空间资源的标识信息。 IdentityInfo
properties 命名空间资源的属性。 NamespaceProperties

IdentityInfo

名称 说明 Value
type 使用的托管标识的类型。 类型“SystemAssigned, UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。 “SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”
identity_ids 与资源关联的用户标识列表。 用户标识字典键引用将是采用以下格式的 ARM 资源 ID:
“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。
此属性当前未使用,保留以供将来使用。
用户标识 ID 的数组。

IdentityInfoUserAssignedIdentities

名称 说明
{customized property} UserIdentityProperties

UserIdentityProperties

名称 说明
clientId 用户分配标识的客户端 ID。 string
principalId 用户分配标识的主体 ID。 字符串

NamespaceProperties

名称 说明
inboundIpRules 这可用于限制来自特定 IP 而不是所有 IP 的流量。 注意:仅当启用了 PublicNetworkAccess 时,才会考虑这些内容。 InboundIpRule[]
isZoneRedundant 允许用户指定服务是否为区域冗余服务。 这是必需属性,用户需要显式指定此值。
指定后,无法更新此属性。
bool
minimumTlsVersionAllowed 允许发布到此命名空间的发布服务器的最低 TLS 版本。 仅支持 TLS 版本 1.2。 "1.0"
"1.1"
"1.2"
专用终结点 PrivateEndpointConnection[]
publicNetworkAccess 这确定是否允许通过公用网络进行流量。 默认情况下,它处于启用状态。
可以通过配置 {seealso cref=“P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PubSub.NamespaceProperties.InboundIpRules” /} 来进一步限制为特定 IP
“Disabled”
“Enabled”
topicsConfiguration 命名空间资源的主题配置信息 TopicsConfiguration
topicSpacesConfiguration 命名空间资源的主题空间配置信息 TopicSpacesConfiguration

InboundIpRule

名称 说明
action 要根据 IpMask 的匹配项或不匹配执行的操作。 “允许”
ipMask 采用 CIDR 表示法的 IP 地址,例如 10.0.0.0/8。 string

PrivateEndpointConnection

名称 说明
properties PrivateEndpointConnection 的属性。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名称 说明
groupIds 专用链接服务资源的 GroupIds。 string[]
privateEndpoint 此连接的专用终结点资源。 PrivateEndpoint
privateLinkServiceConnectionState 有关连接状态的详细信息。 ConnectionState
provisioningState 专用终结点连接的预配状态。 “已取消”
“正在创建”
“正在删除”
“Failed”
“Succeeded”
“正在更新”

PrivateEndpoint

名称 说明 Value
id 专用终结点的 ARM 标识符。 字符串

ConnectionState

名称 说明
actionsRequired 如果有任何) , (所需的操作。 字符串
description 连接状态的说明。 字符串
status 连接状态。 “已批准”
“Disconnected”
“挂起”
“已拒绝”

TopicsConfiguration

此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。

TopicSpacesConfiguration

名称 说明
clientAuthentication 主题空间配置的客户端身份验证设置。 ClientAuthenticationSettings
maximumClientSessionsPerAuthenticationName 每个身份验证名称的最大会话数。 属性默认值为 1。
最小允许值为 1,最大允许值为 100。
int
maximumSessionExpiryInHours 最大会话过期时间(以小时为单位)。 属性默认值为 1 小时。
最小允许值为 1 小时,最大允许值为 8 小时。
int
routeTopicResourceId 事件网格主题的完全限定的 Azure 资源 ID,事件将从命名空间下的 TopicSpaces 路由到该主题。
此属性应采用以下格式'/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft。EventGrid/topics/{topicName}”。
本主题应位于命名空间所在的同一区域。
string
routingEnrichments 主题空间配置的路由扩充 RoutingEnrichments
routingIdentityInfo 主题空间配置的路由标识信息。 RoutingIdentityInfo
state 指示是否为命名空间启用了主题空间配置。 默认值为 Disabled。 “Disabled”
“Enabled”

ClientAuthenticationSettings

名称 说明
alternativeAuthenticationNameSources 与命名空间资源的客户端身份验证设置相关的备用身份验证名称源。 包含任何一项的字符串数组:
“ClientCertificateDns”
“ClientCertificateEmail”
“ClientCertificateIp”
“ClientCertificateSubject”
“ClientCertificateUri”

RoutingEnrichments

名称 说明
dynamic DynamicRoutingEnrichment[]
static StaticRoutingEnrichment[]

DynamicRoutingEnrichment

名称 说明
动态路由扩充密钥。 string
value 动态路由扩充值。 字符串

StaticRoutingEnrichment

名称 说明
静态路由扩充密钥。 字符串
valueType 静态路由扩充值类型。 例如,此属性值可以是“String”。 “String”

RoutingIdentityInfo

名称 说明 Value
type "None"
“SystemAssigned”
“UserAssigned”
userAssignedIdentity 字符串

NamespaceSku

名称 说明
容量 指定定义命名空间容量的吞吐量单位数。 属性默认值为
1 表示每个命名空间有 1 个吞吐量单位 = 1MB/秒的入口和 2MB/秒的传出量。 最小容量为 1,并且
最大允许容量为 20。
int
name SKU 的名称。 “Standard”