Package com.azure.resourcemanager.synapse.models

Interface KustoPoolDataConnections

public interface KustoPoolDataConnections

Resource collection API of KustoPoolDataConnections.

Method Summary

Modifier and Type	Method	Description
CheckNameResult	checkNameAvailability(String resourceGroupName, String workspaceName, String kustoPoolName, String databaseName, DataConnectionCheckNameRequest dataConnectionName)	Checks that the data connection name is valid and is not already in use.
com.azure.core.http.rest.Response<CheckNameResult>	checkNameAvailabilityWithResponse(String resourceGroupName, String workspaceName, String kustoPoolName, String databaseName, DataConnectionCheckNameRequest dataConnectionName, com.azure.core.util.Context context)	Checks that the data connection name is valid and is not already in use.
DataConnection	createOrUpdate(String resourceGroupName, String workspaceName, String kustoPoolName, String databaseName, String dataConnectionName, DataConnectionInner parameters)	Creates or updates a data connection.
DataConnection	createOrUpdate(String resourceGroupName, String workspaceName, String kustoPoolName, String databaseName, String dataConnectionName, DataConnectionInner parameters, com.azure.core.util.Context context)	Creates or updates a data connection.
DataConnectionValidationListResult	dataConnectionValidation(String resourceGroupName, String workspaceName, String kustoPoolName, String databaseName, DataConnectionValidationInner parameters)	Checks that the data connection parameters are valid.
DataConnectionValidationListResult	dataConnectionValidation(String resourceGroupName, String workspaceName, String kustoPoolName, String databaseName, DataConnectionValidationInner parameters, com.azure.core.util.Context context)	Checks that the data connection parameters are valid.
void	delete(String resourceGroupName, String workspaceName, String kustoPoolName, String databaseName, String dataConnectionName)	Deletes the data connection with the given name.
void	delete(String resourceGroupName, String workspaceName, String kustoPoolName, String databaseName, String dataConnectionName, com.azure.core.util.Context context)	Deletes the data connection with the given name.
DataConnection	get(String resourceGroupName, String workspaceName, String kustoPoolName, String databaseName, String dataConnectionName)	Returns a data connection.
com.azure.core.http.rest.Response<DataConnection>	getWithResponse(String resourceGroupName, String workspaceName, String kustoPoolName, String databaseName, String dataConnectionName, com.azure.core.util.Context context)	Returns a data connection.
com.azure.core.http.rest.PagedIterable<DataConnection>	listByDatabase(String resourceGroupName, String workspaceName, String kustoPoolName, String databaseName)	Returns the list of data connections of the given Kusto pool database.
com.azure.core.http.rest.PagedIterable<DataConnection>	listByDatabase(String resourceGroupName, String workspaceName, String kustoPoolName, String databaseName, com.azure.core.util.Context context)	Returns the list of data connections of the given Kusto pool database.
DataConnection	update(String resourceGroupName, String workspaceName, String kustoPoolName, String databaseName, String dataConnectionName, DataConnectionInner parameters)	Updates a data connection.
DataConnection	update(String resourceGroupName, String workspaceName, String kustoPoolName, String databaseName, String dataConnectionName, DataConnectionInner parameters, com.azure.core.util.Context context)	Updates a data connection.

Method Detail

checkNameAvailability

CheckNameResult checkNameAvailability(String resourceGroupName,
                                      String workspaceName,
                                      String kustoPoolName,
                                      String databaseName,
                                      DataConnectionCheckNameRequest dataConnectionName)

Checks that the data connection name is valid and is not already in use.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

databaseName - The name of the database in the Kusto pool.

dataConnectionName - The name of the data connection.

Returns:

the result returned from a check name availability request.

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.

checkNameAvailabilityWithResponse

com.azure.core.http.rest.Response<CheckNameResult> checkNameAvailabilityWithResponse(String resourceGroupName,
                                                                                     String workspaceName,
                                                                                     String kustoPoolName,
                                                                                     String databaseName,
                                                                                     DataConnectionCheckNameRequest dataConnectionName,
                                                                                     com.azure.core.util.Context context)

Checks that the data connection name is valid and is not already in use.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

databaseName - The name of the database in the Kusto pool.

dataConnectionName - The name of the data connection.

context - The context to associate with this operation.

Returns:

the result returned from a check name availability request 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.

dataConnectionValidation

DataConnectionValidationListResult dataConnectionValidation(String resourceGroupName,
                                                            String workspaceName,
                                                            String kustoPoolName,
                                                            String databaseName,
                                                            DataConnectionValidationInner parameters)

Checks that the data connection parameters are valid.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

databaseName - The name of the database in the Kusto pool.

parameters - The data connection parameters supplied to the CreateOrUpdate operation.

Returns:

the list Kusto data connection validation result.

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.

dataConnectionValidation

DataConnectionValidationListResult dataConnectionValidation(String resourceGroupName,
                                                            String workspaceName,
                                                            String kustoPoolName,
                                                            String databaseName,
                                                            DataConnectionValidationInner parameters,
                                                            com.azure.core.util.Context context)

Checks that the data connection parameters are valid.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

databaseName - The name of the database in the Kusto pool.

parameters - The data connection parameters supplied to the CreateOrUpdate operation.

context - The context to associate with this operation.

Returns:

the list Kusto data connection validation result.

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.

listByDatabase

com.azure.core.http.rest.PagedIterable<DataConnection> listByDatabase(String resourceGroupName,
                                                                      String workspaceName,
                                                                      String kustoPoolName,
                                                                      String databaseName)

Returns the list of data connections of the given Kusto pool database.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

databaseName - The name of the database in the Kusto pool.

Returns:

the list Kusto data connections 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.

listByDatabase

com.azure.core.http.rest.PagedIterable<DataConnection> listByDatabase(String resourceGroupName,
                                                                      String workspaceName,
                                                                      String kustoPoolName,
                                                                      String databaseName,
                                                                      com.azure.core.util.Context context)

Returns the list of data connections of the given Kusto pool database.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

databaseName - The name of the database in the Kusto pool.

context - The context to associate with this operation.

Returns:

the list Kusto data connections 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.

get

DataConnection get(String resourceGroupName,
                   String workspaceName,
                   String kustoPoolName,
                   String databaseName,
                   String dataConnectionName)

Returns a data connection.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

databaseName - The name of the database in the Kusto pool.

dataConnectionName - The name of the data connection.

Returns:

class representing a data connection.

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<DataConnection> getWithResponse(String resourceGroupName,
                                                                  String workspaceName,
                                                                  String kustoPoolName,
                                                                  String databaseName,
                                                                  String dataConnectionName,
                                                                  com.azure.core.util.Context context)

Returns a data connection.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

databaseName - The name of the database in the Kusto pool.

dataConnectionName - The name of the data connection.

context - The context to associate with this operation.

Returns:

class representing a data connection 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.

createOrUpdate

DataConnection createOrUpdate(String resourceGroupName,
                              String workspaceName,
                              String kustoPoolName,
                              String databaseName,
                              String dataConnectionName,
                              DataConnectionInner parameters)

Creates or updates a data connection.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

databaseName - The name of the database in the Kusto pool.

dataConnectionName - The name of the data connection.

parameters - The data connection parameters supplied to the CreateOrUpdate operation.

Returns:

class representing a data connection.

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.

createOrUpdate

DataConnection createOrUpdate(String resourceGroupName,
                              String workspaceName,
                              String kustoPoolName,
                              String databaseName,
                              String dataConnectionName,
                              DataConnectionInner parameters,
                              com.azure.core.util.Context context)

Creates or updates a data connection.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

databaseName - The name of the database in the Kusto pool.

dataConnectionName - The name of the data connection.

parameters - The data connection parameters supplied to the CreateOrUpdate operation.

context - The context to associate with this operation.

Returns:

class representing a data connection.

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

DataConnection update(String resourceGroupName,
                      String workspaceName,
                      String kustoPoolName,
                      String databaseName,
                      String dataConnectionName,
                      DataConnectionInner parameters)

Updates a data connection.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

databaseName - The name of the database in the Kusto pool.

dataConnectionName - The name of the data connection.

parameters - The data connection parameters supplied to the Update operation.

Returns:

class representing a data connection.

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

DataConnection update(String resourceGroupName,
                      String workspaceName,
                      String kustoPoolName,
                      String databaseName,
                      String dataConnectionName,
                      DataConnectionInner parameters,
                      com.azure.core.util.Context context)

Updates a data connection.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

databaseName - The name of the database in the Kusto pool.

dataConnectionName - The name of the data connection.

parameters - The data connection parameters supplied to the Update operation.

context - The context to associate with this operation.

Returns:

class representing a data connection.

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 workspaceName,
            String kustoPoolName,
            String databaseName,
            String dataConnectionName)

Deletes the data connection with the given name.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

databaseName - The name of the database in the Kusto pool.

dataConnectionName - The name of the data connection.

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 workspaceName,
            String kustoPoolName,
            String databaseName,
            String dataConnectionName,
            com.azure.core.util.Context context)

Deletes the data connection with the given name.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

databaseName - The name of the database in the Kusto pool.

dataConnectionName - The name of the data connection.

context - The context to associate with this operation.

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.