PartnerConfigurations interface

Package:

@azure/arm-eventgrid

Interface representing a PartnerConfigurations.

Methods

authorizePartner(string, Partner, PartnerConfigurationsAuthorizePartnerOptionalParams)	Authorize a single partner either by partner registration immutable Id or by partner name.
beginCreateOrUpdate(string, PartnerConfiguration, PartnerConfigurationsCreateOrUpdateOptionalParams)	Synchronously creates or updates a partner configuration with the specified parameters.
beginCreateOrUpdateAndWait(string, PartnerConfiguration, PartnerConfigurationsCreateOrUpdateOptionalParams)	Synchronously creates or updates a partner configuration with the specified parameters.
beginDelete(string, PartnerConfigurationsDeleteOptionalParams)	Delete existing partner configuration.
beginDeleteAndWait(string, PartnerConfigurationsDeleteOptionalParams)	Delete existing partner configuration.
beginUpdate(string, PartnerConfigurationUpdateParameters, PartnerConfigurationsUpdateOptionalParams)	Synchronously updates a partner configuration with the specified parameters.
beginUpdateAndWait(string, PartnerConfigurationUpdateParameters, PartnerConfigurationsUpdateOptionalParams)	Synchronously updates a partner configuration with the specified parameters.
get(string, PartnerConfigurationsGetOptionalParams)	Get properties of a partner configuration.
listByResourceGroup(string, PartnerConfigurationsListByResourceGroupOptionalParams)	List all the partner configurations under a resource group.
listBySubscription(PartnerConfigurationsListBySubscriptionOptionalParams)	List all the partner configurations under an Azure subscription.
unauthorizePartner(string, Partner, PartnerConfigurationsUnauthorizePartnerOptionalParams)	Unauthorize a single partner either by partner registration immutable Id or by partner name.

Method Details

authorizePartner(string, Partner, PartnerConfigurationsAuthorizePartnerOptionalParams)

Authorize a single partner either by partner registration immutable Id or by partner name.

function authorizePartner(resourceGroupName: string, partnerInfo: Partner, options?: PartnerConfigurationsAuthorizePartnerOptionalParams): Promise<PartnerConfiguration>

Parameters

resourceGroupName

string

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

partnerInfo

Partner

The information of the partner to be authorized.

options

PartnerConfigurationsAuthorizePartnerOptionalParams

The options parameters.

Returns

Promise<PartnerConfiguration>

beginCreateOrUpdate(string, PartnerConfiguration, PartnerConfigurationsCreateOrUpdateOptionalParams)

Synchronously creates or updates a partner configuration with the specified parameters.

function beginCreateOrUpdate(resourceGroupName: string, partnerConfigurationInfo: PartnerConfiguration, options?: PartnerConfigurationsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<PartnerConfiguration>, PartnerConfiguration>>

Parameters

resourceGroupName

string

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

partnerConfigurationInfo

PartnerConfiguration

Partner configuration information.

options

PartnerConfigurationsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, PartnerConfiguration, PartnerConfigurationsCreateOrUpdateOptionalParams)

Synchronously creates or updates a partner configuration with the specified parameters.

function beginCreateOrUpdateAndWait(resourceGroupName: string, partnerConfigurationInfo: PartnerConfiguration, options?: PartnerConfigurationsCreateOrUpdateOptionalParams): Promise<PartnerConfiguration>

Parameters

resourceGroupName

string

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

partnerConfigurationInfo

PartnerConfiguration

Partner configuration information.

options

PartnerConfigurationsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PartnerConfiguration>

beginDelete(string, PartnerConfigurationsDeleteOptionalParams)

Delete existing partner configuration.

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

Parameters

resourceGroupName

string

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

options

PartnerConfigurationsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, PartnerConfigurationsDeleteOptionalParams)

Delete existing partner configuration.

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

Parameters

resourceGroupName

string

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

options

PartnerConfigurationsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, PartnerConfigurationUpdateParameters, PartnerConfigurationsUpdateOptionalParams)

Synchronously updates a partner configuration with the specified parameters.

function beginUpdate(resourceGroupName: string, partnerConfigurationUpdateParameters: PartnerConfigurationUpdateParameters, options?: PartnerConfigurationsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<PartnerConfiguration>, PartnerConfiguration>>

Parameters

resourceGroupName

string

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

partnerConfigurationUpdateParameters

PartnerConfigurationUpdateParameters

Partner configuration update information.

options

PartnerConfigurationsUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, PartnerConfigurationUpdateParameters, PartnerConfigurationsUpdateOptionalParams)

Synchronously updates a partner configuration with the specified parameters.

function beginUpdateAndWait(resourceGroupName: string, partnerConfigurationUpdateParameters: PartnerConfigurationUpdateParameters, options?: PartnerConfigurationsUpdateOptionalParams): Promise<PartnerConfiguration>

Parameters

resourceGroupName

string

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

partnerConfigurationUpdateParameters

PartnerConfigurationUpdateParameters

Partner configuration update information.

options

PartnerConfigurationsUpdateOptionalParams

The options parameters.

Returns

Promise<PartnerConfiguration>

get(string, PartnerConfigurationsGetOptionalParams)

Get properties of a partner configuration.

function get(resourceGroupName: string, options?: PartnerConfigurationsGetOptionalParams): Promise<PartnerConfiguration>

Parameters

resourceGroupName

string

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

options

PartnerConfigurationsGetOptionalParams

The options parameters.

Returns

Promise<PartnerConfiguration>

listByResourceGroup(string, PartnerConfigurationsListByResourceGroupOptionalParams)

List all the partner configurations under a resource group.

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

Parameters

resourceGroupName

string

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

options

PartnerConfigurationsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PartnerConfiguration, PartnerConfiguration[], PageSettings>

listBySubscription(PartnerConfigurationsListBySubscriptionOptionalParams)

List all the partner configurations under an Azure subscription.

function listBySubscription(options?: PartnerConfigurationsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<PartnerConfiguration, PartnerConfiguration[], PageSettings>

Parameters

options

PartnerConfigurationsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PartnerConfiguration, PartnerConfiguration[], PageSettings>

unauthorizePartner(string, Partner, PartnerConfigurationsUnauthorizePartnerOptionalParams)

Unauthorize a single partner either by partner registration immutable Id or by partner name.

function unauthorizePartner(resourceGroupName: string, partnerInfo: Partner, options?: PartnerConfigurationsUnauthorizePartnerOptionalParams): Promise<PartnerConfiguration>

Parameters

resourceGroupName

string

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

partnerInfo

Partner

The information of the partner to be unauthorized.

options

PartnerConfigurationsUnauthorizePartnerOptionalParams

The options parameters.

Returns

Promise<PartnerConfiguration>