WorkspacesOperations interface

Interface representing a Workspaces operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginDiagnose
beginDiagnoseAndWait
beginPrepareNotebook
beginPrepareNotebookAndWait
beginResyncKeys
beginResyncKeysAndWait
beginUpdate
beginUpdateAndWait
createOrUpdate

Creates or updates a workspace with the specified parameters.

delete

Deletes a machine learning workspace.

diagnose

Diagnose workspace setup issue.

get

Gets the properties of the specified machine learning workspace.

listByResourceGroup

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

listBySubscription

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

listKeys

Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.

listNotebookAccessToken

Get Azure Machine Learning Workspace notebook access token

listNotebookKeys

Lists keys of Azure Machine Learning Workspaces notebook.

listOutboundNetworkDependenciesEndpoints

Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.

listStorageAccountKeys

Lists keys of Azure Machine Learning Workspace's storage account.

prepareNotebook

Prepare Azure Machine Learning Workspace's notebook resource

resyncKeys

Resync all the keys associated with this workspace.This includes keys for the storage account, app insights and password for container registry

update

Updates a machine learning workspace with the specified parameters.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, workspaceName: string, body: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Workspace>, Workspace>>

Property Value

(resourceGroupName: string, workspaceName: string, body: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Workspace>, Workspace>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, workspaceName: string, body: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams) => Promise<Workspace>

Property Value

(resourceGroupName: string, workspaceName: string, body: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams) => Promise<Workspace>

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDiagnose

Warning

This API is now deprecated.

use diagnose instead

beginDiagnose: (resourceGroupName: string, workspaceName: string, options?: WorkspacesDiagnoseOptionalParams) => Promise<SimplePollerLike<OperationState<DiagnoseResponseResult>, DiagnoseResponseResult>>

Property Value

(resourceGroupName: string, workspaceName: string, options?: WorkspacesDiagnoseOptionalParams) => Promise<SimplePollerLike<OperationState<DiagnoseResponseResult>, DiagnoseResponseResult>>

beginDiagnoseAndWait

Warning

This API is now deprecated.

use diagnose instead

beginDiagnoseAndWait: (resourceGroupName: string, workspaceName: string, options?: WorkspacesDiagnoseOptionalParams) => Promise<DiagnoseResponseResult>

Property Value

(resourceGroupName: string, workspaceName: string, options?: WorkspacesDiagnoseOptionalParams) => Promise<DiagnoseResponseResult>

beginPrepareNotebook

Warning

This API is now deprecated.

use prepareNotebook instead

beginPrepareNotebook: (resourceGroupName: string, workspaceName: string, options?: WorkspacesPrepareNotebookOptionalParams) => Promise<SimplePollerLike<OperationState<NotebookResourceInfo>, NotebookResourceInfo>>

Property Value

(resourceGroupName: string, workspaceName: string, options?: WorkspacesPrepareNotebookOptionalParams) => Promise<SimplePollerLike<OperationState<NotebookResourceInfo>, NotebookResourceInfo>>

beginPrepareNotebookAndWait

Warning

This API is now deprecated.

use prepareNotebook instead

beginPrepareNotebookAndWait: (resourceGroupName: string, workspaceName: string, options?: WorkspacesPrepareNotebookOptionalParams) => Promise<NotebookResourceInfo>

Property Value

(resourceGroupName: string, workspaceName: string, options?: WorkspacesPrepareNotebookOptionalParams) => Promise<NotebookResourceInfo>

beginResyncKeys

Warning

This API is now deprecated.

use resyncKeys instead

beginResyncKeys: (resourceGroupName: string, workspaceName: string, options?: WorkspacesResyncKeysOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, workspaceName: string, options?: WorkspacesResyncKeysOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginResyncKeysAndWait

Warning

This API is now deprecated.

use resyncKeys instead

beginResyncKeysAndWait: (resourceGroupName: string, workspaceName: string, options?: WorkspacesResyncKeysOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, workspaceName: string, options?: WorkspacesResyncKeysOptionalParams) => Promise<void>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, workspaceName: string, body: WorkspaceUpdateParameters, options?: WorkspacesUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Workspace>, Workspace>>

Property Value

(resourceGroupName: string, workspaceName: string, body: WorkspaceUpdateParameters, options?: WorkspacesUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Workspace>, Workspace>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, workspaceName: string, body: WorkspaceUpdateParameters, options?: WorkspacesUpdateOptionalParams) => Promise<Workspace>

Property Value

(resourceGroupName: string, workspaceName: string, body: WorkspaceUpdateParameters, options?: WorkspacesUpdateOptionalParams) => Promise<Workspace>

createOrUpdate

Creates or updates a workspace with the specified parameters.

createOrUpdate: (resourceGroupName: string, workspaceName: string, body: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams) => PollerLike<OperationState<Workspace>, Workspace>

Property Value

(resourceGroupName: string, workspaceName: string, body: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams) => PollerLike<OperationState<Workspace>, Workspace>

delete

Deletes a machine learning workspace.

delete: (resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

diagnose

Diagnose workspace setup issue.

diagnose: (resourceGroupName: string, workspaceName: string, options?: WorkspacesDiagnoseOptionalParams) => PollerLike<OperationState<DiagnoseResponseResult>, DiagnoseResponseResult>

Property Value

(resourceGroupName: string, workspaceName: string, options?: WorkspacesDiagnoseOptionalParams) => PollerLike<OperationState<DiagnoseResponseResult>, DiagnoseResponseResult>

get

Gets the properties of the specified machine learning workspace.

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

Property Value

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

listByResourceGroup

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

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

Property Value

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

listBySubscription

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

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

Property Value

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

listKeys

Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.

listKeys: (resourceGroupName: string, workspaceName: string, options?: WorkspacesListKeysOptionalParams) => Promise<ListWorkspaceKeysResult>

Property Value

(resourceGroupName: string, workspaceName: string, options?: WorkspacesListKeysOptionalParams) => Promise<ListWorkspaceKeysResult>

listNotebookAccessToken

Get Azure Machine Learning Workspace notebook access token

listNotebookAccessToken: (resourceGroupName: string, workspaceName: string, options?: WorkspacesListNotebookAccessTokenOptionalParams) => Promise<NotebookAccessTokenResult>

Property Value

(resourceGroupName: string, workspaceName: string, options?: WorkspacesListNotebookAccessTokenOptionalParams) => Promise<NotebookAccessTokenResult>

listNotebookKeys

Lists keys of Azure Machine Learning Workspaces notebook.

listNotebookKeys: (resourceGroupName: string, workspaceName: string, options?: WorkspacesListNotebookKeysOptionalParams) => Promise<ListNotebookKeysResult>

Property Value

(resourceGroupName: string, workspaceName: string, options?: WorkspacesListNotebookKeysOptionalParams) => Promise<ListNotebookKeysResult>

listOutboundNetworkDependenciesEndpoints

Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.

listOutboundNetworkDependenciesEndpoints: (resourceGroupName: string, workspaceName: string, options?: WorkspacesListOutboundNetworkDependenciesEndpointsOptionalParams) => Promise<ExternalFqdnResponse>

Property Value

(resourceGroupName: string, workspaceName: string, options?: WorkspacesListOutboundNetworkDependenciesEndpointsOptionalParams) => Promise<ExternalFqdnResponse>

listStorageAccountKeys

Lists keys of Azure Machine Learning Workspace's storage account.

listStorageAccountKeys: (resourceGroupName: string, workspaceName: string, options?: WorkspacesListStorageAccountKeysOptionalParams) => Promise<ListStorageAccountKeysResult>

Property Value

(resourceGroupName: string, workspaceName: string, options?: WorkspacesListStorageAccountKeysOptionalParams) => Promise<ListStorageAccountKeysResult>

prepareNotebook

Prepare Azure Machine Learning Workspace's notebook resource

prepareNotebook: (resourceGroupName: string, workspaceName: string, options?: WorkspacesPrepareNotebookOptionalParams) => PollerLike<OperationState<NotebookResourceInfo>, NotebookResourceInfo>

Property Value

(resourceGroupName: string, workspaceName: string, options?: WorkspacesPrepareNotebookOptionalParams) => PollerLike<OperationState<NotebookResourceInfo>, NotebookResourceInfo>

resyncKeys

Resync all the keys associated with this workspace.This includes keys for the storage account, app insights and password for container registry

resyncKeys: (resourceGroupName: string, workspaceName: string, options?: WorkspacesResyncKeysOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, workspaceName: string, options?: WorkspacesResyncKeysOptionalParams) => PollerLike<OperationState<void>, void>

update

Updates a machine learning workspace with the specified parameters.

update: (resourceGroupName: string, workspaceName: string, body: WorkspaceUpdateParameters, options?: WorkspacesUpdateOptionalParams) => PollerLike<OperationState<Workspace>, Workspace>

Property Value

(resourceGroupName: string, workspaceName: string, body: WorkspaceUpdateParameters, options?: WorkspacesUpdateOptionalParams) => PollerLike<OperationState<Workspace>, Workspace>