KustoPoolDatabasePrincipalAssignments interface

Package:

@azure/arm-synapse

Interface representing a KustoPoolDatabasePrincipalAssignments.

Methods

beginCreateOrUpdate(string, string, string, string, string, DatabasePrincipalAssignment, KustoPoolDatabasePrincipalAssignmentsCreateOrUpdateOptionalParams)	Creates a Kusto pool database principalAssignment.
beginCreateOrUpdateAndWait(string, string, string, string, string, DatabasePrincipalAssignment, KustoPoolDatabasePrincipalAssignmentsCreateOrUpdateOptionalParams)	Creates a Kusto pool database principalAssignment.
beginDelete(string, string, string, string, string, KustoPoolDatabasePrincipalAssignmentsDeleteOptionalParams)	Deletes a Kusto pool principalAssignment.
beginDeleteAndWait(string, string, string, string, string, KustoPoolDatabasePrincipalAssignmentsDeleteOptionalParams)	Deletes a Kusto pool principalAssignment.
checkNameAvailability(string, string, string, string, DatabasePrincipalAssignmentCheckNameRequest, KustoPoolDatabasePrincipalAssignmentsCheckNameAvailabilityOptionalParams)	Checks that the database principal assignment is valid and is not already in use.
get(string, string, string, string, string, KustoPoolDatabasePrincipalAssignmentsGetOptionalParams)	Gets a Kusto pool database principalAssignment.
list(string, string, string, string, KustoPoolDatabasePrincipalAssignmentsListOptionalParams)	Lists all Kusto pool database principalAssignments.

Method Details

beginCreateOrUpdate(string, string, string, string, string, DatabasePrincipalAssignment, KustoPoolDatabasePrincipalAssignmentsCreateOrUpdateOptionalParams)

Creates a Kusto pool database principalAssignment.

function beginCreateOrUpdate(workspaceName: string, kustoPoolName: string, databaseName: string, principalAssignmentName: string, resourceGroupName: string, parameters: DatabasePrincipalAssignment, options?: KustoPoolDatabasePrincipalAssignmentsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<DatabasePrincipalAssignment>, DatabasePrincipalAssignment>>

Parameters

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

databaseName

string

The name of the database in 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

DatabasePrincipalAssignment

The Kusto principalAssignments parameters supplied for the operation.

options

KustoPoolDatabasePrincipalAssignmentsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<DatabasePrincipalAssignment>, DatabasePrincipalAssignment>>

beginCreateOrUpdateAndWait(string, string, string, string, string, DatabasePrincipalAssignment, KustoPoolDatabasePrincipalAssignmentsCreateOrUpdateOptionalParams)

Creates a Kusto pool database principalAssignment.

function beginCreateOrUpdateAndWait(workspaceName: string, kustoPoolName: string, databaseName: string, principalAssignmentName: string, resourceGroupName: string, parameters: DatabasePrincipalAssignment, options?: KustoPoolDatabasePrincipalAssignmentsCreateOrUpdateOptionalParams): Promise<DatabasePrincipalAssignment>

Parameters

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

databaseName

string

The name of the database in 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

DatabasePrincipalAssignment

The Kusto principalAssignments parameters supplied for the operation.

options

KustoPoolDatabasePrincipalAssignmentsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<DatabasePrincipalAssignment>

beginDelete(string, string, string, string, string, KustoPoolDatabasePrincipalAssignmentsDeleteOptionalParams)

Deletes a Kusto pool principalAssignment.

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

Parameters

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

databaseName

string

The name of the database in 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

KustoPoolDatabasePrincipalAssignmentsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, string, string, KustoPoolDatabasePrincipalAssignmentsDeleteOptionalParams)

Deletes a Kusto pool principalAssignment.

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

Parameters

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

databaseName

string

The name of the database in 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

KustoPoolDatabasePrincipalAssignmentsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

checkNameAvailability(string, string, string, string, DatabasePrincipalAssignmentCheckNameRequest, KustoPoolDatabasePrincipalAssignmentsCheckNameAvailabilityOptionalParams)

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

function checkNameAvailability(workspaceName: string, kustoPoolName: string, databaseName: string, resourceGroupName: string, principalAssignmentName: DatabasePrincipalAssignmentCheckNameRequest, options?: KustoPoolDatabasePrincipalAssignmentsCheckNameAvailabilityOptionalParams): Promise<CheckNameResult>

Parameters

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

databaseName

string

The name of the database in the Kusto pool.

resourceGroupName

string

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

principalAssignmentName

DatabasePrincipalAssignmentCheckNameRequest

The name of the resource.

options

KustoPoolDatabasePrincipalAssignmentsCheckNameAvailabilityOptionalParams

The options parameters.

Returns

Promise<CheckNameResult>

get(string, string, string, string, string, KustoPoolDatabasePrincipalAssignmentsGetOptionalParams)

Gets a Kusto pool database principalAssignment.

function get(workspaceName: string, kustoPoolName: string, databaseName: string, principalAssignmentName: string, resourceGroupName: string, options?: KustoPoolDatabasePrincipalAssignmentsGetOptionalParams): Promise<DatabasePrincipalAssignment>

Parameters

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

databaseName

string

The name of the database in 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

KustoPoolDatabasePrincipalAssignmentsGetOptionalParams

The options parameters.

Returns

Promise<DatabasePrincipalAssignment>

list(string, string, string, string, KustoPoolDatabasePrincipalAssignmentsListOptionalParams)

Lists all Kusto pool database principalAssignments.

function list(workspaceName: string, kustoPoolName: string, databaseName: string, resourceGroupName: string, options?: KustoPoolDatabasePrincipalAssignmentsListOptionalParams): PagedAsyncIterableIterator<DatabasePrincipalAssignment, DatabasePrincipalAssignment[], PageSettings>

Parameters

workspaceName

string

The name of the workspace.

kustoPoolName

string

The name of the Kusto pool.

databaseName

string

The name of the database in the Kusto pool.

resourceGroupName

string

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

options

KustoPoolDatabasePrincipalAssignmentsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DatabasePrincipalAssignment, DatabasePrincipalAssignment[], PageSettings>