Data Lake Workspace (datalakeworkspace) table/entity reference

A workspace is a place to store data in Azure Data Lake.

Messages

The following table lists the messages for the Data Lake Workspace (datalakeworkspace) table. Messages represent operations that can be performed on the table. They may also be events.

Name Is Event?	Web API Operation	SDK for .NET
Create Event: True	POST /datalakeworkspaces See Create	Create records
CreateMultiple Event: True	CreateMultiple	CreateMultipleRequest
Delete Event: True	DELETE /datalakeworkspaces(datalakeworkspaceid) See Delete	Delete records
IsValidStateTransition Event: False	IsValidStateTransition	IsValidStateTransitionRequest
Retrieve Event: True	GET /datalakeworkspaces(datalakeworkspaceid) See Retrieve	Retrieve records
RetrieveMultiple Event: True	GET /datalakeworkspaces See Query data	Query data
SetState Event: True	PATCH /datalakeworkspaces(datalakeworkspaceid) Update the statecode and statuscode properties.	SetStateRequest
Update Event: True	PATCH /datalakeworkspaces(datalakeworkspaceid) See Update	Update records
UpdateMultiple Event: True	UpdateMultiple	UpdateMultipleRequest
Upsert Event: False	PATCH /datalakeworkspaces(datalakeworkspaceid) See Upsert a table row	UpsertRequest
UpsertMultiple Event: False	UpsertMultiple	UpsertMultipleRequest

Properties

The following table lists selected properties for the Data Lake Workspace (datalakeworkspace) table.

Property	Value
DisplayName	Data Lake Workspace
DisplayCollectionName	Data Lake Workspaces
SchemaName	datalakeworkspace
CollectionSchemaName	datalakeworkspaces
EntitySetName	datalakeworkspaces
LogicalName	datalakeworkspace
LogicalCollectionName	datalakeworkspaces
PrimaryIdAttribute	datalakeworkspaceid
PrimaryNameAttribute	name
TableType	Standard
OwnershipType	OrganizationOwned

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

• datalakeworkspace_UniqueName
• datalakeworkspaceId
• ImportSequenceNumber
• iscustomercapacity
• IsCustomizable
• isdeepcopyenabled
• isprivate
• name
• OverriddenCreatedOn
• owningappid
• tenantid
• TimeZoneRuleVersionNumber
• UTCConversionTimeZoneCode
• whitelistedappid

datalakeworkspace_UniqueName

Property	Value
Description	Unique Name for the entity.
DisplayName	Unique Name
IsValidForForm	True
IsValidForRead	True
LogicalName	datalakeworkspace_uniquename
RequiredLevel	SystemRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	128

datalakeworkspaceId

Property	Value
Description	Unique identifier for entity instances
DisplayName	Data Lake Workspace
IsValidForForm	False
IsValidForRead	True
LogicalName	datalakeworkspaceid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

ImportSequenceNumber

Property	Value
Description	Sequence number of the import that created this record.
DisplayName	Import Sequence Number
IsValidForForm	False
IsValidForRead	True
LogicalName	importsequencenumber
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-2147483648

iscustomercapacity

Property	Value
Description	Indicates if workspace data storage uses customer capacity.
DisplayName	Is Customer Capacity
IsValidForForm	True
IsValidForRead	True
LogicalName	iscustomercapacity
RequiredLevel	None
Type	Boolean
GlobalChoiceName	datalakeworkspace_iscustomercapacity
DefaultValue	True
True Label	Yes
False Label	No

IsCustomizable

Property	Value
Description	For internal use only.
DisplayName	Is Customizable
IsValidForForm	False
IsValidForRead	True
LogicalName	iscustomizable
RequiredLevel	SystemRequired
Type	ManagedProperty

isdeepcopyenabled

Property	Value
Description	Indicates if deep copy is enabled for workspace.
DisplayName	Is Deep Copy Enabled
IsValidForForm	True
IsValidForRead	True
LogicalName	isdeepcopyenabled
RequiredLevel	None
Type	Boolean
GlobalChoiceName	datalakeworkspace_isdeepcopyenabled
DefaultValue	False
True Label	Yes
False Label	No

isprivate

Property	Value
Description	Indicates if workspace data and metadata are visible to all applications, or only visible to the workspace owner and applications with explicit permissions to the workspace.
DisplayName	Is Private
IsValidForForm	True
IsValidForRead	True
LogicalName	isprivate
RequiredLevel	ApplicationRequired
Type	Boolean
GlobalChoiceName	datalakeworkspace_isprivate
DefaultValue	False
True Label	Yes
False Label	No

name

Property	Value
Description	The name of the custom entity.
DisplayName	Name
IsValidForForm	True
IsValidForRead	True
LogicalName	name
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

OverriddenCreatedOn

Property	Value
Description	Date and time that the record was migrated.
DisplayName	Record Created On
IsValidForForm	False
IsValidForRead	True
LogicalName	overriddencreatedon
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateOnly
ImeMode	Inactive
SourceTypeMask	0

owningappid

Property	Value
Description	The app id which owns this workspace. The owning app id has full control i.e. read, write and execute permissions on the ADLS folder.
DisplayName	Owning App Id
IsValidForForm	True
IsValidForRead	True
LogicalName	owningappid
RequiredLevel	ApplicationRequired
Type	Uniqueidentifier

tenantid

Property	Value
Description	AAD tenant id where the owning application id is registered.
DisplayName	Tenant Id
IsValidForForm	True
IsValidForRead	True
LogicalName	tenantid
RequiredLevel	ApplicationRequired
Type	Uniqueidentifier

TimeZoneRuleVersionNumber

Property	Value
Description	For internal use only.
DisplayName	Time Zone Rule Version Number
IsValidForForm	False
IsValidForRead	True
LogicalName	timezoneruleversionnumber
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-1

UTCConversionTimeZoneCode

Property	Value
Description	Time zone code that was in use when the record was created.
DisplayName	UTC Conversion Time Zone Code
IsValidForForm	False
IsValidForRead	True
LogicalName	utcconversiontimezonecode
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	-1

whitelistedappid

Property	Value
Description	Application Id that is allow listed in AAD Tenant ID to access the Graph API.
DisplayName	Whitelisted App Id
IsValidForForm	True
IsValidForRead	True
LogicalName	whitelistedappid
RequiredLevel	None
Type	Uniqueidentifier

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.

• ComponentIdUnique
• ComponentState
• containerendpoint
• CreatedBy
• CreatedOn
• CreatedOnBehalfBy
• IsManaged
• ModifiedBy
• ModifiedOn
• ModifiedOnBehalfBy
• OrganizationId
• OverwriteTime
• path
• SolutionId
• statecode
• statuscode
• SupportingSolutionId
• VersionNumber

ComponentIdUnique

Property	Value
Description	For internal use only.
DisplayName	Row id unique
IsValidForForm	False
IsValidForRead	True
LogicalName	componentidunique
RequiredLevel	SystemRequired
Type	Uniqueidentifier

ComponentState

Property	Value
Description	For internal use only.
DisplayName	Component State
IsValidForForm	False
IsValidForRead	True
LogicalName	componentstate
RequiredLevel	SystemRequired
Type	Picklist
DefaultFormValue
GlobalChoiceName	componentstate

ComponentState Choices/Options

Value	Label
0	Published
1	Unpublished
2	Deleted
3	Deleted Unpublished

containerendpoint

Property	Value
Description	Azure Data Lake container endpoint for this workspace.
DisplayName	Container Endpoint
IsValidForForm	True
IsValidForRead	True
LogicalName	containerendpoint
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

CreatedBy

Property	Value
Description	Unique identifier of the user who created the record.
DisplayName	Created By
IsValidForForm	True
IsValidForRead	True
LogicalName	createdby
RequiredLevel	None
Type	Lookup
Targets	systemuser

CreatedOn

Property	Value
Description	Date and time when the record was created.
DisplayName	Created On
IsValidForForm	True
IsValidForRead	True
LogicalName	createdon
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

CreatedOnBehalfBy

Property	Value
Description	Unique identifier of the delegate user who created the record.
DisplayName	Created By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	createdonbehalfby
RequiredLevel	None
Type	Lookup
Targets	systemuser

IsManaged

Property	Value
Description	Indicates whether the solution component is part of a managed solution.
DisplayName	Is Managed
IsValidForForm	False
IsValidForRead	True
LogicalName	ismanaged
RequiredLevel	SystemRequired
Type	Boolean
GlobalChoiceName	ismanaged
DefaultValue	False
True Label	Managed
False Label	Unmanaged

ModifiedBy

Property	Value
Description	Unique identifier of the user who modified the record.
DisplayName	Modified By
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedby
RequiredLevel	None
Type	Lookup
Targets	systemuser

ModifiedOn

Property	Value
Description	Date and time when the record was modified.
DisplayName	Modified On
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedon
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

ModifiedOnBehalfBy

Property	Value
Description	Unique identifier of the delegate user who modified the record.
DisplayName	Modified By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedonbehalfby
RequiredLevel	None
Type	Lookup
Targets	systemuser

OrganizationId

Property	Value
Description	Unique identifier for the organization
DisplayName	Organization Id
IsValidForForm	False
IsValidForRead	True
LogicalName	organizationid
RequiredLevel	None
Type	Lookup
Targets	organization

OverwriteTime

Property	Value
Description	For internal use only.
DisplayName	Record Overwrite Time
IsValidForForm	False
IsValidForRead	True
LogicalName	overwritetime
RequiredLevel	SystemRequired
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

path

Property	Value
Description	Workspace path in the Azure Data Lake container.
DisplayName	Path
IsValidForForm	True
IsValidForRead	True
LogicalName	path
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

SolutionId

Property	Value
Description	Unique identifier of the associated solution.
DisplayName	Solution
IsValidForForm	False
IsValidForRead	True
LogicalName	solutionid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

statecode

Property	Value
Description	Status of the Data Lake Workspace
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	statecode
RequiredLevel	SystemRequired
Type	State
DefaultFormValue
GlobalChoiceName	datalakeworkspace_statecode

statecode Choices/Options

Value	Details
0	Label: Active DefaultStatus: 1 InvariantName: Active
1	Label: Inactive DefaultStatus: 2 InvariantName: Inactive

statuscode

Property	Value
Description	Reason for the status of the Data Lake Workspace
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	statuscode
RequiredLevel	None
Type	Status
DefaultFormValue
GlobalChoiceName	datalakeworkspace_statuscode

statuscode Choices/Options

Value	Details
1	Label: Active State:0 TransitionData: None
2	Label: Inactive State:1 TransitionData: None

SupportingSolutionId

Property	Value
Description	For internal use only.
DisplayName	Solution
IsValidForForm	False
IsValidForRead	False
LogicalName	supportingsolutionid
RequiredLevel	None
Type	Uniqueidentifier

VersionNumber

Property	Value
Description	Version Number
DisplayName	Version Number
IsValidForForm	False
IsValidForRead	True
LogicalName	versionnumber
RequiredLevel	None
Type	BigInt
MaxValue	9223372036854775807
MinValue	-9223372036854775808

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

• lk_datalakeworkspace_createdby
• lk_datalakeworkspace_createdonbehalfby
• lk_datalakeworkspace_modifiedby
• lk_datalakeworkspace_modifiedonbehalfby
• organization_datalakeworkspace

lk_datalakeworkspace_createdby

One-To-Many Relationship: systemuser lk_datalakeworkspace_createdby

Property	Value
ReferencedEntity	systemuser
ReferencedAttribute	systemuserid
ReferencingAttribute	createdby
ReferencingEntityNavigationPropertyName	createdby
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

lk_datalakeworkspace_createdonbehalfby

One-To-Many Relationship: systemuser lk_datalakeworkspace_createdonbehalfby

Property	Value
ReferencedEntity	systemuser
ReferencedAttribute	systemuserid
ReferencingAttribute	createdonbehalfby
ReferencingEntityNavigationPropertyName	createdonbehalfby
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

lk_datalakeworkspace_modifiedby

One-To-Many Relationship: systemuser lk_datalakeworkspace_modifiedby

Property	Value
ReferencedEntity	systemuser
ReferencedAttribute	systemuserid
ReferencingAttribute	modifiedby
ReferencingEntityNavigationPropertyName	modifiedby
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

lk_datalakeworkspace_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_datalakeworkspace_modifiedonbehalfby

Property	Value
ReferencedEntity	systemuser
ReferencedAttribute	systemuserid
ReferencingAttribute	modifiedonbehalfby
ReferencingEntityNavigationPropertyName	modifiedonbehalfby
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

organization_datalakeworkspace

One-To-Many Relationship: organization organization_datalakeworkspace

Property	Value
ReferencedEntity	organization
ReferencedAttribute	organizationid
ReferencingAttribute	organizationid
ReferencingEntityNavigationPropertyName	organizationid
IsHierarchical
CascadeConfiguration	Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

• datalakeworkspace_AsyncOperations
• datalakeworkspace_BulkDeleteFailures
• datalakeworkspace_DuplicateBaseRecord
• datalakeworkspace_DuplicateMatchingRecord
• datalakeworkspace_MailboxTrackingFolders
• datalakeworkspace_PrincipalObjectAttributeAccesses
• datalakeworkspace_ProcessSession
• datalakeworkspace_SyncErrors
• datalakeworkspace_workspacepermission

datalakeworkspace_AsyncOperations

Many-To-One Relationship: asyncoperation datalakeworkspace_AsyncOperations

Property	Value
ReferencingEntity	asyncoperation
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	datalakeworkspace_AsyncOperations
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

datalakeworkspace_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure datalakeworkspace_BulkDeleteFailures

Property	Value
ReferencingEntity	bulkdeletefailure
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	datalakeworkspace_BulkDeleteFailures
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

datalakeworkspace_DuplicateBaseRecord

Many-To-One Relationship: duplicaterecord datalakeworkspace_DuplicateBaseRecord

Property	Value
ReferencingEntity	duplicaterecord
ReferencingAttribute	baserecordid
ReferencedEntityNavigationPropertyName	datalakeworkspace_DuplicateBaseRecord
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

datalakeworkspace_DuplicateMatchingRecord

Many-To-One Relationship: duplicaterecord datalakeworkspace_DuplicateMatchingRecord

Property	Value
ReferencingEntity	duplicaterecord
ReferencingAttribute	duplicaterecordid
ReferencedEntityNavigationPropertyName	datalakeworkspace_DuplicateMatchingRecord
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

datalakeworkspace_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder datalakeworkspace_MailboxTrackingFolders

Property	Value
ReferencingEntity	mailboxtrackingfolder
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	datalakeworkspace_MailboxTrackingFolders
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

datalakeworkspace_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess datalakeworkspace_PrincipalObjectAttributeAccesses

Property	Value
ReferencingEntity	principalobjectattributeaccess
ReferencingAttribute	objectid
ReferencedEntityNavigationPropertyName	datalakeworkspace_PrincipalObjectAttributeAccesses
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

datalakeworkspace_ProcessSession

Many-To-One Relationship: processsession datalakeworkspace_ProcessSession

Property	Value
ReferencingEntity	processsession
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	datalakeworkspace_ProcessSession
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

datalakeworkspace_SyncErrors

Many-To-One Relationship: syncerror datalakeworkspace_SyncErrors

Property	Value
ReferencingEntity	syncerror
ReferencingAttribute	regardingobjectid
ReferencedEntityNavigationPropertyName	datalakeworkspace_SyncErrors
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

datalakeworkspace_workspacepermission

Many-To-One Relationship: datalakeworkspacepermission datalakeworkspace_workspacepermission

Property	Value
ReferencingEntity	datalakeworkspacepermission
ReferencingAttribute	workspaceid
ReferencedEntityNavigationPropertyName	datalakeworkspace_workspacepermission
IsCustomizable	False
AssociatedMenuConfiguration	AvailableOffline: True Behavior: UseCollectionName Group: Details Label: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

See also

Dataverse table/entity reference
Dataverse Web API Reference
datalakeworkspace