CData Cloud offers access to Microsoft Dataverse across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a MySQL or SQL Server database can connect to Microsoft Dataverse through CData Cloud.
CData Cloud allows you to standardize and configure connections to Microsoft Dataverse as though it were any other OData endpoint, or standard SQL Server/MySQL database.
This page provides a guide to Establishing a Connection to Microsoft Dataverse in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to Microsoft Dataverse and configure any necessary connection properties to create a database in CData Cloud
Accessing data from Microsoft Dataverse through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to Microsoft Dataverse by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
Microsoft Dataverse supports schema values of 'System' and 'Entities' and can be set using the Schema property.
Using 'System' for Schema property uses the Web API to query entities/tables.
Using 'Entities' for Schema property uses the EntityDefinitions entity set path and retrieves information about EntityMetadata EntityType entities/tables. This will often result in more user friendly names, though requires extra metadata requests.
To authenticate to the Microsoft Dataverse source, you should first set the OrganizationUrl to the URL of the organization you are connecting to, such as https://[organization].crm.dynamics.com.
Azure AD is a connection type that leverages OAuth to authenticate. OAuth requires the authenticating user to interact with Microsoft Dataverse using an internet browser. The Cloud facilitates this in several ways as described below. Set your AuthScheme to AzureAD. The rest of the AzureAD flows assume that you have done so.
Client OAuth Flow
All permissions related to the client oauth flow require admin consent. This means the app embedded with the CData Cloud cannot be used in the client oauth flow. You must create your own OAuth app in order to use client credentials. See Creating an Azure AD Application for more details.
In your App Registration in portal.azure.com, navigate to API Permissions and select the Microsoft Graph permissions. There are two distinct sets of permissions - Delegated and Application permissions. The permissions used during client credential authentication are under Application Permissions. Select the applicable permissions you require for your integration.
You are ready to connect after setting one of the below connection properties groups depending on the authentication type.
Authentication with client credentials will take place automatically like any other connection, except there will be no window opened prompting the user. Because there is no user context, there is no need for a browser popup. Connections will take place and be handled internally.
Azure Service Principal is role-based application-based authentication. This means that authentication is done per application, rather than per user. All tasks taken on by the application are executed without a default user context, but based on the assigned roles. The application access to the resources is controlled through the assigned roles' permissions.
For information about how to set up Azure Service Principal authentication, see Creating an Azure AD App with Service Principal.
If you are running Microsoft Dataverse on an Azure VM and want to automatically obtain Managed Service Identity (MSI) credentials to connect, set AuthScheme to AzureMSI.
If your VM has multiple user-assigned managed identities, you must also specify OAuthClientId.
By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
The CData Cloud models Microsoft Dataverse data as an easy-to-use SQL database with tables, views, and stored procedures. The definitions are dynamically obtained from the Microsoft Dataverse OData service you connect to. You can load changes to the metadata, such as new or removed columns, or changes in data type, by reconnecting to the service.
The Cloud exposes two data models:
You can use the stored procedures provided by CData Cloud to automate working with Microsoft Dataverse data.
The Entities Data Model defines, stores, and manages structured data within business applications. It enables data relationships, security, automation, and integration with Microsoft Power Platform, Dynamics 365, and external systems.
The Views section, which lists read-only SQL tables, contain samples of what you may have access to in your Microsoft Dataverse account.
The following views are shipped with the Cloud:
| Table | Description |
| MultiSelectPickListAttributeMetaData | Stores metadata for attributes that support MultiSelect OptionSet, defining the structure and behavior of multi-option fields. |
| MultiSelectPickListOptions | Contains the possible selectable options for MultiSelect OptionSet attributes, enabling multi-value selections. |
| PickListAttributeMetaData | Holds metadata for attributes of type Picklist, describing the single-option selection fields in the system. |
| PickListOptions | Defines the set of selectable options available for Picklist attributes, supporting user-defined field values. |
| StateAttributeMetadata | Provides metadata for attributes of type State, describing state-related fields used for status tracking or categorization. |
| StateAttributeOptions | Lists the selectable states available for State attributes, representing various predefined states. |
| StatusAttributeMetadata | Contains metadata for attributes of type Status, often used to track the lifecycle or current condition of an entity. |
| StatusAttributeOptions | Defines the set of statuses that can be assigned to Status attributes, supporting status-driven workflows. |
Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including retrieving and refreshing the OAuth Access Token.
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| MultiSelectPickListAttributeMetaData | Stores metadata for attributes that support MultiSelect OptionSet, defining the structure and behavior of multi-option fields. |
| MultiSelectPickListOptions | Contains the possible selectable options for MultiSelect OptionSet attributes, enabling multi-value selections. |
| PickListAttributeMetaData | Holds metadata for attributes of type Picklist, describing the single-option selection fields in the system. |
| PickListOptions | Defines the set of selectable options available for Picklist attributes, supporting user-defined field values. |
| StateAttributeMetadata | Provides metadata for attributes of type State, describing state-related fields used for status tracking or categorization. |
| StateAttributeOptions | Lists the selectable states available for State attributes, representing various predefined states. |
| StatusAttributeMetadata | Contains metadata for attributes of type Status, often used to track the lifecycle or current condition of an entity. |
| StatusAttributeOptions | Defines the set of statuses that can be assigned to Status attributes, supporting status-driven workflows. |
Stores metadata for attributes that support MultiSelect OptionSet, defining the structure and behavior of multi-option fields.
The Cloud will use the Microsoft Dataverse API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note that without filtering on TableName, the Cloud returns the results for the first table found.
For example, the following queries are processed server side:
SELECT * FROM MultiSelectPickListAttributeMetaData WHERE TableName = 'teams'
SELECT * FROM MultiSelectPickListAttributeMetaData WHERE TableName IN ('accounts', 'teams')
| Name | Type | References | Description |
| ColumnName [KEY] | String | The name of the column in the table where the multi-select picklist is defined. | |
| MetadataId | String | The unique identifier for the metadata associated with this attribute. | |
| OptionSet_Description_LocalizedLabels | String | Localized descriptions of the options in the picklist for different languages. | |
| OptionSet_Description_UserLocalizedLabel_HasChanged | String | Indicates whether the user-localized description label has been modified. | |
| OptionSet_Description_UserLocalizedLabel_IsManaged | Boolean | Specifies if the user-localized description label is managed (part of a managed solution). | |
| OptionSet_Description_UserLocalizedLabel_Label | String | The localized label text for the option set description. | |
| OptionSet_Description_UserLocalizedLabel_LanguageCode | Integer | The language code corresponding to the localized description label. | |
| OptionSet_Description_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata associated with the localized description label. | |
| OptionSet_DisplayName_LocalizedLabels | String | Localized display names of the picklist options for different languages. | |
| OptionSet_DisplayName_UserLocalizedLabel_HasChanged | String | Indicates whether the user-localized display name label has been modified. | |
| OptionSet_DisplayName_UserLocalizedLabel_IsManaged | Boolean | Specifies if the user-localized display name label is managed (part of a managed solution). | |
| OptionSet_DisplayName_UserLocalizedLabel_Label | String | The localized label text for the option set display name. | |
| OptionSet_DisplayName_UserLocalizedLabel_LanguageCode | Integer | The language code corresponding to the localized display name label. | |
| OptionSet_DisplayName_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata associated with the localized display name label. | |
| OptionSet_ExternalTypeName | String | The external type name associated with the option set, if applicable. | |
| OptionSet_HasChanged | String | Indicates if the option set has been modified. | |
| OptionSet_IntroducedVersion | String | The version of the system in which the option set was introduced. | |
| OptionSet_IsCustomizable_CanBeChanged | Boolean | Indicates whether the option set can be customized. | |
| OptionSet_IsCustomizable_ManagedPropertyLogicalName | String | The logical name of the managed property that controls the customizability of the option set. | |
| OptionSet_IsCustomizable_Value | Boolean | Specifies if the option set is customizable. | |
| OptionSet_IsCustomOptionSet | Boolean | Indicates whether the option set is custom or part of a managed solution. | |
| OptionSet_IsGlobal | Boolean | Specifies if the option set is global (shared across entities) or local (specific to one entity). | |
| OptionSet_IsManaged | Boolean | Indicates if the option set is managed (part of a managed solution). | |
| OptionSet_MetadataId | String | The unique identifier for the metadata associated with the option set. | |
| OptionSet_Name | String | The name of the option set. | |
| OptionSet_OptionSetType | String | The type of the option set (e.g., picklist, multi-select). | |
| OptionSet_ParentOptionSetName | String | The name of the parent option set, if this option set is part of a hierarchy. | |
| TableName | String | The name of the table where this multi-select picklist attribute is defined. |
Contains the possible selectable options for MultiSelect OptionSet attributes, enabling multi-value selections.
The Cloud will use the Microsoft Dataverse API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note that without filtering on TableName, the Cloud returns the results for the first table found.
For example, the following queries are processed server side:
SELECT * FROM MultiSelectPickListOptions WHERE TableName = 'teams'
SELECT * FROM MultiSelectPickListOptions WHERE TableName IN ('accounts', 'teams')
| Name | Type | References | Description |
| ColumnName | String |
MultiSelectPickListAttributeMetaData.ColumnName | The name of the column in the table where the multi-select picklist option is defined. |
| Color | String | The color code associated with the picklist option, often used for UI display purposes. | |
| ExternalValue | String | An external system value mapped to this picklist option, if applicable. | |
| HasChanged | String | Indicates whether the option has been modified since its creation or last update. | |
| IsManaged | Boolean | Specifies if the picklist option is managed (part of a managed solution). | |
| Label_LocalizedLabels | String | Localized labels for the picklist option in different languages. | |
| Label_UserLocalizedLabel_HasChanged | String | Indicates if the user-customized label for the picklist option has been modified. | |
| Label_UserLocalizedLabel_IsManaged | Boolean | Specifies if the user-customized label for the picklist option is managed. | |
| Label_UserLocalizedLabel_Label | String | The user-customized label text for the picklist option. | |
| Label_UserLocalizedLabel_LanguageCode | Integer | The language code corresponding to the user-customized label. | |
| Label_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata of the user-customized label. | |
| Description_LocalizedLabels | String | Localized descriptions for the picklist option in different languages. | |
| Description_UserLocalizedLabel_HasChanged | String | Indicates if the user-customized description for the picklist option has been modified. | |
| Description_UserLocalizedLabel_IsManaged | Boolean | Specifies if the user-customized description for the picklist option is managed. | |
| Description_UserLocalizedLabel_Label | String | The user-customized description text for the picklist option. | |
| Description_UserLocalizedLabel_LanguageCode | Integer | The language code corresponding to the user-customized description. | |
| Description_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata of the user-customized description. | |
| MetadataId | String | The unique identifier for the metadata associated with the picklist option. | |
| ParentValues | String | Specifies the parent values for hierarchical picklist options, if applicable. | |
| Value | Integer | The integer value associated with this picklist option, used for storage and retrieval. | |
| TableName | String | The name of the table where this picklist option is defined. |
Holds metadata for attributes of type Picklist, describing the single-option selection fields in the system.
The Cloud will use the Microsoft Dataverse API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note that without filtering on TableName, the Cloud returns the results for the first table found.
For example, the following queries are processed server side:
SELECT * FROM PickListAttributeMetaData WHERE TableName = 'teams'
SELECT * FROM PickListAttributeMetaData WHERE TableName IN ('accounts', 'teams')
| Name | Type | References | Description |
| ColumnName [KEY] | String | The name of the column in the table where the picklist attribute is defined. | |
| MetadataId | String | The unique identifier for the metadata associated with this attribute. | |
| OptionSet_Description_LocalizedLabels | String | Localized descriptions of the options in the picklist for various supported languages. | |
| OptionSet_Description_UserLocalizedLabel_HasChanged | String | Indicates whether the user-customized description label has been modified. | |
| OptionSet_Description_UserLocalizedLabel_IsManaged | Boolean | Specifies if the user-customized description label is managed (part of a managed solution). | |
| OptionSet_Description_UserLocalizedLabel_Label | String | The localized label text for the description of the picklist. | |
| OptionSet_Description_UserLocalizedLabel_LanguageCode | Integer | The language code associated with the user-localized description label. | |
| OptionSet_Description_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata of the user-localized description label. | |
| OptionSet_DisplayName_LocalizedLabels | String | Localized display names for the picklist options in various languages. | |
| OptionSet_DisplayName_UserLocalizedLabel_HasChanged | String | Indicates whether the user-customized display name label has been modified. | |
| OptionSet_DisplayName_UserLocalizedLabel_IsManaged | Boolean | Specifies if the user-customized display name label is managed (part of a managed solution). | |
| OptionSet_DisplayName_UserLocalizedLabel_Label | String | The localized label text for the display name of the picklist. | |
| OptionSet_DisplayName_UserLocalizedLabel_LanguageCode | Integer | The language code associated with the user-localized display name label. | |
| OptionSet_DisplayName_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata of the user-localized display name label. | |
| OptionSet_ExternalTypeName | String | The external type name associated with the option set, if applicable. | |
| OptionSet_HasChanged | String | Indicates if the option set has been modified since its creation or last update. | |
| OptionSet_IntroducedVersion | String | The version of the system in which the option set was introduced. | |
| OptionSet_IsCustomizable_CanBeChanged | Boolean | Indicates whether the option set can be customized by the user or administrators. | |
| OptionSet_IsCustomizable_ManagedPropertyLogicalName | String | The logical name of the managed property controlling customizability of the option set. | |
| OptionSet_IsCustomizable_Value | Boolean | Specifies if the option set is customizable. | |
| OptionSet_IsCustomOptionSet | Boolean | Indicates whether the option set is custom or part of a default configuration. | |
| OptionSet_IsGlobal | Boolean | Specifies if the option set is global (shared across entities) or local (specific to one entity). | |
| OptionSet_IsManaged | Boolean | Indicates if the option set is managed (part of a managed solution). | |
| OptionSet_MetadataId | String | The unique identifier for the metadata associated with the option set. | |
| OptionSet_Name | String | The name of the option set. | |
| OptionSet_OptionSetType | String | The type of the option set (e.g., picklist, drop-down). | |
| OptionSet_ParentOptionSetName | String | The name of the parent option set, if this option set is part of a hierarchy. | |
| TableName | String | The name of the table where the picklist attribute is defined. |
Defines the set of selectable options available for Picklist attributes, supporting user-defined field values.
The Cloud will use the Microsoft Dataverse API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
Note that without filtering on TableName, the Cloud returns the results for the first table found.
For example, the following queries are processed server side:
SELECT * FROM PickListOptions WHERE TableName = 'teams'
SELECT * FROM PickListOptions WHERE TableName IN ('accounts', 'teams')
| Name | Type | References | Description |
| ColumnName | String |
PickListAttributeMetaData.ColumnName | The name of the column in the table where the picklist option is defined. |
| Color | String | The color code associated with the picklist option, often used for display purposes in user interfaces. | |
| ExternalValue | String | An external value associated with this picklist option, used for integration with external systems. | |
| HasChanged | String | Indicates whether the picklist option has been modified since its creation or last update. | |
| IsManaged | Boolean | Specifies if the picklist option is managed (part of a managed solution). | |
| Label_LocalizedLabels | String | Localized labels for the picklist option in multiple languages. | |
| Label_UserLocalizedLabel_HasChanged | String | Indicates if the user-customized label for the picklist option has been modified. | |
| Label_UserLocalizedLabel_IsManaged | Boolean | Specifies if the user-customized label for the picklist option is managed (part of a managed solution). | |
| Label_UserLocalizedLabel_Label | String | The user-customized label text for the picklist option. | |
| Label_UserLocalizedLabel_LanguageCode | Integer | The language code corresponding to the user-customized label. | |
| Label_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata associated with the user-customized label. | |
| Description_LocalizedLabels | String | Localized descriptions for the picklist option in various supported languages. | |
| Description_UserLocalizedLabel | String | The user-customized description for the picklist option, providing additional context or meaning. | |
| MetadataId | String | The unique identifier for the metadata associated with this picklist option. | |
| ParentValues | String | Specifies the parent values for hierarchical picklist options, if applicable. | |
| Value | Integer | The integer value associated with this picklist option, used for storage and retrieval. | |
| TableName | String | The name of the table where this picklist option is defined. |
Provides metadata for attributes of type State, describing state-related fields used for status tracking or categorization.
Note that without filtering on TableName, the Cloud returns the results for the first table found.
The following examples show how to query the view for a specific table or list of tables:
SELECT * FROM StateAttributeMetaData WHERE TableName='AccountLeads'
SELECT * FROM StateAttributeMetaData WHERE TableName IN ('Account','AccountLead');
| Name | Type | References | Description |
| ColumnName [KEY] | String | The name of the column in the table where the state attribute is defined. | |
| MetadataId | String | The unique identifier for the metadata associated with this state attribute. | |
| OptionSet_Description_LocalizedLabels | String | Localized descriptions for the state options in various supported languages. | |
| OptionSet_Description_UserLocalizedLabel_HasChanged | String | Indicates whether the user-customized description label for the state options has been modified. | |
| OptionSet_Description_UserLocalizedLabel_IsManaged | Boolean | Specifies if the user-customized description label for the state options is managed (part of a managed solution). | |
| OptionSet_Description_UserLocalizedLabel_Label | String | The user-customized label text for the description of the state options. | |
| OptionSet_Description_UserLocalizedLabel_LanguageCode | Integer | The language code associated with the user-customized description label. | |
| OptionSet_Description_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata of the user-customized description label. | |
| OptionSet_DisplayName_LocalizedLabels | String | Localized display names for the state options in various supported languages. | |
| OptionSet_DisplayName_UserLocalizedLabel_HasChanged | String | Indicates whether the user-customized display name label for the state options has been modified. | |
| OptionSet_DisplayName_UserLocalizedLabel_IsManaged | Boolean | Specifies if the user-customized display name label for the state options is managed (part of a managed solution). | |
| OptionSet_DisplayName_UserLocalizedLabel_Label | String | The user-customized label text for the display name of the state options. | |
| OptionSet_DisplayName_UserLocalizedLabel_LanguageCode | Integer | The language code associated with the user-customized display name label. | |
| OptionSet_DisplayName_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata of the user-customized display name label. | |
| OptionSet_ExternalTypeName | String | The external type name associated with the state options, if applicable. | |
| OptionSet_HasChanged | String | Indicates whether the state option set has been modified since its creation or last update. | |
| OptionSet_IntroducedVersion | String | The version of the system in which the state option set was introduced. | |
| OptionSet_IsCustomizable_CanBeChanged | Boolean | Indicates whether the state option set can be customized by the user or administrators. | |
| OptionSet_IsCustomizable_ManagedPropertyLogicalName | String | The logical name of the managed property controlling the customizability of the state option set. | |
| OptionSet_IsCustomizable_Value | Boolean | Specifies if the state option set is customizable. | |
| OptionSet_IsCustomOptionSet | Boolean | Indicates whether the state option set is custom or part of a default configuration. | |
| OptionSet_IsGlobal | Boolean | Specifies if the state option set is global (shared across entities) or local (specific to one entity). | |
| OptionSet_IsManaged | Boolean | Indicates if the state option set is managed (part of a managed solution). | |
| OptionSet_MetadataId | String | The unique identifier for the metadata associated with the state option set. | |
| OptionSet_Name | String | The name of the state option set. | |
| OptionSet_OptionSetType | String | The type of the state option set (e.g., picklist, drop-down). | |
| OptionSet_ParentOptionSetName | String | The name of the parent option set, if this state option set is part of a hierarchy. | |
| TableName | String | The name of the table where this state attribute is defined. |
Lists the selectable states available for State attributes, representing various predefined states.
Note that without filtering on TableName, the Cloud returns the results for the first table found.
The following examples show how to query the view for a specific table or list of tables:
SELECT * FROM StateAttributeOptions WHERE TableName='AccountLeads'
SELECT * FROM StateAttributeOptions WHERE TableName IN ('Account','AccountLead');
| Name | Type | References | Description |
| ColumnName | String |
StateAttributeMetadata.ColumnName | The name of the column in the table where the state option is defined. |
| Color | String | The color code associated with the state option, often used for UI representation. | |
| ExternalValue | String | An external system value mapped to this state option, if applicable. | |
| HasChanged | String | Indicates whether the state option has been modified since its creation or last update. | |
| IsManaged | Boolean | Specifies if the state option is managed (part of a managed solution). | |
| Label_LocalizedLabels | String | Localized labels for the state option in various supported languages. | |
| Label_UserLocalizedLabel_HasChanged | String | Indicates if the user-customized label for the state option has been modified. | |
| Label_UserLocalizedLabel_IsManaged | Boolean | Specifies if the user-customized label for the state option is managed (part of a managed solution). | |
| Label_UserLocalizedLabel_Label | String | The user-customized label text for the state option. | |
| Label_UserLocalizedLabel_LanguageCode | Integer | The language code corresponding to the user-customized label. | |
| Label_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata associated with the user-customized label. | |
| Description_LocalizedLabels | String | Localized descriptions for the state option in various supported languages. | |
| Description_UserLocalizedLabel | String | The user-customized description for the state option, providing additional context or details. | |
| MetadataId | String | The unique identifier for the metadata associated with the state option. | |
| ParentValues | String | Specifies the parent values for hierarchical state options, if applicable. | |
| Value | Integer | The integer value associated with this state option, used for storage and retrieval. | |
| TableName | String | The name of the table where this state option is defined. |
Contains metadata for attributes of type Status, often used to track the lifecycle or current condition of an entity.
Note that without filtering on TableName, the Cloud returns the results for the first table found.
The following examples show how to query the view for a specific table or list of tables:
SELECT * FROM StatusAttributeMetaData WHERE TableName='AccountLeads'
SELECT * FROM StatusAttributeMetaData WHERE TableName IN ('Account','AccountLead');
| Name | Type | References | Description |
| ColumnName [KEY] | String | The name of the column in the table where the status attribute is defined. | |
| MetadataId | String | The unique identifier for the metadata associated with this status attribute. | |
| OptionSet_Description_LocalizedLabels | String | Localized descriptions for the status options in various supported languages. | |
| OptionSet_Description_UserLocalizedLabel_HasChanged | String | Indicates whether the user-customized description label for the status options has been modified. | |
| OptionSet_Description_UserLocalizedLabel_IsManaged | Boolean | Specifies if the user-customized description label for the status options is managed (part of a managed solution). | |
| OptionSet_Description_UserLocalizedLabel_Label | String | The user-customized label text for the description of the status options. | |
| OptionSet_Description_UserLocalizedLabel_LanguageCode | Integer | The language code associated with the user-customized description label. | |
| OptionSet_Description_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata of the user-customized description label. | |
| OptionSet_DisplayName_LocalizedLabels | String | Localized display names for the status options in various supported languages. | |
| OptionSet_DisplayName_UserLocalizedLabel_HasChanged | String | Indicates whether the user-customized display name label for the status options has been modified. | |
| OptionSet_DisplayName_UserLocalizedLabel_IsManaged | Boolean | Specifies if the user-customized display name label for the status options is managed (part of a managed solution). | |
| OptionSet_DisplayName_UserLocalizedLabel_Label | String | The user-customized label text for the display name of the status options. | |
| OptionSet_DisplayName_UserLocalizedLabel_LanguageCode | Integer | The language code associated with the user-customized display name label. | |
| OptionSet_DisplayName_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata of the user-customized display name label. | |
| OptionSet_ExternalTypeName | String | The external type name associated with the status options, if applicable. | |
| OptionSet_HasChanged | String | Indicates whether the status option set has been modified since its creation or last update. | |
| OptionSet_IntroducedVersion | String | The version of the system in which the status option set was introduced. | |
| OptionSet_IsCustomizable_CanBeChanged | Boolean | Indicates whether the status option set can be customized by the user or administrators. | |
| OptionSet_IsCustomizable_ManagedPropertyLogicalName | String | The logical name of the managed property controlling the customizability of the status option set. | |
| OptionSet_IsCustomizable_Value | Boolean | Specifies if the status option set is customizable. | |
| OptionSet_IsCustomOptionSet | Boolean | Indicates whether the status option set is custom or part of a default configuration. | |
| OptionSet_IsGlobal | Boolean | Specifies if the status option set is global (shared across entities) or local (specific to one entity). | |
| OptionSet_IsManaged | Boolean | Indicates if the status option set is managed (part of a managed solution). | |
| OptionSet_MetadataId | String | The unique identifier for the metadata associated with the status option set. | |
| OptionSet_Name | String | The name of the status option set. | |
| OptionSet_OptionSetType | String | The type of the status option set (e.g., picklist, drop-down). | |
| OptionSet_ParentOptionSetName | String | The name of the parent option set, if this status option set is part of a hierarchy. | |
| TableName | String | The name of the table where this status attribute is defined. |
Defines the set of statuses that can be assigned to Status attributes, supporting status-driven workflows.
Note that without filtering on TableName, the Cloud returns the results for the first table found.
The following examples show how to query the view for a specific table or list of tables:
SELECT * FROM StatusAttributesOptions WHERE TableName='AccountLeads'
SELECT * FROM StatusAttributesOptions WHERE TableName IN ('Account','AccountLead');
| Name | Type | References | Description |
| ColumnName | String |
StatusAttributeMetadata.ColumnName | The name of the column in the table where the status option is defined. |
| Color | String | The color code associated with the status option, typically used for visual representation in user interfaces. | |
| ExternalValue | String | An external system value mapped to this status option, if applicable. | |
| HasChanged | String | Indicates whether the status option has been modified since its creation or last update. | |
| IsManaged | Boolean | Specifies if the status option is managed (part of a managed solution). | |
| Label_LocalizedLabels | String | Localized labels for the status option in various supported languages. | |
| Label_UserLocalizedLabel_HasChanged | String | Indicates if the user-customized label for the status option has been modified. | |
| Label_UserLocalizedLabel_IsManaged | Boolean | Specifies if the user-customized label for the status option is managed (part of a managed solution). | |
| Label_UserLocalizedLabel_Label | String | The user-customized label text for the status option. | |
| Label_UserLocalizedLabel_LanguageCode | Integer | The language code corresponding to the user-customized label. | |
| Label_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata associated with the user-customized label. | |
| Description_LocalizedLabels | String | Localized descriptions for the status option in various supported languages. | |
| Description_UserLocalizedLabel | String | The user-customized description for the status option, providing additional context or details. | |
| MetadataId | String | The unique identifier for the metadata associated with the status option. | |
| ParentValues | String | Specifies the parent values for hierarchical status options, if applicable. | |
| Value | Integer | The integer value associated with this status option, used for storage and retrieval. | |
| TableName | String | The name of the table where this status option is defined. |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Microsoft Dataverse.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Microsoft Dataverse, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
The System Data Model defines the underlying framework that supports core platform functionality, including security, auditing, and system-level operations. It manages metadata, user roles, workflows, and background processes to ensure seamless data governance and integration across business applications.
Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including retrieving and refreshing the OAuth Access Token.
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Microsoft Dataverse.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Microsoft Dataverse, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
| CreateAssociation | Establishes a link between two entities using their navigation properties. Requires navigation properties to be enabled in the connection configuration. |
| ListAssociations | Displays all associations for a specified table and its navigation properties, detailing entity relationships. |
| ListNavigationProperties | Lists navigation properties for a specified table and its associated tables, aiding in relationship discovery. |
| RemoveAssociation | Deletes a previously established link between two entities, managed via their navigation properties. |
Establishes a link between two entities using their navigation properties. Requires navigation properties to be enabled in the connection configuration.
| Name | Type | Required | Description |
| FromId | String | True | The unique identifier (Id) of the source entity for which you are establishing an association. |
| FromTable | String | True | The name of the table containing the source entity. For example, if the FromId belongs to a record in the Customers table, set this parameter to 'Customers'. |
| ToNavigationProperty | String | True | The name of the navigation property used to define the relationship. This property can be retrieved using the ListNavigationProperties procedure. |
| ToId | String | True | The unique identifier (Id) of the target entity in the associated table defined by the navigation property. |
| Name | Type | Description |
| Success | Boolean | A boolean value indicating whether the association creation operation was successful (true) or failed (false). |
Displays all associations for a specified table and its navigation properties, detailing entity relationships.
| Name | Type | Required | Description |
| FromId | String | True | The unique identifier (Id) of the source entity for which you want to list associated entities. |
| FromTable | String | True | The name of the table containing the source entity. For example, if the FromId belongs to a record in the Customers table, set this parameter to 'Customers'. |
| NavigationProperty | String | True | The name of the navigation property representing the relationship you want to retrieve. This can be obtained using the ListNavigationProperties procedure. |
| Name | Type | Description |
| Uri | String | The URL linking to the associated entities, providing a way to access the related records through the specified navigation property. |
Deletes a previously established link between two entities, managed via their navigation properties.
| Name | Type | Required | Description |
| FromId | String | True | The unique identifier (Id) of the source entity for which you want to remove an association. |
| FromTable | String | True | The name of the table containing the source entity. For example, if the FromId belongs to a record in the Customers table, set this parameter to 'Customers'. |
| ToNavigationProperty | String | True | The name of the navigation property representing the relationship to be removed. This property can be retrieved using the ListNavigationProperties procedure. |
| ToId | String | True | The unique identifier (Id) of the target entity in the associated table defined by the navigation property. |
| Name | Type | Description |
| Success | Boolean | A boolean value indicating whether the removal operation was successful (true) or not (false). |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for Microsoft Dataverse:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries, including batch operations::
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | The database name. |
| SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
| Name | Type | Description |
| CatalogName | String | The database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view. |
| TableType | String | The table type (table or view). |
| Description | String | A description of the table or view. |
| IsUpdateable | Boolean | Whether the table can be updated. |
Describes the columns of the available tables and views.
The following query returns the columns and data types for the Accounts table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Accounts'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view containing the column. |
| ColumnName | String | The column name. |
| DataTypeName | String | The data type name. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| Length | Int32 | The storage size of the column. |
| DisplaySize | Int32 | The designated column's normal maximum width in characters. |
| NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
| NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
| IsNullable | Boolean | Whether the column can contain null. |
| Description | String | A brief description of the column. |
| Ordinal | Int32 | The sequence number of the column. |
| IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
| IsGeneratedColumn | String | Whether the column is generated. |
| IsHidden | Boolean | Whether the column is hidden. |
| IsArray | Boolean | Whether the column is an array. |
| IsReadOnly | Boolean | Whether the column is read-only. |
| IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
| Name | Type | Description |
| CatalogName | String | The database containing the stored procedure. |
| SchemaName | String | The schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure. |
| Description | String | A description of the stored procedure. |
| ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the GetOAuthAccessToken stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='GetOAuthAccessToken' AND Direction=1 OR Direction=2
| Name | Type | Description |
| CatalogName | String | The name of the database containing the stored procedure. |
| SchemaName | String | The name of the schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure containing the parameter. |
| ColumnName | String | The name of the stored procedure parameter. |
| Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
| DataTypeName | String | The name of the data type. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
| NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
| NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
| IsNullable | Boolean | Whether the parameter can contain null. |
| IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
| IsArray | Boolean | Whether the parameter is an array. |
| Description | String | The description of the parameter. |
| Ordinal | Int32 | The index of the parameter. |
Describes the primary and foreign keys.
The following query retrieves the primary key for the Accounts table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Accounts'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
| IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
| ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| KeySeq | String | The sequence number of the primary key. |
| KeyName | String | The name of the primary key. |
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the index. |
| SchemaName | String | The name of the schema containing the index. |
| TableName | String | The name of the table containing the index. |
| IndexName | String | The index name. |
| ColumnName | String | The name of the column associated with the index. |
| IsUnique | Boolean | True if the index is unique. False otherwise. |
| IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
| Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
| SortOrder | String | The sort order: A for ascending or D for descending. |
| OrdinalPosition | Int16 | The sequence number of the column in the index. |
Returns information on the available connection properties and those set in the connection string.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
| Name | Type | Description |
| Name | String | The name of the connection property. |
| ShortDescription | String | A brief description. |
| Type | String | The data type of the connection property. |
| Default | String | The default value if one is not explicitly set. |
| Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
| Value | String | The value you set or a preconfigured default. |
| Required | Boolean | Whether the property is required to connect. |
| Category | String | The category of the connection property. |
| IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
| Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
| PropertyName | String | A camel-cased truncated form of the connection property name. |
| Ordinal | Int32 | The index of the parameter. |
| CatOrdinal | Int32 | The index of the parameter category. |
| Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
| Visible | Boolean | Informs whether the property is visible in the connection UI. |
| ETC | String | Various miscellaneous information about the property. |
Describes the SELECT query processing that the Cloud can offload to the data source.
See SQL Compliance for SQL syntax details.
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
| Name | Description | Possible Values |
| AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
| COUNT | Whether COUNT function is supported. | YES, NO |
| IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
| IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
| SUPPORTED_OPERATORS | A list of supported SQL operators. | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
| GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
| OJ_CAPABILITIES | The supported varieties of outer joins supported. | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
| OUTER_JOINS | Whether outer joins are supported. | YES, NO |
| SUBQUERIES | Whether subqueries are supported, and, if so, the degree of support. | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
| STRING_FUNCTIONS | Supported string functions. | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
| NUMERIC_FUNCTIONS | Supported numeric functions. | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
| TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
| REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
| REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
| IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
| SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES, NO |
| DIALECT | Indicates the SQL dialect to use. | |
| KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
| SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES, NO |
| SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES, NO |
| DATASYNCVERSION | The CData Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | The CData Data Sync category of this driver. | Source, Destination, Cloud Destination |
| SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE, FALSE |
| SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES, NO |
| SQL_CAP | All supported SQL capabilities for this driver. | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
| PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
| ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES, NO |
| PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
| MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE, FALSE |
| REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
| REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
| REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
| REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
| REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
| IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
| CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE, FALSE |
| CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
| Name | Type | Description |
| NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
| VALUE | String | Detail on the supported SQL or SQL syntax. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
| Name | Type | Description |
| Id | String | The database-generated Id returned from a data modification operation. |
| Batch | String | An identifier for the batch. 1 for a single operation. |
| Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
| Message | String | SUCCESS or an error message if the update in the batch failed. |
Describes the available system information.
The following query retrieves all columns:
SELECT * FROM sys_information
| Name | Type | Description |
| Product | String | The name of the product. |
| Version | String | The version number of the product. |
| Datasource | String | The name of the datasource the product connects to. |
| NodeId | String | The unique identifier of the machine where the product is installed. |
| HelpURL | String | The URL to the product's help documentation. |
| License | String | The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.) |
| Location | String | The file path location where the product's library is stored. |
| Environment | String | The version of the environment or rumtine the product is currently running under. |
| DataSyncVersion | String | The tier of CData Sync required to use this connector. |
| DataSyncCategory | String | The category of CData Sync functionality (e.g., Source, Destination). |
The Cloud maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.
| Microsoft Dataverse (OData V4) | CData Schema |
| Edm.Binary | binary |
| Edm.Boolean | bool |
| Edm.Date | datetime |
| Edm.DateTimeOffset | datetime |
| Edm.Decimal | decimal |
| Edm.Double | double |
| Edm.Guid | guid |
| Edm.Int32 | int |
| Edm.String | string |
| Edm.TimeOfDay | time |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| AuthScheme | Specifies the type of authentication to use when connecting to Microsoft Dataverse. If this property is left blank, the default authentication is used. |
| OrganizationURL | The URL to your Dynamics 365 organization, sometimes referred to as the resource. To find the correct URL for your Microsoft Dataverse instance, search the Web Services page. |
| ApiVersion | Identifies the API version being used. Keep this setting up to date to ensure that the full range of available API features are accessed during authentication. |
| Property | Description |
| AzureTenant | Identifies the Microsoft Dataverse tenant being used to access data, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional). |
| AzureEnvironment | Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added. |
| Property | Description |
| OAuthClientId | Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. |
| OAuthClientSecret | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server. |
| OAuthGrantType | Specifies the grant type for the chosen OAuth flow. This value should be the same as the grant_type that was set during OAuth custom application creation. |
| Property | Description |
| OAuthJWTCert | The JWT Certificate store. |
| OAuthJWTCertType | The type of key store containing the JWT Certificate. |
| OAuthJWTCertPassword | The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank. |
| OAuthJWTCertSubject | The subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Schema | Specifies the schema to use when listing metadata from Microsoft Dataverse. |
| Property | Description |
| ContinueOnError | Specifies whether batch requests should continue after encountering an error. (OData 4.0 and higher only.). |
| IncludeFormattedValues | Specifies whether columns that hold formatted values should be exposed. |
| IncludeLookUpLogicalName | Indicates if the referenced entity name for a LookUp field should be exposed. |
| IncludeNavigationKeys | Specifies whether the column listing should include the primary keys of navigation properties. (JSON responses only). |
| IncludeNavigationProperties | Specifies whether the column listing should include navigation properties. |
| MaxRows | Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
| UseDisplayNames | If set to true, the provider will use display names for some operations. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| AuthScheme | Specifies the type of authentication to use when connecting to Microsoft Dataverse. If this property is left blank, the default authentication is used. |
| OrganizationURL | The URL to your Dynamics 365 organization, sometimes referred to as the resource. To find the correct URL for your Microsoft Dataverse instance, search the Web Services page. |
| ApiVersion | Identifies the API version being used. Keep this setting up to date to ensure that the full range of available API features are accessed during authentication. |
Specifies the type of authentication to use when connecting to Microsoft Dataverse. If this property is left blank, the default authentication is used.
string
"AzureAD"
For information about creating a custom application to authenticate with Azure AD, see Creating an Azure AD Application.
For information about creating a custom application to authenticate with Azure AD Service Principal, see Creating an Azure AD App with Service Principal.
The URL to your Dynamics 365 organization, sometimes referred to as the resource. To find the correct URL for your Microsoft Dataverse instance, search the Web Services page.
string
""
Resource URL format is usually similar to https://abc123.cloudax.dynamics.com/, except when the Edition is HumanResources. HumanResources URLs typically look like: https://{cluster}.hr.talent.dynamics.com/namespaces/{namespace_guid}/.
Identifies the API version being used. Keep this setting up to date to ensure that the full range of available API features are accessed during authentication.
string
"9.2"
The service API provides a means to access new features in the data model. When you change the ApiVersion, it changes what service document is used to define the tables and columns exposed by the driver.
This section provides a complete list of the Azure Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| AzureTenant | Identifies the Microsoft Dataverse tenant being used to access data, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional). |
| AzureEnvironment | Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added. |
Identifies the Microsoft Dataverse tenant being used to access data, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional).
string
""
A tenant is a digital representation of your organization, primarily associated with a domain (for example, microsoft.com). The tenant is managed through a Tenant ID (also known as the directory ID), which is specified whenever you assign users permissions to access or manage Azure resources.
To locate the directory ID in the Azure Portal, navigate to Azure Active Directory > Properties.
Specifying AzureTenant is required when AuthScheme = either AzureServicePrincipal or AzureServicePrincipalCert, or if AuthScheme = AzureAD and the user belongs to more than one tenant.
Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.
string
"GLOBAL"
Required if your Azure account is part of a different network than the Global network, such as China, USGOVT, or USGOVTDOD.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. |
| OAuthClientSecret | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server. |
| OAuthGrantType | Specifies the grant type for the chosen OAuth flow. This value should be the same as the grant_type that was set during OAuth custom application creation. |
Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
string
""
OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.
Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
string
""
OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.
Specifies the grant type for the chosen OAuth flow. This value should be the same as the grant_type that was set during OAuth custom application creation.
string
"CODE"
In most cases, the default grant type should not be modified. For information about the most common OAuth grant types and the trade-offs between them, see https://oauth.net/2/grant-types/.
This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthJWTCert | The JWT Certificate store. |
| OAuthJWTCertType | The type of key store containing the JWT Certificate. |
| OAuthJWTCertPassword | The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank. |
| OAuthJWTCertSubject | The subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate. |
The JWT Certificate store.
string
""
The name of the certificate store for the client certificate.
The OAuthJWTCertType field specifies the type of the certificate store specified by OAuthJWTCert. If the store is password protected, specify the password in OAuthJWTCertPassword.
OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, a search for a certificate is initiated. Please refer to the OAuthJWTCertSubject field for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
| SPC | Software publisher certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
The type of key store containing the JWT Certificate.
string
"PEMKEY_BLOB"
This property can take one of the following values:
| USER | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java. |
| MACHINE | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
| PFXFILE | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
| PFXBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. |
| JKSFILE | The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java. |
| JKSBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java. |
| PEMKEY_FILE | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| PEMKEY_BLOB | The certificate store is a string (base64-encoded) that contains a private key and an optional certificate. |
| PUBLIC_KEY_FILE | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| PUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| SSHPUBLIC_KEY_FILE | The certificate store is the name of a file that contains an SSH-style public key. |
| SSHPUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains an SSH-style public key. |
| P7BFILE | The certificate store is the name of a PKCS7 file containing certificates. |
| PPKFILE | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| XMLFILE | The certificate store is the name of a file that contains a certificate in XML format. |
| XMLBLOB | The certificate store is a string that contains a certificate in XML format. |
| BCFKSFILE | The certificate store is the name of a file that contains an Bouncy Castle keystore. |
| BCFKSBLOB | The certificate store is a string (base-64-encoded) that contains a Bouncy Castle keystore. |
The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.
string
""
This property specifies the password needed to open the certificate store, but only if the store type requires one. To determine if a password is necessary, refer to the documentation or configuration for your specific certificate store.
The subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.
string
"*"
The value of this property is used to locate a matching certificate in the store. The search process works as follows:
You can set the value to '*' to automatically select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For example: CN=www.server.com, OU=test, C=US, [email protected]. Common fields include:
| Field | Meaning |
| CN | Common Name. This is commonly a host name like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, enclose it in quotes. For example: "O=ACME, Inc.".
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
string
""
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
string
"1"
This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.
The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.
When combined with the LogModules property, Verbosity can refine logging to specific categories of information.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Schema | Specifies the schema to use when listing metadata from Microsoft Dataverse. |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
string
""
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
Specifies the schema to use when listing metadata from Microsoft Dataverse.
string
"System"
You can set this connection property to the following values:
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| ContinueOnError | Specifies whether batch requests should continue after encountering an error. (OData 4.0 and higher only.). |
| IncludeFormattedValues | Specifies whether columns that hold formatted values should be exposed. |
| IncludeLookUpLogicalName | Indicates if the referenced entity name for a LookUp field should be exposed. |
| IncludeNavigationKeys | Specifies whether the column listing should include the primary keys of navigation properties. (JSON responses only). |
| IncludeNavigationProperties | Specifies whether the column listing should include navigation properties. |
| MaxRows | Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
| UseDisplayNames | If set to true, the provider will use display names for some operations. |
Specifies whether batch requests should continue after encountering an error. (OData 4.0 and higher only.).
bool
false
If ContinueOnError is set to true, batch operations that encounter an error complete, creating a results table that includes the error response. If ContinueOnError is set to false, batch operations that encounter an error abort and display an error message.
Specifies whether columns that hold formatted values should be exposed.
bool
false
If set to true, an extra column named columnname_display is added beside each column. If the column contains a formatted value, the new column exposes that formatted values. If the field does not have a formatted value, columname_display is null.
Indicates if the referenced entity name for a LookUp field should be exposed.
bool
false
For each key column, an extra one is added to expose the LookUp logical name value. New columns will have "_lookuplogicalname" postfix.
Specifies the maximum rows returned for queries without aggregation or GROUP BY.
int
-1
This property sets an upper limit on the number of rows the Cloud returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.
When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
string
""
This property allows you to define which pseudocolumns the Cloud exposes as table columns.
To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"
To include all pseudocolumns for all tables use: "*=*"
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
int
60
This property controls the maximum time, in seconds, that the Cloud waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Cloud cancels the operation and throws an exception.
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
If set to true, the provider will use display names for some operations.
bool
false
If set to true, the Cloud will use display names for some operations. This property is used only for Entities schema.