Package com.azure.resourcemanager.kusto.models

Interface ClusterPrincipalAssignments

public interface ClusterPrincipalAssignments

Resource collection API of ClusterPrincipalAssignments.

Method Summary

Modifier and Type	Method	Description
CheckNameResult	checkNameAvailability(String resourceGroupName, String clusterName, 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 resourceGroupName, String clusterName, 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 resourceGroupName, String clusterName, String principalAssignmentName)	Deletes a Kusto cluster principalAssignment.
void	delete(String resourceGroupName, String clusterName, String principalAssignmentName, com.azure.core.util.Context context)	Deletes a Kusto cluster principalAssignment.
void	deleteById(String id)	Deletes a Kusto cluster principalAssignment.
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Deletes a Kusto cluster principalAssignment.
ClusterPrincipalAssignment	get(String resourceGroupName, String clusterName, String principalAssignmentName)	Gets a Kusto cluster principalAssignment.
ClusterPrincipalAssignment	getById(String id)	Gets a Kusto cluster principalAssignment.
com.azure.core.http.rest.Response<ClusterPrincipalAssignment>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Gets a Kusto cluster principalAssignment.
com.azure.core.http.rest.Response<ClusterPrincipalAssignment>	getWithResponse(String resourceGroupName, String clusterName, String principalAssignmentName, com.azure.core.util.Context context)	Gets a Kusto cluster principalAssignment.
com.azure.core.http.rest.PagedIterable<ClusterPrincipalAssignment>	list(String resourceGroupName, String clusterName)	Lists all Kusto cluster principalAssignments.
com.azure.core.http.rest.PagedIterable<ClusterPrincipalAssignment>	list(String resourceGroupName, String clusterName, com.azure.core.util.Context context)	Lists all Kusto cluster principalAssignments.

Method Detail

checkNameAvailability

CheckNameResult checkNameAvailability(String resourceGroupName,
                                      String clusterName,
                                      ClusterPrincipalAssignmentCheckNameRequest principalAssignmentName)

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

Parameters:

resourceGroupName - The name of the resource group containing the Kusto cluster.

clusterName - The name of the Kusto cluster.

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

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

Parameters:

resourceGroupName - The name of the resource group containing the Kusto cluster.

clusterName - The name of the Kusto cluster.

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.

get

ClusterPrincipalAssignment get(String resourceGroupName,
                               String clusterName,
                               String principalAssignmentName)

Gets a Kusto cluster principalAssignment.

Parameters:

resourceGroupName - The name of the resource group containing the Kusto cluster.

clusterName - The name of the Kusto cluster.

principalAssignmentName - The name of the Kusto principalAssignment.

Returns:

a Kusto cluster 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 resourceGroupName,
                                                                              String clusterName,
                                                                              String principalAssignmentName,
                                                                              com.azure.core.util.Context context)

Gets a Kusto cluster principalAssignment.

Parameters:

resourceGroupName - The name of the resource group containing the Kusto cluster.

clusterName - The name of the Kusto cluster.

principalAssignmentName - The name of the Kusto principalAssignment.

context - The context to associate with this operation.

Returns:

a Kusto cluster 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 resourceGroupName,
            String clusterName,
            String principalAssignmentName)

Deletes a Kusto cluster principalAssignment.

Parameters:

resourceGroupName - The name of the resource group containing the Kusto cluster.

clusterName - The name of the Kusto cluster.

principalAssignmentName - The name of the Kusto 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.

delete

void delete(String resourceGroupName,
            String clusterName,
            String principalAssignmentName,
            com.azure.core.util.Context context)

Deletes a Kusto cluster principalAssignment.

Parameters:

resourceGroupName - The name of the resource group containing the Kusto cluster.

clusterName - The name of the Kusto cluster.

principalAssignmentName - The name of the Kusto principalAssignment.

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.

list

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

Lists all Kusto cluster principalAssignments.

Parameters:

resourceGroupName - The name of the resource group containing the Kusto cluster.

clusterName - The name of the Kusto cluster.

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

Lists all Kusto cluster principalAssignments.

Parameters:

resourceGroupName - The name of the resource group containing the Kusto cluster.

clusterName - The name of the Kusto cluster.

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.

getById

ClusterPrincipalAssignment getById(String id)

Gets a Kusto cluster principalAssignment.

Parameters:

id - the resource ID.

Returns:

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

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

a Kusto cluster 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 cluster 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 cluster 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.