ClusterPrincipalAssignments interface

Package:

@azure/arm-kusto

Interface representing a ClusterPrincipalAssignments.

Methods

beginCreateOrUpdate(string, string, string, ClusterPrincipalAssignment, ClusterPrincipalAssignmentsCreateOrUpdateOptionalParams)	Create a Kusto cluster principalAssignment.
beginCreateOrUpdateAndWait(string, string, string, ClusterPrincipalAssignment, ClusterPrincipalAssignmentsCreateOrUpdateOptionalParams)	Create a Kusto cluster principalAssignment.
beginDelete(string, string, string, ClusterPrincipalAssignmentsDeleteOptionalParams)	Deletes a Kusto cluster principalAssignment.
beginDeleteAndWait(string, string, string, ClusterPrincipalAssignmentsDeleteOptionalParams)	Deletes a Kusto cluster principalAssignment.
checkNameAvailability(string, string, ClusterPrincipalAssignmentCheckNameRequest, ClusterPrincipalAssignmentsCheckNameAvailabilityOptionalParams)	Checks that the principal assignment name is valid and is not already in use.
get(string, string, string, ClusterPrincipalAssignmentsGetOptionalParams)	Gets a Kusto cluster principalAssignment.
list(string, string, ClusterPrincipalAssignmentsListOptionalParams)	Lists all Kusto cluster principalAssignments.

Method Details

beginCreateOrUpdate(string, string, string, ClusterPrincipalAssignment, ClusterPrincipalAssignmentsCreateOrUpdateOptionalParams)

Create a Kusto cluster principalAssignment.

function beginCreateOrUpdate(resourceGroupName: string, clusterName: string, principalAssignmentName: string, parameters: ClusterPrincipalAssignment, options?: ClusterPrincipalAssignmentsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ClusterPrincipalAssignment>, ClusterPrincipalAssignment>>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

principalAssignmentName

string

The name of the Kusto principalAssignment.

parameters

ClusterPrincipalAssignment

The Kusto cluster principalAssignment's parameters supplied for the operation.

options

ClusterPrincipalAssignmentsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<ClusterPrincipalAssignment>, ClusterPrincipalAssignment>>

beginCreateOrUpdateAndWait(string, string, string, ClusterPrincipalAssignment, ClusterPrincipalAssignmentsCreateOrUpdateOptionalParams)

Create a Kusto cluster principalAssignment.

function beginCreateOrUpdateAndWait(resourceGroupName: string, clusterName: string, principalAssignmentName: string, parameters: ClusterPrincipalAssignment, options?: ClusterPrincipalAssignmentsCreateOrUpdateOptionalParams): Promise<ClusterPrincipalAssignment>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

principalAssignmentName

string

The name of the Kusto principalAssignment.

parameters

ClusterPrincipalAssignment

The Kusto cluster principalAssignment's parameters supplied for the operation.

options

ClusterPrincipalAssignmentsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ClusterPrincipalAssignment>

beginDelete(string, string, string, ClusterPrincipalAssignmentsDeleteOptionalParams)

Deletes a Kusto cluster principalAssignment.

function beginDelete(resourceGroupName: string, clusterName: string, principalAssignmentName: string, options?: ClusterPrincipalAssignmentsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

principalAssignmentName

string

The name of the Kusto principalAssignment.

options

ClusterPrincipalAssignmentsDeleteOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, ClusterPrincipalAssignmentsDeleteOptionalParams)

Deletes a Kusto cluster principalAssignment.

function beginDeleteAndWait(resourceGroupName: string, clusterName: string, principalAssignmentName: string, options?: ClusterPrincipalAssignmentsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

principalAssignmentName

string

The name of the Kusto principalAssignment.

options

ClusterPrincipalAssignmentsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

checkNameAvailability(string, string, ClusterPrincipalAssignmentCheckNameRequest, ClusterPrincipalAssignmentsCheckNameAvailabilityOptionalParams)

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

function checkNameAvailability(resourceGroupName: string, clusterName: string, principalAssignmentName: ClusterPrincipalAssignmentCheckNameRequest, options?: ClusterPrincipalAssignmentsCheckNameAvailabilityOptionalParams): Promise<CheckNameResult>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

principalAssignmentName

ClusterPrincipalAssignmentCheckNameRequest

The name of the principal assignment.

options

ClusterPrincipalAssignmentsCheckNameAvailabilityOptionalParams

The options parameters.

Returns

Promise<CheckNameResult>

get(string, string, string, ClusterPrincipalAssignmentsGetOptionalParams)

Gets a Kusto cluster principalAssignment.

function get(resourceGroupName: string, clusterName: string, principalAssignmentName: string, options?: ClusterPrincipalAssignmentsGetOptionalParams): Promise<ClusterPrincipalAssignment>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

principalAssignmentName

string

The name of the Kusto principalAssignment.

options

ClusterPrincipalAssignmentsGetOptionalParams

The options parameters.

Returns

Promise<ClusterPrincipalAssignment>

list(string, string, ClusterPrincipalAssignmentsListOptionalParams)

Lists all Kusto cluster principalAssignments.

function list(resourceGroupName: string, clusterName: string, options?: ClusterPrincipalAssignmentsListOptionalParams): PagedAsyncIterableIterator<ClusterPrincipalAssignment, ClusterPrincipalAssignment[], PageSettings>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the Kusto cluster.

options

ClusterPrincipalAssignmentsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ClusterPrincipalAssignment, ClusterPrincipalAssignment[], PageSettings>