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

Partner Topic Event Subscriptions - Get

获取合作伙伴主题的事件订阅。
获取合作伙伴主题的事件订阅的属性。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerTopics/{partnerTopicName}/eventSubscriptions/{eventSubscriptionName}?api-version=2022-06-15

URI 参数

名称 必需 类型 说明
eventSubscriptionName
path True

string

要找到的事件订阅的名称。 事件订阅名称的长度必须介于 3 到 100 个字符之间,并且仅使用字母数字字母。

partnerTopicName
path True

string

合作伙伴主题的名称。

resourceGroupName
path True

string

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

subscriptionId
path True

string

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

api-version
query True

string

要与客户端请求一起使用的 API 的版本。

响应

名称 类型 说明
200 OK

EventSubscription

确定

Other Status Codes

错误响应: ***

  • 400 错误请求。

  • 500 内部服务器错误。

示例

PartnerTopicEventSubscriptions_Get

示例请求

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1/eventSubscriptions/examplesubscription1?api-version=2022-06-15

示例响应

{
  "properties": {
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1",
    "provisioningState": "Succeeded",
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Storage/storageAccounts/testtrackedsource",
        "queueName": "que"
      },
      "endpointType": "StorageQueue"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix",
      "includedEventTypes": [
        "Microsoft.Storage.BlobCreated",
        "Microsoft.Storage.BlobDeleted"
      ]
    },
    "labels": [
      "label1",
      "label2"
    ],
    "eventDeliverySchema": "EventGridSchema",
    "retryPolicy": {
      "maxDeliveryAttempts": 30,
      "eventTimeToLiveInMinutes": 1440
    }
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerTopics/examplePartnerTopic1/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/partnerTopics/eventSubscriptions"
}

定义

名称 说明
AzureFunctionEventSubscriptionDestination

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

BoolEqualsAdvancedFilter

BoolEquals 高级筛选器。

createdByType

创建资源的标识类型。

DeadLetterWithResourceIdentity

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

DeliveryWithResourceIdentity

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

DynamicDeliveryAttributeMapping

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

EventDeliverySchema

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

EventHubEventSubscriptionDestination

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

EventSubscription

事件订阅

EventSubscriptionFilter

事件订阅的筛选器。

EventSubscriptionIdentity

事件订阅的标识信息。

EventSubscriptionIdentityType

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

EventSubscriptionProvisioningState

事件订阅的预配状态。

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

StringNotBegins 使用高级筛选器。

StringNotContainsAdvancedFilter

StringNotContains 高级筛选器。

StringNotEndsWithAdvancedFilter

StringNotEnds 使用高级筛选器。

StringNotInAdvancedFilter

StringNotIn 高级筛选器。

systemData

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

WebHookEventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestination

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

名称 类型 默认值 说明
endpointType string:

AzureFunction

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

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

传递属性详细信息。

properties.maxEventsPerBatch

integer

1

每个批的最大事件数。

properties.preferredBatchSizeInKilobytes

integer

64

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

properties.resourceId

string

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

BoolEqualsAdvancedFilter

BoolEquals 高级筛选器。

名称 类型 说明
key

string

要基于其进行筛选的事件中的字段/属性。

operatorType string:

BoolEquals

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

value

boolean

布尔筛选器值。

createdByType

创建资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

DeadLetterWithResourceIdentity

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

名称 类型 说明
deadLetterDestination DeadLetterDestination:

StorageBlobDeadLetterDestination

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

identity

EventSubscriptionIdentity

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

DeliveryWithResourceIdentity

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

名称 类型 说明
destination EventSubscriptionDestination:

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

identity

EventSubscriptionIdentity

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

DynamicDeliveryAttributeMapping

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

名称 类型 说明
name

string

传递属性或标头的名称。

properties.sourceField

string

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

type string:

Dynamic

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

EventDeliverySchema

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

名称 类型 说明
CloudEventSchemaV1_0

string

CustomInputSchema

string

EventGridSchema

string

EventHubEventSubscriptionDestination

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

名称 类型 说明
endpointType string:

EventHub

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

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

传递属性详细信息。

properties.resourceId

string

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

EventSubscription

事件订阅

名称 类型 默认值 说明
id

string

资源的完全限定标识符。

name

string

资源的名称。

properties.deadLetterDestination DeadLetterDestination:

StorageBlobDeadLetterDestination

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

properties.deadLetterWithResourceIdentity

DeadLetterWithResourceIdentity

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

properties.deliveryWithResourceIdentity

DeliveryWithResourceIdentity

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

properties.destination EventSubscriptionDestination:

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

properties.eventDeliverySchema

EventDeliverySchema

EventGridSchema

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

properties.expirationTimeUtc

string

事件订阅的过期时间。

properties.filter

EventSubscriptionFilter

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

properties.labels

string[]

用户定义的标签列表。

properties.provisioningState

EventSubscriptionProvisioningState

事件订阅的预配状态。

properties.retryPolicy

RetryPolicy

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

properties.topic

string

事件订阅的主题的名称。

systemData

systemData

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

type

string

资源的类型。

EventSubscriptionFilter

事件订阅的筛选器。

名称 类型 默认值 说明
advancedFilters AdvancedFilter[]:

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

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

string

UserAssigned

string

EventSubscriptionProvisioningState

事件订阅的预配状态。

名称 类型 说明
AwaitingManualAction

string

Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

HybridConnectionEventSubscriptionDestination

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

名称 类型 说明
endpointType string:

HybridConnection

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

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

传递属性详细信息。

properties.resourceId

string

作为事件订阅目标的混合连接的 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

筛选器值。

NumberGreaterThanOrEqualsAdvancedFilter

NumberGreaterThanOrEquals 高级筛选器。

名称 类型 说明
key

string

要基于其进行筛选的事件中的字段/属性。

operatorType string:

NumberGreaterThanOrEquals

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

value

number

筛选器值。

NumberInAdvancedFilter

NumberIn 高级筛选器。

名称 类型 说明
key

string

要基于其进行筛选的事件中的字段/属性。

operatorType string:

NumberIn

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

values

number[]

筛选器值集。

NumberInRangeAdvancedFilter

NumberInRange 高级筛选器。

名称 类型 说明
key

string

要基于其进行筛选的事件中的字段/属性。

operatorType string:

NumberInRange

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

values

number[]

筛选器值集。

NumberLessThanAdvancedFilter

NumberLessThan 高级筛选器。

名称 类型 说明
key

string

要基于其进行筛选的事件中的字段/属性。

operatorType string:

NumberLessThan

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

value

number

筛选器值。

NumberLessThanOrEqualsAdvancedFilter

NumberLessThanOrEquals 高级筛选器。

名称 类型 说明
key

string

要基于其进行筛选的事件中的字段/属性。

operatorType string:

NumberLessThanOrEquals

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

value

number

筛选器值。

NumberNotInAdvancedFilter

NumberNotIn 高级筛选器。

名称 类型 说明
key

string

要基于其进行筛选的事件中的字段/属性。

operatorType string:

NumberNotIn

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

values

number[]

筛选器值集。

NumberNotInRangeAdvancedFilter

NumberNotInRange 高级筛选器。

名称 类型 说明
key

string

要基于其进行筛选的事件中的字段/属性。

operatorType string:

NumberNotInRange

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

values

number[]

筛选器值集。

RetryPolicy

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

名称 类型 默认值 说明
eventTimeToLiveInMinutes

integer

1440

活动) 生存时间 (以分钟为单位。

maxDeliveryAttempts

integer

30

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

ServiceBusQueueEventSubscriptionDestination

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

名称 类型 说明
endpointType string:

ServiceBusQueue

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

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

传递属性详细信息。

properties.resourceId

string

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

ServiceBusTopicEventSubscriptionDestination

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

名称 类型 说明
endpointType string:

ServiceBusTopic

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

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

传递属性详细信息。

properties.resourceId

string

表示事件订阅的服务总线主题目标的终结点的 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

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

StorageQueueEventSubscriptionDestination

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

名称 类型 说明
endpointType string:

StorageQueue

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

properties.queueMessageTimeToLiveInSeconds

integer

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

properties.queueName

string

作为事件订阅目标的存储帐户下的存储队列的名称。

properties.resourceId

string

包含事件订阅目标的队列的存储帐户的 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

StringNotBegins 使用高级筛选器。

名称 类型 说明
key

string

要基于其进行筛选的事件中的字段/属性。

operatorType string:

StringNotBeginsWith

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

values

string[]

筛选器值集。

StringNotContainsAdvancedFilter

StringNotContains 高级筛选器。

名称 类型 说明
key

string

要基于其进行筛选的事件中的字段/属性。

operatorType string:

StringNotContains

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

values

string[]

筛选器值集。

StringNotEndsWithAdvancedFilter

StringNotEnds 使用高级筛选器。

名称 类型 说明
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

资源创建时间戳 (UTC) 。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识类型。

lastModifiedAt

string

资源上次修改的时间戳 (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[]:

传递属性详细信息。

properties.endpointBaseUrl

string

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

properties.endpointUrl

string

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

properties.maxEventsPerBatch

integer

1

每个批的最大事件数。

properties.preferredBatchSizeInKilobytes

integer

64

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