DomainEventSubscriptionsImpl | @azure/arm-eventgrid

Class containing DomainEventSubscriptions operations.

Hierarchy

DomainEventSubscriptionsImpl

Implements

DomainEventSubscriptions

Index

Constructors

constructor

Methods

Constructors

constructor

new DomainEventSubscriptionsImpl(client: EventGridManagementClient): DomainEventSubscriptionsImpl

- Defined in operations/domainEventSubscriptions.ts:40
Initialize a new instance of the class DomainEventSubscriptions class.

Parameters
- client: EventGridManagementClient
  
  Reference to the service client
Returns DomainEventSubscriptionsImpl

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, domainName: string, eventSubscriptionName: string, eventSubscriptionInfo: EventSubscription, options?: DomainEventSubscriptionsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<DomainEventSubscriptionsCreateOrUpdateResponse>, DomainEventSubscriptionsCreateOrUpdateResponse>>

Implementation of DomainEventSubscriptions.beginCreateOrUpdate
- Defined in operations/domainEventSubscriptions.ts:139
Asynchronously creates a new event subscription or updates an existing event subscription.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- domainName: string
  
  Name of the domain topic.
- eventSubscriptionName: string
  
  Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
- eventSubscriptionInfo: EventSubscription
  
  Event subscription properties containing the destination and filter information.
- Optional options: DomainEventSubscriptionsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<DomainEventSubscriptionsCreateOrUpdateResponse>, DomainEventSubscriptionsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, domainName: string, eventSubscriptionName: string, eventSubscriptionInfo: EventSubscription, options?: DomainEventSubscriptionsCreateOrUpdateOptionalParams): Promise<DomainEventSubscriptionsCreateOrUpdateResponse>

Implementation of DomainEventSubscriptions.beginCreateOrUpdateAndWait
- Defined in operations/domainEventSubscriptions.ts:219
Asynchronously creates a new event subscription or updates an existing event subscription.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- domainName: string
  
  Name of the domain topic.
- eventSubscriptionName: string
  
  Name of the event subscription to be created. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
- eventSubscriptionInfo: EventSubscription
  
  Event subscription properties containing the destination and filter information.
- Optional options: DomainEventSubscriptionsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<DomainEventSubscriptionsCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, domainName: string, eventSubscriptionName: string, options?: DomainEventSubscriptionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of DomainEventSubscriptions.beginDelete
- Defined in operations/domainEventSubscriptions.ts:244
Delete an existing event subscription for a domain.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- domainName: string
  
  Name of the domain.
- eventSubscriptionName: string
  
  Name of the event subscription to be deleted. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
- Optional options: DomainEventSubscriptionsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, domainName: string, eventSubscriptionName: string, options?: DomainEventSubscriptionsDeleteOptionalParams): Promise<void>

Implementation of DomainEventSubscriptions.beginDeleteAndWait
- Defined in operations/domainEventSubscriptions.ts:310
Delete an existing event subscription for a domain.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- domainName: string
  
  Name of the domain.
- eventSubscriptionName: string
  
  Name of the event subscription to be deleted. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
- Optional options: DomainEventSubscriptionsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(resourceGroupName: string, domainName: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters, options?: DomainEventSubscriptionsUpdateOptionalParams): Promise<PollerLike<PollOperationState<DomainEventSubscriptionsUpdateResponse>, DomainEventSubscriptionsUpdateResponse>>

Implementation of DomainEventSubscriptions.beginUpdate
- Defined in operations/domainEventSubscriptions.ts:333
Update an existing event subscription for a topic.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- domainName: string
  
  Name of the domain.
- eventSubscriptionName: string
  
  Name of the event subscription to be updated.
- eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters
  
  Updated event subscription information.
- Optional options: DomainEventSubscriptionsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<DomainEventSubscriptionsUpdateResponse>, DomainEventSubscriptionsUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, domainName: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters, options?: DomainEventSubscriptionsUpdateOptionalParams): Promise<DomainEventSubscriptionsUpdateResponse>

Implementation of DomainEventSubscriptions.beginUpdateAndWait
- Defined in operations/domainEventSubscriptions.ts:411
Update an existing event subscription for a topic.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- domainName: string
  
  Name of the domain.
- eventSubscriptionName: string
  
  Name of the event subscription to be updated.
- eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters
  
  Updated event subscription information.
- Optional options: DomainEventSubscriptionsUpdateOptionalParams
  
  The options parameters.
Returns Promise<DomainEventSubscriptionsUpdateResponse>

get

get(resourceGroupName: string, domainName: string, eventSubscriptionName: string, options?: DomainEventSubscriptionsGetOptionalParams): Promise<DomainEventSubscriptionsGetResponse>

Implementation of DomainEventSubscriptions.get
- Defined in operations/domainEventSubscriptions.ts:117
Get properties of an event subscription of a domain.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- domainName: string
  
  Name of the partner topic.
- eventSubscriptionName: string
  
  Name of the event subscription to be found. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
- Optional options: DomainEventSubscriptionsGetOptionalParams
  
  The options parameters.
Returns Promise<DomainEventSubscriptionsGetResponse>

getDeliveryAttributes

getDeliveryAttributes(resourceGroupName: string, domainName: string, eventSubscriptionName: string, options?: DomainEventSubscriptionsGetDeliveryAttributesOptionalParams): Promise<DomainEventSubscriptionsGetDeliveryAttributesResponse>

Implementation of DomainEventSubscriptions.getDeliveryAttributes
- Defined in operations/domainEventSubscriptions.ts:471
Get all delivery attributes for an event subscription for domain.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- domainName: string
  
  Name of the domain topic.
- eventSubscriptionName: string
  
  Name of the event subscription.
- Optional options: DomainEventSubscriptionsGetDeliveryAttributesOptionalParams
  
  The options parameters.
Returns Promise<DomainEventSubscriptionsGetDeliveryAttributesResponse>

getFullUrl

getFullUrl(resourceGroupName: string, domainName: string, eventSubscriptionName: string, options?: DomainEventSubscriptionsGetFullUrlOptionalParams): Promise<DomainEventSubscriptionsGetFullUrlResponse>

Implementation of DomainEventSubscriptions.getFullUrl
- Defined in operations/domainEventSubscriptions.ts:435
Get the full endpoint URL for an event subscription for domain.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- domainName: string
  
  Name of the domain topic.
- eventSubscriptionName: string
  
  Name of the event subscription.
- Optional options: DomainEventSubscriptionsGetFullUrlOptionalParams
  
  The options parameters.
Returns Promise<DomainEventSubscriptionsGetFullUrlResponse>

list

list(resourceGroupName: string, domainName: string, options?: DomainEventSubscriptionsListOptionalParams): PagedAsyncIterableIterator<EventSubscription>

Implementation of DomainEventSubscriptions.list
- Defined in operations/domainEventSubscriptions.ts:56
List all event subscriptions that have been created for a specific topic.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- domainName: string
  
  Name of the domain.
- Optional options: DomainEventSubscriptionsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<EventSubscription>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: EventGridManagementClient

Returns DomainEventSubscriptionsImpl

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

domainName: string

eventSubscriptionName: string

eventSubscriptionInfo: EventSubscription

Optional options: DomainEventSubscriptionsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<DomainEventSubscriptionsCreateOrUpdateResponse>, DomainEventSubscriptionsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

domainName: string

eventSubscriptionName: string

eventSubscriptionInfo: EventSubscription

Optional options: DomainEventSubscriptionsCreateOrUpdateOptionalParams

Returns Promise<DomainEventSubscriptionsCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

domainName: string

eventSubscriptionName: string

Optional options: DomainEventSubscriptionsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

domainName: string

eventSubscriptionName: string

Optional options: DomainEventSubscriptionsDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

domainName: string

eventSubscriptionName: string

eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters

Optional options: DomainEventSubscriptionsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<DomainEventSubscriptionsUpdateResponse>, DomainEventSubscriptionsUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

domainName: string

eventSubscriptionName: string

eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters

Optional options: DomainEventSubscriptionsUpdateOptionalParams

Returns Promise<DomainEventSubscriptionsUpdateResponse>

get

Parameters

resourceGroupName: string

domainName: string

eventSubscriptionName: string

Optional options: DomainEventSubscriptionsGetOptionalParams

Returns Promise<DomainEventSubscriptionsGetResponse>

getDeliveryAttributes

Parameters

resourceGroupName: string

domainName: string

eventSubscriptionName: string

Optional options: DomainEventSubscriptionsGetDeliveryAttributesOptionalParams

Returns Promise<DomainEventSubscriptionsGetDeliveryAttributesResponse>

getFullUrl

Parameters

resourceGroupName: string

domainName: string

eventSubscriptionName: string

Optional options: DomainEventSubscriptionsGetFullUrlOptionalParams

Returns Promise<DomainEventSubscriptionsGetFullUrlResponse>

list

Parameters