Channels | @azure/arm-eventgrid

Interface representing a Channels.

Hierarchy

Channels

Implemented by

ChannelsImpl

Index

Methods

beginDelete

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

- Defined in operationsInterfaces/channels.ts:74
Delete an existing channel.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the partners subscription.
- partnerNamespaceName: string
  
  Name of the partner namespace.
- channelName: string
  
  Name of the channel.
- Optional options: ChannelsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, partnerNamespaceName: string, channelName: string, options?: ChannelsDeleteOptionalParams): Promise<void>

- Defined in operationsInterfaces/channels.ts:87
Delete an existing channel.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the partners subscription.
- partnerNamespaceName: string
  
  Name of the partner namespace.
- channelName: string
  
  Name of the channel.
- Optional options: ChannelsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

createOrUpdate

createOrUpdate(resourceGroupName: string, partnerNamespaceName: string, channelName: string, channelInfo: Channel, options?: ChannelsCreateOrUpdateOptionalParams): Promise<ChannelsCreateOrUpdateResponse>

- Defined in operationsInterfaces/channels.ts:60
Synchronously creates or updates a new channel with the specified parameters.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the partners subscription.
- partnerNamespaceName: string
  
  Name of the partner namespace.
- channelName: string
  
  Name of the channel.
- channelInfo: Channel
  
  Channel information.
- Optional options: ChannelsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ChannelsCreateOrUpdateResponse>

get

get(resourceGroupName: string, partnerNamespaceName: string, channelName: string, options?: ChannelsGetOptionalParams): Promise<ChannelsGetResponse>

- Defined in operationsInterfaces/channels.ts:46
Get properties of a channel.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the partners subscription.
- partnerNamespaceName: string
  
  Name of the partner namespace.
- channelName: string
  
  Name of the channel.
- Optional options: ChannelsGetOptionalParams
  
  The options parameters.
Returns Promise<ChannelsGetResponse>

getFullUrl

getFullUrl(resourceGroupName: string, partnerNamespaceName: string, channelName: string, options?: ChannelsGetFullUrlOptionalParams): Promise<ChannelsGetFullUrlResponse>

- Defined in operationsInterfaces/channels.ts:115
Get the full endpoint URL of a partner destination channel.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the partners subscription.
- partnerNamespaceName: string
  
  Name of the partner namespace.
- channelName: string
  
  Name of the Channel.
- Optional options: ChannelsGetFullUrlOptionalParams
  
  The options parameters.
Returns Promise<ChannelsGetFullUrlResponse>

listByPartnerNamespace

listByPartnerNamespace(resourceGroupName: string, partnerNamespaceName: string, options?: ChannelsListByPartnerNamespaceOptionalParams): PagedAsyncIterableIterator<Channel>

- Defined in operationsInterfaces/channels.ts:34
List all the channels in a partner namespace.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the partners subscription.
- partnerNamespaceName: string
  
  Name of the partner namespace.
- Optional options: ChannelsListByPartnerNamespaceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Channel>

update

update(resourceGroupName: string, partnerNamespaceName: string, channelName: string, channelUpdateParameters: ChannelUpdateParameters, options?: ChannelsUpdateOptionalParams): Promise<void>

- Defined in operationsInterfaces/channels.ts:101
Synchronously updates a channel with the specified parameters.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the partners subscription.
- partnerNamespaceName: string
  
  Name of the partner namespace.
- channelName: string
  
  Name of the channel.
- channelUpdateParameters: ChannelUpdateParameters
  
  Channel update information.
- Optional options: ChannelsUpdateOptionalParams
  
  The options parameters.
Returns Promise<void>

Hierarchy

Implemented by

Index

Methods

Methods

beginDelete

Parameters

resourceGroupName: string

partnerNamespaceName: string

channelName: string

Optional options: ChannelsDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

partnerNamespaceName: string

channelName: string

Optional options: ChannelsDeleteOptionalParams

Returns Promise<void>

createOrUpdate

Parameters

resourceGroupName: string

partnerNamespaceName: string

channelName: string

channelInfo: Channel

Optional options: ChannelsCreateOrUpdateOptionalParams

Returns Promise<ChannelsCreateOrUpdateResponse>

get

Parameters

resourceGroupName: string

partnerNamespaceName: string

channelName: string

Optional options: ChannelsGetOptionalParams

Returns Promise<ChannelsGetResponse>

getFullUrl

Parameters

resourceGroupName: string

partnerNamespaceName: string

channelName: string

Optional options: ChannelsGetFullUrlOptionalParams

Returns Promise<ChannelsGetFullUrlResponse>

listByPartnerNamespace

Parameters

resourceGroupName: string

partnerNamespaceName: string

Optional options: ChannelsListByPartnerNamespaceOptionalParams

Returns PagedAsyncIterableIterator<Channel>

update

Parameters

resourceGroupName: string

partnerNamespaceName: string

channelName: string

channelUpdateParameters: ChannelUpdateParameters

Optional options: ChannelsUpdateOptionalParams

Returns Promise<void>