SystemTopicEventSubscriptions | @azure/arm-eventgrid

Interface representing a SystemTopicEventSubscriptions.

Hierarchy

SystemTopicEventSubscriptions

Implemented by

SystemTopicEventSubscriptionsImpl

Index

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, systemTopicName: string, eventSubscriptionName: string, eventSubscriptionInfo: EventSubscription, options?: SystemTopicEventSubscriptionsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<SystemTopicEventSubscriptionsCreateOrUpdateResponse>, SystemTopicEventSubscriptionsCreateOrUpdateResponse>>

- Defined in operationsInterfaces/systemTopicEventSubscriptions.ts:67
Asynchronously creates or updates an event subscription with the specified parameters. Existing event subscriptions will be updated with this API.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- systemTopicName: string
  
  Name of the system 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: SystemTopicEventSubscriptionsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SystemTopicEventSubscriptionsCreateOrUpdateResponse>, SystemTopicEventSubscriptionsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, systemTopicName: string, eventSubscriptionName: string, eventSubscriptionInfo: EventSubscription, options?: SystemTopicEventSubscriptionsCreateOrUpdateOptionalParams): Promise<SystemTopicEventSubscriptionsCreateOrUpdateResponse>

- Defined in operationsInterfaces/systemTopicEventSubscriptions.ts:90
Asynchronously creates or updates an event subscription with the specified parameters. Existing event subscriptions will be updated with this API.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- systemTopicName: string
  
  Name of the system 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: SystemTopicEventSubscriptionsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SystemTopicEventSubscriptionsCreateOrUpdateResponse>

beginDelete

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

- Defined in operationsInterfaces/systemTopicEventSubscriptions.ts:105
Delete an existing event subscription of a system topic.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- systemTopicName: string
  
  Name of the system 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.
- Optional options: SystemTopicEventSubscriptionsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, systemTopicName: string, eventSubscriptionName: string, options?: SystemTopicEventSubscriptionsDeleteOptionalParams): Promise<void>

- Defined in operationsInterfaces/systemTopicEventSubscriptions.ts:119
Delete an existing event subscription of a system topic.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- systemTopicName: string
  
  Name of the system 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.
- Optional options: SystemTopicEventSubscriptionsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(resourceGroupName: string, systemTopicName: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters, options?: SystemTopicEventSubscriptionsUpdateOptionalParams): Promise<PollerLike<PollOperationState<SystemTopicEventSubscriptionsUpdateResponse>, SystemTopicEventSubscriptionsUpdateResponse>>

- Defined in operationsInterfaces/systemTopicEventSubscriptions.ts:134
Update an existing event subscription of a system topic.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- systemTopicName: string
  
  Name of the system 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.
- eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters
  
  Updated event subscription information.
- Optional options: SystemTopicEventSubscriptionsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SystemTopicEventSubscriptionsUpdateResponse>, SystemTopicEventSubscriptionsUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, systemTopicName: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters, options?: SystemTopicEventSubscriptionsUpdateOptionalParams): Promise<SystemTopicEventSubscriptionsUpdateResponse>

- Defined in operationsInterfaces/systemTopicEventSubscriptions.ts:155
Update an existing event subscription of a system topic.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- systemTopicName: string
  
  Name of the system 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.
- eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters
  
  Updated event subscription information.
- Optional options: SystemTopicEventSubscriptionsUpdateOptionalParams
  
  The options parameters.
Returns Promise<SystemTopicEventSubscriptionsUpdateResponse>

get

get(resourceGroupName: string, systemTopicName: string, eventSubscriptionName: string, options?: SystemTopicEventSubscriptionsGetOptionalParams): Promise<SystemTopicEventSubscriptionsGetResponse>

- Defined in operationsInterfaces/systemTopicEventSubscriptions.ts:50
Get an event subscription.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- systemTopicName: string
  
  Name of the system 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.
- Optional options: SystemTopicEventSubscriptionsGetOptionalParams
  
  The options parameters.
Returns Promise<SystemTopicEventSubscriptionsGetResponse>

getDeliveryAttributes

getDeliveryAttributes(resourceGroupName: string, systemTopicName: string, eventSubscriptionName: string, options?: SystemTopicEventSubscriptionsGetDeliveryAttributesOptionalParams): Promise<SystemTopicEventSubscriptionsGetDeliveryAttributesResponse>

- Defined in operationsInterfaces/systemTopicEventSubscriptions.ts:184
Get all delivery attributes for an event subscription.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- systemTopicName: string
  
  Name of the system 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.
- Optional options: SystemTopicEventSubscriptionsGetDeliveryAttributesOptionalParams
  
  The options parameters.
Returns Promise<SystemTopicEventSubscriptionsGetDeliveryAttributesResponse>

getFullUrl

getFullUrl(resourceGroupName: string, systemTopicName: string, eventSubscriptionName: string, options?: SystemTopicEventSubscriptionsGetFullUrlOptionalParams): Promise<SystemTopicEventSubscriptionsGetFullUrlResponse>

- Defined in operationsInterfaces/systemTopicEventSubscriptions.ts:170
Get the full endpoint URL for an event subscription of a system topic.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- systemTopicName: string
  
  Name of the system 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.
- Optional options: SystemTopicEventSubscriptionsGetFullUrlOptionalParams
  
  The options parameters.
Returns Promise<SystemTopicEventSubscriptionsGetFullUrlResponse>

listBySystemTopic

listBySystemTopic(resourceGroupName: string, systemTopicName: string, options?: SystemTopicEventSubscriptionsListBySystemTopicOptionalParams): PagedAsyncIterableIterator<EventSubscription>

- Defined in operationsInterfaces/systemTopicEventSubscriptions.ts:37
List event subscriptions that belong to a specific system topic.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- systemTopicName: string
  
  Name of the system topic.
- Optional options: SystemTopicEventSubscriptionsListBySystemTopicOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<EventSubscription>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

systemTopicName: string

eventSubscriptionName: string

eventSubscriptionInfo: EventSubscription

Optional options: SystemTopicEventSubscriptionsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<SystemTopicEventSubscriptionsCreateOrUpdateResponse>, SystemTopicEventSubscriptionsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

systemTopicName: string

eventSubscriptionName: string

eventSubscriptionInfo: EventSubscription

Optional options: SystemTopicEventSubscriptionsCreateOrUpdateOptionalParams

Returns Promise<SystemTopicEventSubscriptionsCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

systemTopicName: string

eventSubscriptionName: string

Optional options: SystemTopicEventSubscriptionsDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

systemTopicName: string

eventSubscriptionName: string

Optional options: SystemTopicEventSubscriptionsDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

systemTopicName: string

eventSubscriptionName: string

eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters

Optional options: SystemTopicEventSubscriptionsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<SystemTopicEventSubscriptionsUpdateResponse>, SystemTopicEventSubscriptionsUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

systemTopicName: string

eventSubscriptionName: string

eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters

Optional options: SystemTopicEventSubscriptionsUpdateOptionalParams

Returns Promise<SystemTopicEventSubscriptionsUpdateResponse>

get

Parameters

resourceGroupName: string

systemTopicName: string

eventSubscriptionName: string

Optional options: SystemTopicEventSubscriptionsGetOptionalParams

Returns Promise<SystemTopicEventSubscriptionsGetResponse>

getDeliveryAttributes

Parameters

resourceGroupName: string

systemTopicName: string

eventSubscriptionName: string

Optional options: SystemTopicEventSubscriptionsGetDeliveryAttributesOptionalParams

Returns Promise<SystemTopicEventSubscriptionsGetDeliveryAttributesResponse>

getFullUrl

Parameters

resourceGroupName: string

systemTopicName: string

eventSubscriptionName: string

Optional options: SystemTopicEventSubscriptionsGetFullUrlOptionalParams

Returns Promise<SystemTopicEventSubscriptionsGetFullUrlResponse>

listBySystemTopic

Parameters

resourceGroupName: string

systemTopicName: string

Optional options: SystemTopicEventSubscriptionsListBySystemTopicOptionalParams

Returns PagedAsyncIterableIterator<EventSubscription>