PartnerConfigurations | @azure/arm-eventgrid

Interface representing a PartnerConfigurations.

Hierarchy

PartnerConfigurations

Implemented by

PartnerConfigurationsImpl

Index

Methods

authorizePartner

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

- Defined in operationsInterfaces/partnerConfigurations.ts:136
Authorize a single partner either by partner registration immutable Id or by partner name.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- partnerInfo: Partner
  
  The information of the partner to be authorized.
- Optional options: PartnerConfigurationsAuthorizePartnerOptionalParams
  
  The options parameters.
Returns Promise<PartnerConfigurationsAuthorizePartnerResponse>

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, partnerConfigurationInfo: PartnerConfiguration, options?: PartnerConfigurationsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<PartnerConfigurationsCreateOrUpdateResponse>, PartnerConfigurationsCreateOrUpdateResponse>>

- Defined in operationsInterfaces/partnerConfigurations.ts:64
Synchronously creates or updates a partner configuration with the specified parameters.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- partnerConfigurationInfo: PartnerConfiguration
  
  Partner configuration information.
- Optional options: PartnerConfigurationsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<PartnerConfigurationsCreateOrUpdateResponse>, PartnerConfigurationsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

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

- Defined in operationsInterfaces/partnerConfigurations.ts:80
Synchronously creates or updates a partner configuration with the specified parameters.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- partnerConfigurationInfo: PartnerConfiguration
  
  Partner configuration information.
- Optional options: PartnerConfigurationsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PartnerConfigurationsCreateOrUpdateResponse>

beginDelete

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

- Defined in operationsInterfaces/partnerConfigurations.ts:90
Delete existing partner configuration.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- Optional options: PartnerConfigurationsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

- Defined in operationsInterfaces/partnerConfigurations.ts:99
Delete existing partner configuration.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- Optional options: PartnerConfigurationsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(resourceGroupName: string, partnerConfigurationUpdateParameters: PartnerConfigurationUpdateParameters, options?: PartnerConfigurationsUpdateOptionalParams): Promise<PollerLike<PollOperationState<PartnerConfigurationsUpdateResponse>, PartnerConfigurationsUpdateResponse>>

- Defined in operationsInterfaces/partnerConfigurations.ts:109
Synchronously updates a partner configuration with the specified parameters.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- partnerConfigurationUpdateParameters: PartnerConfigurationUpdateParameters
  
  Partner configuration update information.
- Optional options: PartnerConfigurationsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<PartnerConfigurationsUpdateResponse>, PartnerConfigurationsUpdateResponse>>

beginUpdateAndWait

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

- Defined in operationsInterfaces/partnerConfigurations.ts:125
Synchronously updates a partner configuration with the specified parameters.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- partnerConfigurationUpdateParameters: PartnerConfigurationUpdateParameters
  
  Partner configuration update information.
- Optional options: PartnerConfigurationsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PartnerConfigurationsUpdateResponse>

get

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

- Defined in operationsInterfaces/partnerConfigurations.ts:54
Get properties of a partner configuration.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- Optional options: PartnerConfigurationsGetOptionalParams
  
  The options parameters.
Returns Promise<PartnerConfigurationsGetResponse>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: PartnerConfigurationsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<PartnerConfiguration>

- Defined in operationsInterfaces/partnerConfigurations.ts:38
List all the partner configurations under a resource group.

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

listBySubscription

listBySubscription(options?: PartnerConfigurationsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<PartnerConfiguration>

- Defined in operationsInterfaces/partnerConfigurations.ts:46
List all the partner configurations under an Azure subscription.

Parameters
- Optional options: PartnerConfigurationsListBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<PartnerConfiguration>

unauthorizePartner

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

- Defined in operationsInterfaces/partnerConfigurations.ts:147
Unauthorize a single partner either by partner registration immutable Id or by partner name.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- partnerInfo: Partner
  
  The information of the partner to be unauthorized.
- Optional options: PartnerConfigurationsUnauthorizePartnerOptionalParams
  
  The options parameters.
Returns Promise<PartnerConfigurationsUnauthorizePartnerResponse>

Hierarchy

Implemented by

Index

Methods

Methods

authorizePartner

Parameters

resourceGroupName: string

partnerInfo: Partner

Optional options: PartnerConfigurationsAuthorizePartnerOptionalParams

Returns Promise<PartnerConfigurationsAuthorizePartnerResponse>

beginCreateOrUpdate

Parameters

resourceGroupName: string

partnerConfigurationInfo: PartnerConfiguration

Optional options: PartnerConfigurationsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<PartnerConfigurationsCreateOrUpdateResponse>, PartnerConfigurationsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

partnerConfigurationInfo: PartnerConfiguration

Optional options: PartnerConfigurationsCreateOrUpdateOptionalParams

Returns Promise<PartnerConfigurationsCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

Optional options: PartnerConfigurationsDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

Optional options: PartnerConfigurationsDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

partnerConfigurationUpdateParameters: PartnerConfigurationUpdateParameters

Optional options: PartnerConfigurationsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<PartnerConfigurationsUpdateResponse>, PartnerConfigurationsUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

partnerConfigurationUpdateParameters: PartnerConfigurationUpdateParameters

Optional options: PartnerConfigurationsUpdateOptionalParams

Returns Promise<PartnerConfigurationsUpdateResponse>

get

Parameters

resourceGroupName: string

Optional options: PartnerConfigurationsGetOptionalParams

Returns Promise<PartnerConfigurationsGetResponse>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: PartnerConfigurationsListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<PartnerConfiguration>

listBySubscription

Parameters

Optional options: PartnerConfigurationsListBySubscriptionOptionalParams

Returns PagedAsyncIterableIterator<PartnerConfiguration>

unauthorizePartner

Parameters

resourceGroupName: string

partnerInfo: Partner

Optional options: PartnerConfigurationsUnauthorizePartnerOptionalParams

Returns Promise<PartnerConfigurationsUnauthorizePartnerResponse>