Share via


Channels Interface

public interface Channels

Resource collection API of Channels.

Method Summary

Modifier and Type Method and Description
abstract BotChannel create(String resourceGroupName, String resourceName, ChannelName channelName, BotChannelInner parameters)

Creates a Channel registration for a Bot Service.

abstract Response<BotChannel> createWithResponse(String resourceGroupName, String resourceName, ChannelName channelName, BotChannelInner parameters, Context context)

Creates a Channel registration for a Bot Service.

abstract void delete(String resourceGroupName, String resourceName, String channelName)

Deletes a Channel registration from a Bot Service.

abstract Response<Void> deleteWithResponse(String resourceGroupName, String resourceName, String channelName, Context context)

Deletes a Channel registration from a Bot Service.

abstract BotChannel get(String resourceGroupName, String resourceName, String channelName)

Returns a BotService Channel registration specified by the parameters.

abstract Response<BotChannel> getWithResponse(String resourceGroupName, String resourceName, String channelName, Context context)

Returns a BotService Channel registration specified by the parameters.

abstract PagedIterable<BotChannel> listByResourceGroup(String resourceGroupName, String resourceName)

Returns all the Channel registrations of a particular BotService resource.

abstract PagedIterable<BotChannel> listByResourceGroup(String resourceGroupName, String resourceName, Context context)

Returns all the Channel registrations of a particular BotService resource.

abstract ListChannelWithKeysResponse listWithKeys(String resourceGroupName, String resourceName, ChannelName channelName)

Lists a Channel registration for a Bot Service including secrets.

abstract Response<ListChannelWithKeysResponse> listWithKeysWithResponse(String resourceGroupName, String resourceName, ChannelName channelName, Context context)

Lists a Channel registration for a Bot Service including secrets.

abstract BotChannel update(String resourceGroupName, String resourceName, ChannelName channelName, BotChannelInner parameters)

Updates a Channel registration for a Bot Service.

abstract Response<BotChannel> updateWithResponse(String resourceGroupName, String resourceName, ChannelName channelName, BotChannelInner parameters, Context context)

Updates a Channel registration for a Bot Service.

Method Details

create

public abstract BotChannel create(String resourceGroupName, String resourceName, ChannelName channelName, BotChannelInner parameters)

Creates a Channel registration for a Bot Service.

Parameters:

resourceGroupName - The name of the Bot resource group in the user subscription.
resourceName - The name of the Bot resource.
channelName - The name of the Channel resource.
parameters - The parameters to provide for the created bot.

Returns:

bot channel resource definition.

createWithResponse

public abstract Response<BotChannel> createWithResponse(String resourceGroupName, String resourceName, ChannelName channelName, BotChannelInner parameters, Context context)

Creates a Channel registration for a Bot Service.

Parameters:

resourceGroupName - The name of the Bot resource group in the user subscription.
resourceName - The name of the Bot resource.
channelName - The name of the Channel resource.
parameters - The parameters to provide for the created bot.
context - The context to associate with this operation.

Returns:

bot channel resource definition along with Response<T>.

delete

public abstract void delete(String resourceGroupName, String resourceName, String channelName)

Deletes a Channel registration from a Bot Service.

Parameters:

resourceGroupName - The name of the Bot resource group in the user subscription.
resourceName - The name of the Bot resource.
channelName - The name of the Bot resource.

deleteWithResponse

public abstract Response<Void> deleteWithResponse(String resourceGroupName, String resourceName, String channelName, Context context)

Deletes a Channel registration from a Bot Service.

Parameters:

resourceGroupName - The name of the Bot resource group in the user subscription.
resourceName - The name of the Bot resource.
channelName - The name of the Bot resource.
context - The context to associate with this operation.

Returns:

get

public abstract BotChannel get(String resourceGroupName, String resourceName, String channelName)

Returns a BotService Channel registration specified by the parameters.

Parameters:

resourceGroupName - The name of the Bot resource group in the user subscription.
resourceName - The name of the Bot resource.
channelName - The name of the Bot resource.

Returns:

bot channel resource definition.

getWithResponse

public abstract Response<BotChannel> getWithResponse(String resourceGroupName, String resourceName, String channelName, Context context)

Returns a BotService Channel registration specified by the parameters.

Parameters:

resourceGroupName - The name of the Bot resource group in the user subscription.
resourceName - The name of the Bot resource.
channelName - The name of the Bot resource.
context - The context to associate with this operation.

Returns:

bot channel resource definition along with Response<T>.

listByResourceGroup

public abstract PagedIterable<BotChannel> listByResourceGroup(String resourceGroupName, String resourceName)

Returns all the Channel registrations of a particular BotService resource.

Parameters:

resourceGroupName - The name of the Bot resource group in the user subscription.
resourceName - The name of the Bot resource.

Returns:

the list of bot service channel operation response as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<BotChannel> listByResourceGroup(String resourceGroupName, String resourceName, Context context)

Returns all the Channel registrations of a particular BotService resource.

Parameters:

resourceGroupName - The name of the Bot resource group in the user subscription.
resourceName - The name of the Bot resource.
context - The context to associate with this operation.

Returns:

the list of bot service channel operation response as paginated response with PagedIterable<T>.

listWithKeys

public abstract ListChannelWithKeysResponse listWithKeys(String resourceGroupName, String resourceName, ChannelName channelName)

Lists a Channel registration for a Bot Service including secrets.

Parameters:

resourceGroupName - The name of the Bot resource group in the user subscription.
resourceName - The name of the Bot resource.
channelName - The name of the Channel resource.

Returns:

the ARM channel of list channel with keys operation response.

listWithKeysWithResponse

public abstract Response<ListChannelWithKeysResponse> listWithKeysWithResponse(String resourceGroupName, String resourceName, ChannelName channelName, Context context)

Lists a Channel registration for a Bot Service including secrets.

Parameters:

resourceGroupName - The name of the Bot resource group in the user subscription.
resourceName - The name of the Bot resource.
channelName - The name of the Channel resource.
context - The context to associate with this operation.

Returns:

the ARM channel of list channel with keys operation response along with Response<T>.

update

public abstract BotChannel update(String resourceGroupName, String resourceName, ChannelName channelName, BotChannelInner parameters)

Updates a Channel registration for a Bot Service.

Parameters:

resourceGroupName - The name of the Bot resource group in the user subscription.
resourceName - The name of the Bot resource.
channelName - The name of the Channel resource.
parameters - The parameters to provide for the created bot.

Returns:

bot channel resource definition.

updateWithResponse

public abstract Response<BotChannel> updateWithResponse(String resourceGroupName, String resourceName, ChannelName channelName, BotChannelInner parameters, Context context)

Updates a Channel registration for a Bot Service.

Parameters:

resourceGroupName - The name of the Bot resource group in the user subscription.
resourceName - The name of the Bot resource.
channelName - The name of the Channel resource.
parameters - The parameters to provide for the created bot.
context - The context to associate with this operation.

Returns:

bot channel resource definition along with Response<T>.

Applies to