Share via


Bots Interface

public interface Bots

Resource collection API of Bots.

Method Summary

Modifier and Type Method and Description
abstract Blank define(String name)

Begins definition for a new Bot resource.

abstract void deleteById(String id)

Deletes a Bot Service from the resource group.

abstract Response<Void> deleteByIdWithResponse(String id, Context context)

Deletes a Bot Service from the resource group.

abstract void deleteByResourceGroup(String resourceGroupName, String resourceName)

Deletes a Bot Service from the resource group.

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

Deletes a Bot Service from the resource group.

abstract Bot getById(String id)

Returns a BotService specified by the parameters.

abstract Response<Bot> getByIdWithResponse(String id, Context context)

Returns a BotService specified by the parameters.

abstract Bot getByResourceGroup(String resourceGroupName, String resourceName)

Returns a BotService specified by the parameters.

abstract Response<Bot> getByResourceGroupWithResponse(String resourceGroupName, String resourceName, Context context)

Returns a BotService specified by the parameters.

abstract CheckNameAvailabilityResponseBody getCheckNameAvailability(CheckNameAvailabilityRequestBody parameters)

Check whether a bot name is available.

abstract Response<CheckNameAvailabilityResponseBody> getCheckNameAvailabilityWithResponse(CheckNameAvailabilityRequestBody parameters, Context context)

Check whether a bot name is available.

abstract PagedIterable<Bot> list()

Returns all the resources of a particular type belonging to a subscription.

abstract PagedIterable<Bot> list(Context context)

Returns all the resources of a particular type belonging to a subscription.

abstract PagedIterable<Bot> listByResourceGroup(String resourceGroupName)

Returns all the resources of a particular type belonging to a resource group.

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

Returns all the resources of a particular type belonging to a resource group.

Method Details

define

public abstract Bot.DefinitionStages.Blank define(String name)

Begins definition for a new Bot resource.

Parameters:

name - resource name.

Returns:

the first stage of the new Bot definition.

deleteById

public abstract void deleteById(String id)

Deletes a Bot Service from the resource group.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract Response<Void> deleteByIdWithResponse(String id, Context context)

Deletes a Bot Service from the resource group.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

deleteByResourceGroup

public abstract void deleteByResourceGroup(String resourceGroupName, String resourceName)

Deletes a Bot Service from the resource group.

Parameters:

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

deleteByResourceGroupWithResponse

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

Deletes a Bot Service from the resource group.

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:

getById

public abstract Bot getById(String id)

Returns a BotService specified by the parameters.

Parameters:

id - the resource ID.

Returns:

bot resource definition along with Response<T>.

getByIdWithResponse

public abstract Response<Bot> getByIdWithResponse(String id, Context context)

Returns a BotService specified by the parameters.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

bot resource definition along with Response<T>.

getByResourceGroup

public abstract Bot getByResourceGroup(String resourceGroupName, String resourceName)

Returns a BotService specified by the parameters.

Parameters:

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

Returns:

bot resource definition.

getByResourceGroupWithResponse

public abstract Response<Bot> getByResourceGroupWithResponse(String resourceGroupName, String resourceName, Context context)

Returns a BotService specified by the parameters.

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:

bot resource definition along with Response<T>.

getCheckNameAvailability

public abstract CheckNameAvailabilityResponseBody getCheckNameAvailability(CheckNameAvailabilityRequestBody parameters)

Check whether a bot name is available.

Parameters:

parameters - The request body parameters to provide for the check name availability request.

Returns:

the response body returned for a request to Bot Service Management to check availability of a bot name.

getCheckNameAvailabilityWithResponse

public abstract Response<CheckNameAvailabilityResponseBody> getCheckNameAvailabilityWithResponse(CheckNameAvailabilityRequestBody parameters, Context context)

Check whether a bot name is available.

Parameters:

parameters - The request body parameters to provide for the check name availability request.
context - The context to associate with this operation.

Returns:

the response body returned for a request to Bot Service Management to check availability of a bot name along with Response<T>.

list

public abstract PagedIterable<Bot> list()

Returns all the resources of a particular type belonging to a subscription.

Returns:

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

list

public abstract PagedIterable<Bot> list(Context context)

Returns all the resources of a particular type belonging to a subscription.

Parameters:

context - The context to associate with this operation.

Returns:

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

listByResourceGroup

public abstract PagedIterable<Bot> listByResourceGroup(String resourceGroupName)

Returns all the resources of a particular type belonging to a resource group.

Parameters:

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

Returns:

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

listByResourceGroup

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

Returns all the resources of a particular type belonging to a resource group.

Parameters:

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

Returns:

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

Applies to