Workspaces interface

Package:

@azure/arm-desktopvirtualization

Interface representing a Workspaces.

Methods

createOrUpdate(string, string, Workspace, WorkspacesCreateOrUpdateOptionalParams)	Create or update a workspace.
delete(string, string, WorkspacesDeleteOptionalParams)	Remove a workspace.
get(string, string, WorkspacesGetOptionalParams)	Get a workspace.
listByResourceGroup(string, WorkspacesListByResourceGroupOptionalParams)	List workspaces.
listBySubscription(WorkspacesListBySubscriptionOptionalParams)	List workspaces in subscription.
update(string, string, WorkspacesUpdateOptionalParams)	Update a workspace.

Method Details

createOrUpdate(string, string, Workspace, WorkspacesCreateOrUpdateOptionalParams)

Create or update a workspace.

function createOrUpdate(resourceGroupName: string, workspaceName: string, workspace: 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

workspace

Workspace

Object containing Workspace definitions.

options

WorkspacesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Workspace>

delete(string, string, WorkspacesDeleteOptionalParams)

Remove a workspace.

function delete(resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams): Promise<void>

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<void>

get(string, string, WorkspacesGetOptionalParams)

Get 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>

listByResourceGroup(string, WorkspacesListByResourceGroupOptionalParams)

List workspaces.

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>

listBySubscription(WorkspacesListBySubscriptionOptionalParams)

List workspaces in subscription.

function listBySubscription(options?: WorkspacesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Workspace, Workspace[], PageSettings>

Parameters

options

WorkspacesListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Workspace, Workspace[], PageSettings>

update(string, string, WorkspacesUpdateOptionalParams)

Update a workspace.

function update(resourceGroupName: string, workspaceName: string, 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

options

WorkspacesUpdateOptionalParams

The options parameters.

Returns

Promise<Workspace>