datalakeworkspace table/entity reference

Note

Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.

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

Added by: Data lake workspaces Solution

Messages

Message Web API Operation SDK class or method
Create POST /datalakeworkspaces
See Create
CreateRequest or
Create
CreateMultiple CreateMultiple CreateMultipleRequest
Delete DELETE /datalakeworkspaces(datalakeworkspaceid)
See Delete
DeleteRequest or
Delete
IsValidStateTransition IsValidStateTransition IsValidStateTransitionRequest
Retrieve GET /datalakeworkspaces(datalakeworkspaceid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET /datalakeworkspaces
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
SetState PATCH /datalakeworkspaces(datalakeworkspaceid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH /datalakeworkspaces(datalakeworkspaceid)
See Update
UpdateRequest or
Update
UpdateMultiple UpdateMultiple UpdateMultipleRequest

Properties

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

Writable columns/attributes

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

datalakeworkspace_UniqueName

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

datalakeworkspaceId

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

ImportSequenceNumber

Added by: Basic Solution Solution

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

iscustomercapacity

Property Value
Description Indicates if workspace data storage uses customer capacity.
DisplayName Is Customer Capacity
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName iscustomercapacity
RequiredLevel None
Type Boolean

iscustomercapacity Choices/Options

Value Label Description
1 Yes
0 No

DefaultValue: 1

IsCustomizable

Added by: Basic Solution Solution

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

isdeepcopyenabled Choices/Options

Value Label Description
1 Yes
0 No

DefaultValue: 0

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

isprivate Choices/Options

Value Label Description
1 Yes
0 No

DefaultValue: 0

name

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

OverriddenCreatedOn

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

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
IsValidForUpdate False
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
IsValidForUpdate False
LogicalName tenantid
RequiredLevel ApplicationRequired
Type Uniqueidentifier

TimeZoneRuleVersionNumber

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

UTCConversionTimeZoneCode

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

whitelistedappid

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

Read-only columns/attributes

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

ComponentIdUnique

Added by: Basic Solution Solution

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

ComponentState

Added by: Basic Solution Solution

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

ComponentState Choices/Options

Value Label Description
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished

containerendpoint

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

CreatedBy

Added by: Active Solution Solution

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

CreatedByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

CreatedOn

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

CreatedOnBehalfBy

Added by: Active Solution Solution

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
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

IsManaged

Added by: Basic Solution Solution

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

IsManaged Choices/Options

Value Label Description
1 Managed
0 Unmanaged

DefaultValue: 0

ModifiedBy

Added by: Active Solution Solution

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

ModifiedByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

ModifiedOn

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

ModifiedOnBehalfBy

Added by: Active Solution Solution

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
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

OrganizationId

Added by: Active Solution Solution

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

OrganizationIdName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName organizationidname
MaxLength 100
RequiredLevel SystemRequired
Type String

OverwriteTime

Added by: Basic Solution Solution

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

path

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

SolutionId

Added by: Basic Solution Solution

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

statecode Choices/Options

Value Label DefaultStatus InvariantName
0 Active 1 Active
1 Inactive 2 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

statuscode Choices/Options

Value Label State
1 Active 0
2 Inactive 1

SupportingSolutionId

Added by: Basic Solution Solution

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

VersionNumber

Added by: Active Solution Solution

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

One-To-Many Relationships

Listed by SchemaName.

datalakeworkspace_SyncErrors

Added by: System Solution Solution

Same as the datalakeworkspace_SyncErrors many-to-one relationship for the syncerror table/entity.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName datalakeworkspace_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

datalakeworkspace_DuplicateMatchingRecord

Added by: System Solution Solution

Same as the datalakeworkspace_DuplicateMatchingRecord many-to-one relationship for the duplicaterecord table/entity.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute duplicaterecordid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName datalakeworkspace_DuplicateMatchingRecord
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

datalakeworkspace_DuplicateBaseRecord

Added by: System Solution Solution

Same as the datalakeworkspace_DuplicateBaseRecord many-to-one relationship for the duplicaterecord table/entity.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute baserecordid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName datalakeworkspace_DuplicateBaseRecord
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

datalakeworkspace_AsyncOperations

Added by: System Solution Solution

Same as the datalakeworkspace_AsyncOperations many-to-one relationship for the asyncoperation table/entity.

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName datalakeworkspace_AsyncOperations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

datalakeworkspace_MailboxTrackingFolders

Added by: System Solution Solution

Same as the datalakeworkspace_MailboxTrackingFolders many-to-one relationship for the mailboxtrackingfolder table/entity.

Property Value
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName datalakeworkspace_MailboxTrackingFolders
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

datalakeworkspace_ProcessSession

Added by: System Solution Solution

Same as the datalakeworkspace_ProcessSession many-to-one relationship for the processsession table/entity.

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName datalakeworkspace_ProcessSession
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

datalakeworkspace_BulkDeleteFailures

Added by: System Solution Solution

Same as the datalakeworkspace_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure table/entity.

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName datalakeworkspace_BulkDeleteFailures
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

datalakeworkspace_PrincipalObjectAttributeAccesses

Added by: System Solution Solution

Same as the datalakeworkspace_PrincipalObjectAttributeAccesses many-to-one relationship for the principalobjectattributeaccess table/entity.

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName datalakeworkspace_PrincipalObjectAttributeAccesses
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

datalakeworkspace_workspacepermission

Same as the datalakeworkspace_workspacepermission many-to-one relationship for the datalakeworkspacepermission table/entity.

Property Value
ReferencingEntity datalakeworkspacepermission
ReferencingAttribute workspaceid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName datalakeworkspace_workspacepermission
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related table. Listed by SchemaName.

lk_datalakeworkspace_createdby

Added by: System Solution Solution

See the lk_datalakeworkspace_createdby one-to-many relationship for the systemuser table/entity.

lk_datalakeworkspace_createdonbehalfby

Added by: System Solution Solution

See the lk_datalakeworkspace_createdonbehalfby one-to-many relationship for the systemuser table/entity.

lk_datalakeworkspace_modifiedby

Added by: System Solution Solution

See the lk_datalakeworkspace_modifiedby one-to-many relationship for the systemuser table/entity.

lk_datalakeworkspace_modifiedonbehalfby

Added by: System Solution Solution

See the lk_datalakeworkspace_modifiedonbehalfby one-to-many relationship for the systemuser table/entity.

organization_datalakeworkspace

Added by: System Solution Solution

See the organization_datalakeworkspace one-to-many relationship for the organization table/entity.

See also

Dataverse table/entity reference
Web API Reference
datalakeworkspace EntityType