KustoPoolPrincipalAssignments interface

Package:

@azure/arm-synapse

Interface representing a KustoPoolPrincipalAssignments.

Methods

beginCreateOrUpdate(string, string, string, string, ClusterPrincipalAssignment, KustoPoolPrincipalAssignmentsCreateOrUpdateOptionalParams)	Create a Kusto pool principalAssignment.
beginCreateOrUpdateAndWait(string, string, string, string, ClusterPrincipalAssignment, KustoPoolPrincipalAssignmentsCreateOrUpdateOptionalParams)	Create a Kusto pool principalAssignment.
beginDelete(string, string, string, string, KustoPoolPrincipalAssignmentsDeleteOptionalParams)	Deletes a Kusto pool principalAssignment.
beginDeleteAndWait(string, string, string, string, KustoPoolPrincipalAssignmentsDeleteOptionalParams)	Deletes a Kusto pool principalAssignment.
checkNameAvailability(string, string, string, ClusterPrincipalAssignmentCheckNameRequest, KustoPoolPrincipalAssignmentsCheckNameAvailabilityOptionalParams)	Checks that the principal assignment name is valid and is not already in use.
get(string, string, string, string, KustoPoolPrincipalAssignmentsGetOptionalParams)	Gets a Kusto pool principalAssignment.
list(string, string, string, KustoPoolPrincipalAssignmentsListOptionalParams)	Lists all Kusto pool principalAssignments.

Method Details

beginCreateOrUpdate(string, string, string, string, ClusterPrincipalAssignment, KustoPoolPrincipalAssignmentsCreateOrUpdateOptionalParams)

Create a Kusto pool principalAssignment.

function beginCreateOrUpdate(workspaceName: string, kustoPoolName: string, principalAssignmentName: string, resourceGroupName: string, parameters: ClusterPrincipalAssignment, options?: KustoPoolPrincipalAssignmentsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ClusterPrincipalAssignment>, ClusterPrincipalAssignment>>

Parameters

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

principalAssignmentName

string

The name of the Kusto principalAssignment.

resourceGroupName

string

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

parameters

ClusterPrincipalAssignment

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

options

KustoPoolPrincipalAssignmentsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<ClusterPrincipalAssignment>, ClusterPrincipalAssignment>>

beginCreateOrUpdateAndWait(string, string, string, string, ClusterPrincipalAssignment, KustoPoolPrincipalAssignmentsCreateOrUpdateOptionalParams)

Create a Kusto pool principalAssignment.

function beginCreateOrUpdateAndWait(workspaceName: string, kustoPoolName: string, principalAssignmentName: string, resourceGroupName: string, parameters: ClusterPrincipalAssignment, options?: KustoPoolPrincipalAssignmentsCreateOrUpdateOptionalParams): Promise<ClusterPrincipalAssignment>

Parameters

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

principalAssignmentName

string

The name of the Kusto principalAssignment.

resourceGroupName

string

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

parameters

ClusterPrincipalAssignment

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

options

KustoPoolPrincipalAssignmentsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ClusterPrincipalAssignment>

beginDelete(string, string, string, string, KustoPoolPrincipalAssignmentsDeleteOptionalParams)

Deletes a Kusto pool principalAssignment.

function beginDelete(workspaceName: string, kustoPoolName: string, principalAssignmentName: string, resourceGroupName: string, options?: KustoPoolPrincipalAssignmentsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

principalAssignmentName

string

The name of the Kusto principalAssignment.

resourceGroupName

string

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

options

KustoPoolPrincipalAssignmentsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait(string, string, string, string, KustoPoolPrincipalAssignmentsDeleteOptionalParams)

Deletes a Kusto pool principalAssignment.

function beginDeleteAndWait(workspaceName: string, kustoPoolName: string, principalAssignmentName: string, resourceGroupName: string, options?: KustoPoolPrincipalAssignmentsDeleteOptionalParams): Promise<void>

Parameters

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

principalAssignmentName

string

The name of the Kusto principalAssignment.

resourceGroupName

string

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

options

KustoPoolPrincipalAssignmentsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

checkNameAvailability(string, string, string, ClusterPrincipalAssignmentCheckNameRequest, KustoPoolPrincipalAssignmentsCheckNameAvailabilityOptionalParams)

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

function checkNameAvailability(workspaceName: string, kustoPoolName: string, resourceGroupName: string, principalAssignmentName: ClusterPrincipalAssignmentCheckNameRequest, options?: KustoPoolPrincipalAssignmentsCheckNameAvailabilityOptionalParams): Promise<CheckNameResult>

Parameters

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

resourceGroupName

string

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

principalAssignmentName

ClusterPrincipalAssignmentCheckNameRequest

The name of the principal assignment.

options

KustoPoolPrincipalAssignmentsCheckNameAvailabilityOptionalParams

The options parameters.

Returns

Promise<CheckNameResult>

get(string, string, string, string, KustoPoolPrincipalAssignmentsGetOptionalParams)

Gets a Kusto pool principalAssignment.

function get(workspaceName: string, kustoPoolName: string, principalAssignmentName: string, resourceGroupName: string, options?: KustoPoolPrincipalAssignmentsGetOptionalParams): Promise<ClusterPrincipalAssignment>

Parameters

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

principalAssignmentName

string

The name of the Kusto principalAssignment.

resourceGroupName

string

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

options

KustoPoolPrincipalAssignmentsGetOptionalParams

The options parameters.

Returns

Promise<ClusterPrincipalAssignment>

list(string, string, string, KustoPoolPrincipalAssignmentsListOptionalParams)

Lists all Kusto pool principalAssignments.

function list(workspaceName: string, kustoPoolName: string, resourceGroupName: string, options?: KustoPoolPrincipalAssignmentsListOptionalParams): PagedAsyncIterableIterator<ClusterPrincipalAssignment, ClusterPrincipalAssignment[], PageSettings>

Parameters

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

resourceGroupName

string

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

options

KustoPoolPrincipalAssignmentsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ClusterPrincipalAssignment, ClusterPrincipalAssignment[], PageSettings>