ChannelsOperations interface

Package:

@azure/arm-eventgrid

Interface representing a Channels operations.

Properties

beginDelete
beginDeleteAndWait
createOrUpdate	Synchronously creates or updates a new channel with the specified parameters.
delete
get	Get properties of a channel.
getFullUrl	Get the full endpoint URL of a partner destination channel.
listByPartnerNamespace	List all the channels in a partner namespace.
update	Synchronously updates a channel with the specified parameters.

Property Details

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

createOrUpdate

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

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

Property Value

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

delete

delete: (resourceGroupName: string, partnerNamespaceName: string, channelName: string, options?: ChannelsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, partnerNamespaceName: string, channelName: string, options?: ChannelsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Get properties of a channel.

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

Property Value

(resourceGroupName: string, partnerNamespaceName: string, channelName: string, options?: ChannelsGetOptionalParams) => Promise<Channel>

getFullUrl

Get the full endpoint URL of a partner destination channel.

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

Property Value

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

listByPartnerNamespace

List all the channels in a partner namespace.

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

Property Value

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

update

Synchronously updates a channel with the specified parameters.

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

Property Value

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