Bendrinti naudojant


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
Table type: 
Standard
Display name: 
Synapse Database
Primary key: 
synapsedatabaseid
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
Values Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished
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
Values Label
1 Managed
0 Unmanaged
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
Values Label
0 Active
1 Inactive
statuscode Edm.Int32

Reason for the status of the Synapse Database

Display name: Status Reason

Default options
Values Label
1 Active
2 Inactive
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
DeleteMultiple Not Bound
GrantAccess Not Bound
IsValidStateTransition Not Bound
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound
UpdateMultiple Not Bound

See also