EventChannels | @azure/arm-eventgrid

Interface representing a EventChannels.

Hierarchy

EventChannels

Implemented by

EventChannelsImpl

Index

Methods

beginDelete

beginDelete(resourceGroupName: string, partnerNamespaceName: string, eventChannelName: string, options?: EventChannelsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/eventChannels.ts:70
Delete existing event channel.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- partnerNamespaceName: string
  
  Name of the partner namespace.
- eventChannelName: string
  
  Name of the event channel.
- Optional options: EventChannelsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, partnerNamespaceName: string, eventChannelName: string, options?: EventChannelsDeleteOptionalParams): Promise<void>

- Defined in operationsInterfaces/eventChannels.ts:83
Delete existing event channel.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- partnerNamespaceName: string
  
  Name of the partner namespace.
- eventChannelName: string
  
  Name of the event channel.
- Optional options: EventChannelsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

createOrUpdate

createOrUpdate(resourceGroupName: string, partnerNamespaceName: string, eventChannelName: string, eventChannelInfo: EventChannel, options?: EventChannelsCreateOrUpdateOptionalParams): Promise<EventChannelsCreateOrUpdateResponse>

- Defined in operationsInterfaces/eventChannels.ts:56
Asynchronously creates a new event channel with the specified parameters.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- partnerNamespaceName: string
  
  Name of the partner namespace.
- eventChannelName: string
  
  Name of the event channel.
- eventChannelInfo: EventChannel
  
  EventChannel information.
- Optional options: EventChannelsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<EventChannelsCreateOrUpdateResponse>

get

get(resourceGroupName: string, partnerNamespaceName: string, eventChannelName: string, options?: EventChannelsGetOptionalParams): Promise<EventChannelsGetResponse>

- Defined in operationsInterfaces/eventChannels.ts:42
Get properties of an event channel.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- partnerNamespaceName: string
  
  Name of the partner namespace.
- eventChannelName: string
  
  Name of the event channel.
- Optional options: EventChannelsGetOptionalParams
  
  The options parameters.
Returns Promise<EventChannelsGetResponse>

listByPartnerNamespace

listByPartnerNamespace(resourceGroupName: string, partnerNamespaceName: string, options?: EventChannelsListByPartnerNamespaceOptionalParams): PagedAsyncIterableIterator<EventChannel>

- Defined in operationsInterfaces/eventChannels.ts:30
List all the event channels in a partner namespace.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- partnerNamespaceName: string
  
  Name of the partner namespace.
- Optional options: EventChannelsListByPartnerNamespaceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<EventChannel>

Hierarchy

Implemented by

Index

Methods

Methods

beginDelete

Parameters

resourceGroupName: string

partnerNamespaceName: string

eventChannelName: string

Optional options: EventChannelsDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

partnerNamespaceName: string

eventChannelName: string

Optional options: EventChannelsDeleteOptionalParams

Returns Promise<void>

createOrUpdate

Parameters

resourceGroupName: string

partnerNamespaceName: string

eventChannelName: string

eventChannelInfo: EventChannel

Optional options: EventChannelsCreateOrUpdateOptionalParams

Returns Promise<EventChannelsCreateOrUpdateResponse>

get

Parameters

resourceGroupName: string

partnerNamespaceName: string

eventChannelName: string

Optional options: EventChannelsGetOptionalParams

Returns Promise<EventChannelsGetResponse>

listByPartnerNamespace

Parameters

resourceGroupName: string

partnerNamespaceName: string

Optional options: EventChannelsListByPartnerNamespaceOptionalParams

Returns PagedAsyncIterableIterator<EventChannel>