PartnerDestinations interface

Package:

@azure/arm-eventgrid

Interface representing a PartnerDestinations.

Methods

activate(string, string, PartnerDestinationsActivateOptionalParams)	Activate a newly created partner destination.
beginCreateOrUpdate(string, string, PartnerDestination, PartnerDestinationsCreateOrUpdateOptionalParams)	Asynchronously creates a new partner destination with the specified parameters.
beginCreateOrUpdateAndWait(string, string, PartnerDestination, PartnerDestinationsCreateOrUpdateOptionalParams)	Asynchronously creates a new partner destination with the specified parameters.
beginDelete(string, string, PartnerDestinationsDeleteOptionalParams)	Delete existing partner destination.
beginDeleteAndWait(string, string, PartnerDestinationsDeleteOptionalParams)	Delete existing partner destination.
beginUpdate(string, string, PartnerDestinationUpdateParameters, PartnerDestinationsUpdateOptionalParams)	Asynchronously updates a partner destination with the specified parameters.
beginUpdateAndWait(string, string, PartnerDestinationUpdateParameters, PartnerDestinationsUpdateOptionalParams)	Asynchronously updates a partner destination with the specified parameters.
get(string, string, PartnerDestinationsGetOptionalParams)	Get properties of a partner destination.
listByResourceGroup(string, PartnerDestinationsListByResourceGroupOptionalParams)	List all the partner destinations under a resource group.
listBySubscription(PartnerDestinationsListBySubscriptionOptionalParams)	List all the partner destinations under an Azure subscription.

Method Details

activate(string, string, PartnerDestinationsActivateOptionalParams)

Activate a newly created partner destination.

function activate(resourceGroupName: string, partnerDestinationName: string, options?: PartnerDestinationsActivateOptionalParams): Promise<PartnerDestination>

Parameters

resourceGroupName

string

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

partnerDestinationName

string

Name of the partner destination.

options

PartnerDestinationsActivateOptionalParams

The options parameters.

Returns

Promise<PartnerDestination>

beginCreateOrUpdate(string, string, PartnerDestination, PartnerDestinationsCreateOrUpdateOptionalParams)

Asynchronously creates a new partner destination with the specified parameters.

function beginCreateOrUpdate(resourceGroupName: string, partnerDestinationName: string, partnerDestination: PartnerDestination, options?: PartnerDestinationsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<PartnerDestination>, PartnerDestination>>

Parameters

resourceGroupName

string

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

partnerDestinationName

string

Name of the partner destination.

partnerDestination

PartnerDestination

Partner destination create information.

options

PartnerDestinationsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<PartnerDestination>, PartnerDestination>>

beginCreateOrUpdateAndWait(string, string, PartnerDestination, PartnerDestinationsCreateOrUpdateOptionalParams)

Asynchronously creates a new partner destination with the specified parameters.

function beginCreateOrUpdateAndWait(resourceGroupName: string, partnerDestinationName: string, partnerDestination: PartnerDestination, options?: PartnerDestinationsCreateOrUpdateOptionalParams): Promise<PartnerDestination>

Parameters

resourceGroupName

string

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

partnerDestinationName

string

Name of the partner destination.

partnerDestination

PartnerDestination

Partner destination create information.

options

PartnerDestinationsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PartnerDestination>

beginDelete(string, string, PartnerDestinationsDeleteOptionalParams)

Delete existing partner destination.

function beginDelete(resourceGroupName: string, partnerDestinationName: string, options?: PartnerDestinationsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

partnerDestinationName

string

Name of the partner destination.

options

PartnerDestinationsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, PartnerDestinationsDeleteOptionalParams)

Delete existing partner destination.

function beginDeleteAndWait(resourceGroupName: string, partnerDestinationName: string, options?: PartnerDestinationsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

partnerDestinationName

string

Name of the partner destination.

options

PartnerDestinationsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, PartnerDestinationUpdateParameters, PartnerDestinationsUpdateOptionalParams)

Asynchronously updates a partner destination with the specified parameters.

function beginUpdate(resourceGroupName: string, partnerDestinationName: string, partnerDestinationUpdateParameters: PartnerDestinationUpdateParameters, options?: PartnerDestinationsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<PartnerDestination>, PartnerDestination>>

Parameters

resourceGroupName

string

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

partnerDestinationName

string

Name of the partner destination.

partnerDestinationUpdateParameters

PartnerDestinationUpdateParameters

Partner destination update information.

options

PartnerDestinationsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<PartnerDestination>, PartnerDestination>>

beginUpdateAndWait(string, string, PartnerDestinationUpdateParameters, PartnerDestinationsUpdateOptionalParams)

Asynchronously updates a partner destination with the specified parameters.

function beginUpdateAndWait(resourceGroupName: string, partnerDestinationName: string, partnerDestinationUpdateParameters: PartnerDestinationUpdateParameters, options?: PartnerDestinationsUpdateOptionalParams): Promise<PartnerDestination>

Parameters

resourceGroupName

string

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

partnerDestinationName

string

Name of the partner destination.

partnerDestinationUpdateParameters

PartnerDestinationUpdateParameters

Partner destination update information.

options

PartnerDestinationsUpdateOptionalParams

The options parameters.

Returns

Promise<PartnerDestination>

get(string, string, PartnerDestinationsGetOptionalParams)

Get properties of a partner destination.

function get(resourceGroupName: string, partnerDestinationName: string, options?: PartnerDestinationsGetOptionalParams): Promise<PartnerDestination>

Parameters

resourceGroupName

string

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

partnerDestinationName

string

Name of the partner destination.

options

PartnerDestinationsGetOptionalParams

The options parameters.

Returns

Promise<PartnerDestination>

listByResourceGroup(string, PartnerDestinationsListByResourceGroupOptionalParams)

List all the partner destinations under a resource group.

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

Parameters

resourceGroupName

string

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

options

PartnerDestinationsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PartnerDestination, PartnerDestination[], PageSettings>

listBySubscription(PartnerDestinationsListBySubscriptionOptionalParams)

List all the partner destinations under an Azure subscription.

function listBySubscription(options?: PartnerDestinationsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<PartnerDestination, PartnerDestination[], PageSettings>

Parameters

options

PartnerDestinationsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PartnerDestination, PartnerDestination[], PageSettings>