Freigeben über


EventSubscriptions interface

Schnittstelle, die ein EventSubscriptions darstellt.

Methoden

beginCreateOrUpdate(string, string, EventSubscription, EventSubscriptionsCreateOrUpdateOptionalParams)

Erstellt asynchron ein neues Ereignisabonnement oder aktualisiert ein vorhandenes Ereignisabonnement basierend auf dem angegebenen Bereich.

beginCreateOrUpdateAndWait(string, string, EventSubscription, EventSubscriptionsCreateOrUpdateOptionalParams)

Erstellt asynchron ein neues Ereignisabonnement oder aktualisiert ein vorhandenes Ereignisabonnement basierend auf dem angegebenen Bereich.

beginDelete(string, string, EventSubscriptionsDeleteOptionalParams)

Löschen sie ein vorhandenes Ereignisabonnement.

beginDeleteAndWait(string, string, EventSubscriptionsDeleteOptionalParams)

Löschen sie ein vorhandenes Ereignisabonnement.

beginUpdate(string, string, EventSubscriptionUpdateParameters, EventSubscriptionsUpdateOptionalParams)

Aktualisiert asynchron ein vorhandenes Ereignisabonnement.

beginUpdateAndWait(string, string, EventSubscriptionUpdateParameters, EventSubscriptionsUpdateOptionalParams)

Aktualisiert asynchron ein vorhandenes Ereignisabonnement.

get(string, string, EventSubscriptionsGetOptionalParams)

Dient zum Abrufen von Eigenschaften eines Ereignisabonnements.

getDeliveryAttributes(string, string, EventSubscriptionsGetDeliveryAttributesOptionalParams)

Ruft alle Übermittlungsattribute für ein Ereignisabonnement ab.

getFullUrl(string, string, EventSubscriptionsGetFullUrlOptionalParams)

Rufen Sie die vollständige Endpunkt-URL für ein Ereignisabonnement ab.

listByDomainTopic(string, string, string, EventSubscriptionsListByDomainTopicOptionalParams)

Listet alle Ereignisabonnements auf, die für ein bestimmtes Domänenthema erstellt wurden.

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

Listet alle Ereignisabonnements auf, die für eine bestimmte Ressource erstellt wurden.

listGlobalByResourceGroup(string, EventSubscriptionsListGlobalByResourceGroupOptionalParams)

Auflisten aller globalen Ereignisabonnements unter einem bestimmten Azure-Abonnement und einer bestimmten Ressourcengruppe.

listGlobalByResourceGroupForTopicType(string, string, EventSubscriptionsListGlobalByResourceGroupForTopicTypeOptionalParams)

Auflisten aller globalen Ereignisabonnements unter einer Ressourcengruppe für einen bestimmten Thementyp.

listGlobalBySubscription(EventSubscriptionsListGlobalBySubscriptionOptionalParams)

Auflisten aller aggregierten globalen Ereignisabonnements unter einem bestimmten Azure-Abonnement.

listGlobalBySubscriptionForTopicType(string, EventSubscriptionsListGlobalBySubscriptionForTopicTypeOptionalParams)

Auflisten aller globalen Ereignisabonnements unter einem Azure-Abonnement für einen Thementyp.

listRegionalByResourceGroup(string, string, EventSubscriptionsListRegionalByResourceGroupOptionalParams)

Auflisten aller Ereignisabonnements vom angegebenen Speicherort unter einem bestimmten Azure-Abonnement und einer bestimmten Ressourcengruppe.

listRegionalByResourceGroupForTopicType(string, string, string, EventSubscriptionsListRegionalByResourceGroupForTopicTypeOptionalParams)

Auflisten aller Ereignisabonnements vom angegebenen Speicherort unter einem bestimmten Azure-Abonnement- und Ressourcengruppen- und Thementyp.

listRegionalBySubscription(string, EventSubscriptionsListRegionalBySubscriptionOptionalParams)

Auflisten aller Ereignisabonnements vom angegebenen Speicherort unter einem bestimmten Azure-Abonnement.

listRegionalBySubscriptionForTopicType(string, string, EventSubscriptionsListRegionalBySubscriptionForTopicTypeOptionalParams)

Auflisten aller Ereignisabonnements vom angegebenen Speicherort unter einem bestimmten Azure-Abonnement und Thementyp.

Details zur Methode

beginCreateOrUpdate(string, string, EventSubscription, EventSubscriptionsCreateOrUpdateOptionalParams)

Erstellt asynchron ein neues Ereignisabonnement oder aktualisiert ein vorhandenes Ereignisabonnement basierend auf dem angegebenen Bereich.

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

Parameter

scope

string

Der Bezeichner der Ressource, auf die das Ereignisabonnement erstellt oder aktualisiert werden muss. Der Bereich kann ein Abonnement oder eine Ressourcengruppe oder eine Ressource auf oberster Ebene sein, die zu einem Ressourcenanbieternamespace oder einem EventGrid-Thema gehört. Verwenden Sie z. B. "/subscriptions/{subscriptionId}/" für ein Abonnement. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' für eine Ressourcengruppe und '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' für eine Ressource, und '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' für ein EventGrid-Thema.

eventSubscriptionName

string

Name des zu erstellenden Ereignisabonnements. Ereignisabonnementnamen müssen zwischen 3 und 64 Zeichen lang sein und sollten nur alphanumerische Buchstaben verwenden.

eventSubscriptionInfo
EventSubscription

Ereignisabonnementeigenschaften, die die Ziel- und Filterinformationen enthalten.

options
EventSubscriptionsCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginCreateOrUpdateAndWait(string, string, EventSubscription, EventSubscriptionsCreateOrUpdateOptionalParams)

Erstellt asynchron ein neues Ereignisabonnement oder aktualisiert ein vorhandenes Ereignisabonnement basierend auf dem angegebenen Bereich.

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

Parameter

scope

string

Der Bezeichner der Ressource, auf die das Ereignisabonnement erstellt oder aktualisiert werden muss. Der Bereich kann ein Abonnement oder eine Ressourcengruppe oder eine Ressource auf oberster Ebene sein, die zu einem Ressourcenanbieternamespace oder einem EventGrid-Thema gehört. Verwenden Sie z. B. "/subscriptions/{subscriptionId}/" für ein Abonnement. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' für eine Ressourcengruppe und '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' für eine Ressource, und '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' für ein EventGrid-Thema.

eventSubscriptionName

string

Name des zu erstellenden Ereignisabonnements. Ereignisabonnementnamen müssen zwischen 3 und 64 Zeichen lang sein und sollten nur alphanumerische Buchstaben verwenden.

eventSubscriptionInfo
EventSubscription

Ereignisabonnementeigenschaften, die die Ziel- und Filterinformationen enthalten.

options
EventSubscriptionsCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

beginDelete(string, string, EventSubscriptionsDeleteOptionalParams)

Löschen sie ein vorhandenes Ereignisabonnement.

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

Parameter

scope

string

Der Umfang des Ereignisabonnements. Der Bereich kann ein Abonnement oder eine Ressourcengruppe oder eine Ressource auf oberster Ebene sein, die zu einem Ressourcenanbieternamespace oder einem EventGrid-Thema gehört. Verwenden Sie z. B. "/subscriptions/{subscriptionId}/" für ein Abonnement. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' für eine Ressourcengruppe und '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' für eine Ressource, und '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' für ein EventGrid-Thema.

eventSubscriptionName

string

Name des zu löschenden Ereignisabonnements.

options
EventSubscriptionsDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginDeleteAndWait(string, string, EventSubscriptionsDeleteOptionalParams)

Löschen sie ein vorhandenes Ereignisabonnement.

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

Parameter

scope

string

Der Umfang des Ereignisabonnements. Der Bereich kann ein Abonnement oder eine Ressourcengruppe oder eine Ressource auf oberster Ebene sein, die zu einem Ressourcenanbieternamespace oder einem EventGrid-Thema gehört. Verwenden Sie z. B. "/subscriptions/{subscriptionId}/" für ein Abonnement. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' für eine Ressourcengruppe und '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' für eine Ressource, und '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' für ein EventGrid-Thema.

eventSubscriptionName

string

Name des zu löschenden Ereignisabonnements.

options
EventSubscriptionsDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

beginUpdate(string, string, EventSubscriptionUpdateParameters, EventSubscriptionsUpdateOptionalParams)

Aktualisiert asynchron ein vorhandenes Ereignisabonnement.

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

Parameter

scope

string

Der Umfang des vorhandenen Ereignisabonnements. Der Bereich kann ein Abonnement oder eine Ressourcengruppe oder eine Ressource auf oberster Ebene sein, die zu einem Ressourcenanbieternamespace oder einem EventGrid-Thema gehört. Verwenden Sie z. B. "/subscriptions/{subscriptionId}/" für ein Abonnement. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' für eine Ressourcengruppe und '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' für eine Ressource, und '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' für ein EventGrid-Thema.

eventSubscriptionName

string

Name des zu aktualisierenden Ereignisabonnements.

eventSubscriptionUpdateParameters
EventSubscriptionUpdateParameters

Aktualisierte Ereignisabonnementinformationen.

options
EventSubscriptionsUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

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

beginUpdateAndWait(string, string, EventSubscriptionUpdateParameters, EventSubscriptionsUpdateOptionalParams)

Aktualisiert asynchron ein vorhandenes Ereignisabonnement.

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

Parameter

scope

string

Der Umfang des vorhandenen Ereignisabonnements. Der Bereich kann ein Abonnement oder eine Ressourcengruppe oder eine Ressource auf oberster Ebene sein, die zu einem Ressourcenanbieternamespace oder einem EventGrid-Thema gehört. Verwenden Sie z. B. "/subscriptions/{subscriptionId}/" für ein Abonnement. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' für eine Ressourcengruppe und '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' für eine Ressource, und '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' für ein EventGrid-Thema.

eventSubscriptionName

string

Name des zu aktualisierenden Ereignisabonnements.

eventSubscriptionUpdateParameters
EventSubscriptionUpdateParameters

Aktualisierte Ereignisabonnementinformationen.

options
EventSubscriptionsUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

get(string, string, EventSubscriptionsGetOptionalParams)

Dient zum Abrufen von Eigenschaften eines Ereignisabonnements.

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

Parameter

scope

string

Der Umfang des Ereignisabonnements. Der Bereich kann ein Abonnement oder eine Ressourcengruppe oder eine Ressource auf oberster Ebene sein, die zu einem Ressourcenanbieternamespace oder einem EventGrid-Thema gehört. Verwenden Sie z. B. "/subscriptions/{subscriptionId}/" für ein Abonnement. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' für eine Ressourcengruppe und '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' für eine Ressource, und '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' für ein EventGrid-Thema.

eventSubscriptionName

string

Name des zu findenden Ereignisabonnements.

options
EventSubscriptionsGetOptionalParams

Die Optionsparameter.

Gibt zurück

getDeliveryAttributes(string, string, EventSubscriptionsGetDeliveryAttributesOptionalParams)

Ruft alle Übermittlungsattribute für ein Ereignisabonnement ab.

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

Parameter

scope

string

Der Umfang des Ereignisabonnements. Der Bereich kann ein Abonnement oder eine Ressourcengruppe oder eine Ressource auf oberster Ebene sein, die zu einem Ressourcenanbieternamespace oder einem EventGrid-Thema gehört. Verwenden Sie z. B. "/subscriptions/{subscriptionId}/" für ein Abonnement. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' für eine Ressourcengruppe und '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' für eine Ressource, und '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' für ein EventGrid-Thema.

eventSubscriptionName

string

Name des Ereignisabonnements.

Gibt zurück

getFullUrl(string, string, EventSubscriptionsGetFullUrlOptionalParams)

Rufen Sie die vollständige Endpunkt-URL für ein Ereignisabonnement ab.

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

Parameter

scope

string

Der Umfang des Ereignisabonnements. Der Bereich kann ein Abonnement oder eine Ressourcengruppe oder eine Ressource auf oberster Ebene sein, die zu einem Ressourcenanbieternamespace oder einem EventGrid-Thema gehört. Verwenden Sie z. B. "/subscriptions/{subscriptionId}/" für ein Abonnement. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' für eine Ressourcengruppe und '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' für eine Ressource, und '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' für ein EventGrid-Thema.

eventSubscriptionName

string

Name des Ereignisabonnements.

options
EventSubscriptionsGetFullUrlOptionalParams

Die Optionsparameter.

Gibt zurück

listByDomainTopic(string, string, string, EventSubscriptionsListByDomainTopicOptionalParams)

Listet alle Ereignisabonnements auf, die für ein bestimmtes Domänenthema erstellt wurden.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe innerhalb des Abonnements des Benutzers.

domainName

string

Name der Domäne der obersten Ebene.

topicName

string

Name des Domänenthemas.

Gibt zurück

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

Listet alle Ereignisabonnements auf, die für eine bestimmte Ressource erstellt wurden.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe innerhalb des Abonnements des Benutzers.

providerNamespace

string

Namespace des Anbieters des Themas.

resourceTypeName

string

Name des Ressourcentyps.

resourceName

string

Name der Ressource.

options
EventSubscriptionsListByResourceOptionalParams

Die Optionsparameter.

Gibt zurück

listGlobalByResourceGroup(string, EventSubscriptionsListGlobalByResourceGroupOptionalParams)

Auflisten aller globalen Ereignisabonnements unter einem bestimmten Azure-Abonnement und einer bestimmten Ressourcengruppe.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe innerhalb des Abonnements des Benutzers.

Gibt zurück

listGlobalByResourceGroupForTopicType(string, string, EventSubscriptionsListGlobalByResourceGroupForTopicTypeOptionalParams)

Auflisten aller globalen Ereignisabonnements unter einer Ressourcengruppe für einen bestimmten Thementyp.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe innerhalb des Abonnements des Benutzers.

topicTypeName

string

Name des Thementyps.

Gibt zurück

listGlobalBySubscription(EventSubscriptionsListGlobalBySubscriptionOptionalParams)

Auflisten aller aggregierten globalen Ereignisabonnements unter einem bestimmten Azure-Abonnement.

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

Parameter

Gibt zurück

listGlobalBySubscriptionForTopicType(string, EventSubscriptionsListGlobalBySubscriptionForTopicTypeOptionalParams)

Auflisten aller globalen Ereignisabonnements unter einem Azure-Abonnement für einen Thementyp.

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

Parameter

topicTypeName

string

Name des Thementyps.

Gibt zurück

listRegionalByResourceGroup(string, string, EventSubscriptionsListRegionalByResourceGroupOptionalParams)

Auflisten aller Ereignisabonnements vom angegebenen Speicherort unter einem bestimmten Azure-Abonnement und einer bestimmten Ressourcengruppe.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe innerhalb des Abonnements des Benutzers.

location

string

Name des Speicherorts.

Gibt zurück

listRegionalByResourceGroupForTopicType(string, string, string, EventSubscriptionsListRegionalByResourceGroupForTopicTypeOptionalParams)

Auflisten aller Ereignisabonnements vom angegebenen Speicherort unter einem bestimmten Azure-Abonnement- und Ressourcengruppen- und Thementyp.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe innerhalb des Abonnements des Benutzers.

location

string

Name des Speicherorts.

topicTypeName

string

Name des Thementyps.

Gibt zurück

listRegionalBySubscription(string, EventSubscriptionsListRegionalBySubscriptionOptionalParams)

Auflisten aller Ereignisabonnements vom angegebenen Speicherort unter einem bestimmten Azure-Abonnement.

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

Parameter

location

string

Name des Speicherorts.

Gibt zurück

listRegionalBySubscriptionForTopicType(string, string, EventSubscriptionsListRegionalBySubscriptionForTopicTypeOptionalParams)

Auflisten aller Ereignisabonnements vom angegebenen Speicherort unter einem bestimmten Azure-Abonnement und Thementyp.

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

Parameter

location

string

Name des Speicherorts.

topicTypeName

string

Name des Thementyps.

Gibt zurück