Package com.azure.resourcemanager.botservice.models

Interface BotConnections

public interface BotConnections

Resource collection API of BotConnections.

Method Summary

Modifier and Type	Method	Description
ConnectionSetting.DefinitionStages.Blank	define(String name)	Begins definition for a new ConnectionSetting resource.
void	delete(String resourceGroupName, String resourceName, String connectionName)	Deletes a Connection Setting registration for a Bot Service.
void	deleteById(String id)	Deletes a Connection Setting registration for a Bot Service.
com.azure.core.http.rest.Response<Void>	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	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.
ConnectionSetting	get(String resourceGroupName, String resourceName, String connectionName)	Get a Connection Setting registration for a Bot Service.
ConnectionSetting	getById(String id)	Get a Connection Setting registration for a Bot Service.
com.azure.core.http.rest.Response<ConnectionSetting>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Get a Connection Setting registration for a Bot Service.
com.azure.core.http.rest.Response<ConnectionSetting>	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<ConnectionSetting>	listByBotService(String resourceGroupName, String resourceName)	Returns all the Connection Settings registered to a particular BotService resource.
com.azure.core.http.rest.PagedIterable<ConnectionSetting>	listByBotService(String resourceGroupName, String resourceName, com.azure.core.util.Context context)	Returns all the Connection Settings registered to a particular BotService resource.
ServiceProviderResponseList	listServiceProviders()	Lists the available Service Providers for creating Connection Settings.
com.azure.core.http.rest.Response<ServiceProviderResponseList>	listServiceProvidersWithResponse(com.azure.core.util.Context context)	Lists the available Service Providers for creating Connection Settings.
ConnectionSetting	listWithSecrets(String resourceGroupName, String resourceName, String connectionName)	Get a Connection Setting registration for a Bot Service.
com.azure.core.http.rest.Response<ConnectionSetting>	listWithSecretsWithResponse(String resourceGroupName, String resourceName, String connectionName, com.azure.core.util.Context context)	Get a Connection Setting registration for a Bot Service.

Method Detail

listServiceProviders

ServiceProviderResponseList 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<ServiceProviderResponseList> 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

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

get

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

getById

ConnectionSetting getById(String id)

Get a Connection Setting registration for a Bot Service.

Parameters:

id - the resource ID.

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.

getByIdWithResponse

com.azure.core.http.rest.Response<ConnectionSetting> getByIdWithResponse(String id,
                                                                         com.azure.core.util.Context context)

Get a Connection Setting registration for a Bot Service.

Parameters:

id - the resource ID.

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.

deleteById

void deleteById(String id)

Deletes a Connection Setting registration for a Bot Service.

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

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

ConnectionSetting.DefinitionStages.Blank define(String name)

Begins definition for a new ConnectionSetting resource.

Parameters:

name - resource name.

Returns:

the first stage of the new ConnectionSetting definition.