Workspaces interface
Interface representing a Workspaces.
Methods
Method Details
beginCreateOrUpdate(string, string, Workspace, WorkspacesCreateOrUpdateOptionalParams)
Creates or updates a workspace with the specified parameters.
function beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, parameters: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<Workspace>, Workspace>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
Name of Azure Machine Learning workspace.
- parameters
- Workspace
The parameters for creating or updating a machine learning workspace.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<Workspace>, Workspace>>
beginCreateOrUpdateAndWait(string, string, Workspace, WorkspacesCreateOrUpdateOptionalParams)
Creates or updates a workspace with the specified parameters.
function beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, parameters: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams): Promise<Workspace>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
Name of Azure Machine Learning workspace.
- parameters
- Workspace
The parameters for creating or updating a machine learning workspace.
The options parameters.
Returns
Promise<Workspace>
beginDelete(string, string, WorkspacesDeleteOptionalParams)
Deletes a machine learning workspace.
function beginDelete(resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
Name of Azure Machine Learning workspace.
- options
- WorkspacesDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, WorkspacesDeleteOptionalParams)
Deletes a machine learning workspace.
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
Name of Azure Machine Learning workspace.
- options
- WorkspacesDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginDiagnose(string, string, WorkspacesDiagnoseOptionalParams)
Diagnose workspace setup issue.
function beginDiagnose(resourceGroupName: string, workspaceName: string, options?: WorkspacesDiagnoseOptionalParams): Promise<PollerLike<PollOperationState<DiagnoseResponseResult>, DiagnoseResponseResult>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
Name of Azure Machine Learning workspace.
- options
- WorkspacesDiagnoseOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<DiagnoseResponseResult>, DiagnoseResponseResult>>
beginDiagnoseAndWait(string, string, WorkspacesDiagnoseOptionalParams)
Diagnose workspace setup issue.
function beginDiagnoseAndWait(resourceGroupName: string, workspaceName: string, options?: WorkspacesDiagnoseOptionalParams): Promise<DiagnoseResponseResult>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
Name of Azure Machine Learning workspace.
- options
- WorkspacesDiagnoseOptionalParams
The options parameters.
Returns
Promise<DiagnoseResponseResult>
beginPrepareNotebook(string, string, WorkspacesPrepareNotebookOptionalParams)
Prepare a notebook.
function beginPrepareNotebook(resourceGroupName: string, workspaceName: string, options?: WorkspacesPrepareNotebookOptionalParams): Promise<PollerLike<PollOperationState<NotebookResourceInfo>, NotebookResourceInfo>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
Name of Azure Machine Learning workspace.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<NotebookResourceInfo>, NotebookResourceInfo>>
beginPrepareNotebookAndWait(string, string, WorkspacesPrepareNotebookOptionalParams)
Prepare a notebook.
function beginPrepareNotebookAndWait(resourceGroupName: string, workspaceName: string, options?: WorkspacesPrepareNotebookOptionalParams): Promise<NotebookResourceInfo>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
Name of Azure Machine Learning workspace.
The options parameters.
Returns
Promise<NotebookResourceInfo>
beginResyncKeys(string, string, WorkspacesResyncKeysOptionalParams)
Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry
function beginResyncKeys(resourceGroupName: string, workspaceName: string, options?: WorkspacesResyncKeysOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
Name of Azure Machine Learning workspace.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginResyncKeysAndWait(string, string, WorkspacesResyncKeysOptionalParams)
Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry
function beginResyncKeysAndWait(resourceGroupName: string, workspaceName: string, options?: WorkspacesResyncKeysOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
Name of Azure Machine Learning workspace.
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. The name is case insensitive.
- workspaceName
-
string
Name of Azure Machine Learning workspace.
- options
- WorkspacesGetOptionalParams
The options parameters.
Returns
Promise<Workspace>
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. The name is case insensitive.
The options parameters.
Returns
listBySubscription(WorkspacesListBySubscriptionOptionalParams)
Lists all the available machine learning workspaces under the specified subscription.
function listBySubscription(options?: WorkspacesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Workspace, Workspace[], PageSettings>Parameters
The options parameters.
Returns
listKeys(string, string, WorkspacesListKeysOptionalParams)
Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry
function listKeys(resourceGroupName: string, workspaceName: string, options?: WorkspacesListKeysOptionalParams): Promise<ListWorkspaceKeysResult>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
Name of Azure Machine Learning workspace.
- options
- WorkspacesListKeysOptionalParams
The options parameters.
Returns
Promise<ListWorkspaceKeysResult>
listNotebookAccessToken(string, string, WorkspacesListNotebookAccessTokenOptionalParams)
return notebook access token and refresh token
function listNotebookAccessToken(resourceGroupName: string, workspaceName: string, options?: WorkspacesListNotebookAccessTokenOptionalParams): Promise<NotebookAccessTokenResult>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
Name of Azure Machine Learning workspace.
The options parameters.
Returns
Promise<NotebookAccessTokenResult>
listNotebookKeys(string, string, WorkspacesListNotebookKeysOptionalParams)
List keys of a notebook.
function listNotebookKeys(resourceGroupName: string, workspaceName: string, options?: WorkspacesListNotebookKeysOptionalParams): Promise<ListNotebookKeysResult>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
Name of Azure Machine Learning workspace.
The options parameters.
Returns
Promise<ListNotebookKeysResult>
listOutboundNetworkDependenciesEndpoints(string, string, WorkspacesListOutboundNetworkDependenciesEndpointsOptionalParams)
Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.
function listOutboundNetworkDependenciesEndpoints(resourceGroupName: string, workspaceName: string, options?: WorkspacesListOutboundNetworkDependenciesEndpointsOptionalParams): Promise<ExternalFqdnResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
Name of Azure Machine Learning workspace.
The options parameters.
Returns
Promise<ExternalFqdnResponse>
listStorageAccountKeys(string, string, WorkspacesListStorageAccountKeysOptionalParams)
List storage account keys of a workspace.
function listStorageAccountKeys(resourceGroupName: string, workspaceName: string, options?: WorkspacesListStorageAccountKeysOptionalParams): Promise<ListStorageAccountKeysResult>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
Name of Azure Machine Learning workspace.
The options parameters.
Returns
Promise<ListStorageAccountKeysResult>
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. The name is case insensitive.
- workspaceName
-
string
Name of Azure Machine Learning workspace.
- parameters
- WorkspaceUpdateParameters
The parameters for updating a machine learning workspace.
- options
- WorkspacesUpdateOptionalParams
The options parameters.
Returns
Promise<Workspace>