Workspaces interface

  • Reference
Package:
@azure/arm-workspaces

Interface representing a Workspaces.

Methods

createOrUpdate(string, string, Workspace, WorkspacesCreateOrUpdateOptionalParams)

Creates or updates a workspace with the specified parameters.
delete(string, string, WorkspacesDeleteOptionalParams)

Deletes a machine learning workspace.
get(string, string, WorkspacesGetOptionalParams)

Gets the properties of the specified machine learning workspace.
list(WorkspacesListOptionalParams)

Lists all the available machine learning workspaces under the specified subscription.
listByResourceGroup(string, WorkspacesListByResourceGroupOptionalParams)

Lists all the available machine learning workspaces under the specified resource group.
listWorkspaceKeys(string, string, WorkspacesListWorkspaceKeysOptionalParams)

List the authorization keys associated with this workspace.
resyncStorageKeys(string, string, WorkspacesResyncStorageKeysOptionalParams)

Resync storage keys associated with this workspace.
update(string, string, WorkspaceUpdateParameters, WorkspacesUpdateOptionalParams)

Updates a machine learning workspace with the specified parameters.

Method Details

createOrUpdate(string, string, Workspace, WorkspacesCreateOrUpdateOptionalParams)

Creates or updates a workspace with the specified parameters.

function createOrUpdate(resourceGroupName: string, workspaceName: string, parameters: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams): Promise<Workspace>

Parameters

resourceGroupName

string

The name of the resource group to which the machine learning workspace belongs.

workspaceName

string

The name of the machine learning workspace.

parameters
Workspace

The parameters for creating or updating a machine learning workspace.

options
WorkspacesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Workspace>

delete(string, string, WorkspacesDeleteOptionalParams)

Deletes a machine learning workspace.

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

Parameters

resourceGroupName

string

The name of the resource group to which the machine learning workspace belongs.

workspaceName

string

The name of the machine learning workspace.

options
WorkspacesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, WorkspacesGetOptionalParams)

Gets the properties of the specified machine learning workspace.

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

Parameters

resourceGroupName

string

The name of the resource group to which the machine learning workspace belongs.

workspaceName

string

The name of the machine learning workspace.

options
WorkspacesGetOptionalParams

The options parameters.

Returns

Promise<Workspace>

list(WorkspacesListOptionalParams)

Lists all the available machine learning workspaces under the specified subscription.

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

Parameters

options
WorkspacesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Workspace, Workspace[], PageSettings>

listByResourceGroup(string, WorkspacesListByResourceGroupOptionalParams)

Lists all the available machine learning workspaces under the specified resource group.

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

Parameters

resourceGroupName

string

The name of the resource group to which the machine learning workspace belongs.

options
WorkspacesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Workspace, Workspace[], PageSettings>

listWorkspaceKeys(string, string, WorkspacesListWorkspaceKeysOptionalParams)

List the authorization keys associated with this workspace.

function listWorkspaceKeys(workspaceName: string, resourceGroupName: string, options?: WorkspacesListWorkspaceKeysOptionalParams): Promise<WorkspaceKeysResponse>

Parameters

workspaceName

string

The name of the machine learning workspace.

resourceGroupName

string

The name of the resource group to which the machine learning workspace belongs.

options
WorkspacesListWorkspaceKeysOptionalParams

The options parameters.

Returns

Promise<WorkspaceKeysResponse>

resyncStorageKeys(string, string, WorkspacesResyncStorageKeysOptionalParams)

Resync storage keys associated with this workspace.

function resyncStorageKeys(workspaceName: string, resourceGroupName: string, options?: WorkspacesResyncStorageKeysOptionalParams): Promise<void>

Parameters

workspaceName

string

The name of the machine learning workspace.

resourceGroupName

string

The name of the resource group to which the machine learning workspace belongs.

options
WorkspacesResyncStorageKeysOptionalParams

The options parameters.

Returns

Promise<void>

update(string, string, WorkspaceUpdateParameters, WorkspacesUpdateOptionalParams)

Updates a machine learning workspace with the specified parameters.

function update(resourceGroupName: string, workspaceName: string, parameters: WorkspaceUpdateParameters, options?: WorkspacesUpdateOptionalParams): Promise<Workspace>

Parameters

resourceGroupName

string

The name of the resource group to which the machine learning workspace belongs.

workspaceName

string

The name of the machine learning workspace.

parameters
WorkspaceUpdateParameters

The parameters for updating a machine learning workspace.

options
WorkspacesUpdateOptionalParams

The options parameters.

Returns

Promise<Workspace>