Поделиться через


EventSubscriptions interface

Интерфейс, представляющий 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}" для ресурса и "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}" для раздела EventGrid.

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

Идентификатор ресурса, для которого необходимо создать или обновить подписку на события. Область может быть подпиской, группой ресурсов, ресурсом верхнего уровня, принадлежащим пространству имен поставщика ресурсов, или разделу 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

Параметры параметров.

Возвращаемое значение

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}" для ресурса и "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}" для раздела EventGrid.

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

Область подписки на события. Область может быть подпиской, группой ресурсов, ресурсом верхнего уровня, принадлежащим пространству имен поставщика ресурсов, или разделу 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<SimplePollerLike<OperationState<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<@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

Область существующей подписки на события. Область может быть подпиской, группой ресурсов, ресурсом верхнего уровня, принадлежащим пространству имен поставщика ресурсов, или разделу 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

Параметры параметров.

Возвращаемое значение

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

Параметры параметров.

Возвращаемое значение

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

Параметры параметров.

Возвращаемое значение

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

Параметры параметров.

Возвращаемое значение

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

Параметры параметров.

Возвращаемое значение

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

Параметры параметров.

Возвращаемое значение

listGlobalByResourceGroup(string, EventSubscriptionsListGlobalByResourceGroupOptionalParams)

Выведите список всех глобальных подписок на события в определенной подписке Azure и группе ресурсов.

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

Параметры

resourceGroupName

string

Имя группы ресурсов в подписке пользователя.

options
EventSubscriptionsListGlobalByResourceGroupOptionalParams

Параметры параметров.

Возвращаемое значение

listGlobalByResourceGroupForTopicType(string, string, EventSubscriptionsListGlobalByResourceGroupForTopicTypeOptionalParams)

Вывод списка всех глобальных подписок на события в группе ресурсов для определенного типа раздела.

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

Параметры

resourceGroupName

string

Имя группы ресурсов в подписке пользователя.

topicTypeName

string

Имя типа раздела.

options
EventSubscriptionsListGlobalByResourceGroupForTopicTypeOptionalParams

Параметры параметров.

Возвращаемое значение

listGlobalBySubscription(EventSubscriptionsListGlobalBySubscriptionOptionalParams)

Вывод списка всех агрегированных глобальных подписок на события в определенной подписке Azure.

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

Параметры

options
EventSubscriptionsListGlobalBySubscriptionOptionalParams

Параметры параметров.

Возвращаемое значение

listGlobalBySubscriptionForTopicType(string, EventSubscriptionsListGlobalBySubscriptionForTopicTypeOptionalParams)

Вывод списка всех глобальных подписок на события в подписке Azure для типа раздела.

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

Параметры

topicTypeName

string

Имя типа раздела.

options
EventSubscriptionsListGlobalBySubscriptionForTopicTypeOptionalParams

Параметры параметров.

Возвращаемое значение

listRegionalByResourceGroup(string, string, EventSubscriptionsListRegionalByResourceGroupOptionalParams)

Выведите список всех подписок на события из заданного расположения в определенной подписке Azure и группе ресурсов.

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

Параметры

resourceGroupName

string

Имя группы ресурсов в подписке пользователя.

location

string

Название расположения.

options
EventSubscriptionsListRegionalByResourceGroupOptionalParams

Параметры параметров.

Возвращаемое значение

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

Параметры параметров.

Возвращаемое значение

listRegionalBySubscription(string, EventSubscriptionsListRegionalBySubscriptionOptionalParams)

Вывод списка всех подписок на события из заданного расположения в определенной подписке Azure.

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

Параметры

location

string

Название расположения.

options
EventSubscriptionsListRegionalBySubscriptionOptionalParams

Параметры параметров.

Возвращаемое значение

listRegionalBySubscriptionForTopicType(string, string, EventSubscriptionsListRegionalBySubscriptionForTopicTypeOptionalParams)

Выведите список всех подписок на события из заданного расположения в определенной подписке Azure и типе раздела.

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

Параметры

location

string

Название расположения.

topicTypeName

string

Имя типа раздела.

options
EventSubscriptionsListRegionalBySubscriptionForTopicTypeOptionalParams

Параметры параметров.

Возвращаемое значение