Workspace Class

An object that represents a machine learning workspace.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

Workspace(*, identity: Identity | None = None, location: str | None = None, tags: Dict[str, str] | None = None, sku: Sku | None = None, description: str | None = None, friendly_name: str | None = None, key_vault: str | None = None, application_insights: str | None = None, container_registry: str | None = None, storage_account: str | None = None, discovery_url: str | None = None, encryption: EncryptionProperty | None = None, hbi_workspace: bool | None = False, image_build_compute: str | None = None, allow_public_access_when_behind_vnet: bool | None = False, shared_private_link_resources: List[SharedPrivateLinkResource] | None = None, **kwargs)

Parameters

Name	Description
identity Required	Identity The identity of the resource.
location Required	str Specifies the location of the resource.
tags Required	dict[str, str] A set of tags. Contains resource tags defined as key/value pairs.
sku Required	Sku The sku of the workspace.
description Required	str The description of this workspace.
friendly_name Required	str The friendly name for this workspace. This name in mutable.
key_vault Required	str ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created.
application_insights Required	str ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created.
container_registry Required	str ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created.
storage_account Required	str ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created.
discovery_url Required	str Url for the discovery service to identify regional endpoints for machine learning experimentation services.
encryption Required	EncryptionProperty The encryption settings of Azure ML workspace.
hbi_workspace Required	bool The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service.
image_build_compute Required	str The compute name for image build.
allow_public_access_when_behind_vnet Required	bool The flag to indicate whether to allow public access when behind VNet.
shared_private_link_resources Required	list[SharedPrivateLinkResource] The list of shared private link resources in this workspace.

Keyword-Only Parameters

Name	Description
identity	Default value: None
location	Default value: None
tags	Default value: None
sku	Default value: None
description	Default value: None
friendly_name	Default value: None
key_vault	Default value: None
application_insights	Default value: None
container_registry	Default value: None
storage_account	Default value: None
discovery_url	Default value: None
encryption	Default value: None
hbi_workspace	Default value: False
image_build_compute	Default value: None
allow_public_access_when_behind_vnet	Default value: False
shared_private_link_resources	Default value: None

Variables

Name	Description
id	str Specifies the resource ID.
name	str Specifies the name of the resource.
type	str Specifies the type of the resource.
workspace_id	str The immutable id associated with this workspace.
creation_time	datetime The creation time of the machine learning workspace in ISO8601 format.
provisioning_state	str or ProvisioningState The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. Possible values include: "Unknown", "Updating", "Creating", "Deleting", "Succeeded", "Failed", "Canceled".
service_provisioned_resource_group	str The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace.
private_link_count	int Count of private connections in the workspace.
private_endpoint_connections	list[PrivateEndpointConnection] The list of private endpoint connections in the workspace.
notebook_info	NotebookResourceInfo The notebook info of Azure ML workspace.