Event Subscriptions - List Global By Subscription For Topic Type

服务:

Event Grid

API 版本:

2022-06-15

列出主题类型的所有全局事件订阅。
列出主题类型 Azure 订阅下的所有全局事件订阅。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventSubscriptions?api-version=2022-06-15

具有可选参数:

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

URI 参数

名称	在	必需	类型	说明
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”函数以及以下逻辑作：not、or， or， eq （for equal）和 ne （对于不相等）。 不支持算术运算。 下面是有效的筛选器示例：$filter=contains（namE、'PATTERN'）和名称 ne 'PATTERN-1'。 下面是无效的筛选器示例：$filter=location eq 'westus'。
$top	query		integer (int32)	要为列表作返回每页的结果数。 顶部参数的有效范围为 1 到 100。 如果未指定，则返回的默认结果数是每页 20 个项目。

响应

名称	类型	说明
200 OK	EventSubscriptionsListResult	还行
Other Status Codes		错误响应： *** 400 错误的请求。 500 内部服务器错误。

示例

EventSubscriptions_ListGlobalBySubscriptionForTopicType

示例请求

HTTP

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/topicTypes/Microsoft.Resources.Subscriptions/eventSubscriptions?api-version=2022-06-15

示例响应

状态代码:

200

{
  "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"
      },
      "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/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 高级筛选器。
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 函数目标的信息。

名称	类型	默认值	说明
endpointType	string: AzureFunction		事件订阅目标的终结点类型。
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]		传递属性详细信息。
properties.maxEventsPerBatch	integer (int32)	1	每个批处理的最大事件数。
properties.preferredBatchSizeInKilobytes	integer (int32)	64	首选批大小（以千字节为单位）。
properties.resourceId	string (arm-id)		表示事件订阅的 Azure Function 目标的终结点的 Azure 资源 ID。

BoolEqualsAdvancedFilter

对象

BoolEquals 高级筛选器。

名称	类型	说明
key	string	要根据要筛选的事件中的字段/属性。
operatorType	string: BoolEquals	用于筛选的运算符类型，例如 NumberIn、StringContains、BoolEquals 等。
value	boolean	布尔筛选器值。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

DeadLetterWithResourceIdentity

对象

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

名称	类型	说明
deadLetterDestination	DeadLetterDestination: StorageBlobDeadLetterDestination	有关事件订阅必须传送事件的目标的信息。 使用父资源（即主题或域）上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。
identity	EventSubscriptionIdentity	死信事件时要使用的标识。

DeliveryWithResourceIdentity

对象

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

名称	类型	说明
destination	EventSubscriptionDestination: AzureFunctionEventSubscriptionDestination EventHubEventSubscriptionDestination HybridConnectionEventSubscriptionDestination ServiceBusQueueEventSubscriptionDestination ServiceBusTopicEventSubscriptionDestination StorageQueueEventSubscriptionDestination WebHookEventSubscriptionDestination	有关事件订阅必须传送事件的目标的信息。 使用 Azure 事件网格的标识获取在传递/死信期间使用的身份验证令牌。
identity	EventSubscriptionIdentity	传送事件时要使用的标识。

DynamicDeliveryAttributeMapping

对象

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

名称	类型	说明
name	string	传递属性或标头的名称。
properties.sourceField	string	包含属性值的事件中的 JSON 路径。
type	string: Dynamic	传递属性或标头名称的类型。

EventDeliverySchema

枚举

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

值	说明
EventGridSchema
CustomInputSchema
CloudEventSchemaV1_0

EventHubEventSubscriptionDestination

对象

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

名称	类型	说明
endpointType	string: EventHub	事件订阅目标的终结点类型。
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	传递属性详细信息。
properties.resourceId	string (arm-id)	表示事件订阅的事件中心目标的终结点的 Azure 资源 ID。

EventSubscription

对象

事件订阅

名称	类型	默认值	说明
id	string		资源的完全限定标识符。
name	string		资源的名称。
properties.deadLetterDestination	DeadLetterDestination: StorageBlobDeadLetterDestination		事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。 使用 Azure 事件网格的标识获取在传递/死信期间使用的身份验证令牌。
properties.deadLetterWithResourceIdentity	DeadLetterWithResourceIdentity		事件订阅的死信目标。 无法传递到其目标的任何事件都将发送到死信目标。 使用父资源（即主题或域）上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。
properties.deliveryWithResourceIdentity	DeliveryWithResourceIdentity		有关事件订阅必须传送事件的目标的信息。 使用父资源（即主题或域）上的托管标识设置来获取在传递/死信期间使用的身份验证令牌。
properties.destination	EventSubscriptionDestination: AzureFunctionEventSubscriptionDestination EventHubEventSubscriptionDestination HybridConnectionEventSubscriptionDestination ServiceBusQueueEventSubscriptionDestination ServiceBusTopicEventSubscriptionDestination StorageQueueEventSubscriptionDestination WebHookEventSubscriptionDestination		有关事件订阅必须传送事件的目标的信息。 使用 Azure 事件网格的标识获取在传递/死信期间使用的身份验证令牌。
properties.eventDeliverySchema	EventDeliverySchema	EventGridSchema	事件订阅的事件传送架构。
properties.expirationTimeUtc	string (date-time)		事件订阅的过期时间。
properties.filter	EventSubscriptionFilter		有关事件订阅筛选器的信息。
properties.labels	string[]		用户定义的标签列表。
properties.provisioningState	EventSubscriptionProvisioningState		事件订阅的预配状态。
properties.retryPolicy	RetryPolicy		事件的重试策略。 这可用于配置事件的最大传递尝试次数和生存时间。
properties.topic	string		事件订阅的主题的名称。
systemData	systemData		与事件订阅资源相关的系统元数据。
type	string		资源的类型。

EventSubscriptionFilter

对象

筛选事件订阅。

名称	类型	默认值	说明
advancedFilters	AdvancedFilter[]: BoolEqualsAdvancedFilter[] IsNotNullAdvancedFilter[] IsNullOrUndefinedAdvancedFilter[] NumberGreaterThanAdvancedFilter[] NumberGreaterThanOrEqualsAdvancedFilter[] NumberInAdvancedFilter[] NumberInRangeAdvancedFilter[] NumberLessThanAdvancedFilter[] NumberLessThanOrEqualsAdvancedFilter[] NumberNotInAdvancedFilter[] NumberNotInRangeAdvancedFilter[] StringBeginsWithAdvancedFilter[] StringContainsAdvancedFilter[] StringEndsWithAdvancedFilter[] StringInAdvancedFilter[] StringNotBeginsWithAdvancedFilter[] StringNotContainsAdvancedFilter[] StringNotEndsWithAdvancedFilter[] StringNotInAdvancedFilter[]		用于筛选事件订阅的高级筛选器数组。
enableAdvancedFilteringOnArrays	boolean		允许针对值数组（而不是期望一个单一值）评估高级筛选器。
includedEventTypes	string[]		需要属于事件订阅的适用事件类型的列表。 如果需要订阅所有默认事件类型，请将 IncludedEventTypes 设置为 null。
isSubjectCaseSensitive	boolean	False	指定是否应以区分大小写的方式比较筛选器的 SubjectBeginsWith 和 SubjectEndsWith 属性。
subjectBeginsWith	string		一个可选字符串，用于根据资源路径前缀筛选事件订阅的事件。 此格式取决于事件的发布者。 此路径不支持通配符。
subjectEndsWith	string		一个可选字符串，用于根据资源路径后缀筛选事件订阅的事件。 此路径不支持通配符。

EventSubscriptionIdentity

对象

事件订阅的标识信息。

名称	类型	说明
type	EventSubscriptionIdentityType	使用的托管标识的类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。
userAssignedIdentity	string	与资源关联的用户标识。

EventSubscriptionIdentityType

枚举

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

值	说明
SystemAssigned
UserAssigned

EventSubscriptionProvisioningState

枚举

事件订阅的预配状态。

值	说明
Creating
Updating
Deleting
Succeeded
Canceled
Failed
AwaitingManualAction

EventSubscriptionsListResult

对象

List EventSubscriptions作的结果

名称	类型	说明
nextLink	string	事件订阅的下一页的链接
value	EventSubscription[]	EventSubscriptions 的集合

HybridConnectionEventSubscriptionDestination

对象

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

名称	类型	说明
endpointType	string: HybridConnection	事件订阅目标的终结点类型。
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	传递属性详细信息。
properties.resourceId	string (arm-id)	作为事件订阅目标的混合连接的 Azure 资源 ID。

IsNotNullAdvancedFilter

对象

IsNotNull 高级筛选器。

名称	类型	说明
key	string	要根据要筛选的事件中的字段/属性。
operatorType	string: IsNotNull	用于筛选的运算符类型，例如 NumberIn、StringContains、BoolEquals 等。

IsNullOrUndefinedAdvancedFilter

对象

IsNullOrUndefined 高级筛选器。

名称	类型	说明
key	string	要根据要筛选的事件中的字段/属性。
operatorType	string: IsNullOrUndefined	用于筛选的运算符类型，例如 NumberIn、StringContains、BoolEquals 等。

NumberGreaterThanAdvancedFilter

对象

NumberGreaterThan 高级筛选器。

名称	类型	说明
key	string	要根据要筛选的事件中的字段/属性。
operatorType	string: NumberGreaterThan	用于筛选的运算符类型，例如 NumberIn、StringContains、BoolEquals 等。
value	number (double)	筛选器值。

NumberGreaterThanOrEqualsAdvancedFilter

对象

NumberGreaterThanOrEquals 高级筛选器。

名称	类型	说明
key	string	要根据要筛选的事件中的字段/属性。
operatorType	string: NumberGreaterThanOrEquals	用于筛选的运算符类型，例如 NumberIn、StringContains、BoolEquals 等。
value	number (double)	筛选器值。

NumberInAdvancedFilter

对象

NumberIn 高级筛选器。

名称	类型	说明
key	string	要根据要筛选的事件中的字段/属性。
operatorType	string: NumberIn	用于筛选的运算符类型，例如 NumberIn、StringContains、BoolEquals 等。
values	number[] (double)	筛选器值集。

NumberInRangeAdvancedFilter

对象

NumberInRange 高级筛选器。

名称	类型	说明
key	string	要根据要筛选的事件中的字段/属性。
operatorType	string: NumberInRange	用于筛选的运算符类型，例如 NumberIn、StringContains、BoolEquals 等。
values	number[] (double)	筛选器值集。

NumberLessThanAdvancedFilter

对象

NumberLessThan 高级筛选器。

名称	类型	说明
key	string	要根据要筛选的事件中的字段/属性。
operatorType	string: NumberLessThan	用于筛选的运算符类型，例如 NumberIn、StringContains、BoolEquals 等。
value	number (double)	筛选器值。

NumberLessThanOrEqualsAdvancedFilter

对象

NumberLessThanOrEquals 高级筛选器。

名称	类型	说明
key	string	要根据要筛选的事件中的字段/属性。
operatorType	string: NumberLessThanOrEquals	用于筛选的运算符类型，例如 NumberIn、StringContains、BoolEquals 等。
value	number (double)	筛选器值。

NumberNotInAdvancedFilter

对象

NumberNotIn 高级筛选器。

名称	类型	说明
key	string	要根据要筛选的事件中的字段/属性。
operatorType	string: NumberNotIn	用于筛选的运算符类型，例如 NumberIn、StringContains、BoolEquals 等。
values	number[] (double)	筛选器值集。

NumberNotInRangeAdvancedFilter

对象

NumberNotInRange 高级筛选器。

名称	类型	说明
key	string	要根据要筛选的事件中的字段/属性。
operatorType	string: NumberNotInRange	用于筛选的运算符类型，例如 NumberIn、StringContains、BoolEquals 等。
values	number[] (double)	筛选器值集。

RetryPolicy

对象

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

名称	类型	默认值	说明
eventTimeToLiveInMinutes	integer (int32)	1440	事件生存时间（以分钟为单位）。
maxDeliveryAttempts	integer (int32)	30	事件的最大传递重试尝试次数。

ServiceBusQueueEventSubscriptionDestination

对象

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

名称	类型	说明
endpointType	string: ServiceBusQueue	事件订阅目标的终结点类型。
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	传递属性详细信息。
properties.resourceId	string (arm-id)	表示事件订阅的服务总线目标的终结点的 Azure 资源 ID。

ServiceBusTopicEventSubscriptionDestination

对象

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

名称	类型	说明
endpointType	string: ServiceBusTopic	事件订阅目标的终结点类型。
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	传递属性详细信息。
properties.resourceId	string (arm-id)	表示事件订阅的服务总线主题目标的终结点的 Azure 资源 ID。

StaticDeliveryAttributeMapping

对象

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

名称	类型	默认值	说明
name	string		传递属性或标头的名称。
properties.isSecret	boolean	False	指示属性是否包含敏感信息的布尔标志。
properties.value	string		传递属性的值。
type	string: Static		传递属性或标头名称的类型。

StorageBlobDeadLetterDestination

对象

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

名称	类型	说明
endpointType	string: StorageBlob	死信目标的终结点类型
properties.blobContainerName	string	存储 Blob 容器的名称，该容器是死信事件的目标
properties.resourceId	string (arm-id)	存储帐户的 Azure 资源 ID，该 ID 是死信事件的目标

StorageQueueEventSubscriptionDestination

对象

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

名称	类型	说明
endpointType	string: StorageQueue	事件订阅目标的终结点类型。
properties.queueMessageTimeToLiveInSeconds	integer (int64)	存储队列消息生存时间（以秒为单位）。
properties.queueName	string	作为事件订阅目标的存储帐户下的存储队列的名称。
properties.resourceId	string (arm-id)	包含作为事件订阅目标的队列的存储帐户的 Azure 资源 ID。

StringBeginsWithAdvancedFilter

对象

StringBeginsWith 高级筛选器。

名称	类型	说明
key	string	要根据要筛选的事件中的字段/属性。
operatorType	string: StringBeginsWith	用于筛选的运算符类型，例如 NumberIn、StringContains、BoolEquals 等。
values	string[]	筛选器值集。

StringContainsAdvancedFilter

对象

StringContains 高级筛选器。

名称	类型	说明
key	string	要根据要筛选的事件中的字段/属性。
operatorType	string: StringContains	用于筛选的运算符类型，例如 NumberIn、StringContains、BoolEquals 等。
values	string[]	筛选器值集。

StringEndsWithAdvancedFilter

对象

StringEndsWith 高级筛选器。

名称	类型	说明
key	string	要根据要筛选的事件中的字段/属性。
operatorType	string: StringEndsWith	用于筛选的运算符类型，例如 NumberIn、StringContains、BoolEquals 等。
values	string[]	筛选器值集。

StringInAdvancedFilter

对象

StringIn 高级筛选器。

名称	类型	说明
key	string	要根据要筛选的事件中的字段/属性。
operatorType	string: StringIn	用于筛选的运算符类型，例如 NumberIn、StringContains、BoolEquals 等。
values	string[]	筛选器值集。

StringNotBeginsWithAdvancedFilter

对象

StringNotBeginsWith 高级筛选器。

名称	类型	说明
key	string	要根据要筛选的事件中的字段/属性。
operatorType	string: StringNotBeginsWith	用于筛选的运算符类型，例如 NumberIn、StringContains、BoolEquals 等。
values	string[]	筛选器值集。

StringNotContainsAdvancedFilter

对象

StringNotContains 高级筛选器。

名称	类型	说明
key	string	要根据要筛选的事件中的字段/属性。
operatorType	string: StringNotContains	用于筛选的运算符类型，例如 NumberIn、StringContains、BoolEquals 等。
values	string[]	筛选器值集。

StringNotEndsWithAdvancedFilter

对象

StringNotEndsWith 高级筛选器。

名称	类型	说明
key	string	要根据要筛选的事件中的字段/属性。
operatorType	string: StringNotEndsWith	用于筛选的运算符类型，例如 NumberIn、StringContains、BoolEquals 等。
values	string[]	筛选器值集。

StringNotInAdvancedFilter

对象

StringNotIn 高级筛选器。

名称	类型	说明
key	string	要根据要筛选的事件中的字段/属性。
operatorType	string: StringNotIn	用于筛选的运算符类型，例如 NumberIn、StringContains、BoolEquals 等。
values	string[]	筛选器值集。

systemData

对象

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

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

WebHookEventSubscriptionDestination

对象

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

名称	类型	默认值	说明
endpointType	string: WebHook		事件订阅目标的终结点类型。
properties.azureActiveDirectoryApplicationIdOrUri	string		用于获取访问令牌的 Azure Active Directory 应用程序 ID 或 URI，该令牌将作为持有者令牌包含在传递请求中。
properties.azureActiveDirectoryTenantId	string		用于获取访问令牌的 Azure Active Directory 租户 ID，该令牌将作为传递请求中的持有者令牌包含在内。
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]		传递属性详细信息。
properties.endpointBaseUrl	string		表示事件订阅目标的终结点的基 URL。
properties.endpointUrl	string		表示事件订阅目标的终结点的 URL。
properties.maxEventsPerBatch	integer (int32)	1	每个批处理的最大事件数。
properties.preferredBatchSizeInKilobytes	integer (int32)	64	首选批大小（以千字节为单位）。