datalakefolder EntityType
A folder is a place to store data in Azure Data Lake.
- Entity Set Path
- [organization URI]/api/data/v9.2/datalakefolders
- Base Type
- crmbaseentity
- Display Name
- Data Lake Folder
- Primary Key
- datalakefolderid
- Primary Key Attribute
- 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 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| accesstype | Edm.String |
Azure Data Lake Access Type. Display Name: Access Type |
||||||||||
| cdmpath | Edm.String |
Path to the CDM file. Display Name: CDM Path |
||||||||||
| 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 folder. Display Name: Container Endpoint |
||||||||||
| contributorsecuritygroupid | Edm.Guid |
The security group for contributor access. Display Name: Contributor Security Group Id |
||||||||||
| createdon | Edm.DateTimeOffset |
Date and time when the record was created. Display Name: Created On Read Only
|
||||||||||
| datalakefolder_uniquename | Edm.String |
Unique Name for the entity. Display Name: Unique Name |
||||||||||
| datalakefolderid | Edm.Guid |
Unique identifier for entity instances Display Name: Data Lake Folder |
||||||||||
| deltaLakePath | Edm.String |
Sub folder path to delta lake. Display Name: deltaLakePath |
||||||||||
| extendedproperties | Edm.String |
Extended Properties associated with this folder. Display Name: Extended Properties |
||||||||||
| importsequencenumber | Edm.Int32 |
Sequence number of the import that created this record. Display Name: Import Sequence Number |
||||||||||
| iscustomercapacity | Edm.Boolean |
Indicates if folder 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 folder. Display Name: Is Deep Copy Enabled
Default Options
|
||||||||||
| isexternallake | Edm.Boolean |
Indicates whether lake is managed or external. Display Name: Is External Lake
Default Options
|
||||||||||
| isexternallakereadonly | Edm.Boolean |
Indicates whether external lake is read only. Display Name: Is External Lake Read Only
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 folder data and metadata are visible to all applications, or only visible to the folder owner and applications with explicit permissions to the folder. 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 folder. 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 |
Folder path in the Azure Data Lake container. Display Name: Path |
||||||||||
| readersecuritygroupid | Edm.Guid |
The security group for reader access. Display Name: Reader Security Group Id |
||||||||||
| resourcegroup | Edm.String |
Azure resource group of the storage account. Display Name: ResourceGroup |
||||||||||
| sharedforreadaccess | Edm.Boolean |
Indicates if folder is shared for readaccess for other FPAs. Display Name: Is Shared for Read Access
Default Options
|
||||||||||
| solutionid | Edm.Guid |
Unique identifier of the associated solution. Display Name: Solution Read Only
|
||||||||||
| statecode | Edm.Int32 |
Status of the Data Lake Folder Display Name: Status
Default Options
|
||||||||||
| statuscode | Edm.Int32 |
Reason for the status of the Data Lake Folder Display Name: Status Reason
Default Options
|
||||||||||
| subscription | Edm.String |
Azure subscription of the storage account. Display Name: Subscription |
||||||||||
| synchronizeschematodataverse | Edm.Boolean |
Enable schema synchronization to Dataverse. Display Name: Synchronize Schema To Dataverse
Default Options
|
||||||||||
| synchronizeschematosynapsedb | Edm.Boolean |
Enable schema synchronization to Synapse database. Display Name: Synchronize Schema To Synapse Db
Default Options
|
||||||||||
| tenant | Edm.String |
Azure tenant of the storage account. Display Name: Tenant |
||||||||||
| 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
|
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. |
| _ownerid_value | ownerid |
Owner Id |
| _owningbusinessunit_value | owningbusinessunit |
Unique identifier for the business unit that owns the record |
| _owningteam_value | owningteam |
Unique identifier for the team that owns the record. |
| _owninguser_value | owninguser |
Unique identifier for the user that owns the record. |
| _parentfolderid_value | parentfolderid |
Unique identifier of the parent folder for this folder. |
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_datalakefolder_createdby |
| createdonbehalfby | systemuser | lk_datalakefolder_createdonbehalfby |
| modifiedby | systemuser | lk_datalakefolder_modifiedby |
| modifiedonbehalfby | systemuser | lk_datalakefolder_modifiedonbehalfby |
| ownerid | principal | owner_datalakefolder |
| owningbusinessunit | businessunit | business_unit_datalakefolder |
| owningteam | team | team_datalakefolder |
| owninguser | systemuser | user_datalakefolder |
| parentfolderid | datalakefolder | datalakefolder_datalakesubfolder |
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 |
|---|---|---|
| datalakefolder_AsyncOperations | asyncoperation | regardingobjectid_datalakefolder |
| datalakefolder_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_datalakefolder |
| datalakefolder_datalakefolderpermission | datalakefolderpermission | folderid |
| datalakefolder_datalakesubfolder | datalakefolder | parentfolderid |
| datalakefolder_DuplicateBaseRecord | duplicaterecord | baserecordid_datalakefolder |
| datalakefolder_DuplicateMatchingRecord | duplicaterecord | duplicaterecordid_datalakefolder |
| datalakefolder_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_datalakefolder |
| datalakefolder_PrincipalObjectAttributeAccesses | principalobjectattributeaccess | objectid_datalakefolder |
| datalakefolder_ProcessSession | processsession | regardingobjectid_datalakefolder |
| datalakefolder_SyncErrors | syncerror | regardingobjectid_datalakefolder |
| msdyn_dataflow_datalakefolder_dlfolder | msdyn_dataflow_datalakefolder | msdyn_DatalakeFolder |
| synapsedatabases | synapsedatabase | datalakefolder |
| synapselinkexternaltablestates | synapselinkexternaltablestate | datalakefolder |
| synapselinkprofiles | synapselinkprofile | datalakefolder |
Operations
The following operations can be used with the datalakefolder entity type.
| Name | Binding |
|---|---|
| CreateMultiple | Not Bound |
| GrantAccess | Not Bound |
| IsValidStateTransition | Not Bound |
| ModifyAccess | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| RetrieveSharedPrincipalsAndAccess | Not Bound |
| RevokeAccess | Not Bound |
| UpdateMultiple | Not Bound |