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.

Inheritance
azure.mgmt.machinelearningservices.models._models_py3.Resource
Workspace

Constructor

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

Parameters

identity
Identity
Required

The identity of the resource.

location
str
Required

Specifies the location of the resource.

tags
dict[str, str]
Required

A set of tags. Contains resource tags defined as key/value pairs.

sku
Sku
Required

The sku of the workspace.

description
str
Required

The description of this workspace.

friendly_name
str
Required

The friendly name for this workspace. This name in mutable.

key_vault
str
Required

ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created.

application_insights
str
Required

ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created.

container_registry
str
Required

ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created.

storage_account
str
Required

ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created.

discovery_url
str
Required

Url for the discovery service to identify regional endpoints for machine learning experimentation services.

encryption
EncryptionProperty
Required

The encryption settings of Azure ML workspace.

hbi_workspace
bool
Required

The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service.

image_build_compute
str
Required

The compute name for image build.

allow_public_access_when_behind_vnet
bool
Required

The flag to indicate whether to allow public access when behind VNet.

shared_private_link_resources
list[SharedPrivateLinkResource]
Required

The list of shared private link resources in this workspace.

Variables

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.