Workspaces | @azure/arm-synapse

Interface representing a Workspaces.

Hierarchy

Workspaces

Implemented by

WorkspacesImpl

Index

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, workspaceInfo: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<WorkspacesCreateOrUpdateResponse>, WorkspacesCreateOrUpdateResponse>>

- Defined in operationsInterfaces/workspaces.ts:94
Creates or updates a workspace

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- workspaceInfo: Workspace
  
  Workspace create or update request properties
- Optional options: WorkspacesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<WorkspacesCreateOrUpdateResponse>, WorkspacesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, workspaceInfo: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams): Promise<WorkspacesCreateOrUpdateResponse>

- Defined in operationsInterfaces/workspaces.ts:112
Creates or updates a workspace

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- workspaceInfo: Workspace
  
  Workspace create or update request properties
- Optional options: WorkspacesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<WorkspacesCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams): Promise<PollerLike<PollOperationState<WorkspacesDeleteResponse>, WorkspacesDeleteResponse>>

- Defined in operationsInterfaces/workspaces.ts:124
Deletes a workspace

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

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams): Promise<WorkspacesDeleteResponse>

- Defined in operationsInterfaces/workspaces.ts:140
Deletes a workspace

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

beginUpdate

beginUpdate(resourceGroupName: string, workspaceName: string, workspacePatchInfo: WorkspacePatchInfo, options?: WorkspacesUpdateOptionalParams): Promise<PollerLike<PollOperationState<WorkspacesUpdateResponse>, WorkspacesUpdateResponse>>

- Defined in operationsInterfaces/workspaces.ts:63
Updates a workspace

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- workspacePatchInfo: WorkspacePatchInfo
  
  Workspace patch request properties
- Optional options: WorkspacesUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<WorkspacesUpdateResponse>, WorkspacesUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, workspaceName: string, workspacePatchInfo: WorkspacePatchInfo, options?: WorkspacesUpdateOptionalParams): Promise<WorkspacesUpdateResponse>

- Defined in operationsInterfaces/workspaces.ts:81
Updates a workspace

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- workspacePatchInfo: WorkspacePatchInfo
  
  Workspace patch request properties
- Optional options: WorkspacesUpdateOptionalParams
  
  The options parameters.
Returns Promise<WorkspacesUpdateResponse>

get

get(resourceGroupName: string, workspaceName: string, options?: WorkspacesGetOptionalParams): Promise<WorkspacesGetResponse>

- Defined in operationsInterfaces/workspaces.ts:51
Gets a workspace

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

list

list(options?: WorkspacesListOptionalParams): PagedAsyncIterableIterator<Workspace>

- Defined in operationsInterfaces/workspaces.ts:42
Returns a list of workspaces in a subscription

Parameters
- Optional options: WorkspacesListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Workspace>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: WorkspacesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Workspace>

- Defined in operationsInterfaces/workspaces.ts:34
Returns a list of workspaces in a resource group

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- Optional options: WorkspacesListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Workspace>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

workspaceName: string

workspaceInfo: Workspace

Optional options: WorkspacesCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<WorkspacesCreateOrUpdateResponse>, WorkspacesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

workspaceName: string

workspaceInfo: Workspace

Optional options: WorkspacesCreateOrUpdateOptionalParams

Returns Promise<WorkspacesCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

workspaceName: string

Optional options: WorkspacesDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<WorkspacesDeleteResponse>, WorkspacesDeleteResponse>>

beginDeleteAndWait

Parameters

resourceGroupName: string

workspaceName: string

Optional options: WorkspacesDeleteOptionalParams

Returns Promise<WorkspacesDeleteResponse>

beginUpdate

Parameters

resourceGroupName: string

workspaceName: string

workspacePatchInfo: WorkspacePatchInfo

Optional options: WorkspacesUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<WorkspacesUpdateResponse>, WorkspacesUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

workspaceName: string

workspacePatchInfo: WorkspacePatchInfo

Optional options: WorkspacesUpdateOptionalParams

Returns Promise<WorkspacesUpdateResponse>

get

Parameters

resourceGroupName: string

workspaceName: string

Optional options: WorkspacesGetOptionalParams

Returns Promise<WorkspacesGetResponse>

list

Parameters

Optional options: WorkspacesListOptionalParams

Returns PagedAsyncIterableIterator<Workspace>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: WorkspacesListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<Workspace>