Feedback Edit

Workspace Class

  • Reference

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.

Inheritance
azure.mgmt.synapse.models._models_py3.TrackedResource
Workspace

Constructor

Workspace(*, location: str, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.mgmt.synapse.models._models_py3.ManagedIdentity] = None, default_data_lake_storage: Optional[azure.mgmt.synapse.models._models_py3.DataLakeStorageAccountDetails] = None, sql_administrator_login_password: Optional[str] = None, managed_resource_group_name: Optional[str] = None, sql_administrator_login: Optional[str] = None, virtual_network_profile: Optional[azure.mgmt.synapse.models._models_py3.VirtualNetworkProfile] = None, connectivity_endpoints: Optional[Dict[str, str]] = None, managed_virtual_network: Optional[str] = None, private_endpoint_connections: Optional[List[azure.mgmt.synapse.models._models_py3.PrivateEndpointConnection]] = None, encryption: Optional[azure.mgmt.synapse.models._models_py3.EncryptionDetails] = None, managed_virtual_network_settings: Optional[azure.mgmt.synapse.models._models_py3.ManagedVirtualNetworkSettings] = None, workspace_repository_configuration: Optional[azure.mgmt.synapse.models._models_py3.WorkspaceRepositoryConfiguration] = None, purview_configuration: Optional[azure.mgmt.synapse.models._models_py3.PurviewConfiguration] = None, public_network_access: Optional[Union[str, azure.mgmt.synapse.models._synapse_management_client_enums.WorkspacePublicNetworkAccess]] = None, **kwargs)

Parameters

tags
dict[str, str]
Required

A set of tags. Resource tags.

location
str
Required

Required. The geo-location where the resource lives.

identity
ManagedIdentity
Required

Identity of the workspace.

default_data_lake_storage
DataLakeStorageAccountDetails
Required

Workspace default data lake storage account details.

sql_administrator_login_password
str
Required

SQL administrator login password.

managed_resource_group_name
str
Required

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

Login for workspace SQL active directory administrator.

virtual_network_profile
VirtualNetworkProfile
Required

Virtual Network profile.

connectivity_endpoints
dict[str, str]
Required

Connectivity endpoints.

managed_virtual_network
str
Required

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
list[PrivateEndpointConnection]
Required

Private endpoint connections to the workspace.

encryption
EncryptionDetails
Required

The encryption details of the workspace.

managed_virtual_network_settings
ManagedVirtualNetworkSettings
Required

Managed Virtual Network Settings.

workspace_repository_configuration
WorkspaceRepositoryConfiguration
Required

Git integration settings.

purview_configuration
PurviewConfiguration
Required

Purview Configuration.

public_network_access
str or WorkspacePublicNetworkAccess
Required

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

Variables

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
dict[str, object]

Workspace level configs and feature flags.

adla_resource_id
str

The ADLA resource ID.