datalakeworkspace EntityType
A workspace is a place to store data in Azure Data Lake.
- Entity set path:
- [organization URI]/api/data/v9.2/datalakeworkspaces
- Base type:
- crmbaseentity
- Table type:
- Standard
- Display name:
- Data Lake Workspace
- Primary key:
- datalakeworkspaceid
- Primary name column:
- name
- Operations supported:
- POST GET PATCH DELETE
Properties
Properties represent fields of data stored in the entity. Some properties are read-only.
| Name | Type | Details | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| componentidunique | Edm.Guid |
For internal use only. Display name: Row id unique Read only
|
||||||||||
| componentstate | Edm.Int32 |
For internal use only. Display name: Component State Read only
Default options
|
||||||||||
| containerendpoint | Edm.String |
Azure Data Lake container endpoint for this workspace. Display name: Container Endpoint Read only
|
||||||||||
| createdon | Edm.DateTimeOffset |
Date and time when the record was created. Display name: Created On Read only
|
||||||||||
| datalakeworkspace_uniquename | Edm.String |
Unique Name for the entity. Display name: Unique Name |
||||||||||
| datalakeworkspaceid | Edm.Guid |
Unique identifier for entity instances Display name: Data Lake Workspace |
||||||||||
| importsequencenumber | Edm.Int32 |
Sequence number of the import that created this record. Display name: Import Sequence Number |
||||||||||
| iscustomercapacity | Edm.Boolean |
Indicates if workspace data storage uses customer capacity. Display name: Is Customer Capacity
Default options
|
||||||||||
| iscustomizable | BooleanManagedProperty |
For internal use only. Display name: Is Customizable |
||||||||||
| isdeepcopyenabled | Edm.Boolean |
Indicates if deep copy is enabled for workspace. Display name: Is Deep Copy Enabled
Default options
|
||||||||||
| ismanaged | Edm.Boolean |
Indicates whether the solution component is part of a managed solution. Display name: Is Managed Read only
Default options
|
||||||||||
| isprivate | Edm.Boolean |
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. Display name: Is Private
Default options
|
||||||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when the record was modified. Display name: Modified On Read only
|
||||||||||
| name | Edm.String |
The name of the custom entity. Display name: Name |
||||||||||
| overriddencreatedon | Edm.DateTimeOffset |
Date and time that the record was migrated. Display name: Record Created On |
||||||||||
| overwritetime | Edm.DateTimeOffset |
For internal use only. Display name: Record Overwrite Time Read only
|
||||||||||
| owningappid | Edm.Guid |
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. Display name: Owning App Id |
||||||||||
| path | Edm.String |
Workspace path in the Azure Data Lake container. Display name: Path Read only
|
||||||||||
| solutionid | Edm.Guid |
Unique identifier of the associated solution. Display name: Solution Read only
|
||||||||||
| statecode | Edm.Int32 |
Status of the Data Lake Workspace Display name: Status Read only
Default options
|
||||||||||
| statuscode | Edm.Int32 |
Reason for the status of the Data Lake Workspace Display name: Status Reason Read only
Default options
|
||||||||||
| tenantid | Edm.Guid |
AAD tenant id where the owning application id is registered. Display name: Tenant Id |
||||||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display name: Time Zone Rule Version Number |
||||||||||
| utcconversiontimezonecode | Edm.Int32 |
Time zone code that was in use when the record was created. Display name: UTC Conversion Time Zone Code |
||||||||||
| versionnumber | Edm.Int64 |
Version Number Display name: Version Number Read only
|
||||||||||
| whitelistedappid | Edm.Guid |
Application Id that is white listed in AAD Tenant ID to access the Graph API. Display name: Whitelisted App Id |
Lookup properties
Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.
| Name | Single-valued navigation property | Description |
|---|---|---|
| _createdby_value | createdby |
Unique identifier of the user who created the record. |
| _createdonbehalfby_value | createdonbehalfby |
Unique identifier of the delegate user who created the record. |
| _modifiedby_value | modifiedby |
Unique identifier of the user who modified the record. |
| _modifiedonbehalfby_value | modifiedonbehalfby |
Unique identifier of the delegate user who modified the record. |
| _organizationid_value | organizationid |
Unique identifier for the organization |
Single-valued navigation properties
Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.
| Name | Type | Partner |
|---|---|---|
| createdby | systemuser | lk_datalakeworkspace_createdby |
| createdonbehalfby | systemuser | lk_datalakeworkspace_createdonbehalfby |
| modifiedby | systemuser | lk_datalakeworkspace_modifiedby |
| modifiedonbehalfby | systemuser | lk_datalakeworkspace_modifiedonbehalfby |
| organizationid | organization | organization_datalakeworkspace |
Collection-valued navigation properties
Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.
| Name | Type | Partner |
|---|---|---|
| datalakeworkspace_AsyncOperations | asyncoperation | regardingobjectid_datalakeworkspace |
| datalakeworkspace_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_datalakeworkspace |
| datalakeworkspace_DuplicateBaseRecord | duplicaterecord | baserecordid_datalakeworkspace |
| datalakeworkspace_DuplicateMatchingRecord | duplicaterecord | duplicaterecordid_datalakeworkspace |
| datalakeworkspace_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_datalakeworkspace |
| datalakeworkspace_PrincipalObjectAttributeAccesses | principalobjectattributeaccess | objectid_datalakeworkspace |
| datalakeworkspace_ProcessSession | processsession | regardingobjectid_datalakeworkspace |
| datalakeworkspace_SyncErrors | syncerror | regardingobjectid_datalakeworkspace |
| datalakeworkspace_workspacepermission | datalakeworkspacepermission | workspaceid |
Operations
The following operations can be used with the datalakeworkspace entity type.
| Name | Binding |
|---|---|
| CreateMultiple | Not Bound |
| DeleteMultiple | Not Bound |
| IsValidStateTransition | Not Bound |
| UpdateMultiple | Not Bound |