EventSubscriptions interface
Интерфейс, представляющий eventSubscriptions.
Методы
Сведения о методе
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
Свойства подписки на события, содержащие сведения о назначении и фильтрации.
Параметры параметров.
Возвращаемое значение
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
Свойства подписки на события, содержащие сведения о назначении и фильтрации.
Параметры параметров.
Возвращаемое значение
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
Имя подписки на событие.
Параметры параметров.
Возвращаемое значение
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
Имя подписки на событие.
Параметры параметров.
Возвращаемое значение
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
Обновлены сведения о подписке на события.
Параметры параметров.
Возвращаемое значение
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
Обновлены сведения о подписке на события.
Параметры параметров.
Возвращаемое значение
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
Имя подписки на событие.
Параметры параметров.
Возвращаемое значение
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
Имя подписки на событие.
Параметры параметров.
Возвращаемое значение
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
Имя подписки на событие.
Параметры параметров.
Возвращаемое значение
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
Имя раздела домена.
Параметры параметров.
Возвращаемое значение
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
Имя ресурса.
Параметры параметров.
Возвращаемое значение
listGlobalByResourceGroup(string, EventSubscriptionsListGlobalByResourceGroupOptionalParams)
Список всех глобальных подписок на события в определенной подписке Azure и группе ресурсов.
function listGlobalByResourceGroup(resourceGroupName: string, options?: EventSubscriptionsListGlobalByResourceGroupOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>Параметры
- resourceGroupName
-
string
Имя группы ресурсов в подписке пользователя.
Параметры параметров.
Возвращаемое значение
listGlobalByResourceGroupForTopicType(string, string, EventSubscriptionsListGlobalByResourceGroupForTopicTypeOptionalParams)
Список всех глобальных подписок на события в группе ресурсов для определенного типа раздела.
function listGlobalByResourceGroupForTopicType(resourceGroupName: string, topicTypeName: string, options?: EventSubscriptionsListGlobalByResourceGroupForTopicTypeOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>Параметры
- resourceGroupName
-
string
Имя группы ресурсов в подписке пользователя.
- topicTypeName
-
string
Имя типа раздела.
Параметры параметров.
Возвращаемое значение
listGlobalBySubscription(EventSubscriptionsListGlobalBySubscriptionOptionalParams)
Перечислите все объединенные глобальные подписки на события в рамках определенной подписки Azure.
function listGlobalBySubscription(options?: EventSubscriptionsListGlobalBySubscriptionOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>Параметры
Параметры параметров.
Возвращаемое значение
listGlobalBySubscriptionForTopicType(string, EventSubscriptionsListGlobalBySubscriptionForTopicTypeOptionalParams)
Список всех глобальных подписок на события в подписке Azure для типа раздела.
function listGlobalBySubscriptionForTopicType(topicTypeName: string, options?: EventSubscriptionsListGlobalBySubscriptionForTopicTypeOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>Параметры
- topicTypeName
-
string
Имя типа раздела.
Параметры параметров.
Возвращаемое значение
listRegionalByResourceGroup(string, string, EventSubscriptionsListRegionalByResourceGroupOptionalParams)
Перечислите все подписки на события из заданного расположения в определенной подписке Azure и группе ресурсов.
function listRegionalByResourceGroup(resourceGroupName: string, location: string, options?: EventSubscriptionsListRegionalByResourceGroupOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>Параметры
- resourceGroupName
-
string
Имя группы ресурсов в подписке пользователя.
- location
-
string
Имя расположения.
Параметры параметров.
Возвращаемое значение
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
Имя типа раздела.
Параметры параметров.
Возвращаемое значение
listRegionalBySubscription(string, EventSubscriptionsListRegionalBySubscriptionOptionalParams)
Вывод списка всех подписок на события из заданного расположения в определенной подписке Azure.
function listRegionalBySubscription(location: string, options?: EventSubscriptionsListRegionalBySubscriptionOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>Параметры
- location
-
string
Имя расположения.
Параметры параметров.
Возвращаемое значение
listRegionalBySubscriptionForTopicType(string, string, EventSubscriptionsListRegionalBySubscriptionForTopicTypeOptionalParams)
Список всех подписок на события из заданного расположения в определенном типе подписки Azure и раздела.
function listRegionalBySubscriptionForTopicType(location: string, topicTypeName: string, options?: EventSubscriptionsListRegionalBySubscriptionForTopicTypeOptionalParams): PagedAsyncIterableIterator<EventSubscription, EventSubscription[], PageSettings>Параметры
- location
-
string
Имя расположения.
- topicTypeName
-
string
Имя типа раздела.
Параметры параметров.