KustoPoolPrincipalAssignments | @azure/arm-synapse

Interface representing a KustoPoolPrincipalAssignments.

Hierarchy

KustoPoolPrincipalAssignments

Implemented by

KustoPoolPrincipalAssignmentsImpl

Index

Methods

beginCreateOrUpdate

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

- Defined in operationsInterfaces/kustoPoolPrincipalAssignments.ts:79
Create a Kusto pool principalAssignment.

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.
- Optional options: KustoPoolPrincipalAssignmentsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<KustoPoolPrincipalAssignmentsCreateOrUpdateResponse>, KustoPoolPrincipalAssignmentsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

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

- Defined in operationsInterfaces/kustoPoolPrincipalAssignments.ts:101
Create a Kusto pool principalAssignment.

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.
- Optional options: KustoPoolPrincipalAssignmentsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<KustoPoolPrincipalAssignmentsCreateOrUpdateResponse>

beginDelete

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

- Defined in operationsInterfaces/kustoPoolPrincipalAssignments.ts:117
Deletes a Kusto pool principalAssignment.

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.
- Optional options: KustoPoolPrincipalAssignmentsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

- Defined in operationsInterfaces/kustoPoolPrincipalAssignments.ts:132
Deletes a Kusto pool principalAssignment.

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.
- Optional options: KustoPoolPrincipalAssignmentsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

checkNameAvailability

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

- Defined in operationsInterfaces/kustoPoolPrincipalAssignments.ts:48
Checks that the principal assignment name is valid and is not already in use.

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.
- Optional options: KustoPoolPrincipalAssignmentsCheckNameAvailabilityOptionalParams
  
  The options parameters.
Returns Promise<KustoPoolPrincipalAssignmentsCheckNameAvailabilityResponse>

get

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

- Defined in operationsInterfaces/kustoPoolPrincipalAssignments.ts:63
Gets a Kusto pool principalAssignment.

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.
- Optional options: KustoPoolPrincipalAssignmentsGetOptionalParams
  
  The options parameters.
Returns Promise<KustoPoolPrincipalAssignmentsGetResponse>

list

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

- Defined in operationsInterfaces/kustoPoolPrincipalAssignments.ts:34
Lists all Kusto pool principalAssignments.

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.
- Optional options: KustoPoolPrincipalAssignmentsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ClusterPrincipalAssignment>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

workspaceName: string

kustoPoolName: string

principalAssignmentName: string

resourceGroupName: string

parameters: ClusterPrincipalAssignment

Optional options: KustoPoolPrincipalAssignmentsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<KustoPoolPrincipalAssignmentsCreateOrUpdateResponse>, KustoPoolPrincipalAssignmentsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

workspaceName: string

kustoPoolName: string

principalAssignmentName: string

resourceGroupName: string

parameters: ClusterPrincipalAssignment

Optional options: KustoPoolPrincipalAssignmentsCreateOrUpdateOptionalParams

Returns Promise<KustoPoolPrincipalAssignmentsCreateOrUpdateResponse>

beginDelete

Parameters

workspaceName: string

kustoPoolName: string

principalAssignmentName: string

resourceGroupName: string

Optional options: KustoPoolPrincipalAssignmentsDeleteOptionalParams

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

beginDeleteAndWait

Parameters

workspaceName: string

kustoPoolName: string

principalAssignmentName: string

resourceGroupName: string

Optional options: KustoPoolPrincipalAssignmentsDeleteOptionalParams

Returns Promise<void>

checkNameAvailability

Parameters

workspaceName: string

kustoPoolName: string

resourceGroupName: string

principalAssignmentName: ClusterPrincipalAssignmentCheckNameRequest

Optional options: KustoPoolPrincipalAssignmentsCheckNameAvailabilityOptionalParams

Returns Promise<KustoPoolPrincipalAssignmentsCheckNameAvailabilityResponse>

get

Parameters

workspaceName: string

kustoPoolName: string

principalAssignmentName: string

resourceGroupName: string

Optional options: KustoPoolPrincipalAssignmentsGetOptionalParams

Returns Promise<KustoPoolPrincipalAssignmentsGetResponse>

list

Parameters

workspaceName: string

kustoPoolName: string

resourceGroupName: string

Optional options: KustoPoolPrincipalAssignmentsListOptionalParams

Returns PagedAsyncIterableIterator<ClusterPrincipalAssignment>