Workspaces interface

  • Reference
Package:
@azure/arm-quantum

Interface representing a Workspaces.

Methods

beginCreateOrUpdate(string, string, QuantumWorkspace, WorkspacesCreateOrUpdateOptionalParams)

Creates or updates a workspace resource.
beginCreateOrUpdateAndWait(string, string, QuantumWorkspace, WorkspacesCreateOrUpdateOptionalParams)

Creates or updates a workspace resource.
beginDelete(string, string, WorkspacesDeleteOptionalParams)

Deletes a Workspace resource.
beginDeleteAndWait(string, string, WorkspacesDeleteOptionalParams)

Deletes a Workspace resource.
get(string, string, WorkspacesGetOptionalParams)

Returns the Workspace resource associated with the given name.
listByResourceGroup(string, WorkspacesListByResourceGroupOptionalParams)

Gets the list of Workspaces within a resource group.
listBySubscription(WorkspacesListBySubscriptionOptionalParams)

Gets the list of Workspaces within a Subscription.
updateTags(string, string, TagsObject, WorkspacesUpdateTagsOptionalParams)

Updates an existing workspace's tags.

Method Details

beginCreateOrUpdate(string, string, QuantumWorkspace, WorkspacesCreateOrUpdateOptionalParams)

Creates or updates a workspace resource.

function beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, quantumWorkspace: QuantumWorkspace, options?: WorkspacesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<QuantumWorkspace>, QuantumWorkspace>>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the quantum workspace resource.

quantumWorkspace
QuantumWorkspace

Workspace details.

options
WorkspacesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<QuantumWorkspace>, QuantumWorkspace>>

beginCreateOrUpdateAndWait(string, string, QuantumWorkspace, WorkspacesCreateOrUpdateOptionalParams)

Creates or updates a workspace resource.

function beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, quantumWorkspace: QuantumWorkspace, options?: WorkspacesCreateOrUpdateOptionalParams): Promise<QuantumWorkspace>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the quantum workspace resource.

quantumWorkspace
QuantumWorkspace

Workspace details.

options
WorkspacesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<QuantumWorkspace>

beginDelete(string, string, WorkspacesDeleteOptionalParams)

Deletes a Workspace resource.

function beginDelete(resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the quantum workspace resource.

options
WorkspacesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, WorkspacesDeleteOptionalParams)

Deletes a Workspace resource.

function beginDeleteAndWait(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 quantum workspace resource.

options
WorkspacesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, WorkspacesGetOptionalParams)

Returns the Workspace resource associated with the given name.

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

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the quantum workspace resource.

options
WorkspacesGetOptionalParams

The options parameters.

Returns

Promise<QuantumWorkspace>

listByResourceGroup(string, WorkspacesListByResourceGroupOptionalParams)

Gets the list of Workspaces within a resource group.

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

Parameters

resourceGroupName

string

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

options
WorkspacesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<QuantumWorkspace, QuantumWorkspace[], PageSettings>

listBySubscription(WorkspacesListBySubscriptionOptionalParams)

Gets the list of Workspaces within a Subscription.

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

Parameters

options
WorkspacesListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<QuantumWorkspace, QuantumWorkspace[], PageSettings>

updateTags(string, string, TagsObject, WorkspacesUpdateTagsOptionalParams)

Updates an existing workspace's tags.

function updateTags(resourceGroupName: string, workspaceName: string, workspaceTags: TagsObject, options?: WorkspacesUpdateTagsOptionalParams): Promise<QuantumWorkspace>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the quantum workspace resource.

workspaceTags
TagsObject

Parameters supplied to update tags.

options
WorkspacesUpdateTagsOptionalParams

The options parameters.

Returns

Promise<QuantumWorkspace>