WorkspaceSqlAadAdmins | @azure/arm-synapse

Interface representing a WorkspaceSqlAadAdmins.

Hierarchy

WorkspaceSqlAadAdmins

Implemented by

WorkspaceSqlAadAdminsImpl

Index

Methods

beginCreateOrUpdate

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

- Defined in operationsInterfaces/workspaceSqlAadAdmins.ts:39
Creates or updates a workspace SQL active directory admin

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

beginCreateOrUpdateAndWait

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

- Defined in operationsInterfaces/workspaceSqlAadAdmins.ts:57
Creates or updates a workspace SQL active directory admin

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

beginDelete

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

- Defined in operationsInterfaces/workspaceSqlAadAdmins.ts:69
Deletes a workspace SQL active directory admin

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- Optional options: WorkspaceSqlAadAdminsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

- Defined in operationsInterfaces/workspaceSqlAadAdmins.ts:80
Deletes a workspace SQL active directory admin

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- Optional options: WorkspaceSqlAadAdminsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

- Defined in operationsInterfaces/workspaceSqlAadAdmins.ts:27
Gets a workspace SQL active directory admin

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- Optional options: WorkspaceSqlAadAdminsGetOptionalParams
  
  The options parameters.
Returns Promise<WorkspaceSqlAadAdminsGetResponse>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

workspaceName: string

aadAdminInfo: WorkspaceAadAdminInfo

Optional options: WorkspaceSqlAadAdminsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<WorkspaceSqlAadAdminsCreateOrUpdateResponse>, WorkspaceSqlAadAdminsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

workspaceName: string

aadAdminInfo: WorkspaceAadAdminInfo

Optional options: WorkspaceSqlAadAdminsCreateOrUpdateOptionalParams

Returns Promise<WorkspaceSqlAadAdminsCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

workspaceName: string

Optional options: WorkspaceSqlAadAdminsDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

workspaceName: string

Optional options: WorkspaceSqlAadAdminsDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

workspaceName: string

Optional options: WorkspaceSqlAadAdminsGetOptionalParams

Returns Promise<WorkspaceSqlAadAdminsGetResponse>