azure.ai.ml.entities.Workspace.yml

### YamlMime:PythonClass
uid: azure.ai.ml.entities.Workspace
name: Workspace
fullName: azure.ai.ml.entities.Workspace
module: azure.ai.ml.entities
inheritances:
- azure.ai.ml.entities._resource.Resource
summary: "Azure ML workspace.\n\nCreating a Workspace object.<!--[!code-python[Main](les\\\
  ml_samples_workspace.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [],\
  \ \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
  \\windows\\\\Python\\\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
  \\10\\\\azure-ai-ml-1.16.0\\\\samples\\\\ml_samples_workspace.py\", \"xml:space\"\
  : \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\":\
  \ {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n   from azure.ai.ml.entities\
  \ import Workspace\n\n   ws = Workspace(name=\"sample-ws\", location=\"eastus\"\
  , description=\"a sample workspace object\")\n\n   ````"
constructor:
  syntax: 'Workspace(*, name: str, description: str | None = None, tags: Dict[str,
    str] | None = None, display_name: str | None = None, location: str | None = None,
    resource_group: str | None = None, hbi_workspace: bool = False, storage_account:
    str | None = None, container_registry: str | None = None, key_vault: str | None
    = None, application_insights: str | None = None, customer_managed_key: CustomerManagedKey
    | None = None, image_build_compute: str | None = None, public_network_access:
    str | None = None, identity: IdentityConfiguration | None = None, primary_user_assigned_identity:
    str | None = None, managed_network: ManagedNetwork | None = None, enable_data_isolation:
    bool = False, hub_id: str | None = None, workspace_hub: str | None = None, serverless_compute:
    ServerlessComputeSettings | None = None, **kwargs: Any)'
  parameters:
  - name: name
    description: Name of the workspace.
    isRequired: true
    types:
    - <xref:str>
  - name: description
    description: Description of the workspace.
    isRequired: true
    types:
    - <xref:str>
  - name: tags
    description: Tags of the workspace.
    isRequired: true
    types:
    - <xref:dict>
  - name: display_name
    description: Display name for the workspace. This is non-unique within the resource
      group.
    isRequired: true
    types:
    - <xref:str>
  - name: location
    description: 'The location to create the workspace in.

      If not specified, the same location as the resource group will be used.'
    isRequired: true
    types:
    - <xref:str>
  - name: resource_group
    description: Name of resource group to create the workspace in.
    isRequired: true
    types:
    - <xref:str>
  - name: hbi_workspace
    description: 'Whether the customer data is of high business impact (HBI),

      containing sensitive business information.

      For more information, see

      [https://docs.microsoft.com/azure/machine-learning/concept-data-encryption#encryption-at-rest](https://docs.microsoft.com/azure/machine-learning/concept-data-encryption#encryption-at-rest).'
    isRequired: true
    types:
    - <xref:bool>
  - name: storage_account
    description: The resource ID of an existing storage account to use instead of
      creating a new one.
    isRequired: true
    types:
    - <xref:str>
  - name: container_registry
    description: 'The resource ID of an existing container registry

      to use instead of creating a new one.'
    isRequired: true
    types:
    - <xref:str>
  - name: key_vault
    description: The resource ID of an existing key vault to use instead of creating
      a new one.
    isRequired: true
    types:
    - <xref:str>
  - name: application_insights
    description: 'The resource ID of an existing application insights

      to use instead of creating a new one.'
    isRequired: true
    types:
    - <xref:str>
  - name: customer_managed_key
    description: 'Key vault details for encrypting data with customer-managed keys.

      If not specified, Microsoft-managed keys will be used by default.'
    isRequired: true
    types:
    - <xref:azure.ai.ml.entities.CustomerManagedKey>
  - name: image_build_compute
    description: 'The name of the compute target to use for building environment

      Docker images with the container registry is behind a VNet.'
    isRequired: true
    types:
    - <xref:str>
  - name: public_network_access
    description: 'Whether to allow public endpoint connectivity

      when a workspace is private link enabled.'
    isRequired: true
    types:
    - <xref:str>
  - name: identity
    description: workspace's Managed Identity (user assigned, or system assigned)
    isRequired: true
    types:
    - <xref:azure.ai.ml.entities.IdentityConfiguration>
  - name: primary_user_assigned_identity
    description: The workspace's primary user assigned identity
    isRequired: true
    types:
    - <xref:str>
  - name: managed_network
    description: workspace's Managed Network configuration
    isRequired: true
    types:
    - <xref:azure.ai.ml.entities.ManagedNetwork>
  - name: enable_data_isolation
    description: 'A flag to determine if workspace has data isolation enabled.

      The flag can only be set at the creation phase, it can''t be updated.'
    isRequired: true
    types:
    - <xref:bool>
  - name: serverless_compute
    description: The serverless compute settings for the workspace.
    isRequired: true
  - name: workspace_hub
    description: 'Deprecated resource ID of an existing workspace hub to help create
      project workspace.

      Use the Project class instead now.'
    isRequired: true
    types:
    - <xref:typing.Optional>[<xref:str>]
  - name: kwargs
    description: A dictionary of additional configuration parameters.
    isRequired: true
    types:
    - <xref:dict>
  keywordOnlyParameters:
  - name: name
    isRequired: true
  - name: description
    isRequired: true
  - name: tags
    isRequired: true
  - name: display_name
    isRequired: true
  - name: location
    isRequired: true
  - name: resource_group
    isRequired: true
  - name: hbi_workspace
    isRequired: true
  - name: storage_account
    isRequired: true
  - name: container_registry
    isRequired: true
  - name: key_vault
    isRequired: true
  - name: application_insights
    isRequired: true
  - name: customer_managed_key
    isRequired: true
  - name: image_build_compute
    isRequired: true
  - name: public_network_access
    isRequired: true
  - name: identity
    isRequired: true
  - name: primary_user_assigned_identity
    isRequired: true
  - name: managed_network
    isRequired: true
  - name: enable_data_isolation
    isRequired: true
  - name: hub_id
    isRequired: true
  - name: workspace_hub
    isRequired: true
  - name: serverless_compute
    isRequired: true
methods:
- uid: azure.ai.ml.entities.Workspace.dump
  name: dump
  summary: Dump the workspace spec into a file in yaml format.
  signature: 'dump(dest: str | PathLike | IO, **kwargs: Any) -> None'
  parameters:
  - name: dest
    description: 'The destination to receive this workspace''s spec.

      Must be either a path to a local file, or an already-open file stream.

      If dest is a file path, a new file will be created,

      and an exception is raised if the file exists.

      If dest is an open file, the file will be written to directly,

      and an exception will be raised if the file is not writable.'
    isRequired: true
    types:
    - <xref:typing.Union>[<xref:PathLike>, <xref:str>, <xref:typing.IO>[<xref:typing.AnyStr>]]
attributes:
- uid: azure.ai.ml.entities.Workspace.base_path
  name: base_path
  summary: The base path of the resource.
  return:
    description: The base path of the resource.
    types:
    - <xref:str>
- uid: azure.ai.ml.entities.Workspace.creation_context
  name: creation_context
  summary: The creation context of the resource.
  return:
    description: The creation metadata for the resource.
    types:
    - <xref:typing.Optional>[<xref:azure.ai.ml.entities.SystemData>]
- uid: azure.ai.ml.entities.Workspace.discovery_url
  name: discovery_url
  summary: Backend service base URLs for the workspace.
  return:
    description: Backend service URLs of the workspace
    types:
    - <xref:str>
- uid: azure.ai.ml.entities.Workspace.id
  name: id
  summary: The resource ID.
  return:
    description: The global ID of the resource, an Azure Resource Manager (ARM) ID.
    types:
    - <xref:typing.Optional>[<xref:str>]
- uid: azure.ai.ml.entities.Workspace.mlflow_tracking_uri
  name: mlflow_tracking_uri
  summary: MLflow tracking uri for the workspace.
  return:
    description: Returns mlflow tracking uri of the workspace.
    types:
    - <xref:str>