get_workspace {azuremlsdk}

Get an existing workspace

Description

Returns a Workspace object for an existing Azure Machine Learning workspace. Throws an exception if the workpsace doesn't exist or the required fields don't lead to a uniquely identifiable workspace.

Usage

get_workspace(name, auth = NULL, subscription_id = NULL, resource_group = NULL)

Arguments

name

A string of the workspace name to get.

auth

The ServicePrincipalAuthentication or InteractiveLoginAuthentication object. For more details refer to https://aka.ms/aml-notebook-auth. If NULL, the default Azure CLI credentials will be used or the API will prompt for credentials.

subscription_id

A string of the subscription ID to use. The parameter is required if the user has access to more than one subscription.

resource_group

A string of the resource group to use. If NULL the method will search all resource groups in the subscription.

Value

The Workspace object.

See Also

create_workspace() service_principal_authentication() interactive_login_authentication()