Interface ChannelsClient


public interface ChannelsClient
An instance of this class provides access to all the operations defined in ChannelsClient.
  • Method Details

    • create

      BotChannelInner 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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • createWithResponse

      com.azure.core.http.rest.Response<BotChannelInner> createWithResponse(String resourceGroupName, String resourceName, ChannelName channelName, BotChannelInner parameters, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • update

      BotChannelInner 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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • updateWithResponse

      com.azure.core.http.rest.Response<BotChannelInner> updateWithResponse(String resourceGroupName, String resourceName, ChannelName channelName, BotChannelInner parameters, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • delete

      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • deleteWithResponse

      com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String resourceName, String channelName, com.azure.core.util.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:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • get

      BotChannelInner 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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getWithResponse

      com.azure.core.http.rest.Response<BotChannelInner> getWithResponse(String resourceGroupName, String resourceName, String channelName, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • listWithKeys

      ListChannelWithKeysResponseInner 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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • listWithKeysWithResponse

      com.azure.core.http.rest.Response<ListChannelWithKeysResponseInner> listWithKeysWithResponse(String resourceGroupName, String resourceName, ChannelName channelName, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<BotChannelInner> 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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<BotChannelInner> listByResourceGroup(String resourceGroupName, String resourceName, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.