Hub Class

  • Reference

Note

This is an experimental class, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

A Hub is a special type of workspace that acts as a parent and resource container for lightweight child workspaces called projects. Resources like the hub's storage account, key vault, and container registry are shared by all child projects.

As a type of workspace, hub management is controlled by an MLClient's workspace operations.

Creating a Hub object.


   from azure.ai.ml.entities import Hub

   ws = Hub(name="sample-ws", location="eastus", description="a sample workspace hub object")
Inheritance
azure.ai.ml.entities._workspace.workspace.Workspace
Hub

Constructor

Hub(*, 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, managed_network: ManagedNetwork | None = None, storage_account: str | None = None, key_vault: str | None = None, container_registry: str | None = None, customer_managed_key: CustomerManagedKey | None = None, public_network_access: str | None = None, identity: IdentityConfiguration | None = None, primary_user_assigned_identity: str | None = None, enable_data_isolation: bool = False, default_resource_group: str | None = None, associated_workspaces: List[str] | None = None, **kwargs: Any)

Parameters

Name Description
name
Required
str

Name of the hub.
description
Required
str

Description of the hub.
tags
Required
dict

Tags of the hub.
display_name
Required
str

Display name for the hub. This is non-unique within the resource group.
location
Required
str

The location to create the hub in. If not specified, the same location as the resource group will be used.
resource_group
Required
str

Name of resource group to create the hub in.
managed_network
Required
ManagedNetwork

Hub's Managed Network configuration
storage_account
Required
str

The resource ID of an existing storage account to use instead of creating a new one.
key_vault
Required
str

The resource ID of an existing key vault to use instead of creating a new one.
container_registry
Required
str

The resource ID of an existing container registry to use instead of creating a new one.
customer_managed_key
Required
CustomerManagedKey

Key vault details for encrypting data with customer-managed keys. If not specified, Microsoft-managed keys will be used by default.
image_build_compute
Required
str

The name of the compute target to use for building environment. Docker images with the container registry is behind a VNet.
public_network_access
Required
str

Whether to allow public endpoint connectivity. when a workspace is private link enabled.
identity
Required
IdentityConfiguration

The hub's Managed Identity (user assigned, or system assigned).
primary_user_assigned_identity
Required
str

The hub's primary user assigned identity.
enable_data_isolation
Required
bool

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.
default_resource_group
Required
str

The resource group that will be used by projects created under this hub if no resource group is specified.
kwargs
Required
dict

A dictionary of additional configuration parameters.

Methods

dump

Dump the workspace spec into a file in yaml format.

dump

Dump the workspace spec into a file in yaml format.

dump(dest: str | PathLike | IO, **kwargs: Any) -> None

Parameters

Name Description
dest
Required
Union[<xref:PathLike>, str, IO[AnyStr]]

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.

Attributes

associated_workspaces

The workspaces associated with the hub.

Returns

Type Description
Optional[List[str]]

The resource group.

base_path

The base path of the resource.

Returns

Type Description
str

The base path of the resource.

creation_context

The creation context of the resource.

Returns

Type Description
Optional[SystemData]

The creation metadata for the resource.

default_resource_group

The default resource group for this hub and its children.

Returns

Type Description
Optional[str]

The resource group.

discovery_url

Backend service base URLs for the workspace.

Returns

Type Description
str

Backend service URLs of the workspace

id

The resource ID.

Returns

Type Description
Optional[str]

The global ID of the resource, an Azure Resource Manager (ARM) ID.

mlflow_tracking_uri

MLflow tracking uri for the workspace.

Returns

Type Description
str

Returns mlflow tracking uri of the workspace.