PartnerDestinations | @azure/arm-eventgrid

Interface representing a PartnerDestinations.

Hierarchy

PartnerDestinations

Implemented by

PartnerDestinationsImpl

Index

Methods

activate

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

- Defined in operationsInterfaces/partnerDestinations.ts:111
Activate a newly created partner destination.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- partnerDestinationName: string
  
  Name of the partner destination.
- Optional options: PartnerDestinationsActivateOptionalParams
  
  The options parameters.
Returns Promise<PartnerDestinationsActivateResponse>

beginDelete

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

- Defined in operationsInterfaces/partnerDestinations.ts:76
Delete existing partner destination.

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

beginDeleteAndWait

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

- Defined in operationsInterfaces/partnerDestinations.ts:87
Delete existing partner destination.

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

createOrUpdate

createOrUpdate(resourceGroupName: string, partnerDestinationName: string, partnerDestination: PartnerDestination, options?: PartnerDestinationsCreateOrUpdateOptionalParams): Promise<PartnerDestinationsCreateOrUpdateResponse>

- Defined in operationsInterfaces/partnerDestinations.ts:64
Asynchronously creates a new partner destination with the specified parameters.

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.
- Optional options: PartnerDestinationsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PartnerDestinationsCreateOrUpdateResponse>

get

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

- Defined in operationsInterfaces/partnerDestinations.ts:52
Get properties of a partner destination.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- partnerDestinationName: string
  
  Name of the partner destination.
- Optional options: PartnerDestinationsGetOptionalParams
  
  The options parameters.
Returns Promise<PartnerDestinationsGetResponse>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: PartnerDestinationsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<PartnerDestination>

- Defined in operationsInterfaces/partnerDestinations.ts:42
List all the partner destinations under a resource group.

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

listBySubscription

listBySubscription(options?: PartnerDestinationsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<PartnerDestination>

- Defined in operationsInterfaces/partnerDestinations.ts:34
List all the partner destinations under an Azure subscription.

Parameters
- Optional options: PartnerDestinationsListBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<PartnerDestination>

update

update(resourceGroupName: string, partnerDestinationName: string, partnerDestinationUpdateParameters: PartnerDestinationUpdateParameters, options?: PartnerDestinationsUpdateOptionalParams): Promise<PartnerDestinationsUpdateResponse>

- Defined in operationsInterfaces/partnerDestinations.ts:99
Asynchronously updates a partner destination with the specified parameters.

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.
- Optional options: PartnerDestinationsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PartnerDestinationsUpdateResponse>

Hierarchy

Implemented by

Index

Methods

Methods

activate

Parameters

resourceGroupName: string

partnerDestinationName: string

Optional options: PartnerDestinationsActivateOptionalParams

Returns Promise<PartnerDestinationsActivateResponse>

beginDelete

Parameters

resourceGroupName: string

partnerDestinationName: string

Optional options: PartnerDestinationsDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

partnerDestinationName: string

Optional options: PartnerDestinationsDeleteOptionalParams

Returns Promise<void>

createOrUpdate

Parameters

resourceGroupName: string

partnerDestinationName: string

partnerDestination: PartnerDestination

Optional options: PartnerDestinationsCreateOrUpdateOptionalParams

Returns Promise<PartnerDestinationsCreateOrUpdateResponse>

get

Parameters

resourceGroupName: string

partnerDestinationName: string

Optional options: PartnerDestinationsGetOptionalParams

Returns Promise<PartnerDestinationsGetResponse>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: PartnerDestinationsListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<PartnerDestination>

listBySubscription

Parameters

Optional options: PartnerDestinationsListBySubscriptionOptionalParams

Returns PagedAsyncIterableIterator<PartnerDestination>

update

Parameters

resourceGroupName: string

partnerDestinationName: string

partnerDestinationUpdateParameters: PartnerDestinationUpdateParameters

Optional options: PartnerDestinationsUpdateOptionalParams

Returns Promise<PartnerDestinationsUpdateResponse>