Share via

Channels interface

  • Reference
Package:
@azure/arm-eventgrid

Interface representing a Channels.

Methods

beginDelete(string, string, string, ChannelsDeleteOptionalParams)

Delete an existing channel.
beginDeleteAndWait(string, string, string, ChannelsDeleteOptionalParams)

Delete an existing channel.
createOrUpdate(string, string, string, Channel, ChannelsCreateOrUpdateOptionalParams)

Synchronously creates or updates a new channel with the specified parameters.
get(string, string, string, ChannelsGetOptionalParams)

Get properties of a channel.
getFullUrl(string, string, string, ChannelsGetFullUrlOptionalParams)

Get the full endpoint URL of a partner destination channel.
listByPartnerNamespace(string, string, ChannelsListByPartnerNamespaceOptionalParams)

List all the channels in a partner namespace.
update(string, string, string, ChannelUpdateParameters, ChannelsUpdateOptionalParams)

Synchronously updates a channel with the specified parameters.

Method Details

beginDelete(string, string, string, ChannelsDeleteOptionalParams)

Delete an existing channel.

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

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.

options
ChannelsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, ChannelsDeleteOptionalParams)

Delete an existing channel.

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

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.

options
ChannelsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

createOrUpdate(string, string, string, Channel, ChannelsCreateOrUpdateOptionalParams)

Synchronously creates or updates a new channel with the specified parameters.

function createOrUpdate(resourceGroupName: string, partnerNamespaceName: string, channelName: string, channelInfo: Channel, options?: ChannelsCreateOrUpdateOptionalParams): Promise<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.

channelInfo
Channel

Channel information.

options
ChannelsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Channel>

get(string, string, string, ChannelsGetOptionalParams)

Get properties of a channel.

function get(resourceGroupName: string, partnerNamespaceName: string, channelName: string, options?: ChannelsGetOptionalParams): Promise<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.

options
ChannelsGetOptionalParams

The options parameters.

Returns

Promise<Channel>

getFullUrl(string, string, string, ChannelsGetFullUrlOptionalParams)

Get the full endpoint URL of a partner destination channel.

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

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.

options
ChannelsGetFullUrlOptionalParams

The options parameters.

Returns

Promise<EventSubscriptionFullUrl>

listByPartnerNamespace(string, string, ChannelsListByPartnerNamespaceOptionalParams)

List all the channels in a partner namespace.

function listByPartnerNamespace(resourceGroupName: string, partnerNamespaceName: string, options?: ChannelsListByPartnerNamespaceOptionalParams): PagedAsyncIterableIterator<Channel, Channel[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group within the partners subscription.

partnerNamespaceName

string

Name of the partner namespace.

options
ChannelsListByPartnerNamespaceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Channel, Channel[], PageSettings>

update(string, string, string, ChannelUpdateParameters, ChannelsUpdateOptionalParams)

Synchronously updates a channel with the specified parameters.

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

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.

options
ChannelsUpdateOptionalParams

The options parameters.

Returns

Promise<void>