WorkspaceAadAdmins interface

Package:

@azure/arm-synapse

Interface representing a WorkspaceAadAdmins.

Methods

beginCreateOrUpdate(string, string, WorkspaceAadAdminInfo, WorkspaceAadAdminsCreateOrUpdateOptionalParams)	Creates or updates a workspace active directory admin
beginCreateOrUpdateAndWait(string, string, WorkspaceAadAdminInfo, WorkspaceAadAdminsCreateOrUpdateOptionalParams)	Creates or updates a workspace active directory admin
beginDelete(string, string, WorkspaceAadAdminsDeleteOptionalParams)	Deletes a workspace active directory admin
beginDeleteAndWait(string, string, WorkspaceAadAdminsDeleteOptionalParams)	Deletes a workspace active directory admin
get(string, string, WorkspaceAadAdminsGetOptionalParams)	Gets a workspace active directory admin

Method Details

beginCreateOrUpdate(string, string, WorkspaceAadAdminInfo, WorkspaceAadAdminsCreateOrUpdateOptionalParams)

Creates or updates a workspace active directory admin

function beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, aadAdminInfo: WorkspaceAadAdminInfo, options?: WorkspaceAadAdminsCreateOrUpdateOptionalParams): 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

WorkspaceAadAdminsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, WorkspaceAadAdminInfo, WorkspaceAadAdminsCreateOrUpdateOptionalParams)

Creates or updates a workspace active directory admin

function beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, aadAdminInfo: WorkspaceAadAdminInfo, options?: WorkspaceAadAdminsCreateOrUpdateOptionalParams): 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

WorkspaceAadAdminsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<WorkspaceAadAdminInfo>

beginDelete(string, string, WorkspaceAadAdminsDeleteOptionalParams)

Deletes a workspace active directory admin

function beginDelete(resourceGroupName: string, workspaceName: string, options?: WorkspaceAadAdminsDeleteOptionalParams): 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

WorkspaceAadAdminsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, WorkspaceAadAdminsDeleteOptionalParams)

Deletes a workspace active directory admin

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

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

options

WorkspaceAadAdminsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, WorkspaceAadAdminsGetOptionalParams)

Gets a workspace active directory admin

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

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

options

WorkspaceAadAdminsGetOptionalParams

The options parameters.

Returns

Promise<WorkspaceAadAdminInfo>