Workspace Class

A workspace.

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

All required parameters must be populated in order to send to Azure.

Constructor

Workspace(*, location: str, tags: Dict[str, str] | None = None, identity: ManagedIdentity | None = None, default_data_lake_storage: DataLakeStorageAccountDetails | None = None, sql_administrator_login_password: str | None = None, managed_resource_group_name: str | None = None, sql_administrator_login: str | None = None, virtual_network_profile: VirtualNetworkProfile | None = None, connectivity_endpoints: Dict[str, str] | None = None, managed_virtual_network: str | None = None, private_endpoint_connections: List[PrivateEndpointConnection] | None = None, encryption: EncryptionDetails | None = None, managed_virtual_network_settings: ManagedVirtualNetworkSettings | None = None, workspace_repository_configuration: WorkspaceRepositoryConfiguration | None = None, purview_configuration: PurviewConfiguration | None = None, public_network_access: str | WorkspacePublicNetworkAccess | None = None, **kwargs)

Parameters

Name Description
tags
Required

A set of tags. Resource tags.

location
Required
str

Required. The geo-location where the resource lives.

identity
Required

Identity of the workspace.

default_data_lake_storage
Required

Workspace default data lake storage account details.

sql_administrator_login_password
Required
str

SQL administrator login password.

managed_resource_group_name
Required
str

Workspace managed resource group. The resource group name uniquely identifies the resource group within the user subscriptionId. The resource group name must be no longer than 90 characters long, and must be alphanumeric characters (Char.IsLetterOrDigit()) and '-', '_', '(', ')' and'.'. Note that the name cannot end with '.'.

sql_administrator_login
Required
str

Login for workspace SQL active directory administrator.

virtual_network_profile
Required

Virtual Network profile.

connectivity_endpoints
Required

Connectivity endpoints.

managed_virtual_network
Required
str

Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user.

private_endpoint_connections
Required

Private endpoint connections to the workspace.

encryption
Required

The encryption details of the workspace.

managed_virtual_network_settings
Required

Managed Virtual Network Settings.

workspace_repository_configuration
Required

Git integration settings.

purview_configuration
Required

Purview Configuration.

public_network_access
Required

Enable or Disable pubic network access to workspace. Possible values include: "Enabled", "Disabled".

Keyword-Only Parameters

Name Description
location
Required
tags
Default value: None
identity
Default value: None
default_data_lake_storage
Default value: None
sql_administrator_login_password
Default value: None
managed_resource_group_name
Default value: None
sql_administrator_login
Default value: None
virtual_network_profile
Default value: None
connectivity_endpoints
Default value: None
managed_virtual_network
Default value: None
private_endpoint_connections
Default value: None
encryption
Default value: None
managed_virtual_network_settings
Default value: None
workspace_repository_configuration
Default value: None
purview_configuration
Default value: None
public_network_access
Default value: None

Variables

Name Description
id
str

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

name
str

The name of the resource.

type
str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

provisioning_state
str

Resource provisioning state.

workspace_uid
str

The workspace unique identifier.

extra_properties

Workspace level configs and feature flags.

adla_resource_id
str

The ADLA resource ID.