WorkspacesImpl | @azure/arm-machinelearning

Class containing Workspaces operations.

Hierarchy

WorkspacesImpl

Implements

Workspaces

Constructors

constructor

new WorkspacesImpl(client: AzureMachineLearningWorkspaces): WorkspacesImpl

- Defined in operations/workspaces.ts:55
Initialize a new instance of the class Workspaces class.

Parameters
- client: AzureMachineLearningWorkspaces
  
  Reference to the service client
Returns WorkspacesImpl

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, parameters: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<WorkspacesCreateOrUpdateResponse>, WorkspacesCreateOrUpdateResponse>>

Implementation of Workspaces.beginCreateOrUpdate
- Defined in operations/workspaces.ts:184
Creates or updates a workspace with the specified parameters.

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.
- Optional options: WorkspacesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<WorkspacesCreateOrUpdateResponse>, WorkspacesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, parameters: Workspace, options?: WorkspacesCreateOrUpdateOptionalParams): Promise<WorkspacesCreateOrUpdateResponse>

Implementation of Workspaces.beginCreateOrUpdateAndWait
- Defined in operations/workspaces.ts:254
Creates or updates a workspace with the specified parameters.

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.
- Optional options: WorkspacesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<WorkspacesCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, workspaceName: string, options?: WorkspacesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of Workspaces.beginDelete
- Defined in operations/workspaces.ts:275
Deletes a machine learning workspace.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- Optional options: WorkspacesDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

Implementation of Workspaces.beginDeleteAndWait
- Defined in operations/workspaces.ts:338
Deletes a machine learning workspace.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- Optional options: WorkspacesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginDiagnose

beginDiagnose(resourceGroupName: string, workspaceName: string, options?: WorkspacesDiagnoseOptionalParams): Promise<PollerLike<PollOperationState<WorkspacesDiagnoseResponse>, WorkspacesDiagnoseResponse>>

Implementation of Workspaces.beginDiagnose
- Defined in operations/workspaces.ts:464
Diagnose workspace setup issue.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- Optional options: WorkspacesDiagnoseOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<WorkspacesDiagnoseResponse>, WorkspacesDiagnoseResponse>>

beginDiagnoseAndWait

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

Implementation of Workspaces.beginDiagnoseAndWait
- Defined in operations/workspaces.ts:533
Diagnose workspace setup issue.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- Optional options: WorkspacesDiagnoseOptionalParams
  
  The options parameters.
Returns Promise<WorkspacesDiagnoseResponse>

beginPrepareNotebook

beginPrepareNotebook(resourceGroupName: string, workspaceName: string, options?: WorkspacesPrepareNotebookOptionalParams): Promise<PollerLike<PollOperationState<WorkspacesPrepareNotebookResponse>, WorkspacesPrepareNotebookResponse>>

Implementation of Workspaces.beginPrepareNotebook
- Defined in operations/workspaces.ts:684
Prepare a notebook.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- Optional options: WorkspacesPrepareNotebookOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<WorkspacesPrepareNotebookResponse>, WorkspacesPrepareNotebookResponse>>

beginPrepareNotebookAndWait

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

Implementation of Workspaces.beginPrepareNotebookAndWait
- Defined in operations/workspaces.ts:753
Prepare a notebook.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- Optional options: WorkspacesPrepareNotebookOptionalParams
  
  The options parameters.
Returns Promise<WorkspacesPrepareNotebookResponse>

beginResyncKeys

beginResyncKeys(resourceGroupName: string, workspaceName: string, options?: WorkspacesResyncKeysOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of Workspaces.beginResyncKeys
- Defined in operations/workspaces.ts:571
Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- Optional options: WorkspacesResyncKeysOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginResyncKeysAndWait

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

Implementation of Workspaces.beginResyncKeysAndWait
- Defined in operations/workspaces.ts:635
Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- Optional options: WorkspacesResyncKeysOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(resourceGroupName: string, workspaceName: string, parameters: WorkspaceUpdateParameters, options?: WorkspacesUpdateOptionalParams): Promise<PollerLike<PollOperationState<WorkspacesUpdateResponse>, WorkspacesUpdateResponse>>

Implementation of Workspaces.beginUpdate
- Defined in operations/workspaces.ts:358
Updates a machine learning workspace with the specified parameters.

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.
- Optional options: WorkspacesUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<WorkspacesUpdateResponse>, WorkspacesUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, workspaceName: string, parameters: WorkspaceUpdateParameters, options?: WorkspacesUpdateOptionalParams): Promise<WorkspacesUpdateResponse>

Implementation of Workspaces.beginUpdateAndWait
- Defined in operations/workspaces.ts:428
Updates a machine learning workspace with the specified parameters.

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.
- Optional options: WorkspacesUpdateOptionalParams
  
  The options parameters.
Returns Promise<WorkspacesUpdateResponse>

get

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

Implementation of Workspaces.get
- Defined in operations/workspaces.ts:166
Gets the properties of the specified machine learning workspace.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- Optional options: WorkspacesGetOptionalParams
  
  The options parameters.
Returns Promise<WorkspacesGetResponse>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: WorkspacesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Workspace>

Implementation of Workspaces.listByResourceGroup
- Defined in operations/workspaces.ts:70
Lists all the available machine learning workspaces under the specified resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- Optional options: WorkspacesListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Workspace>

listBySubscription

listBySubscription(options?: WorkspacesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Workspace>

Implementation of Workspaces.listBySubscription
- Defined in operations/workspaces.ts:122
Lists all the available machine learning workspaces under the specified subscription.

Parameters
- Optional options: WorkspacesListBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Workspace>

listKeys

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

Implementation of Workspaces.listKeys
- Defined in operations/workspaces.ts:553
Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- Optional options: WorkspacesListKeysOptionalParams
  
  The options parameters.
Returns Promise<WorkspacesListKeysResponse>

listNotebookAccessToken

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

Implementation of Workspaces.listNotebookAccessToken
- Defined in operations/workspaces.ts:667
return notebook access token and refresh token

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- Optional options: WorkspacesListNotebookAccessTokenOptionalParams
  
  The options parameters.
Returns Promise<WorkspacesListNotebookAccessTokenResponse>

listNotebookKeys

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

Implementation of Workspaces.listNotebookKeys
- Defined in operations/workspaces.ts:789
List keys of a notebook.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- Optional options: WorkspacesListNotebookKeysOptionalParams
  
  The options parameters.
Returns Promise<WorkspacesListNotebookKeysResponse>

listOutboundNetworkDependenciesEndpoints

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

Implementation of Workspaces.listOutboundNetworkDependenciesEndpoints
- Defined in operations/workspaces.ts:807
Called by Client (Portal, CLI, etc) to get a list of all external outbound dependencies (FQDNs) programmatically.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- Optional options: WorkspacesListOutboundNetworkDependenciesEndpointsOptionalParams
  
  The options parameters.
Returns Promise<WorkspacesListOutboundNetworkDependenciesEndpointsResponse>

listStorageAccountKeys

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

Implementation of Workspaces.listStorageAccountKeys
- Defined in operations/workspaces.ts:772
List storage account keys of a workspace.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- Optional options: WorkspacesListStorageAccountKeysOptionalParams
  
  The options parameters.
Returns Promise<WorkspacesListStorageAccountKeysResponse>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: AzureMachineLearningWorkspaces

Returns WorkspacesImpl

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

workspaceName: string

parameters: Workspace

Optional options: WorkspacesCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<WorkspacesCreateOrUpdateResponse>, WorkspacesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

workspaceName: string

parameters: Workspace

Optional options: WorkspacesCreateOrUpdateOptionalParams

Returns Promise<WorkspacesCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

workspaceName: string

Optional options: WorkspacesDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

workspaceName: string

Optional options: WorkspacesDeleteOptionalParams

Returns Promise<void>

beginDiagnose

Parameters

resourceGroupName: string

workspaceName: string

Optional options: WorkspacesDiagnoseOptionalParams

Returns Promise<PollerLike<PollOperationState<WorkspacesDiagnoseResponse>, WorkspacesDiagnoseResponse>>

beginDiagnoseAndWait

Parameters

resourceGroupName: string

workspaceName: string

Optional options: WorkspacesDiagnoseOptionalParams

Returns Promise<WorkspacesDiagnoseResponse>

beginPrepareNotebook

Parameters

resourceGroupName: string

workspaceName: string

Optional options: WorkspacesPrepareNotebookOptionalParams

Returns Promise<PollerLike<PollOperationState<WorkspacesPrepareNotebookResponse>, WorkspacesPrepareNotebookResponse>>

beginPrepareNotebookAndWait

Parameters

resourceGroupName: string

workspaceName: string

Optional options: WorkspacesPrepareNotebookOptionalParams

Returns Promise<WorkspacesPrepareNotebookResponse>

beginResyncKeys

Parameters

resourceGroupName: string

workspaceName: string

Optional options: WorkspacesResyncKeysOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginResyncKeysAndWait

Parameters

resourceGroupName: string

workspaceName: string

Optional options: WorkspacesResyncKeysOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

workspaceName: string

parameters: WorkspaceUpdateParameters

Optional options: WorkspacesUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<WorkspacesUpdateResponse>, WorkspacesUpdateResponse>>