PartnerTopicEventSubscriptionsImpl | @azure/arm-eventgrid

Class containing PartnerTopicEventSubscriptions operations.

Hierarchy

PartnerTopicEventSubscriptionsImpl

Implements

PartnerTopicEventSubscriptions

Index

Constructors

constructor

Methods

Constructors

constructor

new PartnerTopicEventSubscriptionsImpl(client: EventGridManagementClient): PartnerTopicEventSubscriptionsImpl

- Defined in operations/partnerTopicEventSubscriptions.ts:41
Initialize a new instance of the class PartnerTopicEventSubscriptions class.

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

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, partnerTopicName: string, eventSubscriptionName: string, eventSubscriptionInfo: EventSubscription, options?: PartnerTopicEventSubscriptionsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<PartnerTopicEventSubscriptionsCreateOrUpdateResponse>, PartnerTopicEventSubscriptionsCreateOrUpdateResponse>>

Implementation of PartnerTopicEventSubscriptions.beginCreateOrUpdate
- Defined in operations/partnerTopicEventSubscriptions.ts:153
Asynchronously creates or updates an event subscription of a partner topic 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.
- partnerTopicName: string
  
  Name of the partner 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: PartnerTopicEventSubscriptionsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<PartnerTopicEventSubscriptionsCreateOrUpdateResponse>, PartnerTopicEventSubscriptionsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, partnerTopicName: string, eventSubscriptionName: string, eventSubscriptionInfo: EventSubscription, options?: PartnerTopicEventSubscriptionsCreateOrUpdateOptionalParams): Promise<PartnerTopicEventSubscriptionsCreateOrUpdateResponse>

Implementation of PartnerTopicEventSubscriptions.beginCreateOrUpdateAndWait
- Defined in operations/partnerTopicEventSubscriptions.ts:234
Asynchronously creates or updates an event subscription of a partner topic 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.
- partnerTopicName: string
  
  Name of the partner 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: PartnerTopicEventSubscriptionsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PartnerTopicEventSubscriptionsCreateOrUpdateResponse>

beginDelete

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

Implementation of PartnerTopicEventSubscriptions.beginDelete
- Defined in operations/partnerTopicEventSubscriptions.ts:259
Delete an existing event subscription of a partner topic.

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

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, partnerTopicName: string, eventSubscriptionName: string, options?: PartnerTopicEventSubscriptionsDeleteOptionalParams): Promise<void>

Implementation of PartnerTopicEventSubscriptions.beginDeleteAndWait
- Defined in operations/partnerTopicEventSubscriptions.ts:325
Delete an existing event subscription of a partner topic.

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

beginUpdate

beginUpdate(resourceGroupName: string, partnerTopicName: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters, options?: PartnerTopicEventSubscriptionsUpdateOptionalParams): Promise<PollerLike<PollOperationState<PartnerTopicEventSubscriptionsUpdateResponse>, PartnerTopicEventSubscriptionsUpdateResponse>>

Implementation of PartnerTopicEventSubscriptions.beginUpdate
- Defined in operations/partnerTopicEventSubscriptions.ts:349
Update an existing event subscription of a partner topic.

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

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, partnerTopicName: string, eventSubscriptionName: string, eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters, options?: PartnerTopicEventSubscriptionsUpdateOptionalParams): Promise<PartnerTopicEventSubscriptionsUpdateResponse>

Implementation of PartnerTopicEventSubscriptions.beginUpdateAndWait
- Defined in operations/partnerTopicEventSubscriptions.ts:428
Update an existing event subscription of a partner topic.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- partnerTopicName: string
  
  Name of the partner 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: PartnerTopicEventSubscriptionsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PartnerTopicEventSubscriptionsUpdateResponse>

get

get(resourceGroupName: string, partnerTopicName: string, eventSubscriptionName: string, options?: PartnerTopicEventSubscriptionsGetOptionalParams): Promise<PartnerTopicEventSubscriptionsGetResponse>

Implementation of PartnerTopicEventSubscriptions.get
- Defined in operations/partnerTopicEventSubscriptions.ts:130
Get properties of an event subscription of a partner topic.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- partnerTopicName: 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: PartnerTopicEventSubscriptionsGetOptionalParams
  
  The options parameters.
Returns Promise<PartnerTopicEventSubscriptionsGetResponse>

getDeliveryAttributes

getDeliveryAttributes(resourceGroupName: string, partnerTopicName: string, eventSubscriptionName: string, options?: PartnerTopicEventSubscriptionsGetDeliveryAttributesOptionalParams): Promise<PartnerTopicEventSubscriptionsGetDeliveryAttributesResponse>

Implementation of PartnerTopicEventSubscriptions.getDeliveryAttributes
- Defined in operations/partnerTopicEventSubscriptions.ts:490
Get all delivery attributes for an event subscription of a partner topic.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- partnerTopicName: string
  
  Name of the partner 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: PartnerTopicEventSubscriptionsGetDeliveryAttributesOptionalParams
  
  The options parameters.
Returns Promise<PartnerTopicEventSubscriptionsGetDeliveryAttributesResponse>

getFullUrl

getFullUrl(resourceGroupName: string, partnerTopicName: string, eventSubscriptionName: string, options?: PartnerTopicEventSubscriptionsGetFullUrlOptionalParams): Promise<PartnerTopicEventSubscriptionsGetFullUrlResponse>

Implementation of PartnerTopicEventSubscriptions.getFullUrl
- Defined in operations/partnerTopicEventSubscriptions.ts:453
Get the full endpoint URL for an event subscription of a partner topic.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- partnerTopicName: string
  
  Name of the partner 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: PartnerTopicEventSubscriptionsGetFullUrlOptionalParams
  
  The options parameters.
Returns Promise<PartnerTopicEventSubscriptionsGetFullUrlResponse>

listByPartnerTopic

listByPartnerTopic(resourceGroupName: string, partnerTopicName: string, options?: PartnerTopicEventSubscriptionsListByPartnerTopicOptionalParams): PagedAsyncIterableIterator<EventSubscription>

Implementation of PartnerTopicEventSubscriptions.listByPartnerTopic
- Defined in operations/partnerTopicEventSubscriptions.ts:57
List event subscriptions that belong to a specific partner topic.

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

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: EventGridManagementClient

Returns PartnerTopicEventSubscriptionsImpl

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

partnerTopicName: string

eventSubscriptionName: string

eventSubscriptionInfo: EventSubscription

Optional options: PartnerTopicEventSubscriptionsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<PartnerTopicEventSubscriptionsCreateOrUpdateResponse>, PartnerTopicEventSubscriptionsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

partnerTopicName: string

eventSubscriptionName: string

eventSubscriptionInfo: EventSubscription

Optional options: PartnerTopicEventSubscriptionsCreateOrUpdateOptionalParams

Returns Promise<PartnerTopicEventSubscriptionsCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

partnerTopicName: string

eventSubscriptionName: string

Optional options: PartnerTopicEventSubscriptionsDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

partnerTopicName: string

eventSubscriptionName: string

Optional options: PartnerTopicEventSubscriptionsDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

partnerTopicName: string

eventSubscriptionName: string

eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters

Optional options: PartnerTopicEventSubscriptionsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<PartnerTopicEventSubscriptionsUpdateResponse>, PartnerTopicEventSubscriptionsUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

partnerTopicName: string

eventSubscriptionName: string

eventSubscriptionUpdateParameters: EventSubscriptionUpdateParameters

Optional options: PartnerTopicEventSubscriptionsUpdateOptionalParams

Returns Promise<PartnerTopicEventSubscriptionsUpdateResponse>

get

Parameters

resourceGroupName: string

partnerTopicName: string

eventSubscriptionName: string

Optional options: PartnerTopicEventSubscriptionsGetOptionalParams

Returns Promise<PartnerTopicEventSubscriptionsGetResponse>

getDeliveryAttributes

Parameters

resourceGroupName: string

partnerTopicName: string

eventSubscriptionName: string

Optional options: PartnerTopicEventSubscriptionsGetDeliveryAttributesOptionalParams

Returns Promise<PartnerTopicEventSubscriptionsGetDeliveryAttributesResponse>

getFullUrl

Parameters

resourceGroupName: string

partnerTopicName: string

eventSubscriptionName: string

Optional options: PartnerTopicEventSubscriptionsGetFullUrlOptionalParams

Returns Promise<PartnerTopicEventSubscriptionsGetFullUrlResponse>

listByPartnerTopic

Parameters