WorkspaceSqlAadAdmins interface

Package:

@azure/arm-synapse

Interface representing a WorkspaceSqlAadAdmins.

Methods

beginCreateOrUpdate(string, string, WorkspaceAadAdminInfo, WorkspaceSqlAadAdminsCreateOrUpdateOptionalParams)	Creates or updates a workspace SQL active directory admin
beginCreateOrUpdateAndWait(string, string, WorkspaceAadAdminInfo, WorkspaceSqlAadAdminsCreateOrUpdateOptionalParams)	Creates or updates a workspace SQL active directory admin
beginDelete(string, string, WorkspaceSqlAadAdminsDeleteOptionalParams)	Deletes a workspace SQL active directory admin
beginDeleteAndWait(string, string, WorkspaceSqlAadAdminsDeleteOptionalParams)	Deletes a workspace SQL active directory admin
get(string, string, WorkspaceSqlAadAdminsGetOptionalParams)	Gets a workspace SQL active directory admin

Method Details

beginCreateOrUpdate(string, string, WorkspaceAadAdminInfo, WorkspaceSqlAadAdminsCreateOrUpdateOptionalParams)

Creates or updates a workspace SQL active directory admin

function beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, aadAdminInfo: WorkspaceAadAdminInfo, options?: WorkspaceSqlAadAdminsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<WorkspaceAadAdminInfo>, WorkspaceAadAdminInfo>>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

aadAdminInfo

WorkspaceAadAdminInfo

Workspace active directory administrator properties

options

WorkspaceSqlAadAdminsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<WorkspaceAadAdminInfo>, WorkspaceAadAdminInfo>>

beginCreateOrUpdateAndWait(string, string, WorkspaceAadAdminInfo, WorkspaceSqlAadAdminsCreateOrUpdateOptionalParams)

Creates or updates a workspace SQL active directory admin

function beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, aadAdminInfo: WorkspaceAadAdminInfo, options?: WorkspaceSqlAadAdminsCreateOrUpdateOptionalParams): Promise<WorkspaceAadAdminInfo>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

aadAdminInfo

WorkspaceAadAdminInfo

Workspace active directory administrator properties

options

WorkspaceSqlAadAdminsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<WorkspaceAadAdminInfo>

beginDelete(string, string, WorkspaceSqlAadAdminsDeleteOptionalParams)

Deletes a workspace SQL active directory admin

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

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

options

WorkspaceSqlAadAdminsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, WorkspaceSqlAadAdminsDeleteOptionalParams)

Deletes a workspace SQL active directory admin

function beginDeleteAndWait(resourceGroupName: string, workspaceName: string, options?: WorkspaceSqlAadAdminsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

options

WorkspaceSqlAadAdminsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, WorkspaceSqlAadAdminsGetOptionalParams)

Gets a workspace SQL active directory admin

function get(resourceGroupName: string, workspaceName: string, options?: WorkspaceSqlAadAdminsGetOptionalParams): Promise<WorkspaceAadAdminInfo>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

options

WorkspaceSqlAadAdminsGetOptionalParams

The options parameters.

Returns

Promise<WorkspaceAadAdminInfo>