通过

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

Topics - Update

  • 参考
服务:
Event Grid
API 版本:
2025-02-15

更新主题。
使用指定的参数异步更新主题。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}?api-version=2025-02-15

URI 参数

名称 在 必需 类型 说明
resourceGroupName
 path True

string

用户订阅中的资源组的名称。
subscriptionId
 path True

string

唯一标识Microsoft Azure 订阅的订阅凭据。 订阅 ID 构成了每个服务调用的 URI 的一部分。
topicName
 path True

string

主题的名称。
api-version
 query True

string

要用于客户端请求的 API 的版本。

请求正文

名称 类型 说明
identity

IdentityInfo

主题资源标识信息。
properties.dataResidencyBoundary

DataResidencyBoundary

主题的数据驻留边界。
properties.disableLocalAuth

boolean

此布尔值用于启用或禁用本地身份验证。默认值为 false。 如果该属性设置为 true，则仅使用 AAD 令牌在允许用户发布到主题时进行身份验证。
properties.eventTypeInfo

EventTypeInfo

主题的 eventTypeInfo。
properties.inboundIpRules

InboundIpRule[]

这可用于限制来自特定 IP 而不是所有 IP 的流量。 注意：仅当启用了 PublicNetworkAccess 时，才会考虑这些内容。
properties.minimumTlsVersionAllowed

TlsVersion

允许发布到此域的发布服务器的最低 TLS 版本
properties.publicNetworkAccess

PublicNetworkAccess

这决定了是否允许通过公用网络流量。 默认情况下，它处于启用状态。 可以通过配置进一步限制为特定 IP
tags

object

主题资源的标记。

响应

名称 类型 说明
200 OK

还行
201 Created

Topic

接受主题更新请求。
Other Status Codes

错误响应： ***

  • 400 错误的请求。

  • 500 内部服务器错误。

示例

Topics_Update

示例请求

PATCH https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1?api-version=2025-02-15

{
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "publicNetworkAccess": "Enabled",
    "inboundIpRules": [
      {
        "ipMask": "12.18.30.15",
        "action": "Allow"
      },
      {
        "ipMask": "12.18.176.1",
        "action": "Allow"
      }
    ]
  }
}

示例响应

状态代码:
200
状态代码:
201 
{
  "properties": {
    "endpoint": "https://exampletopic1.westus2-1.eventgrid.azure.net/api/events",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "Enabled",
    "inboundIpRules": [
      {
        "ipMask": "12.18.30.15",
        "action": "Allow"
      },
      {
        "ipMask": "12.18.176.1",
        "action": "Allow"
      }
    ]
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1",
  "location": "westus2",
  "name": "exampletopic1",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "type": "Microsoft.EventGrid/topics"
}

定义

名称 说明
ConnectionState

ConnectionState 信息。
createdByType

创建资源的标识的类型。
DataResidencyBoundary

资源的数据驻留边界。
EventDefinitionKind

所使用的事件类型。
EventTypeInfo

通道的事件类型信息。
IdentityInfo

资源的标识信息。
IdentityType

使用的托管标识的类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。
InboundIpRule
InlineEventProperties

有关每个内联事件的其他信息。
InputSchema

这决定了事件网格应期望用于发布到事件网格域资源的传入事件的格式。
IpActionType

根据匹配项或 IpMask 的匹配项执行的作。
JsonField

这用于表示事件网格事件架构中单个目标字段的输入架构映射的源。 这当前用于“id”、“topic”和“eventtime”属性的映射中。 这表示输入事件架构中的字段。
JsonFieldWithDefault

这用于表示事件网格事件架构中单个目标字段的输入架构映射的源。 这当前用于“subject”、“eventtype”和“dataversion”属性的映射中。 这表示输入事件架构中的字段以及要使用的默认值，并且至少应提供这两个属性中的一个。
JsonInputSchemaMapping

这允许使用自定义输入架构发布到事件网格。 这可用于将自定义输入 JSON 架构中的属性映射到事件网格事件架构。
PersistedConnectionStatus

连接状态。
PrivateEndpoint

PrivateEndpoint 信息。
PrivateEndpointConnection
PublicNetworkAccess

这决定了是否允许通过公用网络流量。 默认情况下，它处于启用状态。 可以通过配置进一步限制为特定 IP
ResourceProvisioningState

专用终结点连接的预配状态。
systemData

与创建和上次修改资源相关的元数据。
TlsVersion

允许发布到此域的发布服务器的最低 TLS 版本
Topic

EventGrid 主题
TopicProvisioningState

主题的预配状态。
TopicUpdateParameters

主题更新的属性
UserIdentityProperties

有关用户标识的信息。

ConnectionState

Object

ConnectionState 信息。

名称 类型 说明
actionsRequired

string

需要的作（如果有）。
description

string

连接状态的说明。
status

PersistedConnectionStatus

连接状态。

createdByType

Enumeration

创建资源的标识的类型。

值 说明
Application
Key
ManagedIdentity
User

DataResidencyBoundary

Enumeration

资源的数据驻留边界。

值 说明
WithinGeopair
WithinRegion

EventDefinitionKind

Enumeration

所使用的事件类型。

值 说明
Inline

EventTypeInfo

Object

通道的事件类型信息。

名称 类型 说明
inlineEventTypes

<string,  InlineEventProperties>

资源的内联事件类型的集合。 内联事件类型键是表示事件名称的类型字符串。 有效的内联事件名称示例是“Contoso.OrderCreated”。 内联事件类型值的类型为 InlineEventProperties，并且将包含每个内联事件类型的附加信息。
kind

EventDefinitionKind

所使用的事件类型。

IdentityInfo

Object

资源的标识信息。

名称 类型 说明
principalId

string

资源标识的主体 ID。
tenantId

string

资源的租户 ID。
type

IdentityType

使用的托管标识的类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。
userAssignedIdentities

<string,  UserIdentityProperties>

与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 此属性当前未使用，并保留以供将来使用。

IdentityType

Enumeration

使用的托管标识的类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。

值 说明
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

InboundIpRule

Object
名称 类型 说明
action

IpActionType

根据匹配项或 IpMask 的匹配项执行的作。
ipMask

string

CIDR 表示法中的 IP 地址，例如 10.0.0.0/8。

InlineEventProperties

Object

有关每个内联事件的其他信息。

名称 类型 说明
dataSchemaUrl

string

内联事件的 dataSchemaUrl。
description

string

内联事件的说明。
displayName

string

内联事件的 displayName。
documentationUrl

string

内联事件的 documentationUrl。

InputSchema

Enumeration

这决定了事件网格应期望用于发布到事件网格域资源的传入事件的格式。

值 说明
CloudEventSchemaV1_0
CustomEventSchema
EventGridSchema

IpActionType

Enumeration

根据匹配项或 IpMask 的匹配项执行的作。

值 说明
Allow

JsonField

Object

这用于表示事件网格事件架构中单个目标字段的输入架构映射的源。 这当前用于“id”、“topic”和“eventtime”属性的映射中。 这表示输入事件架构中的字段。

名称 类型 说明
sourceField

string

要用作映射源的输入事件架构中的字段的名称。

JsonFieldWithDefault

Object

这用于表示事件网格事件架构中单个目标字段的输入架构映射的源。 这当前用于“subject”、“eventtype”和“dataversion”属性的映射中。 这表示输入事件架构中的字段以及要使用的默认值，并且至少应提供这两个属性中的一个。

名称 类型 说明
defaultValue

string

如果未提供 SourceField 或已发布 JSON 事件有效负载中没有具有指定名称的属性，则用于映射的默认值。
sourceField

string

要用作映射源的输入事件架构中的字段的名称。

JsonInputSchemaMapping

Object

这允许使用自定义输入架构发布到事件网格。 这可用于将自定义输入 JSON 架构中的属性映射到事件网格事件架构。

名称 类型 说明
inputSchemaMappingType string:

Json

自定义映射的类型
properties.dataVersion

JsonFieldWithDefault

事件网格事件的 DataVersion 属性的映射信息。
properties.eventTime

JsonField

事件网格事件的 EventTime 属性的映射信息。
properties.eventType

JsonFieldWithDefault

事件网格事件的 EventType 属性的映射信息。
properties.id

JsonField

事件网格事件的 Id 属性的映射信息。
properties.subject

JsonFieldWithDefault

事件网格事件的 Subject 属性的映射信息。
properties.topic

JsonField

事件网格事件的 Topic 属性的映射信息。

PersistedConnectionStatus

Enumeration

连接状态。

值 说明
Approved
Disconnected
Pending
Rejected

PrivateEndpoint

Object

PrivateEndpoint 信息。

名称 类型 说明
id

string

专用终结点的 ARM 标识符。

PrivateEndpointConnection

Object
名称 类型 说明
id

string

资源的完全限定标识符。
name

string

资源的名称。
properties.groupIds

string[]

专用链接服务资源的 GroupId。
properties.privateEndpoint

PrivateEndpoint

此连接的专用终结点资源。
properties.privateLinkServiceConnectionState

ConnectionState

有关连接状态的详细信息。
properties.provisioningState

ResourceProvisioningState

专用终结点连接的预配状态。
type

string

资源的类型。

PublicNetworkAccess

Enumeration

这决定了是否允许通过公用网络流量。 默认情况下，它处于启用状态。 可以通过配置进一步限制为特定 IP

值 说明
Disabled
Enabled

ResourceProvisioningState

Enumeration

专用终结点连接的预配状态。

值 说明
Canceled
Creating
Deleting
Failed
Succeeded
Updating

systemData

Object

与创建和上次修改资源相关的元数据。

名称 类型 说明
createdAt

string

资源创建时间戳（UTC）。
createdBy

string

创建资源的标识。
createdByType

createdByType

创建资源的标识的类型。
lastModifiedAt

string

上次修改的资源时间戳（UTC）
lastModifiedBy

string

上次修改资源的标识。
lastModifiedByType

createdByType

上次修改资源的标识的类型。

TlsVersion

Enumeration

允许发布到此域的发布服务器的最低 TLS 版本

值 说明
1.0
1.1
1.2

Topic

Object

EventGrid 主题

名称 类型 默认值 说明
id

string

资源的完全限定标识符。
identity

IdentityInfo

资源的标识信息。
location

string

资源的位置。
name

string

资源的名称。
properties.dataResidencyBoundary

DataResidencyBoundary

资源的数据驻留边界。
properties.disableLocalAuth

boolean

False

此布尔值用于启用或禁用本地身份验证。默认值为 false。 如果该属性设置为 true，则仅使用 AAD 令牌在允许用户发布到主题时进行身份验证。
properties.endpoint

string

主题的终结点。
properties.eventTypeInfo

EventTypeInfo

用户主题的事件类型信息。 此信息由发布者提供，可供订阅者用来查看发布的不同类型的事件。
properties.inboundIpRules

InboundIpRule[]

这可用于限制来自特定 IP 而不是所有 IP 的流量。 注意：仅当启用了 PublicNetworkAccess 时，才会考虑这些内容。
properties.inputSchema

InputSchema

EventGridSchema

这决定了事件网格应该期望用于发布到主题的传入事件的格式。
properties.inputSchemaMapping InputSchemaMapping:

JsonInputSchemaMapping

这允许使用自定义事件架构进行发布。 可以指定 InputSchemaMapping，将源架构的各种属性映射到 EventGridEvent 架构的各种必需属性。
properties.metricResourceId

string

主题的指标资源 ID。
properties.minimumTlsVersionAllowed

TlsVersion

允许发布到本主题的发布服务器的最低 TLS 版本
properties.privateEndpointConnections

PrivateEndpointConnection[]

专用终结点连接列表。
properties.provisioningState

TopicProvisioningState

主题的预配状态。
properties.publicNetworkAccess

PublicNetworkAccess

Enabled

这决定了是否允许通过公用网络流量。 默认情况下，它处于启用状态。 可以通过配置进一步限制为特定 IP
systemData

systemData

与事件网格资源相关的系统元数据。
tags

object

资源的标记。
type

string

资源的类型。

TopicProvisioningState

Enumeration

主题的预配状态。

值 说明
Canceled
Creating
Deleting
Failed
Succeeded
Updating

TopicUpdateParameters

Object

主题更新的属性

名称 类型 默认值 说明
identity

IdentityInfo

主题资源标识信息。
properties.dataResidencyBoundary

DataResidencyBoundary

主题的数据驻留边界。
properties.disableLocalAuth

boolean

此布尔值用于启用或禁用本地身份验证。默认值为 false。 如果该属性设置为 true，则仅使用 AAD 令牌在允许用户发布到主题时进行身份验证。
properties.eventTypeInfo

EventTypeInfo

主题的 eventTypeInfo。
properties.inboundIpRules

InboundIpRule[]

这可用于限制来自特定 IP 而不是所有 IP 的流量。 注意：仅当启用了 PublicNetworkAccess 时，才会考虑这些内容。
properties.minimumTlsVersionAllowed

TlsVersion

允许发布到此域的发布服务器的最低 TLS 版本
properties.publicNetworkAccess

PublicNetworkAccess

Enabled

这决定了是否允许通过公用网络流量。 默认情况下，它处于启用状态。 可以通过配置进一步限制为特定 IP
tags

object

主题资源的标记。

UserIdentityProperties

Object

有关用户标识的信息。

名称 类型 说明
clientId

string

用户分配标识的客户端 ID。
principalId

string

用户分配标识的主体 ID。