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

EventSubscriptions interface

包:: @azure/arm-eventgrid

表示 EventSubscriptions 的接口。

方法

beginCreateOrUpdate(string, string, EventSubscription, EventSubscriptionsCreateOrUpdateOptionalParams)	异步创建一个新的事件订阅，或根据指定的范围更新现有事件订阅。
beginCreateOrUpdateAndWait(string, string, EventSubscription, EventSubscriptionsCreateOrUpdateOptionalParams)	异步创建一个新的事件订阅，或根据指定的范围更新现有事件订阅。
beginDelete(string, string, EventSubscriptionsDeleteOptionalParams)	删除现有事件订阅。
beginDeleteAndWait(string, string, EventSubscriptionsDeleteOptionalParams)	删除现有事件订阅。
beginUpdate(string, string, EventSubscriptionUpdateParameters, EventSubscriptionsUpdateOptionalParams)	异步更新现有事件订阅。
beginUpdateAndWait(string, string, EventSubscriptionUpdateParameters, EventSubscriptionsUpdateOptionalParams)	异步更新现有事件订阅。
get(string, string, EventSubscriptionsGetOptionalParams)	获取事件订阅的属性。
getDeliveryAttributes(string, string, EventSubscriptionsGetDeliveryAttributesOptionalParams)	获取事件订阅的所有传递属性。
getFullUrl(string, string, EventSubscriptionsGetFullUrlOptionalParams)	获取事件订阅的完整终结点 URL。
listByDomainTopic(string, string, string, EventSubscriptionsListByDomainTopicOptionalParams)	列出为特定域主题创建的所有事件订阅。
listByResource(string, string, string, string, EventSubscriptionsListByResourceOptionalParams)	列出已为特定资源创建的所有事件订阅。
listGlobalByResourceGroup(string, EventSubscriptionsListGlobalByResourceGroupOptionalParams)	列出特定 Azure 订阅和资源组下的所有全局事件订阅。
listGlobalByResourceGroupForTopicType(string, string, EventSubscriptionsListGlobalByResourceGroupForTopicTypeOptionalParams)	列出特定主题类型的资源组下的所有全局事件订阅。
listGlobalBySubscription(EventSubscriptionsListGlobalBySubscriptionOptionalParams)	列出特定 Azure 订阅下的所有聚合全局事件订阅。
listGlobalBySubscriptionForTopicType(string, EventSubscriptionsListGlobalBySubscriptionForTopicTypeOptionalParams)	列出主题类型 Azure 订阅下的所有全局事件订阅。
listRegionalByResourceGroup(string, string, EventSubscriptionsListRegionalByResourceGroupOptionalParams)	列出特定 Azure 订阅和资源组下给定位置的所有事件订阅。
listRegionalByResourceGroupForTopicType(string, string, string, EventSubscriptionsListRegionalByResourceGroupForTopicTypeOptionalParams)	列出特定 Azure 订阅和资源组和主题类型下给定位置的所有事件订阅。
listRegionalBySubscription(string, EventSubscriptionsListRegionalBySubscriptionOptionalParams)	列出特定 Azure 订阅下给定位置的所有事件订阅。
listRegionalBySubscriptionForTopicType(string, string, EventSubscriptionsListRegionalBySubscriptionForTopicTypeOptionalParams)	列出特定 Azure 订阅和主题类型下给定位置的所有事件订阅。

方法详细信息

beginCreateOrUpdate(string, string, EventSubscription, EventSubscriptionsCreateOrUpdateOptionalParams)

异步创建一个新的事件订阅，或根据指定的范围更新现有事件订阅。

function beginCreateOrUpdate(scope: string, eventSubscriptionName: string, eventSubscriptionInfo: EventSubscription, options?: EventSubscriptionsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<EventSubscription>, EventSubscription>>

参数

scope: string

需要创建或更新事件订阅的资源的标识符。范围可以是订阅、资源组或属于资源提供程序命名空间的顶级资源，也可以是 EventGrid 主题。例如，对订阅使用“/subscriptions/{subscriptionId}/”，对资源组使用“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}”，和 “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”，以及 EventGrid 主题的“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}”。

eventSubscriptionName: string

要创建的事件订阅的名称。事件订阅名称的长度必须介于 3 到 64 个字符之间，并且只应使用字母数字字母。

eventSubscriptionInfo: EventSubscription

包含目标和筛选器信息的事件订阅属性。

options: EventSubscriptionsCreateOrUpdateOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<EventSubscription>, EventSubscription>>

beginCreateOrUpdateAndWait(string, string, EventSubscription, EventSubscriptionsCreateOrUpdateOptionalParams)

异步创建一个新的事件订阅，或根据指定的范围更新现有事件订阅。

function beginCreateOrUpdateAndWait(scope: string, eventSubscriptionName: string, eventSubscriptionInfo: EventSubscription, options?: EventSubscriptionsCreateOrUpdateOptionalParams): Promise<EventSubscription>

参数

scope: string

eventSubscriptionName: string

要创建的事件订阅的名称。事件订阅名称的长度必须介于 3 到 64 个字符之间，并且只应使用字母数字字母。

eventSubscriptionInfo: EventSubscription

包含目标和筛选器信息的事件订阅属性。

options: EventSubscriptionsCreateOrUpdateOptionalParams

选项参数。

Promise<EventSubscription>

beginDelete(string, string, EventSubscriptionsDeleteOptionalParams)

删除现有事件订阅。

function beginDelete(scope: string, eventSubscriptionName: string, options?: EventSubscriptionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

参数

scope: string

事件订阅的范围。范围可以是订阅、资源组或属于资源提供程序命名空间的顶级资源，也可以是 EventGrid 主题。例如，对订阅使用“/subscriptions/{subscriptionId}/”，对资源组使用“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}”，和 “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”，以及 EventGrid 主题的“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}”。

eventSubscriptionName: string

要删除的事件订阅的名称。

options: EventSubscriptionsDeleteOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, EventSubscriptionsDeleteOptionalParams)

删除现有事件订阅。

function beginDeleteAndWait(scope: string, eventSubscriptionName: string, options?: EventSubscriptionsDeleteOptionalParams): Promise<void>

参数

scope: string

eventSubscriptionName: string

要删除的事件订阅的名称。

options: EventSubscriptionsDeleteOptionalParams

选项参数。

Promise<void>

beginUpdate(string, string, EventSubscriptionUpdateParameters, EventSubscriptionsUpdateOptionalParams)

异步更新现有事件订阅。

function beginUpdate(scope: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters, options?: EventSubscriptionsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<EventSubscription>, EventSubscription>>

参数

scope: string

现有事件订阅的范围。范围可以是订阅、资源组或属于资源提供程序命名空间的顶级资源，也可以是 EventGrid 主题。例如，对订阅使用“/subscriptions/{subscriptionId}/”，对资源组使用“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}”，和 “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”，以及 EventGrid 主题的“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}”。

eventSubscriptionName: string

要更新的事件订阅的名称。

eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters

更新了事件订阅信息。

options: EventSubscriptionsUpdateOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<EventSubscription>, EventSubscription>>

beginUpdateAndWait(string, string, EventSubscriptionUpdateParameters, EventSubscriptionsUpdateOptionalParams)

异步更新现有事件订阅。

function beginUpdateAndWait(scope: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters, options?: EventSubscriptionsUpdateOptionalParams): Promise<EventSubscription>

参数

scope: string

eventSubscriptionName: string

要更新的事件订阅的名称。

eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters

更新了事件订阅信息。

options: EventSubscriptionsUpdateOptionalParams

选项参数。

Promise<EventSubscription>

get(string, string, EventSubscriptionsGetOptionalParams)

获取事件订阅的属性。

function get(scope: string, eventSubscriptionName: string, options?: EventSubscriptionsGetOptionalParams): Promise<EventSubscription>

参数

scope: string

eventSubscriptionName: string

要找到的事件订阅的名称。

options: EventSubscriptionsGetOptionalParams

选项参数。

Promise<EventSubscription>

getDeliveryAttributes(string, string, EventSubscriptionsGetDeliveryAttributesOptionalParams)

获取事件订阅的所有传递属性。

function getDeliveryAttributes(scope: string, eventSubscriptionName: string, options?: EventSubscriptionsGetDeliveryAttributesOptionalParams): Promise<DeliveryAttributeListResult>

参数

scope: string

eventSubscriptionName: string

事件订阅的名称。

options: EventSubscriptionsGetDeliveryAttributesOptionalParams

选项参数。

Promise<DeliveryAttributeListResult>

getFullUrl(string, string, EventSubscriptionsGetFullUrlOptionalParams)

获取事件订阅的完整终结点 URL。

function getFullUrl(scope: string, eventSubscriptionName: string, options?: EventSubscriptionsGetFullUrlOptionalParams): Promise<EventSubscriptionFullUrl>

参数

scope: string

eventSubscriptionName: string

事件订阅的名称。

options: EventSubscriptionsGetFullUrlOptionalParams

选项参数。

Promise<EventSubscriptionFullUrl>

listByDomainTopic(string, string, string, EventSubscriptionsListByDomainTopicOptionalParams)

列出为特定域主题创建的所有事件订阅。

function listByDomainTopic(resourceGroupName: string, domainName: string, topicName: string, options?: EventSubscriptionsListByDomainTopicOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

参数

resourceGroupName: string

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

domainName: string

顶级域的名称。

topicName: string

域主题的名称。

options: EventSubscriptionsListByDomainTopicOptionalParams

选项参数。

PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

listByResource(string, string, string, string, EventSubscriptionsListByResourceOptionalParams)

列出已为特定资源创建的所有事件订阅。

function listByResource(resourceGroupName: string, providerNamespace: string, resourceTypeName: string, resourceName: string, options?: EventSubscriptionsListByResourceOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

参数

resourceGroupName: string

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

providerNamespace: string

主题提供程序的命名空间。

resourceTypeName: string

资源类型的名称。

resourceName: string

资源的名称。

options: EventSubscriptionsListByResourceOptionalParams

选项参数。

PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

listGlobalByResourceGroup(string, EventSubscriptionsListGlobalByResourceGroupOptionalParams)

列出特定 Azure 订阅和资源组下的所有全局事件订阅。

function listGlobalByResourceGroup(resourceGroupName: string, options?: EventSubscriptionsListGlobalByResourceGroupOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

参数

resourceGroupName: string

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

options: EventSubscriptionsListGlobalByResourceGroupOptionalParams

选项参数。

PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

listGlobalByResourceGroupForTopicType(string, string, EventSubscriptionsListGlobalByResourceGroupForTopicTypeOptionalParams)

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

function listGlobalByResourceGroupForTopicType(resourceGroupName: string, topicTypeName: string, options?: EventSubscriptionsListGlobalByResourceGroupForTopicTypeOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

参数

resourceGroupName: string

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

topicTypeName: string

主题类型的名称。

options: EventSubscriptionsListGlobalByResourceGroupForTopicTypeOptionalParams

选项参数。

PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

listGlobalBySubscription(EventSubscriptionsListGlobalBySubscriptionOptionalParams)

列出特定 Azure 订阅下的所有聚合全局事件订阅。

function listGlobalBySubscription(options?: EventSubscriptionsListGlobalBySubscriptionOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

参数

options: EventSubscriptionsListGlobalBySubscriptionOptionalParams

选项参数。

PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

listGlobalBySubscriptionForTopicType(string, EventSubscriptionsListGlobalBySubscriptionForTopicTypeOptionalParams)

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

function listGlobalBySubscriptionForTopicType(topicTypeName: string, options?: EventSubscriptionsListGlobalBySubscriptionForTopicTypeOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

参数

topicTypeName: string

主题类型的名称。

options: EventSubscriptionsListGlobalBySubscriptionForTopicTypeOptionalParams

选项参数。

PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

listRegionalByResourceGroup(string, string, EventSubscriptionsListRegionalByResourceGroupOptionalParams)

列出特定 Azure 订阅和资源组下给定位置的所有事件订阅。

function listRegionalByResourceGroup(resourceGroupName: string, location: string, options?: EventSubscriptionsListRegionalByResourceGroupOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

参数

resourceGroupName: string

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

location: string

位置的名称。

options: EventSubscriptionsListRegionalByResourceGroupOptionalParams

选项参数。

PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

listRegionalByResourceGroupForTopicType(string, string, string, EventSubscriptionsListRegionalByResourceGroupForTopicTypeOptionalParams)

列出特定 Azure 订阅和资源组和主题类型下给定位置的所有事件订阅。

function listRegionalByResourceGroupForTopicType(resourceGroupName: string, location: string, topicTypeName: string, options?: EventSubscriptionsListRegionalByResourceGroupForTopicTypeOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

参数

resourceGroupName: string

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

location: string

位置的名称。

topicTypeName: string

主题类型的名称。

options: EventSubscriptionsListRegionalByResourceGroupForTopicTypeOptionalParams

选项参数。

PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

listRegionalBySubscription(string, EventSubscriptionsListRegionalBySubscriptionOptionalParams)

列出特定 Azure 订阅下给定位置的所有事件订阅。

function listRegionalBySubscription(location: string, options?: EventSubscriptionsListRegionalBySubscriptionOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

参数

location: string

位置的名称。

options: EventSubscriptionsListRegionalBySubscriptionOptionalParams

选项参数。

PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

listRegionalBySubscriptionForTopicType(string, string, EventSubscriptionsListRegionalBySubscriptionForTopicTypeOptionalParams)

列出特定 Azure 订阅和主题类型下给定位置的所有事件订阅。

function listRegionalBySubscriptionForTopicType(location: string, topicTypeName: string, options?: EventSubscriptionsListRegionalBySubscriptionForTopicTypeOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

参数

location: string

位置的名称。

topicTypeName: string

主题类型的名称。

options: EventSubscriptionsListRegionalBySubscriptionForTopicTypeOptionalParams

选项参数。

PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>

通过

EventSubscriptions interface

方法

方法详细信息

beginCreateOrUpdate(string, string, EventSubscription, EventSubscriptionsCreateOrUpdateOptionalParams)

参数

返回

beginCreateOrUpdateAndWait(string, string, EventSubscription, EventSubscriptionsCreateOrUpdateOptionalParams)

参数

返回

beginDelete(string, string, EventSubscriptionsDeleteOptionalParams)

参数

返回

beginDeleteAndWait(string, string, EventSubscriptionsDeleteOptionalParams)

参数

返回

beginUpdate(string, string, EventSubscriptionUpdateParameters, EventSubscriptionsUpdateOptionalParams)

参数

返回

beginUpdateAndWait(string, string, EventSubscriptionUpdateParameters, EventSubscriptionsUpdateOptionalParams)

参数

返回

get(string, string, EventSubscriptionsGetOptionalParams)

参数

返回

getDeliveryAttributes(string, string, EventSubscriptionsGetDeliveryAttributesOptionalParams)

参数

返回

getFullUrl(string, string, EventSubscriptionsGetFullUrlOptionalParams)

参数

返回

listByDomainTopic(string, string, string, EventSubscriptionsListByDomainTopicOptionalParams)

参数

返回

listByResource(string, string, string, string, EventSubscriptionsListByResourceOptionalParams)

参数

返回

listGlobalByResourceGroup(string, EventSubscriptionsListGlobalByResourceGroupOptionalParams)

参数

返回

listGlobalByResourceGroupForTopicType(string, string, EventSubscriptionsListGlobalByResourceGroupForTopicTypeOptionalParams)

参数

返回

listGlobalBySubscription(EventSubscriptionsListGlobalBySubscriptionOptionalParams)

参数

返回

listGlobalBySubscriptionForTopicType(string, EventSubscriptionsListGlobalBySubscriptionForTopicTypeOptionalParams)

参数

返回

listRegionalByResourceGroup(string, string, EventSubscriptionsListRegionalByResourceGroupOptionalParams)

参数

返回

listRegionalByResourceGroupForTopicType(string, string, string, EventSubscriptionsListRegionalByResourceGroupForTopicTypeOptionalParams)

参数

返回

listRegionalBySubscription(string, EventSubscriptionsListRegionalBySubscriptionOptionalParams)

参数

返回

listRegionalBySubscriptionForTopicType(string, string, EventSubscriptionsListRegionalBySubscriptionForTopicTypeOptionalParams)

参数

返回