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

Event Subscriptions - List Global By Resource Group For Topic Type

列出主题类型的资源组下的所有全局事件订阅。
列出特定主题类型的资源组下的所有全局事件订阅。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventSubscriptions?api-version=2021-10-15-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventSubscriptions?api-version=2021-10-15-preview&$filter={$filter}&$top={$top}

URI 参数

Name In Required Type Description
resourceGroupName
path True
  • string

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

subscriptionId
path True
  • string

唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

topicTypeName
path True
  • string

主题类型的名称。

api-version
query True
  • string

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

$filter
query
  • string

用于使用 OData 语法筛选搜索结果的查询。 仅允许对“name”属性进行筛选,并且 OData 操作数有限。 这些操作包括:“contains”函数以及以下逻辑操作:不,或者 eq (等于) ,对于不等于) ,则为 ne (。 不支持算术运算。 下面是一个有效的筛选器示例:$filter=包含 (namE、“PATTERN”) 和名称 ne “PATTERN-1”。 下面是无效的筛选器示例:$filter=location eq 'westus'。

$top
query
  • integer
int32

要为列表操作返回每页的结果数。 顶部参数的有效范围为 1 到 100。 如果未指定,则返回的默认结果数是每页 20 个项目。

响应

Name Type Description
200 OK

OK

Other Status Codes

错误响应: ***

  • 400 错误请求。

  • 500 内部服务器错误。

示例

EventSubscriptions_ListGlobalByResourceGroupForTopicType

Sample Request

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topicTypes/Microsoft.Resources.ResourceGroups/eventSubscriptions?api-version=2021-10-15-preview

Sample Response

{
  "value": [
    {
      "properties": {
        "destination": {
          "properties": {
            "endpointBaseUrl": "https://requestb.in/15ksip71"
          },
          "endpointType": "WebHook"
        },
        "filter": {
          "isSubjectCaseSensitive": false,
          "subjectBeginsWith": "ExamplePrefix",
          "subjectEndsWith": "ExampleSuffix"
        },
        "labels": [
          "Finance",
          "HR"
        ],
        "provisioningState": "Succeeded",
        "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"
      },
      "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3",
      "name": "examplesubscription3",
      "type": "Microsoft.EventGrid/eventSubscriptions"
    }
  ]
}

定义

AzureFunctionEventSubscriptionDestination

有关事件订阅的 azure 函数目标的信息。

BoolEqualsAdvancedFilter

BoolEquals 高级筛选器。

createdByType

创建资源的标识的类型。

DeadLetterWithResourceIdentity

有关具有资源标识的死机目标的信息。

DeliveryWithResourceIdentity

有关使用资源标识的事件订阅传递的信息。

DynamicDeliveryAttributeMapping

动态传递属性映射详细信息。

EventDeliverySchema

事件订阅的事件传送架构。

EventHubEventSubscriptionDestination

有关事件订阅的事件中心目标的信息。

EventSubscription

事件订阅

EventSubscriptionFilter

事件订阅的筛选器。

EventSubscriptionIdentity

事件订阅的标识信息。

EventSubscriptionIdentityType

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

EventSubscriptionProvisioningState

事件订阅的预配状态。

EventSubscriptionsListResult

List EventSubscriptions 操作的结果

HybridConnectionEventSubscriptionDestination

有关事件订阅的 HybridConnection 目标的信息。

IsNotNullAdvancedFilter

IsNotNull 高级筛选器。

IsNullOrUndefinedAdvancedFilter

IsNullOrUndefined 高级筛选器。

NumberGreaterThanAdvancedFilter

NumberGreaterThan 高级筛选器。

NumberGreaterThanOrEqualsAdvancedFilter

NumberGreaterThanOrEquals 高级筛选器。

NumberInAdvancedFilter

NumberIn 高级筛选器。

NumberInRangeAdvancedFilter

NumberInRange 高级筛选器。

NumberLessThanAdvancedFilter

NumberLessThan 高级筛选器。

NumberLessThanOrEqualsAdvancedFilter

NumberLessThanOrEquals 高级筛选器。

NumberNotInAdvancedFilter

NumberNotIn 高级筛选器。

NumberNotInRangeAdvancedFilter

NumberNotInRange 高级筛选器。

PartnerEventSubscriptionDestination
RetryPolicy

有关事件订阅的重试策略的信息。

ServiceBusQueueEventSubscriptionDestination

有关事件订阅的服务总线目标的信息。

ServiceBusTopicEventSubscriptionDestination

有关事件订阅的服务总线主题目标的信息。

StaticDeliveryAttributeMapping

静态传递属性映射详细信息。

StorageBlobDeadLetterDestination

有关基于存储 Blob 的死信目标的信息。

StorageQueueEventSubscriptionDestination

有关事件订阅的存储队列目标的信息。

StringBeginsWithAdvancedFilter

StringBeginsWith 高级筛选器。

StringContainsAdvancedFilter

StringContains 高级筛选器。

StringEndsWithAdvancedFilter

StringEndsWith 高级筛选器。

StringInAdvancedFilter

StringIn 高级筛选器。

StringNotBeginsWithAdvancedFilter

StringNotBeginsWith 高级筛选器。

StringNotContainsAdvancedFilter

StringNotContains 高级筛选器。

StringNotEndsWithAdvancedFilter

StringNotEndsWith 高级筛选器。

StringNotInAdvancedFilter

StringNotIn 高级筛选器。

systemData

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

WebHookEventSubscriptionDestination

有关事件订阅的 Webhook 目标的信息。

AzureFunctionEventSubscriptionDestination

有关事件订阅的 azure 函数目标的信息。

Name Type Default Value Description
endpointType string:
  • AzureFunction

事件订阅目标的终结点的类型。

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

传递属性详细信息。

properties.maxEventsPerBatch
  • integer
1

每个批处理的最大事件数。

properties.preferredBatchSizeInKilobytes
  • integer
64

首选批大小(以千字节为单位)。

properties.resourceId
  • string

表示事件订阅的 Azure 函数目标的终结点的 Azure 资源 ID。

BoolEqualsAdvancedFilter

BoolEquals 高级筛选器。

Name Type Description
key
  • string

要筛选的事件中的字段/属性。

operatorType string:
  • BoolEquals

用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。

value
  • boolean

布尔筛选器值。

createdByType

创建资源的标识的类型。

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

DeadLetterWithResourceIdentity

有关具有资源标识的死机目标的信息。

Name Type Description
deadLetterDestination DeadLetterDestination:

有关事件订阅必须传递事件的目标信息。 使用父 (资源(即主题或域) )上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。

identity

死信事件时要使用的标识。

DeliveryWithResourceIdentity

有关使用资源标识的事件订阅传递的信息。

Name Type Description
destination EventSubscriptionDestination:

有关事件订阅必须传递事件的目标信息。 使用Azure 事件网格的标识来获取在传递/死信期间使用的身份验证令牌。

identity

传递事件时要使用的标识。

DynamicDeliveryAttributeMapping

动态传递属性映射详细信息。

Name Type Description
name
  • string

传递属性或标头的名称。

properties.sourceField
  • string

包含属性值的事件中的 JSON 路径。

type string:
  • Dynamic

传递属性或标头名称的类型。

EventDeliverySchema

事件订阅的事件传送架构。

Name Type Description
CloudEventSchemaV1_0
  • string
CustomInputSchema
  • string
EventGridSchema
  • string

EventHubEventSubscriptionDestination

有关事件订阅的事件中心目标的信息。

Name Type Description
endpointType string:
  • EventHub

事件订阅目标的终结点的类型。

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

传递属性详细信息。

properties.resourceId
  • string

表示事件订阅事件中心目标的终结点的 Azure 资源 ID。

EventSubscription

事件订阅

Name Type Default Value Description
id
  • string

资源的完全限定标识符。

name
  • string

资源的名称。

properties.deadLetterDestination DeadLetterDestination:

事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。 使用Azure 事件网格的标识来获取在传递/死信期间使用的身份验证令牌。

properties.deadLetterWithResourceIdentity

事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。 使用父 (资源(即主题或域) )上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。

properties.deliveryWithResourceIdentity

有关事件订阅必须传递事件的目标信息。 使用父 (资源(即主题或域) )上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。

properties.destination EventSubscriptionDestination:

有关事件订阅必须传递事件的目标信息。 使用Azure 事件网格的标识来获取在传递/死信期间使用的身份验证令牌。

properties.eventDeliverySchema EventGridSchema

事件订阅的事件传送架构。

properties.expirationTimeUtc
  • string

事件订阅的过期时间。

properties.filter

有关事件订阅筛选器的信息。

properties.labels
  • string[]

用户定义的标签列表。

properties.provisioningState

事件订阅的预配状态。

properties.retryPolicy

事件的重试策略。 这可用于配置事件的最大传递尝试次数和生存时间。

properties.topic
  • string

事件订阅的主题的名称。

systemData

与事件订阅资源相关的系统元数据。

type
  • string

资源的类型。

EventSubscriptionFilter

事件订阅的筛选器。

Name Type Default Value Description
advancedFilters AdvancedFilter[]:

用于筛选事件订阅的高级筛选器数组。

enableAdvancedFilteringOnArrays
  • boolean

允许针对值数组(而不是期望单一值)评估高级筛选器。

includedEventTypes
  • string[]

需要属于事件订阅的适用事件类型的列表。 如果需要订阅所有默认事件类型,请将 IncludedEventTypes 设置为 null。

isSubjectCaseSensitive
  • boolean
False

指定是否应以区分大小写的方式比较筛选器的 SubjectBeginsWith 和 SubjectEndsWith 属性。

subjectBeginsWith
  • string

一个可选字符串,用于根据资源路径前缀筛选事件订阅的事件。 其格式取决于事件的发布者。 此路径不支持通配符。

subjectEndsWith
  • string

一个可选字符串,用于根据资源路径后缀筛选事件订阅的事件。 此路径不支持通配符。

EventSubscriptionIdentity

事件订阅的标识信息。

Name Type Description
type

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

userAssignedIdentity
  • string

与资源关联的用户标识。

EventSubscriptionIdentityType

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

Name Type Description
SystemAssigned
  • string
UserAssigned
  • string

EventSubscriptionProvisioningState

事件订阅的预配状态。

Name Type Description
AwaitingManualAction
  • string
Canceled
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

EventSubscriptionsListResult

List EventSubscriptions 操作的结果

Name Type Description
nextLink
  • string

事件订阅下一页的链接

value

EventSubscriptions 的集合

HybridConnectionEventSubscriptionDestination

有关事件订阅的 HybridConnection 目标的信息。

Name Type Description
endpointType string:
  • HybridConnection

事件订阅目标的终结点的类型。

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

传递属性详细信息。

properties.resourceId
  • string

混合连接的 Azure 资源 ID,该 ID 是事件订阅的目标。

IsNotNullAdvancedFilter

IsNotNull 高级筛选器。

Name Type Description
key
  • string

要筛选的事件中的字段/属性。

operatorType string:
  • IsNotNull

用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。

IsNullOrUndefinedAdvancedFilter

IsNullOrUndefined 高级筛选器。

Name Type Description
key
  • string

要筛选的事件中的字段/属性。

operatorType string:
  • IsNullOrUndefined

用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。

NumberGreaterThanAdvancedFilter

NumberGreaterThan 高级筛选器。

Name Type Description
key
  • string

要筛选的事件中的字段/属性。

operatorType string:
  • NumberGreaterThan

用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。

value
  • number

筛选器值。

NumberGreaterThanOrEqualsAdvancedFilter

NumberGreaterThanOrEquals 高级筛选器。

Name Type Description
key
  • string

要筛选的事件中的字段/属性。

operatorType string:
  • NumberGreaterThanOrEquals

用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。

value
  • number

筛选器值。

NumberInAdvancedFilter

NumberIn 高级筛选器。

Name Type Description
key
  • string

要筛选的事件中的字段/属性。

operatorType string:
  • NumberIn

用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。

values
  • number[]

筛选器值集。

NumberInRangeAdvancedFilter

NumberInRange 高级筛选器。

Name Type Description
key
  • string

要筛选的事件中的字段/属性。

operatorType string:
  • NumberInRange

用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。

values
  • array[]

筛选器值集。

NumberLessThanAdvancedFilter

NumberLessThan 高级筛选器。

Name Type Description
key
  • string

要筛选的事件中的字段/属性。

operatorType string:
  • NumberLessThan

用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。

value
  • number

筛选器值。

NumberLessThanOrEqualsAdvancedFilter

NumberLessThanOrEquals 高级筛选器。

Name Type Description
key
  • string

要筛选的事件中的字段/属性。

operatorType string:
  • NumberLessThanOrEquals

用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。

value
  • number

筛选器值。

NumberNotInAdvancedFilter

NumberNotIn 高级筛选器。

Name Type Description
key
  • string

要筛选的事件中的字段/属性。

operatorType string:
  • NumberNotIn

用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。

values
  • number[]

筛选器值集。

NumberNotInRangeAdvancedFilter

NumberNotInRange 高级筛选器。

Name Type Description
key
  • string

要筛选的事件中的字段/属性。

operatorType string:
  • NumberNotInRange

用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。

values
  • array[]

筛选器值集。

PartnerEventSubscriptionDestination

Name Type Description
endpointType string:
  • PartnerDestination

事件订阅目标的终结点的类型。

properties.resourceId
  • string

表示事件订阅合作伙伴目标的终结点的 Azure 资源 ID。

RetryPolicy

有关事件订阅的重试策略的信息。

Name Type Default Value Description
eventTimeToLiveInMinutes
  • integer
1440

事件) 分钟 (生存时间。

maxDeliveryAttempts
  • integer
30

事件的最大传递重试次数。

ServiceBusQueueEventSubscriptionDestination

有关事件订阅的服务总线目标的信息。

Name Type Description
endpointType string:
  • ServiceBusQueue

事件订阅目标的终结点的类型。

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

传递属性详细信息。

properties.resourceId
  • string

表示事件订阅的服务总线目标的终结点的 Azure 资源 ID。

ServiceBusTopicEventSubscriptionDestination

有关事件订阅的服务总线主题目标的信息。

Name Type Description
endpointType string:
  • ServiceBusTopic

事件订阅目标的终结点的类型。

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

传递属性详细信息。

properties.resourceId
  • string

表示事件订阅的服务总线主题目标的终结点的 Azure 资源 ID。

StaticDeliveryAttributeMapping

静态传递属性映射详细信息。

Name Type Default Value Description
name
  • string

传递属性或标头的名称。

properties.isSecret
  • boolean
False

指示属性是否包含敏感信息的布尔标志。

properties.value
  • string

传递属性的值。

type string:
  • Static

传递属性或标头名称的类型。

StorageBlobDeadLetterDestination

有关基于存储 Blob 的死信目标的信息。

Name Type Description
endpointType string:
  • StorageBlob

死信目标的终结点的类型

properties.blobContainerName
  • string

存储 Blob 容器的名称,该容器是死信事件的目标

properties.resourceId
  • string

存储帐户的 Azure 资源 ID,它是死信事件的目标

StorageQueueEventSubscriptionDestination

有关事件订阅的存储队列目标的信息。

Name Type Description
endpointType string:
  • StorageQueue

事件订阅目标的终结点的类型。

properties.queueMessageTimeToLiveInSeconds
  • integer

存储队列消息生存时间(以秒为单位)。

properties.queueName
  • string

存储帐户下存储队列的名称,该存储帐户是事件订阅的目标。

properties.resourceId
  • string

包含事件订阅目标的队列的存储帐户的 Azure 资源 ID。

StringBeginsWithAdvancedFilter

StringBeginsWith 高级筛选器。

Name Type Description
key
  • string

要筛选的事件中的字段/属性。

operatorType string:
  • StringBeginsWith

用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。

values
  • string[]

筛选器值集。

StringContainsAdvancedFilter

StringContains 高级筛选器。

Name Type Description
key
  • string

要筛选的事件中的字段/属性。

operatorType string:
  • StringContains

用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。

values
  • string[]

筛选器值集。

StringEndsWithAdvancedFilter

StringEndsWith 高级筛选器。

Name Type Description
key
  • string

要筛选的事件中的字段/属性。

operatorType string:
  • StringEndsWith

用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。

values
  • string[]

筛选器值集。

StringInAdvancedFilter

StringIn 高级筛选器。

Name Type Description
key
  • string

要筛选的事件中的字段/属性。

operatorType string:
  • StringIn

用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。

values
  • string[]

筛选器值集。

StringNotBeginsWithAdvancedFilter

StringNotBeginsWith 高级筛选器。

Name Type Description
key
  • string

要筛选的事件中的字段/属性。

operatorType string:
  • StringNotBeginsWith

用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。

values
  • string[]

筛选器值集。

StringNotContainsAdvancedFilter

StringNotContains 高级筛选器。

Name Type Description
key
  • string

要筛选的事件中的字段/属性。

operatorType string:
  • StringNotContains

用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。

values
  • string[]

筛选器值集。

StringNotEndsWithAdvancedFilter

StringNotEndsWith 高级筛选器。

Name Type Description
key
  • string

要筛选的事件中的字段/属性。

operatorType string:
  • StringNotEndsWith

用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。

values
  • string[]

筛选器值集。

StringNotInAdvancedFilter

StringNotIn 高级筛选器。

Name Type Description
key
  • string

要筛选的事件中的字段/属性。

operatorType string:
  • StringNotIn

用于筛选的运算符类型,例如 NumberIn、StringContains、BoolEquals 等。

values
  • string[]

筛选器值集。

systemData

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

Name Type Description
createdAt
  • string

资源创建时间戳 (UTC) 。

createdBy
  • string

创建资源的标识。

createdByType

创建资源的标识的类型。

lastModifiedAt
  • string

资源上次修改的时间戳 (UTC)

lastModifiedBy
  • string

上次修改资源的标识。

lastModifiedByType

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

WebHookEventSubscriptionDestination

有关事件订阅的 Webhook 目标的信息。

Name Type Default Value Description
endpointType string:
  • WebHook

事件订阅目标的终结点的类型。

properties.azureActiveDirectoryApplicationIdOrUri
  • string

用于获取作为传递请求中的持有者令牌包含的访问令牌的 Azure Active Directory 应用程序 ID 或 URI。

properties.azureActiveDirectoryTenantId
  • string

用于获取将作为传递请求中的持有者令牌包含的访问令牌的 Azure Active Directory 租户 ID。

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

传递属性详细信息。

properties.endpointBaseUrl
  • string

表示事件订阅目标的终结点的基本 URL。

properties.endpointUrl
  • string

表示事件订阅目标的终结点的 URL。

properties.maxEventsPerBatch
  • integer
1

每个批处理的最大事件数。

properties.preferredBatchSizeInKilobytes
  • integer
64

首选批大小(以千字节为单位)。