Workspaces interface

Package:

@azure/arm-synapse

Interface representing a Workspaces.

Methods

beginCreateOrUpdate(string, string, Workspace, WorkspacesCreateOrUpdateOptionalParams)	Creates or updates a workspace
beginCreateOrUpdateAndWait(string, string, Workspace, WorkspacesCreateOrUpdateOptionalParams)	Creates or updates a workspace
beginDelete(string, string, WorkspacesDeleteOptionalParams)	Deletes a workspace
beginDeleteAndWait(string, string, WorkspacesDeleteOptionalParams)	Deletes a workspace
beginUpdate(string, string, WorkspacePatchInfo, WorkspacesUpdateOptionalParams)	Updates a workspace
beginUpdateAndWait(string, string, WorkspacePatchInfo, WorkspacesUpdateOptionalParams)	Updates a workspace
get(string, string, WorkspacesGetOptionalParams)	Gets a workspace
list(WorkspacesListOptionalParams)	Returns a list of workspaces in a subscription
listByResourceGroup(string, WorkspacesListByResourceGroupOptionalParams)	Returns a list of workspaces in a resource group

Method Details

beginCreateOrUpdate(string, string, Workspace, WorkspacesCreateOrUpdateOptionalParams)

Creates or updates a workspace

function beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, workspaceInfo: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<Workspace>, 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

options

WorkspacesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<Workspace>, Workspace>>

beginCreateOrUpdateAndWait(string, string, Workspace, WorkspacesCreateOrUpdateOptionalParams)

Creates or updates a workspace

function beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, workspaceInfo: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams): Promise<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

options

WorkspacesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Workspace>

beginDelete(string, string, WorkspacesDeleteOptionalParams)

Deletes a workspace

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

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

options

WorkspacesDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<WorkspacesDeleteResponse>, WorkspacesDeleteResponse>>

beginDeleteAndWait(string, string, WorkspacesDeleteOptionalParams)

Deletes a workspace

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

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

options

WorkspacesDeleteOptionalParams

The options parameters.

Returns

Promise<WorkspacesDeleteResponse>

beginUpdate(string, string, WorkspacePatchInfo, WorkspacesUpdateOptionalParams)

Updates a workspace

function beginUpdate(resourceGroupName: string, workspaceName: string, workspacePatchInfo: WorkspacePatchInfo, options?: WorkspacesUpdateOptionalParams): Promise<PollerLike<PollOperationState<Workspace>, 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

options

WorkspacesUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<Workspace>, Workspace>>

beginUpdateAndWait(string, string, WorkspacePatchInfo, WorkspacesUpdateOptionalParams)

Updates a workspace

function beginUpdateAndWait(resourceGroupName: string, workspaceName: string, workspacePatchInfo: WorkspacePatchInfo, options?: WorkspacesUpdateOptionalParams): Promise<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

options

WorkspacesUpdateOptionalParams

The options parameters.

Returns

Promise<Workspace>

get(string, string, WorkspacesGetOptionalParams)

Gets a workspace

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

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

options

WorkspacesGetOptionalParams

The options parameters.

Returns

Promise<Workspace>

list(WorkspacesListOptionalParams)

Returns a list of workspaces in a subscription

function list(options?: WorkspacesListOptionalParams): PagedAsyncIterableIterator<Workspace, Workspace[], PageSettings>

Parameters

options

WorkspacesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Workspace, Workspace[], PageSettings>

listByResourceGroup(string, WorkspacesListByResourceGroupOptionalParams)

Returns a list of workspaces in a resource group

function listByResourceGroup(resourceGroupName: string, options?: WorkspacesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Workspace, Workspace[], PageSettings>

Parameters

resourceGroupName

string

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

options

WorkspacesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Workspace, Workspace[], PageSettings>