workspace
Creates, updates, deletes, gets or lists a workspace resource.
Overview
| Name | workspace |
| Type | Resource |
| Id | azure.synapse_artifacts.workspace |
Fields
The following fields are returned by SELECT queries:
- get
| Name | Datatype | Description |
|---|---|---|
id | string | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long |
name | string | The name of the resource. |
adlaResourceId | string | The ADLA resource ID. |
connectivityEndpoints | object | Connectivity endpoints. |
defaultDataLakeStorage | object | Workspace default data lake storage account details. |
encryption | object | The encryption details of the workspace. |
extraProperties | object | Workspace level configs and feature flags. |
identity | object | Identity of the workspace. |
location | string | The geo-location where the resource lives. Required. |
managedResourceGroupName | string | 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 '.'. |
managedVirtualNetwork | string | Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user. |
managedVirtualNetworkSettings | object | Managed Virtual Network Settings. |
privateEndpointConnections | array | Private endpoint connections to the workspace. |
provisioningState | string | Resource provisioning state. |
purviewConfiguration | object | Purview Configuration. |
sqlAdministratorLogin | string | Login for workspace SQL active directory administrator. |
sqlAdministratorLoginPassword | string | SQL administrator login password. |
tags | object | Resource tags. |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". |
virtualNetworkProfile | object | Virtual Network profile. |
workspaceRepositoryConfiguration | object | Git integration settings. |
workspaceUID | string | The workspace unique identifier. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | endpoint | Get Workspace. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
endpoint | string | The service endpoint host (no scheme). (default: ) |
SELECT examples
- get
Get Workspace.
SELECT
id,
name,
adlaResourceId,
connectivityEndpoints,
defaultDataLakeStorage,
encryption,
extraProperties,
identity,
location,
managedResourceGroupName,
managedVirtualNetwork,
managedVirtualNetworkSettings,
privateEndpointConnections,
provisioningState,
purviewConfiguration,
sqlAdministratorLogin,
sqlAdministratorLoginPassword,
tags,
type,
virtualNetworkProfile,
workspaceRepositoryConfiguration,
workspaceUID
FROM azure.synapse_artifacts.workspace
WHERE endpoint = '{{ endpoint }}' -- required
;