PartnerTopicsImpl | @azure/arm-eventgrid

Class containing PartnerTopics operations.

Hierarchy

PartnerTopicsImpl

Implements

PartnerTopics

Index

Constructors

constructor

Methods

Constructors

constructor

new PartnerTopicsImpl(client: EventGridManagementClient): PartnerTopicsImpl

- Defined in operations/partnerTopics.ts:44
Initialize a new instance of the class PartnerTopics class.

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

Methods

activate

activate(resourceGroupName: string, partnerTopicName: string, options?: PartnerTopicsActivateOptionalParams): Promise<PartnerTopicsActivateResponse>

Implementation of PartnerTopics.activate
- Defined in operations/partnerTopics.ts:325
Activate a newly created 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: PartnerTopicsActivateOptionalParams
  
  The options parameters.
Returns Promise<PartnerTopicsActivateResponse>

beginDelete

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

Implementation of PartnerTopics.beginDelete
- Defined in operations/partnerTopics.ts:191
Delete existing 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: PartnerTopicsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

Implementation of PartnerTopics.beginDeleteAndWait
- Defined in operations/partnerTopics.ts:254
Delete existing 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: PartnerTopicsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

createOrUpdate

createOrUpdate(resourceGroupName: string, partnerTopicName: string, partnerTopicInfo: PartnerTopic, options?: PartnerTopicsCreateOrUpdateOptionalParams): Promise<PartnerTopicsCreateOrUpdateResponse>

Implementation of PartnerTopics.createOrUpdate
- Defined in operations/partnerTopics.ts:173
Asynchronously creates a new partner topic with the specified parameters.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- partnerTopicName: string
  
  Name of the partner topic.
- partnerTopicInfo: PartnerTopic
  
  Partner Topic information.
- Optional options: PartnerTopicsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PartnerTopicsCreateOrUpdateResponse>

deactivate

deactivate(resourceGroupName: string, partnerTopicName: string, options?: PartnerTopicsDeactivateOptionalParams): Promise<PartnerTopicsDeactivateResponse>

Implementation of PartnerTopics.deactivate
- Defined in operations/partnerTopics.ts:342
Deactivate 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: PartnerTopicsDeactivateOptionalParams
  
  The options parameters.
Returns Promise<PartnerTopicsDeactivateResponse>

get

get(resourceGroupName: string, partnerTopicName: string, options?: PartnerTopicsGetOptionalParams): Promise<PartnerTopicsGetResponse>

Implementation of PartnerTopics.get
- Defined in operations/partnerTopics.ts:155
Get properties 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.
- Optional options: PartnerTopicsGetOptionalParams
  
  The options parameters.
Returns Promise<PartnerTopicsGetResponse>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: PartnerTopicsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<PartnerTopic>

Implementation of PartnerTopics.listByResourceGroup
- Defined in operations/partnerTopics.ts:101
List all the partner topics under a resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- Optional options: PartnerTopicsListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<PartnerTopic>

listBySubscription

listBySubscription(options?: PartnerTopicsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<PartnerTopic>

Implementation of PartnerTopics.listBySubscription
- Defined in operations/partnerTopics.ts:58
List all the partner topics under an Azure subscription.

Parameters
- Optional options: PartnerTopicsListBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<PartnerTopic>

update

update(resourceGroupName: string, partnerTopicName: string, partnerTopicUpdateParameters: PartnerTopicUpdateParameters, options?: PartnerTopicsUpdateOptionalParams): Promise<PartnerTopicsUpdateResponse>

Implementation of PartnerTopics.update
- Defined in operations/partnerTopics.ts:274
Asynchronously updates a partner topic with the specified parameters.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- partnerTopicName: string
  
  Name of the partner topic.
- partnerTopicUpdateParameters: PartnerTopicUpdateParameters
  
  PartnerTopic update information.
- Optional options: PartnerTopicsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PartnerTopicsUpdateResponse>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: EventGridManagementClient

Returns PartnerTopicsImpl

Methods

activate

Parameters

resourceGroupName: string

partnerTopicName: string

Optional options: PartnerTopicsActivateOptionalParams

Returns Promise<PartnerTopicsActivateResponse>

beginDelete

Parameters

resourceGroupName: string

partnerTopicName: string

Optional options: PartnerTopicsDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

partnerTopicName: string

Optional options: PartnerTopicsDeleteOptionalParams

Returns Promise<void>

createOrUpdate

Parameters

resourceGroupName: string

partnerTopicName: string

partnerTopicInfo: PartnerTopic

Optional options: PartnerTopicsCreateOrUpdateOptionalParams

Returns Promise<PartnerTopicsCreateOrUpdateResponse>

deactivate

Parameters

resourceGroupName: string

partnerTopicName: string

Optional options: PartnerTopicsDeactivateOptionalParams

Returns Promise<PartnerTopicsDeactivateResponse>

get

Parameters

resourceGroupName: string

partnerTopicName: string

Optional options: PartnerTopicsGetOptionalParams

Returns Promise<PartnerTopicsGetResponse>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: PartnerTopicsListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<PartnerTopic>

listBySubscription

Parameters

Optional options: PartnerTopicsListBySubscriptionOptionalParams

Returns PagedAsyncIterableIterator<PartnerTopic>

update

Parameters

resourceGroupName: string

partnerTopicName: string

partnerTopicUpdateParameters: PartnerTopicUpdateParameters

Optional options: PartnerTopicsUpdateOptionalParams

Returns Promise<PartnerTopicsUpdateResponse>