共用方式為

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<PollerLike<PollOperationState<EventSubscription>, EventSubscription>>

參數

scope

string

需要建立或更新事件訂用帳戶之資源的標識碼。 範圍可以是訂用帳戶、資源群組，或屬於資源提供者命名空間或 EventGrid 主題的最上層資源。 例如，針對資源群組使用 '/subscriptions/{subscriptionId}/' 的訂用帳戶 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' 和 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' 作為資源，以及 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' 作為 EventGrid 主題。

eventSubscriptionName

string

事件訂閱的名稱。 事件訂閱名稱長度必須介於 3 到 64 個字元之間，而且應該只使用英數位元字母。

eventSubscriptionInfo
EventSubscription

包含目的地和篩選資訊的事件訂閱屬性。

options
EventSubscriptionsCreateOrUpdateOptionalParams

選項參數。

傳回

Promise<PollerLike<@azure/core-lro.PollOperationState<EventSubscription>, EventSubscription>>

beginCreateOrUpdateAndWait(string, string, EventSubscription, EventSubscriptionsCreateOrUpdateOptionalParams)

以異步方式建立新的事件訂閱，或根據指定的範圍更新現有的事件訂閱。

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

參數

scope

string

需要建立或更新事件訂用帳戶之資源的標識碼。 範圍可以是訂用帳戶、資源群組，或屬於資源提供者命名空間或 EventGrid 主題的最上層資源。 例如，針對資源群組使用 '/subscriptions/{subscriptionId}/' 的訂用帳戶 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' 和 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' 作為資源，以及 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' 作為 EventGrid 主題。

eventSubscriptionName

string

事件訂閱的名稱。 事件訂閱名稱長度必須介於 3 到 64 個字元之間，而且應該只使用英數位元字母。

eventSubscriptionInfo
EventSubscription

包含目的地和篩選資訊的事件訂閱屬性。

options
EventSubscriptionsCreateOrUpdateOptionalParams

選項參數。

傳回

Promise<EventSubscription>

beginDelete(string, string, EventSubscriptionsDeleteOptionalParams)

刪除現有的事件訂閱。

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

參數

scope

string

事件訂閱的範圍。 範圍可以是訂用帳戶、資源群組，或屬於資源提供者命名空間或 EventGrid 主題的最上層資源。 例如，針對資源群組使用 '/subscriptions/{subscriptionId}/' 的訂用帳戶 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' 和 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' 作為資源，以及 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' 作為 EventGrid 主題。

eventSubscriptionName

string

事件訂閱的名稱。

options
EventSubscriptionsDeleteOptionalParams

選項參數。

傳回

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, EventSubscriptionsDeleteOptionalParams)

刪除現有的事件訂閱。

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

參數

scope

string

事件訂閱的範圍。 範圍可以是訂用帳戶、資源群組，或屬於資源提供者命名空間或 EventGrid 主題的最上層資源。 例如，針對資源群組使用 '/subscriptions/{subscriptionId}/' 的訂用帳戶 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' 和 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' 作為資源，以及 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' 作為 EventGrid 主題。

eventSubscriptionName

string

事件訂閱的名稱。

options
EventSubscriptionsDeleteOptionalParams

選項參數。

傳回

Promise<void>

beginUpdate(string, string, EventSubscriptionUpdateParameters, EventSubscriptionsUpdateOptionalParams)

以異步方式更新現有的事件訂閱。

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

參數

scope

string

現有事件訂用帳戶的範圍。 範圍可以是訂用帳戶、資源群組，或屬於資源提供者命名空間或 EventGrid 主題的最上層資源。 例如，針對資源群組使用 '/subscriptions/{subscriptionId}/' 的訂用帳戶 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' 和 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' 作為資源，以及 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' 作為 EventGrid 主題。

eventSubscriptionName

string

要更新的事件訂閱名稱。

eventSubscriptionUpdateParameters
EventSubscriptionUpdateParameters

已更新事件訂用帳戶資訊。

options
EventSubscriptionsUpdateOptionalParams

選項參數。

傳回

Promise<PollerLike<@azure/core-lro.PollOperationState<EventSubscription>, EventSubscription>>

beginUpdateAndWait(string, string, EventSubscriptionUpdateParameters, EventSubscriptionsUpdateOptionalParams)

以異步方式更新現有的事件訂閱。

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

參數

scope

string

現有事件訂用帳戶的範圍。 範圍可以是訂用帳戶、資源群組，或屬於資源提供者命名空間或 EventGrid 主題的最上層資源。 例如，針對資源群組使用 '/subscriptions/{subscriptionId}/' 的訂用帳戶 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' 和 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' 作為資源，以及 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' 作為 EventGrid 主題。

eventSubscriptionName

string

要更新的事件訂閱名稱。

eventSubscriptionUpdateParameters
EventSubscriptionUpdateParameters

已更新事件訂用帳戶資訊。

options
EventSubscriptionsUpdateOptionalParams

選項參數。

傳回

Promise<EventSubscription>

get(string, string, EventSubscriptionsGetOptionalParams)

取得事件訂閱的屬性。

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

參數

scope

string

事件訂閱的範圍。 範圍可以是訂用帳戶、資源群組，或屬於資源提供者命名空間或 EventGrid 主題的最上層資源。 例如，針對資源群組使用 '/subscriptions/{subscriptionId}/' 的訂用帳戶 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' 和 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' 作為資源，以及 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' 作為 EventGrid 主題。

eventSubscriptionName

string

事件訂閱的名稱。

options
EventSubscriptionsGetOptionalParams

選項參數。

傳回

Promise<EventSubscription>

getDeliveryAttributes(string, string, EventSubscriptionsGetDeliveryAttributesOptionalParams)

取得事件訂閱的所有傳遞屬性。

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

參數

scope

string

事件訂閱的範圍。 範圍可以是訂用帳戶、資源群組，或屬於資源提供者命名空間或 EventGrid 主題的最上層資源。 例如，針對資源群組使用 '/subscriptions/{subscriptionId}/' 的訂用帳戶 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' 和 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' 作為資源，以及 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' 作為 EventGrid 主題。

eventSubscriptionName

string

事件訂閱的名稱。

options
EventSubscriptionsGetDeliveryAttributesOptionalParams

選項參數。

傳回

Promise<DeliveryAttributeListResult>

getFullUrl(string, string, EventSubscriptionsGetFullUrlOptionalParams)

取得事件訂用帳戶的完整端點 URL。

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

參數

scope

string

事件訂閱的範圍。 範圍可以是訂用帳戶、資源群組，或屬於資源提供者命名空間或 EventGrid 主題的最上層資源。 例如，針對資源群組使用 '/subscriptions/{subscriptionId}/' 的訂用帳戶 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' 和 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' 作為資源，以及 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' 作為 EventGrid 主題。

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>