Package com.azure.resourcemanager.synapse.models

Interface KustoPoolPrincipalAssignments

public interface KustoPoolPrincipalAssignments

Resource collection API of KustoPoolPrincipalAssignments.

Method Summary

Modifier and Type	Method	Description
CheckNameResult	checkNameAvailability(String workspaceName, String kustoPoolName, String resourceGroupName, ClusterPrincipalAssignmentCheckNameRequest principalAssignmentName)	Checks that the principal assignment name is valid and is not already in use.
com.azure.core.http.rest.Response<CheckNameResult>	checkNameAvailabilityWithResponse(String workspaceName, String kustoPoolName, String resourceGroupName, ClusterPrincipalAssignmentCheckNameRequest principalAssignmentName, com.azure.core.util.Context context)	Checks that the principal assignment name is valid and is not already in use.
ClusterPrincipalAssignment.DefinitionStages.Blank	define(String name)	Begins definition for a new ClusterPrincipalAssignment resource.
void	delete(String workspaceName, String kustoPoolName, String principalAssignmentName, String resourceGroupName)	Deletes a Kusto pool principalAssignment.
void	delete(String workspaceName, String kustoPoolName, String principalAssignmentName, String resourceGroupName, com.azure.core.util.Context context)	Deletes a Kusto pool principalAssignment.
void	deleteById(String id)	Deletes a Kusto pool principalAssignment.
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Deletes a Kusto pool principalAssignment.
ClusterPrincipalAssignment	get(String workspaceName, String kustoPoolName, String principalAssignmentName, String resourceGroupName)	Gets a Kusto pool principalAssignment.
ClusterPrincipalAssignment	getById(String id)	Gets a Kusto pool principalAssignment.
com.azure.core.http.rest.Response<ClusterPrincipalAssignment>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Gets a Kusto pool principalAssignment.
com.azure.core.http.rest.Response<ClusterPrincipalAssignment>	getWithResponse(String workspaceName, String kustoPoolName, String principalAssignmentName, String resourceGroupName, com.azure.core.util.Context context)	Gets a Kusto pool principalAssignment.
com.azure.core.http.rest.PagedIterable<ClusterPrincipalAssignment>	list(String workspaceName, String kustoPoolName, String resourceGroupName)	Lists all Kusto pool principalAssignments.
com.azure.core.http.rest.PagedIterable<ClusterPrincipalAssignment>	list(String workspaceName, String kustoPoolName, String resourceGroupName, com.azure.core.util.Context context)	Lists all Kusto pool principalAssignments.

Method Detail

checkNameAvailability

CheckNameResult checkNameAvailability(String workspaceName,
                                      String kustoPoolName,
                                      String resourceGroupName,
                                      ClusterPrincipalAssignmentCheckNameRequest principalAssignmentName)

Checks that the principal assignment name is valid and is not already in use.

Parameters:

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

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

principalAssignmentName - The name of the principal assignment.

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

Checks that the principal assignment name is valid and is not already in use.

Parameters:

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

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

principalAssignmentName - The name of the principal assignment.

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.

list

com.azure.core.http.rest.PagedIterable<ClusterPrincipalAssignment> list(String workspaceName,
                                                                        String kustoPoolName,
                                                                        String resourceGroupName)

Lists all Kusto pool principalAssignments.

Parameters:

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

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

Returns:

the list Kusto cluster principal assignments 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<ClusterPrincipalAssignment> list(String workspaceName,
                                                                        String kustoPoolName,
                                                                        String resourceGroupName,
                                                                        com.azure.core.util.Context context)

Lists all Kusto pool principalAssignments.

Parameters:

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

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

context - The context to associate with this operation.

Returns:

the list Kusto cluster principal assignments 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

ClusterPrincipalAssignment get(String workspaceName,
                               String kustoPoolName,
                               String principalAssignmentName,
                               String resourceGroupName)

Gets a Kusto pool principalAssignment.

Parameters:

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

principalAssignmentName - The name of the Kusto principalAssignment.

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

Returns:

a Kusto pool principalAssignment.

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

Gets a Kusto pool principalAssignment.

Parameters:

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

principalAssignmentName - The name of the Kusto principalAssignment.

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

context - The context to associate with this operation.

Returns:

a Kusto pool principalAssignment 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 workspaceName,
            String kustoPoolName,
            String principalAssignmentName,
            String resourceGroupName)

Deletes a Kusto pool principalAssignment.

Parameters:

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

principalAssignmentName - The name of the Kusto principalAssignment.

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

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

Deletes a Kusto pool principalAssignment.

Parameters:

workspaceName - The name of the workspace.

kustoPoolName - The name of the Kusto pool.

principalAssignmentName - The name of the Kusto principalAssignment.

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

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.

getById

ClusterPrincipalAssignment getById(String id)

Gets a Kusto pool principalAssignment.

Parameters:

id - the resource ID.

Returns:

a Kusto pool principalAssignment 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<ClusterPrincipalAssignment> getByIdWithResponse(String id,
                                                                                  com.azure.core.util.Context context)

Gets a Kusto pool principalAssignment.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

a Kusto pool principalAssignment 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 Kusto pool principalAssignment.

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

void deleteByIdWithResponse(String id,
                            com.azure.core.util.Context context)

Deletes a Kusto pool principalAssignment.

Parameters:

id - the resource ID.

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.

define

ClusterPrincipalAssignment.DefinitionStages.Blank define(String name)

Begins definition for a new ClusterPrincipalAssignment resource.

Parameters:

name - resource name.

Returns:

the first stage of the new ClusterPrincipalAssignment definition.