Interface Bots
public interface Bots
Resource collection API of Bots.
-
Method Summary
Modifier and TypeMethodDescriptionBegins definition for a new Bot resource.void
deleteById
(String id) Deletes a Bot Service from the resource group.com.azure.core.http.rest.Response<Void>
deleteByIdWithResponse
(String id, com.azure.core.util.Context context) Deletes a Bot Service from the resource group.void
deleteByResourceGroup
(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.Returns a BotService specified by the parameters.com.azure.core.http.rest.Response<Bot>
getByIdWithResponse
(String id, com.azure.core.util.Context context) Returns a BotService specified by the parameters.getByResourceGroup
(String resourceGroupName, String resourceName) Returns a BotService specified by the parameters.com.azure.core.http.rest.Response<Bot>
getByResourceGroupWithResponse
(String resourceGroupName, String resourceName, com.azure.core.util.Context context) Returns a BotService specified by the parameters.Check whether a bot name is available.com.azure.core.http.rest.Response<CheckNameAvailabilityResponseBody>
getCheckNameAvailabilityWithResponse
(CheckNameAvailabilityRequestBody parameters, com.azure.core.util.Context context) Check whether a bot name is available.com.azure.core.http.rest.PagedIterable<Bot>
list()
Returns all the resources of a particular type belonging to a subscription.com.azure.core.http.rest.PagedIterable<Bot>
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<Bot>
listByResourceGroup
(String resourceGroupName) Returns all the resources of a particular type belonging to a resource group.com.azure.core.http.rest.PagedIterable<Bot>
listByResourceGroup
(String resourceGroupName, com.azure.core.util.Context context) Returns all the resources of a particular type belonging to a resource group.
-
Method Details
-
deleteByResourceGroup
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
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<Bot> 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
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<Bot> 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<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
. - 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
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
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.
- 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<CheckNameAvailabilityResponseBody> 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.
-
getById
Returns a BotService specified by the parameters.- Parameters:
id
- the resource ID.- 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.
-
getByIdWithResponse
com.azure.core.http.rest.Response<Bot> getByIdWithResponse(String id, com.azure.core.util.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
. - 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.
-
deleteById
Deletes a Bot Service from the resource group.- Parameters:
id
- the resource ID.- 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.
-
deleteByIdWithResponse
com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id, com.azure.core.util.Context context) Deletes a Bot Service from the resource group.- Parameters:
id
- the resource ID.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.
-
define
Begins definition for a new Bot resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new Bot definition.
-