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

System Topic Event Subscriptions - Create Or Update

服务:

Event Grid

API 版本:

2022-06-15

为系统主题创建或更新事件订阅。
使用指定参数异步创建或更新事件订阅。 现有事件订阅将使用此 API 进行更新。

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

URI 参数

名称	在	必需	类型	说明
eventSubscriptionName	path	True	string	要创建的事件订阅的名称。 事件订阅名称的长度必须介于 3 到 100 个字符之间，并且仅使用字母数字字母。
resourceGroupName	path	True	string	用户订阅中的资源组的名称。
subscriptionId	path	True	string	唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。
systemTopicName	path	True	string	系统主题的名称。
api-version	query	True	string	要与客户端请求一起使用的 API 的版本。

请求正文

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

响应

名称	类型	说明
201 Created	EventSubscription	创建
Other Status Codes		错误响应： *** 400 错误请求。 500 内部服务器错误。

示例

SystemTopicEventSubscriptions_CreateOrUpdate

示例请求

HTTP

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1/eventSubscriptions/exampleEventSubscriptionName1?api-version=2022-06-15

{
  "properties": {
    "destination": {
      "endpointType": "WebHook",
      "properties": {
        "endpointUrl": "https://requestb.in/15ksip71"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    }
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.eventgrid.fluent.models.EventSubscriptionInner;
import com.azure.resourcemanager.eventgrid.models.EventSubscriptionFilter;
import com.azure.resourcemanager.eventgrid.models.WebhookEventSubscriptionDestination;

/** Samples for SystemTopicEventSubscriptions CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_CreateOrUpdate.json
     */
    /**
     * Sample code: SystemTopicEventSubscriptions_CreateOrUpdate.
     *
     * @param manager Entry point to EventGridManager.
     */
    public static void systemTopicEventSubscriptionsCreateOrUpdate(
        com.azure.resourcemanager.eventgrid.EventGridManager manager) {
        manager
            .systemTopicEventSubscriptions()
            .createOrUpdate(
                "examplerg",
                "exampleSystemTopic1",
                "exampleEventSubscriptionName1",
                new EventSubscriptionInner()
                    .withDestination(
                        new WebhookEventSubscriptionDestination().withEndpointUrl("https://requestb.in/15ksip71"))
                    .withFilter(
                        new EventSubscriptionFilter()
                            .withSubjectBeginsWith("ExamplePrefix")
                            .withSubjectEndsWith("ExampleSuffix")
                            .withIsSubjectCaseSensitive(false)),
                Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.eventgrid import EventGridManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-eventgrid
# USAGE
    python system_topic_event_subscriptions_create_or_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = EventGridManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
    )

    response = client.system_topic_event_subscriptions.begin_create_or_update(
        resource_group_name="examplerg",
        system_topic_name="exampleSystemTopic1",
        event_subscription_name="exampleEventSubscriptionName1",
        event_subscription_info={
            "properties": {
                "destination": {
                    "endpointType": "WebHook",
                    "properties": {"endpointUrl": "https://requestb.in/15ksip71"},
                },
                "filter": {
                    "isSubjectCaseSensitive": False,
                    "subjectBeginsWith": "ExamplePrefix",
                    "subjectEndsWith": "ExampleSuffix",
                },
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_CreateOrUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armeventgrid_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_CreateOrUpdate.json
func ExampleSystemTopicEventSubscriptionsClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSystemTopicEventSubscriptionsClient().BeginCreateOrUpdate(ctx, "examplerg", "exampleSystemTopic1", "exampleEventSubscriptionName1", armeventgrid.EventSubscription{
		Properties: &armeventgrid.EventSubscriptionProperties{
			Destination: &armeventgrid.WebHookEventSubscriptionDestination{
				EndpointType: to.Ptr(armeventgrid.EndpointTypeWebHook),
				Properties: &armeventgrid.WebHookEventSubscriptionDestinationProperties{
					EndpointURL: to.Ptr("https://requestb.in/15ksip71"),
				},
			},
			Filter: &armeventgrid.EventSubscriptionFilter{
				IsSubjectCaseSensitive: to.Ptr(false),
				SubjectBeginsWith:      to.Ptr("ExamplePrefix"),
				SubjectEndsWith:        to.Ptr("ExampleSuffix"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { EventGridManagementClient } = require("@azure/arm-eventgrid");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Asynchronously creates or updates an event subscription with the specified parameters. Existing event subscriptions will be updated with this API.
 *
 * @summary Asynchronously creates or updates an event subscription with the specified parameters. Existing event subscriptions will be updated with this API.
 * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_CreateOrUpdate.json
 */
async function systemTopicEventSubscriptionsCreateOrUpdate() {
  const subscriptionId =
    process.env["EVENTGRID_SUBSCRIPTION_ID"] || "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
  const resourceGroupName = process.env["EVENTGRID_RESOURCE_GROUP"] || "examplerg";
  const systemTopicName = "exampleSystemTopic1";
  const eventSubscriptionName = "exampleEventSubscriptionName1";
  const eventSubscriptionInfo = {
    destination: {
      endpointType: "WebHook",
      endpointUrl: "https://requestb.in/15ksip71",
    },
    filter: {
      isSubjectCaseSensitive: false,
      subjectBeginsWith: "ExamplePrefix",
      subjectEndsWith: "ExampleSuffix",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new EventGridManagementClient(credential, subscriptionId);
  const result = await client.systemTopicEventSubscriptions.beginCreateOrUpdateAndWait(
    resourceGroupName,
    systemTopicName,
    eventSubscriptionName,
    eventSubscriptionInfo
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.EventGrid;
using Azure.ResourceManager.EventGrid.Models;

// Generated from example definition: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/SystemTopicEventSubscriptions_CreateOrUpdate.json
// this example is just showing the usage of "SystemTopicEventSubscriptions_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SystemTopicResource created on azure
// for more information of creating SystemTopicResource, please refer to the document of SystemTopicResource
string subscriptionId = "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
string resourceGroupName = "examplerg";
string systemTopicName = "exampleSystemTopic1";
ResourceIdentifier systemTopicResourceId = SystemTopicResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, systemTopicName);
SystemTopicResource systemTopic = client.GetSystemTopicResource(systemTopicResourceId);

// get the collection of this SystemTopicEventSubscriptionResource
SystemTopicEventSubscriptionCollection collection = systemTopic.GetSystemTopicEventSubscriptions();

// invoke the operation
string eventSubscriptionName = "exampleEventSubscriptionName1";
EventGridSubscriptionData data = new EventGridSubscriptionData()
{
    Destination = new WebHookEventSubscriptionDestination()
    {
        Endpoint = new Uri("https://requestb.in/15ksip71"),
    },
    Filter = new EventSubscriptionFilter()
    {
        SubjectBeginsWith = "ExamplePrefix",
        SubjectEndsWith = "ExampleSuffix",
        IsSubjectCaseSensitive = false,
    },
};
ArmOperation<SystemTopicEventSubscriptionResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, eventSubscriptionName, data);
SystemTopicEventSubscriptionResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
EventGridSubscriptionData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:

201

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "labels": null,
    "eventDeliverySchema": "EventGridSchema",
    "retryPolicy": {
      "maxDeliveryAttempts": 30,
      "eventTimeToLiveInMinutes": 1440
    },
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/systemTopics/exampleSystemTopic1/eventSubscriptions/exampleEventSubscriptionName1",
  "name": "exampleEventSubscriptionName1",
  "type": "Microsoft.EventGrid/systemTopics/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	StringNotBeginsWith 高级筛选器。
StringNotContainsAdvancedFilter	StringNotContains 高级筛选器。
StringNotEndsWithAdvancedFilter	StringNotEndsWith 高级筛选器。
StringNotInAdvancedFilter	StringNotIn 高级筛选器。
systemData	与资源的创建和上次修改相关的元数据。
WebHookEventSubscriptionDestination	有关事件订阅的 Webhook 目标的信息。

AzureFunctionEventSubscriptionDestination

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

名称	类型	默认值	说明
endpointType	string: AzureFunction		事件订阅目标的终结点的类型。
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]		传递属性详细信息。
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: AzureFunctionEventSubscriptionDestination EventHubEventSubscriptionDestination HybridConnectionEventSubscriptionDestination ServiceBusQueueEventSubscriptionDestination ServiceBusTopicEventSubscriptionDestination StorageQueueEventSubscriptionDestination WebHookEventSubscriptionDestination	有关必须为事件订阅传递事件的目标的信息。 使用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[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	传递属性详细信息。
properties.resourceId	string	表示事件订阅的事件中心目标的终结点的 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		事件订阅的过期时间。
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	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[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	传递属性详细信息。
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[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	传递属性详细信息。
properties.resourceId	string	表示事件订阅的服务总线目标的终结点的 Azure 资源 ID。

ServiceBusTopicEventSubscriptionDestination

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

名称	类型	说明
endpointType	string: ServiceBusTopic	事件订阅目标的终结点的类型。
properties.deliveryAttributeMappings	DeliveryAttributeMapping[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]	传递属性详细信息。
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

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	资源创建时间戳 (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[]: DynamicDeliveryAttributeMapping[] StaticDeliveryAttributeMapping[]		传递属性详细信息。
properties.endpointBaseUrl	string		表示事件订阅目标终结点的基 URL。
properties.endpointUrl	string		表示事件订阅目标终结点的 URL。
properties.maxEventsPerBatch	integer	1	每个批的最大事件数。
properties.preferredBatchSizeInKilobytes	integer	64	首选批大小（以千字节为单位）。