synapsedatabase EntityType
This entity represents an external Synapse database and its associated datalake folder link.
- Entity Set Path
- [organization URI]/api/data/v9.2/synapsedatabases
- Base Type
- crmbaseentity
- Display Name
- Synapse Database
- Primary Key
- synapsedatabaseid
- 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 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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
|
||||||||||
| createdon | Edm.DateTimeOffset |
Date and time when the record was created. Display Name: Created On Read Only
|
||||||||||
| databasename | Edm.String |
Name of the Synapse database. Display Name: Database Name |
||||||||||
| developmentendpoint | Edm.String |
The development endpoint for this Synapse database. Display Name: DevelopmentEndpoint |
||||||||||
| importsequencenumber | Edm.Int32 |
Sequence number of the import that created this record. Display Name: Import Sequence Number |
||||||||||
| iscustomizable | BooleanManagedProperty |
For internal use only. Display Name: Is Customizable |
||||||||||
| ismanaged | Edm.Boolean |
Indicates whether the solution component is part of a managed solution. Display Name: Is Managed Read Only
Default Options
|
||||||||||
| lakehouseconnectionid | Edm.Guid |
Connection Id for the Lakehouse that contains shortcuts to the table. Display Name: Lakehouse Connection Id |
||||||||||
| lakehouseid | Edm.Guid |
Id for the Lakehouse that contains shortcuts to the table. Display Name: Lakehouse Id |
||||||||||
| lakehouseworkspaceid | Edm.Guid |
Id for the Power BI workspace that contains the Lakehouse Display Name: Lakehouse Workspace Id |
||||||||||
| 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
|
||||||||||
| resourcegroup | Edm.String |
Azure resource group of the Synapse database. Display Name: ResourceGroup |
||||||||||
| schemaprefix | Edm.String |
Schema prefix to use for the table names Display Name: Schema Prefix |
||||||||||
| serverlesssqlendpoint | Edm.String |
Serverless Sql Endpoint of the Synapse database. Display Name: Serverless Sql Endpoint |
||||||||||
| solutionid | Edm.Guid |
Unique identifier of the associated solution. Display Name: Solution Read Only
|
||||||||||
| sparkpoolconfig | Edm.String |
Spark pool configuration Display Name: Spark Pool Configuration |
||||||||||
| statecode | Edm.Int32 |
Status of the Synapse Database Display Name: Status
Default Options
|
||||||||||
| statuscode | Edm.Int32 |
Reason for the status of the Synapse Database Display Name: Status Reason
Default Options
|
||||||||||
| subscription | Edm.String |
Azure subscription for the Synapse database Display Name: Subscription |
||||||||||
| synapsedatabaseid | Edm.Guid |
Unique identifier for entity instances Display Name: Synapse Database |
||||||||||
| tenant | Edm.String |
Azure tenant of the Synapse database Display Name: Tenant |
||||||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display Name: Time Zone Rule Version Number |
||||||||||
| uniquename | Edm.String |
Unique Name for the entity. Display Name: Unique Name |
||||||||||
| 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
|
||||||||||
| workspacename | Edm.String |
Workspace name of the Synapse database. Display Name: Workspace Name |
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. |
| _datalakefolder_value | datalakefolder |
Unique identifier for Data Lake Folder associated with Synapse Database. |
| _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. |
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_synapsedatabase_createdby |
| createdonbehalfby | systemuser | lk_synapsedatabase_createdonbehalfby |
| datalakefolder | datalakefolder | synapsedatabases |
| modifiedby | systemuser | lk_synapsedatabase_modifiedby |
| modifiedonbehalfby | systemuser | lk_synapsedatabase_modifiedonbehalfby |
| ownerid | principal | owner_synapsedatabase |
| owningbusinessunit | businessunit | business_unit_synapsedatabase |
| owningteam | team | team_synapsedatabase |
| owninguser | systemuser | user_synapsedatabase |
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 |
|---|---|---|
| synapsedatabase_AsyncOperations | asyncoperation | regardingobjectid_synapsedatabase |
| synapsedatabase_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_synapsedatabase |
| synapsedatabase_DuplicateBaseRecord | duplicaterecord | baserecordid_synapsedatabase |
| synapsedatabase_DuplicateMatchingRecord | duplicaterecord | duplicaterecordid_synapsedatabase |
| synapsedatabase_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_synapsedatabase |
| synapsedatabase_PrincipalObjectAttributeAccesses | principalobjectattributeaccess | objectid_synapsedatabase |
| synapsedatabase_ProcessSession | processsession | regardingobjectid_synapsedatabase |
| synapsedatabase_SyncErrors | syncerror | regardingobjectid_synapsedatabase |
Operations
The following operations can be used with the synapsedatabase 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 |