Share via

Workspace interface

  • Reference
Package:
@azure/arm-synapse

A workspace

Extends
TrackedResource

Properties

adlaResourceId

The ADLA resource ID. NOTE: This property will not be serialized. It can only be populated by the server.
azureADOnlyAuthentication

Enable or Disable AzureADOnlyAuthentication on All Workspace subresource
connectivityEndpoints

Connectivity endpoints
cspWorkspaceAdminProperties

Initial workspace AAD admin properties for a CSP subscription
defaultDataLakeStorage

Workspace default data lake storage account details
encryption

The encryption details of the workspace
extraProperties

Workspace level configs and feature flags NOTE: This property will not be serialized. It can only be populated by the server.
identity

Identity of the workspace
managedResourceGroupName

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

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

Managed Virtual Network Settings
privateEndpointConnections

Private endpoint connections to the workspace
provisioningState

Resource provisioning state NOTE: This property will not be serialized. It can only be populated by the server.
publicNetworkAccess

Enable or Disable public network access to workspace
purviewConfiguration

Purview Configuration
settings

Workspace settings NOTE: This property will not be serialized. It can only be populated by the server.
sqlAdministratorLogin

Login for workspace SQL active directory administrator
sqlAdministratorLoginPassword

SQL administrator login password
trustedServiceBypassEnabled

Is trustedServiceBypassEnabled for the workspace
virtualNetworkProfile

Virtual Network profile
workspaceRepositoryConfiguration

Git integration settings
workspaceUID

The workspace unique identifier NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

adlaResourceId

The ADLA resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

adlaResourceId?: string

Property Value

string

azureADOnlyAuthentication

Enable or Disable AzureADOnlyAuthentication on All Workspace subresource

azureADOnlyAuthentication?: boolean

Property Value

boolean

connectivityEndpoints

Connectivity endpoints

connectivityEndpoints?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

cspWorkspaceAdminProperties

Initial workspace AAD admin properties for a CSP subscription

cspWorkspaceAdminProperties?: CspWorkspaceAdminProperties

Property Value

CspWorkspaceAdminProperties

defaultDataLakeStorage

Workspace default data lake storage account details

defaultDataLakeStorage?: DataLakeStorageAccountDetails

Property Value

DataLakeStorageAccountDetails

encryption

The encryption details of the workspace

encryption?: EncryptionDetails

Property Value

EncryptionDetails

extraProperties

Workspace level configs and feature flags NOTE: This property will not be serialized. It can only be populated by the server.

extraProperties?: {[propertyName: string]: Record<string, unknown>}

Property Value

{[propertyName: string]: Record<string, unknown>}

identity

Identity of the workspace

identity?: ManagedIdentity

Property Value

ManagedIdentity

managedResourceGroupName

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 '.'

managedResourceGroupName?: string

Property Value

string

managedVirtualNetwork

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

managedVirtualNetwork?: string

Property Value

string

managedVirtualNetworkSettings

Managed Virtual Network Settings

managedVirtualNetworkSettings?: ManagedVirtualNetworkSettings

Property Value

ManagedVirtualNetworkSettings

privateEndpointConnections

Private endpoint connections to the workspace

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

provisioningState

Resource provisioning state NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

publicNetworkAccess

Enable or Disable public network access to workspace

publicNetworkAccess?: string

Property Value

string

purviewConfiguration

Purview Configuration

purviewConfiguration?: PurviewConfiguration

Property Value

PurviewConfiguration

settings

Workspace settings NOTE: This property will not be serialized. It can only be populated by the server.

settings?: {[propertyName: string]: Record<string, unknown>}

Property Value

{[propertyName: string]: Record<string, unknown>}

sqlAdministratorLogin

Login for workspace SQL active directory administrator

sqlAdministratorLogin?: string

Property Value

string

sqlAdministratorLoginPassword

SQL administrator login password

sqlAdministratorLoginPassword?: string

Property Value

string

trustedServiceBypassEnabled

Is trustedServiceBypassEnabled for the workspace

trustedServiceBypassEnabled?: boolean

Property Value

boolean

virtualNetworkProfile

Virtual Network profile

virtualNetworkProfile?: VirtualNetworkProfile

Property Value

VirtualNetworkProfile

workspaceRepositoryConfiguration

Git integration settings

workspaceRepositoryConfiguration?: WorkspaceRepositoryConfiguration

Property Value

WorkspaceRepositoryConfiguration

workspaceUID

The workspace unique identifier NOTE: This property will not be serialized. It can only be populated by the server.

workspaceUID?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type