PartnerTopicEventSubscriptions | @azure/arm-eventgrid

Interface representing a PartnerTopicEventSubscriptions.

Hierarchy

PartnerTopicEventSubscriptions

Implemented by

PartnerTopicEventSubscriptionsImpl

Index

Methods

beginCreateOrUpdate

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

- Defined in operationsInterfaces/partnerTopicEventSubscriptions.ts:67
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>

- Defined in operationsInterfaces/partnerTopicEventSubscriptions.ts:90
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>>

- Defined in operationsInterfaces/partnerTopicEventSubscriptions.ts:105
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>

- Defined in operationsInterfaces/partnerTopicEventSubscriptions.ts:119
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>>

- Defined in operationsInterfaces/partnerTopicEventSubscriptions.ts:134
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>

- Defined in operationsInterfaces/partnerTopicEventSubscriptions.ts:155
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>

- Defined in operationsInterfaces/partnerTopicEventSubscriptions.ts:50
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>

- Defined in operationsInterfaces/partnerTopicEventSubscriptions.ts:184
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>

- Defined in operationsInterfaces/partnerTopicEventSubscriptions.ts:170
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>

- Defined in operationsInterfaces/partnerTopicEventSubscriptions.ts:37
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

Implemented by

Index

Methods

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

resourceGroupName: string

partnerTopicName: string

Optional options: PartnerTopicEventSubscriptionsListByPartnerTopicOptionalParams

Returns PagedAsyncIterableIterator<EventSubscription>