PartnerTopics interface

Package:

@azure/arm-eventgrid

Interface representing a PartnerTopics.

Methods

activate(string, string, PartnerTopicsActivateOptionalParams)	Activate a newly created partner topic.
beginDelete(string, string, PartnerTopicsDeleteOptionalParams)	Delete existing partner topic.
beginDeleteAndWait(string, string, PartnerTopicsDeleteOptionalParams)	Delete existing partner topic.
createOrUpdate(string, string, PartnerTopic, PartnerTopicsCreateOrUpdateOptionalParams)	Asynchronously creates a new partner topic with the specified parameters.
deactivate(string, string, PartnerTopicsDeactivateOptionalParams)	Deactivate specific partner topic.
get(string, string, PartnerTopicsGetOptionalParams)	Get properties of a partner topic.
listByResourceGroup(string, PartnerTopicsListByResourceGroupOptionalParams)	List all the partner topics under a resource group.
listBySubscription(PartnerTopicsListBySubscriptionOptionalParams)	List all the partner topics under an Azure subscription.
update(string, string, PartnerTopicUpdateParameters, PartnerTopicsUpdateOptionalParams)	Asynchronously updates a partner topic with the specified parameters.

Method Details

activate(string, string, PartnerTopicsActivateOptionalParams)

Activate a newly created partner topic.

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

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

partnerTopicName

string

Name of the partner topic.

options

PartnerTopicsActivateOptionalParams

The options parameters.

Returns

Promise<PartnerTopic>

beginDelete(string, string, PartnerTopicsDeleteOptionalParams)

Delete existing partner topic.

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

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

partnerTopicName

string

Name of the partner topic.

options

PartnerTopicsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, PartnerTopicsDeleteOptionalParams)

Delete existing partner topic.

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

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

partnerTopicName

string

Name of the partner topic.

options

PartnerTopicsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

createOrUpdate(string, string, PartnerTopic, PartnerTopicsCreateOrUpdateOptionalParams)

Asynchronously creates a new partner topic with the specified parameters.

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

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.

options

PartnerTopicsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PartnerTopic>

deactivate(string, string, PartnerTopicsDeactivateOptionalParams)

Deactivate specific partner topic.

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

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

partnerTopicName

string

Name of the partner topic.

options

PartnerTopicsDeactivateOptionalParams

The options parameters.

Returns

Promise<PartnerTopic>

get(string, string, PartnerTopicsGetOptionalParams)

Get properties of a partner topic.

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

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

partnerTopicName

string

Name of the partner topic.

options

PartnerTopicsGetOptionalParams

The options parameters.

Returns

Promise<PartnerTopic>

listByResourceGroup(string, PartnerTopicsListByResourceGroupOptionalParams)

List all the partner topics under a resource group.

function listByResourceGroup(resourceGroupName: string, options?: PartnerTopicsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<PartnerTopic, PartnerTopic[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

options

PartnerTopicsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PartnerTopic, PartnerTopic[], PageSettings>

listBySubscription(PartnerTopicsListBySubscriptionOptionalParams)

List all the partner topics under an Azure subscription.

function listBySubscription(options?: PartnerTopicsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<PartnerTopic, PartnerTopic[], PageSettings>

Parameters

options

PartnerTopicsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PartnerTopic, PartnerTopic[], PageSettings>

update(string, string, PartnerTopicUpdateParameters, PartnerTopicsUpdateOptionalParams)

Asynchronously updates a partner topic with the specified parameters.

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

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.

options

PartnerTopicsUpdateOptionalParams

The options parameters.

Returns

Promise<PartnerTopic>