Package com.azure.resourcemanager.botservice.fluent

Interface BotsClient

public interface BotsClient

An instance of this class provides access to all the operations defined in BotsClient.

Method Summary

Modifier and Type	Method	Description
BotInner	create(String resourceGroupName, String resourceName, BotInner parameters)	Creates a Bot Service.
com.azure.core.http.rest.Response<BotInner>	createWithResponse(String resourceGroupName, String resourceName, BotInner parameters, com.azure.core.util.Context context)	Creates a Bot Service.
void	delete(String resourceGroupName, String resourceName)	Deletes a Bot Service from the resource group.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String resourceName, com.azure.core.util.Context context)	Deletes a Bot Service from the resource group.
BotInner	getByResourceGroup(String resourceGroupName, String resourceName)	Returns a BotService specified by the parameters.
com.azure.core.http.rest.Response<BotInner>	getByResourceGroupWithResponse(String resourceGroupName, String resourceName, com.azure.core.util.Context context)	Returns a BotService specified by the parameters.
CheckNameAvailabilityResponseBodyInner	getCheckNameAvailability(CheckNameAvailabilityRequestBody parameters)	Check whether a bot name is available.
com.azure.core.http.rest.Response<CheckNameAvailabilityResponseBodyInner>	getCheckNameAvailabilityWithResponse(CheckNameAvailabilityRequestBody parameters, com.azure.core.util.Context context)	Check whether a bot name is available.
com.azure.core.http.rest.PagedIterable<BotInner>	list()	Returns all the resources of a particular type belonging to a subscription.
com.azure.core.http.rest.PagedIterable<BotInner>	list(com.azure.core.util.Context context)	Returns all the resources of a particular type belonging to a subscription.
com.azure.core.http.rest.PagedIterable<BotInner>	listByResourceGroup(String resourceGroupName)	Returns all the resources of a particular type belonging to a resource group.
com.azure.core.http.rest.PagedIterable<BotInner>	listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)	Returns all the resources of a particular type belonging to a resource group.
BotInner	update(String resourceGroupName, String resourceName, BotInner parameters)	Updates a Bot Service.
com.azure.core.http.rest.Response<BotInner>	updateWithResponse(String resourceGroupName, String resourceName, BotInner parameters, com.azure.core.util.Context context)	Updates a Bot Service.

Method Detail

create

BotInner create(String resourceGroupName,
                String resourceName,
                BotInner parameters)

Creates a Bot Service. Bot Service is a resource group wide resource type.

Parameters:

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

resourceName - The name of the Bot resource.

parameters - The parameters to provide for the created bot.

Returns:

bot 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<BotInner> createWithResponse(String resourceGroupName,
                                                               String resourceName,
                                                               BotInner parameters,
                                                               com.azure.core.util.Context context)

Creates a Bot Service. Bot Service is a resource group wide resource type.

Parameters:

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

resourceName - The name of the Bot resource.

parameters - The parameters to provide for the created bot.

context - The context to associate with this operation.

Returns:

bot 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

BotInner update(String resourceGroupName,
                String resourceName,
                BotInner parameters)

Updates a Bot Service.

Parameters:

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

resourceName - The name of the Bot resource.

parameters - The parameters to provide for the created bot.

Returns:

bot 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<BotInner> updateWithResponse(String resourceGroupName,
                                                               String resourceName,
                                                               BotInner parameters,
                                                               com.azure.core.util.Context context)

Updates a Bot Service.

Parameters:

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

resourceName - The name of the Bot resource.

parameters - The parameters to provide for the created bot.

context - The context to associate with this operation.

Returns:

bot 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)

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.

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,
                                                           com.azure.core.util.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:

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.

getByResourceGroup

BotInner 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.

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.

getByResourceGroupWithResponse

com.azure.core.http.rest.Response<BotInner> getByResourceGroupWithResponse(String resourceGroupName,
                                                                           String resourceName,
                                                                           com.azure.core.util.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.

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<BotInner> 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.

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<BotInner> listByResourceGroup(String resourceGroupName,
                                                                     com.azure.core.util.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.

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.

list

com.azure.core.http.rest.PagedIterable<BotInner> 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.

Throws:

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.

list

com.azure.core.http.rest.PagedIterable<BotInner> list(com.azure.core.util.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.

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.

getCheckNameAvailability

CheckNameAvailabilityResponseBodyInner 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.

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.

getCheckNameAvailabilityWithResponse

com.azure.core.http.rest.Response<CheckNameAvailabilityResponseBodyInner> getCheckNameAvailabilityWithResponse(CheckNameAvailabilityRequestBody parameters,
                                                                                                               com.azure.core.util.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.

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.