Package com.azure.resourcemanager.botservice.fluent

Interface BotConnectionsClient

public interface BotConnectionsClient

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

Method Summary

Modifier and Type	Method	Description
ConnectionSettingInner	create(String resourceGroupName, String resourceName, String connectionName, ConnectionSettingInner parameters)	Register a new Auth Connection for a Bot Service.
com.azure.core.http.rest.Response<ConnectionSettingInner>	createWithResponse(String resourceGroupName, String resourceName, String connectionName, ConnectionSettingInner parameters, com.azure.core.util.Context context)	Register a new Auth Connection for a Bot Service.
void	delete(String resourceGroupName, String resourceName, String connectionName)	Deletes a Connection Setting registration for a Bot Service.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String resourceName, String connectionName, com.azure.core.util.Context context)	Deletes a Connection Setting registration for a Bot Service.
ConnectionSettingInner	get(String resourceGroupName, String resourceName, String connectionName)	Get a Connection Setting registration for a Bot Service.
com.azure.core.http.rest.Response<ConnectionSettingInner>	getWithResponse(String resourceGroupName, String resourceName, String connectionName, com.azure.core.util.Context context)	Get a Connection Setting registration for a Bot Service.
com.azure.core.http.rest.PagedIterable<ConnectionSettingInner>	listByBotService(String resourceGroupName, String resourceName)	Returns all the Connection Settings registered to a particular BotService resource.
com.azure.core.http.rest.PagedIterable<ConnectionSettingInner>	listByBotService(String resourceGroupName, String resourceName, com.azure.core.util.Context context)	Returns all the Connection Settings registered to a particular BotService resource.
ServiceProviderResponseListInner	listServiceProviders()	Lists the available Service Providers for creating Connection Settings.
com.azure.core.http.rest.Response<ServiceProviderResponseListInner>	listServiceProvidersWithResponse(com.azure.core.util.Context context)	Lists the available Service Providers for creating Connection Settings.
ConnectionSettingInner	listWithSecrets(String resourceGroupName, String resourceName, String connectionName)	Get a Connection Setting registration for a Bot Service.
com.azure.core.http.rest.Response<ConnectionSettingInner>	listWithSecretsWithResponse(String resourceGroupName, String resourceName, String connectionName, com.azure.core.util.Context context)	Get a Connection Setting registration for a Bot Service.
ConnectionSettingInner	update(String resourceGroupName, String resourceName, String connectionName, ConnectionSettingInner parameters)	Updates a Connection Setting registration for a Bot Service.
com.azure.core.http.rest.Response<ConnectionSettingInner>	updateWithResponse(String resourceGroupName, String resourceName, String connectionName, ConnectionSettingInner parameters, com.azure.core.util.Context context)	Updates a Connection Setting registration for a Bot Service.

Method Detail

listServiceProviders

ServiceProviderResponseListInner listServiceProviders()

Lists the available Service Providers for creating Connection Settings.

Returns:

the list of bot service providers response.

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.

listServiceProvidersWithResponse

com.azure.core.http.rest.Response<ServiceProviderResponseListInner> listServiceProvidersWithResponse(com.azure.core.util.Context context)

Lists the available Service Providers for creating Connection Settings.

Parameters:

context - The context to associate with this operation.

Returns:

the list of bot service providers 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.

listWithSecrets

ConnectionSettingInner listWithSecrets(String resourceGroupName,
                                       String resourceName,
                                       String connectionName)

Get a Connection Setting 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.

connectionName - The name of the Bot Service Connection Setting resource.

Returns:

a Connection Setting registration for a Bot Service.

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.

listWithSecretsWithResponse

com.azure.core.http.rest.Response<ConnectionSettingInner> listWithSecretsWithResponse(String resourceGroupName,
                                                                                      String resourceName,
                                                                                      String connectionName,
                                                                                      com.azure.core.util.Context context)

Get a Connection Setting 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.

connectionName - The name of the Bot Service Connection Setting resource.

context - The context to associate with this operation.

Returns:

a Connection Setting registration for a Bot Service 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.

create

ConnectionSettingInner create(String resourceGroupName,
                              String resourceName,
                              String connectionName,
                              ConnectionSettingInner parameters)

Register a new Auth Connection for a Bot Service.

Parameters:

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

resourceName - The name of the Bot resource.

connectionName - The name of the Bot Service Connection Setting resource.

parameters - The parameters to provide for creating the Connection Setting.

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

Register a new Auth Connection for a Bot Service.

Parameters:

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

resourceName - The name of the Bot resource.

connectionName - The name of the Bot Service Connection Setting resource.

parameters - The parameters to provide for creating the Connection Setting.

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

ConnectionSettingInner update(String resourceGroupName,
                              String resourceName,
                              String connectionName,
                              ConnectionSettingInner parameters)

Updates a Connection Setting 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.

connectionName - The name of the Bot Service Connection Setting resource.

parameters - The parameters to provide for updating the Connection Setting.

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

Updates a Connection Setting 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.

connectionName - The name of the Bot Service Connection Setting resource.

parameters - The parameters to provide for updating the Connection Setting.

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.

get

ConnectionSettingInner get(String resourceGroupName,
                           String resourceName,
                           String connectionName)

Get a Connection Setting 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.

connectionName - The name of the Bot Service Connection Setting resource.

Returns:

a Connection Setting registration for a Bot Service.

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<ConnectionSettingInner> getWithResponse(String resourceGroupName,
                                                                          String resourceName,
                                                                          String connectionName,
                                                                          com.azure.core.util.Context context)

Get a Connection Setting 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.

connectionName - The name of the Bot Service Connection Setting resource.

context - The context to associate with this operation.

Returns:

a Connection Setting registration for a Bot Service 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 connectionName)

Deletes a Connection Setting 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.

connectionName - The name of the Bot Service Connection Setting 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 connectionName,
                                                           com.azure.core.util.Context context)

Deletes a Connection Setting 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.

connectionName - The name of the Bot Service Connection Setting 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.

listByBotService

com.azure.core.http.rest.PagedIterable<ConnectionSettingInner> listByBotService(String resourceGroupName,
                                                                                String resourceName)

Returns all the Connection Settings registered to 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 connection settings 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.

listByBotService

com.azure.core.http.rest.PagedIterable<ConnectionSettingInner> listByBotService(String resourceGroupName,
                                                                                String resourceName,
                                                                                com.azure.core.util.Context context)

Returns all the Connection Settings registered to 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 connection settings 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.