このページでは、CData Cloud でのMicrosoft Dynamics 365 への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

Microsoft Dynamics 365 への接続

接続の確立 は、CData Cloud にデータベースを作成するためのMicrosoft Dynamics 365 への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してMicrosoft Dynamics 365 からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

Database タブで対応するアイコンを選択して、Microsoft Dynamics 365 に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

Microsoft Dynamics 365 への接続

Microsoft Dynamics 365 ドライバーは、以下のMicrosoft Dynamics 365 エディションへの接続をサポートしています。

• CustomerService
• FieldService
• FinOpsOnline (Default)
• FinOpsOnPremise
• HumanResources
• Marketing
• ProjectOperations
• Sales

Notes：

• Supply Chain Management はFinance and Operations と同一です。これらのいずれかに接続するには、Edition をFinOpsOnline またはFinOpsOnPremise のいずれかに設定します。
• Microsoft Dynamics 365 Business Central については、個別のMicrosoft Dynamics 365 Business Central ドライバーを使用してください。

接続するには、次のパラメータを設定します。

• OrganizationUrl：お使いのMicrosoft Dynamics 365 組織のURL。例えば、https://orgcb42e1d0.crm.dynamics.com。
• Edition：上記のエディション一覧に示すとおり。

Microsoft Dynamics 365 への認証

Microsoft Dynamics 365 は、Azure AD、Azure サービスプリンシパル、Azure マネージドID（MSI）を経由する認証をサポートします。これらはすべてOAuth 規格に基づきます。

Azure AD

Azure AD 経由で認証するには、Azure AD アプリケーションの作成 で説明するように、カスタムAzureAD アプリケーションを作成する必要があります。クライアントシークレットまたはJWT 証明書のいずれかで認証できます。

接続するには、次のプロパティを設定します。

• AuthScheme：AzureAD。
• InitiateOAuth：GETANDREFRESH。この設定により、InitiateOAuth を使用することでAzureAD 交換の繰り返しや手動でのOAuthAccessToken 設定を避けられます。
• AzureTenant：接続するAzure テナント。
• OAuthClientId：カスタムアプリケーションの作成時に割り当てられたクライアントId。
• OAuthClientSecret（クライアントシークレットのみ）：カスタムアプリケーションの作成時に割り当てられたクライアントシークレット。
• OAuthJWTCert（証明書のみ）：JWT 証明書のストア。
• OAuthJWTCertType（証明書のみ）：OAuthJWTCert で指定された証明書ストアの種類。

管理者の同意

管理者の同意とは、Azure AD テナントの管理者が、使用ケースに応じてカスタムアプリケーションに付与する権限を指します。 （CData Cloud 内の埋め込みアプリケーションには管理者の同意を必要とする権限は含まれていないため、管理者の同意はカスタムアプリケーションにのみ適用されます。）

組織がAzure テナントの新しいOAuth アプリケーションを認可するために管理者の同意を必要とする場合、組織の誰かが初めてOAuth アプリケーションをインストールして使用するときは、組織の管理者が明示的にそのアプリケーションへのアクセスを許可する必要があることを意味します。

（組織はこの要件を無効にすることができます。）

管理者の同意の付与

Azure ポータルで新しいOAuth アプリケーションを作成する場合（Azure AD アプリケーションの作成 参照）には、そのアプリケーションに必要なアクセス許可を指定する必要があります。 新しいカスタムアプリケーションに管理者の同意が必要であることが分かっている場合は、管理者の同意が必要と表示されている権限を指定することから始めることができます。 （例えば、すべてのグループのアクセス許可には管理者の同意が必要です。）

管理者の同意を付与するには2つの方法があります。

• 管理者の同意を付与する最も簡単な方法は、管理者がportal.azure.com にログインして、アプリの登録で作成したアプリケーションに移動するだけです。 API のアクセス許可で、同意の付与をクリックします。 アプリケーションが作成されたテナントで必要なアクセス権限を付与します。
• 組織に複数のテナントがある場合、またはアプリケーションが組織外の他のテナントにアクセス許可を与える必要がある場合、GetAdminConsentURL を使用してAdmin Authorization URL を生成できます。 GetOAuthAuthorizationUrl とは異なり、このエンドポイントから返される重要な情報はありません。テナントがアクセスを許可すると、権限が付与されたことを確認するBoolean を返します。

管理者が同意を付与すると、通常通り認証が行われます。

クライアントクレデンシャル認証フロー

クライアントクレデンシャルは、直接ユーザー認証が行われないOAuth のフローを指します。代わりに、クレデンシャルはアプリケーション自体のためだけに作成されます。アプリケーションで実行されるすべてのタスクは、デフォルトユーザーコンテキストなしで実行されます。そのため、認証フローが標準とは少し違ったものになります。

クライアントOAuth フローに関連するすべてのアクセス許可には、管理者の同意が必要です。 これは、CData Cloud が埋め込まれたアプリケーションをクライアントOAuth フローでは使用できないことを意味します。クライアントクレデンシャルを使用するには、Azure AD アプリケーションの作成 で説明するように独自のOAuth アプリケーションを作成する必要があります。

これを行うには：

1. portal.azure.com にログインします。
2. アプリの登録 -> API のアクセス許可に移動します。
3. Microsoft Graph アクセス許可を選択します。アクセス許可には2つの異なるアクセス許可セットがあります。委任されたアクセス許可とアプリケーションの許可です。 クライアントの資格情報認証時に使用されるアクセス許可は、［アプリケーションの許可］の下にあります。 インテグレーションに必要なアクセス許可を選択します。

接続するには、次のプロパティを設定します。

• InitiateOAuth：GETANDREFRESH。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。
• AzureTenant：接続するテナント。
• OAuthClientId：カスタムアプリケーションの作成時に割り当てられたクライアントId。
• OAuthClientSecret（クライアントシークレットのみ）：カスタムアプリケーションの作成時に割り当てられたクライアントシークレット。
• OAuthJWTCert（証明書のみ）：JWT 証明書のストア。
• OAuthJWTCertType（証明書のみ）：OAuthJWTCert で指定された証明書ストアの種類。

Azure サービスプリンシパル

Azure AD のアクションは、ユーザーアカウントまたはサービスプリンシパルのいずれかで実行できます。サービスプリンシパルは、割り当てられたロールと権限に基づいてタスクを実行する、上位権限を持つ非インタラクティブアカウントです。 Azure サービスプリンシパルとしての認証は、OAuth クライアントクレデンシャルフローを介して処理されるため、ユーザーは関与しません。 Azure サービスプリンシパルとして認証するには、カスタムAzureAD サービスプリンシパルアプリの作成 で説明するように、カスタムAzureAD サービスプリンシパルアプリケーションを作成する必要があります。

接続の準備ができたら、次のプロパティを設定します。

• AuthScheme： クライアントシークレットを使用する場合はAzureServicePrincipal、JWT 証明書を使用する場合はAzureServicePrincipalCert。
• InitiateOAuth：GETANDREFRESH。InitiateOAuth を使えば、繰り返しOAuth の交換を行ったり、手動でOAuthAccessToken を設定する必要はなくなります。
• AzureTenant：接続するテナント。
• OAuthClientId（クライアントシークレットのみ）：アプリケーション設定のクライアントId。
• OAuthClientSecret（クライアントシークレットのみ）：カスタムアプリケーションの作成時に割り当てられたクライアントシークレット。
• OAuthJWTCert（証明書のみ）：JWT 証明書のストア。
• OAuthJWTCertType（証明書のみ）：OAuthJWTCert で指定された証明書ストアの種類。

Managed Service Identity (MSI)

Azure VM 上でMicrosoft Dynamics 365 を実行しており、マネージドID（MSI）認証情報を自動的に取得して接続したい場合は、AuthScheme を AzureMSI に設定します。

User-Managed Identities

マネージドID のトークンを取得するには、OAuthClientId プロパティを使用してマネージドID のclient_id を指定します。

VM に複数のユーザーが割り当てられたマネージドID がある場合は、OAuthClientId も指定する必要があります。

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

• ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
• ProxyPort：プロキシサーバーが起動しているTCP ポート。
• ProxyAuthScheme：プロキシサーバーに対して認証する際にCloud が使用する認証方法。
• ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
• ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

CData Cloud は、Microsoft Dynamics 365 データをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。テーブル定義は、接続先のMicrosoft Dynamics 365 OData サービスから動的に取得されます。カラムの新規追加や削除、データ型の変更など、メタデータに変更があった場合は再接続時に自動的に読み込まれます。

ビュー

ビュー セクションには読み取り専用SQL テーブルの一覧が記載されています。これらには、Microsoft Dynamics 365 アカウントでのアクセスを想定したサンプルが含まれています。

以下のビューはCloud に同梱されています。

ビュー	説明
MultiSelectPickListAttributeMetaData	MultiSelect OptionSet タイプの属性に対するメタデータを格納します。このメタデータは、Edition が CustomerService、FieldService、Marketing、ProjectOperations、またはSales に設定されている場合にのみ利用可能です。
MultiSelectPickListOptions	MultiSelect Picklist メタデータ属性の値（オプション）を含みます。Edition が CustomerService、FieldService、Marketing、ProjectOperations、またはSales に設定されている場合にのみ利用可能です。
PickListAttributeMetaData	Picklist タイプの属性に対するメタデータを保持し、そのオプションと構成の詳細を示します。Edition が CustomerService、FieldService、Marketing、ProjectOperations、またはSales に設定されている場合にのみ利用可能です。
PickListOptions	Picklist メタデータ属性のオプション値を格納し、列挙されたセレクションの詳細を提供します。Edition が CustomerService、FieldService、Marketing、ProjectOperations、またはSales に設定されている場合にのみ利用可能です。

ストアドプロシージャ

ストアドプロシージャ は、SQLクエリを介して呼び出されるアクションです。標準的なCRUD 操作だけでなく、関連付けの管理やOAuth アクセストークンの取得など、より高度なタスクも実行します。

Cloud は、Microsoft Dynamics 365 OData サービスを使用して接続時にすべてのMicrosoft Dynamics 365 テーブルを動的に取得します。

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - Microsoft Dynamics 365 ビュー

Name	Description
MultiSelectPickListAttributeMetaData	Stores metadata for attributes with a MultiSelect OptionSet type. This metadata is only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales.
MultiSelectPickListOptions	Contains the values (options) for MultiSelect Picklist metadata attributes. Only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales.
PickListAttributeMetaData	Holds metadata for attributes of the Picklist type, detailing their options and configuration. Only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales.
PickListOptions	Stores option values for Picklist metadata attributes, providing details for enumerated selections. Only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales.

Stores metadata for attributes with a MultiSelect OptionSet type. This metadata is only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales.

Select

The Cloud will use the Microsoft Dynamics 365 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.

• TableName supports '=','IN' operators.

For example, the following queries are processed server side:

SELECT * FROM MultiSelectPickListAttributeMetaData WHERE TableName = 'teams'

SELECT * FROM MultiSelectPickListAttributeMetaData WHERE TableName IN ('accounts', 'teams')

Columns

Name	Type	Description
ColumnName [KEY]	String	The name of the column representing the attribute within the table.
MetadataId	String	The unique identifier for the metadata of the attribute.
OptionSet_Description_LocalizedLabels	String	Localized labels providing descriptions for the option set in various languages.
OptionSet_Description_UserLocalizedLabel_HasChanged	String	Indicates if the user-defined localized label for the description has been modified.
OptionSet_Description_UserLocalizedLabel_IsManaged	Boolean	Specifies whether the user-defined localized label for the description is managed.
OptionSet_Description_UserLocalizedLabel_Label	String	The actual text of the user-defined localized label for the description.
OptionSet_Description_UserLocalizedLabel_LanguageCode	Integer	The language code associated with the user-defined localized label for the description.
OptionSet_Description_UserLocalizedLabel_MetadataId	String	The unique identifier for the metadata of the user-defined localized label for the description.
OptionSet_DisplayName_LocalizedLabels	String	Localized labels providing display names for the option set in various languages.
OptionSet_DisplayName_UserLocalizedLabel_HasChanged	String	Indicates if the user-defined localized label for the display name has been modified.
OptionSet_DisplayName_UserLocalizedLabel_IsManaged	Boolean	Specifies whether the user-defined localized label for the display name is managed.
OptionSet_DisplayName_UserLocalizedLabel_Label	String	The actual text of the user-defined localized label for the display name.
OptionSet_DisplayName_UserLocalizedLabel_LanguageCode	Integer	The language code associated with the user-defined localized label for the display name.
OptionSet_DisplayName_UserLocalizedLabel_MetadataId	String	The unique identifier for the metadata of the user-defined localized label for the display name.
OptionSet_ExternalTypeName	String	The external type name associated with the option set, if applicable.
OptionSet_HasChanged	String	Indicates whether the option set has been modified since its creation.
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.
OptionSet_IsCustomizable_ManagedPropertyLogicalName	String	The logical name of the managed property that defines whether the option set is customizable.
OptionSet_IsCustomizable_Value	Boolean	Specifies if the option set is marked as customizable.
OptionSet_IsCustomOptionSet	Boolean	Specifies if the option set is custom or predefined.
OptionSet_IsGlobal	Boolean	Indicates whether the option set is global (shared across entities) or local to a specific entity.
OptionSet_IsManaged	Boolean	Specifies if the option set is part of a managed solution.
OptionSet_MetadataId	String	The unique identifier for the metadata of the option set.
OptionSet_Name	String	The name of the option set.
OptionSet_OptionSetType	String	The type of the option set, defining its structure and usage.
OptionSet_ParentOptionSetName	String	The name of the parent option set if the current option set is part of a hierarchical structure.
TableName	String	The name of the table containing the attribute represented by the option set.

Contains the values (options) for MultiSelect Picklist metadata attributes. Only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales.

Select

The Cloud will use the Microsoft Dynamics 365 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.

• TableName supports '=','IN' operators.

For example, the following queries are processed server side:

SELECT * FROM MultiSelectPickListOptions WHERE TableName = 'teams'

SELECT * FROM MultiSelectPickListOptions WHERE TableName IN ('accounts', 'teams')

Columns

Name	Type	Description
ColumnName	String	The name of the column representing the multi-select picklist attribute.
Color	String	The color associated with the picklist option, typically used for UI representation.
ExternalValue	String	The external value associated with the picklist option, used for integration or mapping purposes.
HasChanged	String	Indicates whether the picklist option has been modified since its creation.
IsManaged	Boolean	Specifies whether the picklist option is part of a managed solution.
Label_LocalizedLabels	String	Localized labels providing display names for the picklist option in various languages.
Label_UserLocalizedLabel_HasChanged	String	Indicates if the user-defined localized label for the picklist option's label has been modified.
Label_UserLocalizedLabel_IsManaged	Boolean	Specifies whether the user-defined localized label for the picklist option's label is managed.
Label_UserLocalizedLabel_Label	String	The actual text of the user-defined localized label for the picklist option's label.
Label_UserLocalizedLabel_LanguageCode	Integer	The language code associated with the user-defined localized label for the picklist option's label.
Label_UserLocalizedLabel_MetadataId	String	The unique identifier for the metadata of the user-defined localized label for the picklist option's label.
Description_LocalizedLabels	String	Localized labels providing descriptions for the picklist option in various languages.
Description_UserLocalizedLabel_HasChanged	String	Indicates if the user-defined localized label for the picklist option's description has been modified.
Description_UserLocalizedLabel_IsManaged	Boolean	Specifies whether the user-defined localized label for the picklist option's description is managed.
Description_UserLocalizedLabel_Label	String	The actual text of the user-defined localized label for the picklist option's description.
Description_UserLocalizedLabel_LanguageCode	Integer	The language code associated with the user-defined localized label for the picklist option's description.
Description_UserLocalizedLabel_MetadataId	String	The unique identifier for the metadata of the user-defined localized label for the picklist option's description.
MetadataId	String	The unique identifier for the metadata of the picklist option.
ParentValues	String	The parent values associated with the picklist option, used when the option is part of a hierarchical structure.
Value	Integer	The numeric value assigned to the picklist option.
TableName	String	The name of the table containing the multi-select picklist attribute.

Holds metadata for attributes of the Picklist type, detailing their options and configuration. Only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales.

Select

The Cloud will use the Microsoft Dynamics 365 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.

• TableName supports '=','IN' operators.

For example, the following queries are processed server side:

SELECT * FROM PickListAttributeMetaData WHERE TableName = 'teams'

SELECT * FROM PickListAttributeMetaData WHERE TableName IN ('accounts', 'teams')

Columns

Name	Type	Description
ColumnName [KEY]	String	The name of the column representing the picklist attribute within the table.
MetadataId	String	The unique identifier for the metadata of the picklist attribute.
OptionSet_Description_LocalizedLabels	String	Localized labels providing descriptions for the option set in various languages.
OptionSet_Description_UserLocalizedLabel_HasChanged	String	Indicates if the user-defined localized label for the description has been modified.
OptionSet_Description_UserLocalizedLabel_IsManaged	Boolean	Specifies whether the user-defined localized label for the description is managed.
OptionSet_Description_UserLocalizedLabel_Label	String	The actual text of the user-defined localized label for the description.
OptionSet_Description_UserLocalizedLabel_LanguageCode	Integer	The language code associated with the user-defined localized label for the description.
OptionSet_Description_UserLocalizedLabel_MetadataId	String	The unique identifier for the metadata of the user-defined localized label for the description.
OptionSet_DisplayName_LocalizedLabels	String	Localized labels providing display names for the option set in various languages.
OptionSet_DisplayName_UserLocalizedLabel_HasChanged	String	Indicates if the user-defined localized label for the display name has been modified.
OptionSet_DisplayName_UserLocalizedLabel_IsManaged	Boolean	Specifies whether the user-defined localized label for the display name is managed.
OptionSet_DisplayName_UserLocalizedLabel_Label	String	The actual text of the user-defined localized label for the display name.
OptionSet_DisplayName_UserLocalizedLabel_LanguageCode	Integer	The language code associated with the user-defined localized label for the display name.
OptionSet_DisplayName_UserLocalizedLabel_MetadataId	String	The unique identifier for the metadata of the user-defined localized label for the display name.
OptionSet_ExternalTypeName	String	The external type name associated with the option set, if applicable.
OptionSet_HasChanged	String	Indicates whether the option set has been modified since its creation.
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.
OptionSet_IsCustomizable_ManagedPropertyLogicalName	String	The logical name of the managed property that defines whether the option set is customizable.
OptionSet_IsCustomizable_Value	Boolean	Specifies if the option set is marked as customizable.
OptionSet_IsCustomOptionSet	Boolean	Specifies if the option set is custom or predefined.
OptionSet_IsGlobal	Boolean	Indicates whether the option set is global (shared across entities) or local to a specific entity.
OptionSet_IsManaged	Boolean	Specifies if the option set is part of a managed solution.
OptionSet_MetadataId	String	The unique identifier for the metadata of the option set.
OptionSet_Name	String	The name of the option set.
OptionSet_OptionSetType	String	The type of the option set, defining its structure and usage.
OptionSet_ParentOptionSetName	String	The name of the parent option set if the current option set is part of a hierarchical structure.
TableName	String	The name of the table containing the picklist attribute.

Stores option values for Picklist metadata attributes, providing details for enumerated selections. Only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales.

Select

The Cloud will use the Microsoft Dynamics 365 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.

• TableName supports '=','IN' operators.

For example, the following queries are processed server side:

SELECT * FROM PickListOptions WHERE TableName = 'teams'

SELECT * FROM PickListOptions WHERE TableName IN ('accounts', 'teams')

Columns

Name	Type	Description
ColumnName	String	The name of the column representing the picklist attribute.
Color	String	The color associated with the picklist option, typically used for visual representation in the UI.
ExternalValue	String	An external value associated with the picklist option, useful for integration or mapping purposes.
HasChanged	String	Indicates whether the picklist option has been modified since its creation.
IsManaged	Boolean	Specifies whether the picklist option is part of a managed solution.
Label_LocalizedLabels	String	Localized labels providing display names for the picklist option in various languages.
Label_UserLocalizedLabel_HasChanged	String	Indicates whether the user-defined localized label for the picklist option has been modified.
Label_UserLocalizedLabel_IsManaged	Boolean	Specifies whether the user-defined localized label for the picklist option is managed.
Label_UserLocalizedLabel_Label	String	The actual text of the user-defined localized label for the picklist option.
Label_UserLocalizedLabel_LanguageCode	Integer	The language code associated with the user-defined localized label for the picklist option.
Label_UserLocalizedLabel_MetadataId	String	The unique identifier for the metadata of the user-defined localized label for the picklist option.
Description_LocalizedLabels	String	Localized labels providing descriptions for the picklist option in various languages.
Description_UserLocalizedLabel	String	The user-defined localized label for the description of the picklist option.
MetadataId	String	The unique identifier for the metadata of the picklist option.
ParentValues	String	The parent values associated with the picklist option, used when the option is part of a hierarchical structure.
Value	Integer	The numeric value assigned to the picklist option.
TableName	String	The name of the table containing the picklist attribute.

ストアドプロシージャはファンクションライクなインターフェースで、Microsoft Dynamics 365 の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにMicrosoft Dynamics 365 から関連するレスポンスデータを返します。

CData Cloud - Microsoft Dynamics 365 ストアドプロシージャ

Name	Description
CreateAssociation	Creates an association between two entities using the specified navigation property. This procedure is essential for linking related entities dynamically and requires the IncludeNavigationProperties connection property to be enabled.
EnableChangeTracking	Enables change tracking on an entity, allowing incremental updates and efficient data synchronization. Note: This feature is irreversible once activated.
GetAdminConsentURL	Retrieves the admin consent URL required for granting domain-wide access to the application by an administrator. Necessary when using custom OAuth credentials.
ListAssociations	Lists all associations for a specified table and its related navigation properties. Requires the IncludeNavigationProperties connection property to be enabled.
ListNavigationProperties	Displays the navigation properties for a specified table, showing their relationships with associated tables. Useful for defining entity associations and dependencies.
RemoveAssociation	Deletes an association between two entities based on a specified navigation property. This requires the IncludeNavigationProperties connection property to be enabled.

Creates an association between two entities using the specified navigation property. This procedure is essential for linking related entities dynamically and requires the IncludeNavigationProperties connection property to be enabled.

Input

Name	Type	Required	Description
FromId	String	False	The unique identifier of the entity for which you are creating an association. This is essential to link the source entity to the target.
UrlId	String	False	The full URL of the source resource for creating the association. This is required when the navigation property is abstract or when specifying a child type in cases where the navigation property entity type serves as a base type.
FromTable	String	True	The name of the table containing the source entity. For example, if the FromId corresponds to an entity in the Customers table, set this parameter to 'Customers'.
ToNavigationProperty	String	True	The name of the navigation property on which the association is being created. This value can be retrieved from the ListNavigationProperties function.
ToId	String	False	The unique identifier of the target navigation entity. This ID should come from the table associated with the specified navigation property.
ToUrlId	String	False	The full URL of the target resource to be associated. This is required when the navigation property is abstract or when specifying a child type in cases where the navigation property entity type serves as a base type.

Result Set Columns

Name	Type	Description
Success	Boolean	Indicates whether the operation was successful. Returns true if the association was created successfully; otherwise, returns false.

Enables change tracking on an entity, allowing incremental updates and efficient data synchronization. Note: This feature is irreversible once activated.

Input

Name	Type	Required	Description
TableName	String	True	The name of the table for which change tracking should be enabled. This must be a valid table within the database.

Result Set Columns

Name	Type	Description
Success	Bool	Indicates whether the operation to enable change tracking was successful. Returns true if successful; otherwise, false.
Message	String	Provides details about any errors encountered during the operation. If no errors occurred, this is empty.

Retrieves the admin consent URL required for granting domain-wide access to the application by an administrator. Necessary when using custom OAuth credentials.

Input

Name	Type	Required	Description
CallbackUrl	String	False	The URL to which the user is redirected after authorizing your application. This must match the Reply URL configured in the Azure Active Directory application settings.
State	String	False	A value used to maintain state between the request and the callback. This should match the value you sent when requesting the authorization code to ensure security.

Result Set Columns

Name	Type	Description
URL	String	The generated authorization URL that the user must visit in a web browser to grant consent and obtain the verifier token for your application.

Lists all associations for a specified table and its related navigation properties. Requires the IncludeNavigationProperties connection property to be enabled.

Input

Name	Type	Required	Description
FromId	String	False	The unique identifier of the entity for which you want to list associations. This helps specify the source entity.
UrlId	String	False	An alternative to using FromId, representing the full URL of the resource for which associations are being listed. This is required when the navigation property is abstract or when specifying child types of a base-type navigation property entity.
FromTable	String	True	The name of the table containing the source entity. For example, if the FromId corresponds to an entity in the 'Customers' table, set this parameter to 'Customers'.
NavigationProperty	String	True	The navigation property associated with the entity for which you want to list associations. This can be obtained using the ListNavigationProperties function.

Result Set Columns

Name	Type	Description
Uri	String	The URL of the associated resource, providing a direct link to the related entity.

Displays the navigation properties for a specified table, showing their relationships with associated tables. Useful for defining entity associations and dependencies.

Input

Name	Type	Required	Description
TableName	String	True	The name of the table for which you want to list navigation properties. This table must exist in the database.

Result Set Columns

Name	Type	Description
Name	String	The name of the navigation property associated with the specified table. Navigation properties define relationships to other entities.
AssociatedTable	String	The name of the table that is related to the specified table through the navigation property.

Deletes an association between two entities based on a specified navigation property. This requires the IncludeNavigationProperties connection property to be enabled.

Input

Name	Type	Required	Description
FromId	String	False	The unique identifier of the source entity for which you are removing an association. This helps specify the source entity involved in the relationship.
UrlId	String	False	An alternative to specifying the FromId. This is the full URL of the resource for which the association is being removed. It is required when the navigation property is abstract or when specifying child types for base-type navigation properties.
FromTable	String	True	The name of the table containing the source entity for which you are removing an association. For example, if the FromId corresponds to an entity in the 'Customers' table, set this parameter to 'Customers'.
ToNavigationProperty	String	True	The name of the navigation property for which the association is being removed. This value can be retrieved using the ListNavigationProperties function.
ToId	String	False	The unique identifier of the target entity in the association. This ID should come from the table related to the specified navigation property.
ToUrlId	String	False	An alternative to specifying the ToId. This is the full URL of the target resource in the association. It is required when the navigation property is abstract or when specifying child types for base-type navigation properties.

Result Set Columns

Name	Type	Description
Success	Boolean	Indicates whether the operation to remove the association was successful. Returns true if successful; otherwise, returns false.

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、Microsoft Dynamics 365 のデータベースメタデータを返します。

• sys_catalogs：利用可能なデータベースをリスト。
• sys_schemas：利用可能なスキーマをリスト。
• sys_tables：利用可能なテーブルおよびビューをリスト。
• sys_tablecolumns：利用可能なテーブルおよびビューのカラムについて説明。
• sys_procedures：利用可能なストアドプロシージャについて説明。
• sys_procedureparameters：ストアドプロシージャパラメータについて説明。
• sys_keycolumns：主キーおよび外部キーについて説明。
• sys_indexes：利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

• sys_connection_props：利用可能な接続プロパティについての情報を返す。
• sys_sqlinfo：Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリ（バッチ処理を含む）のクエリ統計を返します。

• sys_identity：バッチ処理または単一の更新に関する情報を返す。

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	データベース名。

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	データベース名。
SchemaName	String	スキーマ名。

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	テーブルまたはビューを含むデータベース。
SchemaName	String	テーブルまたはビューを含むスキーマ。
TableName	String	テーブル名またはビュー名。
TableType	String	テーブルの種類（テーブルまたはビュー）。
Description	String	テーブルまたはビューの説明。
IsUpdateable	Boolean	テーブルが更新可能かどうか。

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、GoalHeadings テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='GoalHeadings' 

Columns

Name	Type	Description
CatalogName	String	テーブルまたはビューを含むデータベースの名前。
SchemaName	String	テーブルまたはビューを含むスキーマ。
TableName	String	カラムを含むテーブルまたはビューの名前。
ColumnName	String	カラム名。
DataTypeName	String	データ型の名前。
DataType	Int32	データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length	Int32	カラムのストレージサイズ。
DisplaySize	Int32	指定されたカラムの通常の最大幅（文字数）。
NumericPrecision	Int32	数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ（文字数）。
NumericScale	Int32	カラムのスケール（小数点以下の桁数）。
IsNullable	Boolean	カラムがNull を含められるかどうか。
Description	String	カラムの簡単な説明。
Ordinal	Int32	カラムのシーケンスナンバー。
IsAutoIncrement	String	カラムに固定増分値が割り当てられるかどうか。
IsGeneratedColumn	String	生成されたカラムであるかどうか。
IsHidden	Boolean	カラムが非表示かどうか。
IsArray	Boolean	カラムが配列かどうか。
IsReadOnly	Boolean	カラムが読み取り専用かどうか。
IsKey	Boolean	sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures
          

Columns

Name	Type	Description
CatalogName	String	ストアドプロシージャを含むデータベース。
SchemaName	String	ストアドプロシージャを含むスキーマ。
ProcedureName	String	ストアドプロシージャの名前。
Description	String	ストアドプロシージャの説明。
ProcedureType	String	PROCEDURE やFUNCTION などのプロシージャのタイプ。

ストアドプロシージャパラメータについて説明します。

次のクエリは、GetOAuthAccessToken ストアドプロシージャのすべての入力パラメータについての情報を返します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName='GetOAuthAccessToken' AND Direction=1 OR Direction=2

Columns

Name	Type	Description
CatalogName	String	ストアドプロシージャを含むデータベースの名前。
SchemaName	String	ストアドプロシージャを含むスキーマの名前。
ProcedureName	String	パラメータを含むストアドプロシージャの名前。
ColumnName	String	ストアドプロシージャパラメータの名前。
Direction	Int32	パラメータのタイプに対応する整数値：input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataTypeName	String	データ型の名前。
DataType	Int32	データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length	Int32	文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericPrecision	Int32	数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ（文字数）。
NumericScale	Int32	数値データの小数点以下の桁数。
IsNullable	Boolean	パラメータがNull を含められるかどうか。
IsRequired	Boolean	プロシージャの実行にパラメータが必要かどうか。
IsArray	Boolean	パラメータが配列かどうか。
Description	String	パラメータの説明。
Ordinal	Int32	パラメータのインデックス。

主キーおよび外部キーについて説明します。

次のクエリは、GoalHeadings テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='GoalHeadings' 
          

Columns

Name	Type	Description
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前
IsKey	Boolean	カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。
IsForeignKey	Boolean	カラムがTableName フィールドで参照される外部キーかどうか。
PrimaryKeyName	String	主キーの名前。
ForeignKeyName	String	外部キーの名前。
ReferencedCatalogName	String	主キーを含むデータベース。
ReferencedSchemaName	String	主キーを含むスキーマ。
ReferencedTableName	String	主キーを含むテーブル。
ReferencedColumnName	String	主キーのカラム名。

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

名前	タイプ	説明
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前
PrimaryKeyName	String	主キーの名前。
ForeignKeyName	String	外部キーの名前。
ReferencedCatalogName	String	主キーを含むデータベース。
ReferencedSchemaName	String	主キーを含むスキーマ。
ReferencedTableName	String	主キーを含むテーブル。
ReferencedColumnName	String	主キーのカラム名。
ForeignKeyType	String	外部キーがインポート（他のテーブルを指す）キーかエクスポート（他のテーブルから参照される）キーかを指定します。

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys
          

Columns

Name	Type	Description
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前。
KeySeq	String	主キーのシーケンス番号。
KeyName	String	主キーの名前。

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name	Type	Description
CatalogName	String	インデックスを含むデータベースの名前。
SchemaName	String	インデックスを含むスキーマの名前。
TableName	String	インデックスを含むテーブルの名前。
IndexName	String	インデックス名。
ColumnName	String	インデックスに関連付けられたカラムの名前。
IsUnique	Boolean	インデックスが固有の場合はTrue。そうでない場合はFalse。
IsPrimary	Boolean	インデックスが主キーの場合はTrue。そうでない場合はFalse。
Type	Int16	インデックスタイプに対応する整数値：statistic (0)、clustered (1)、hashed (2)、またはother (3)。
SortOrder	String	並べ替え順序：A が昇順、D が降順。
OrdinalPosition	Int16	インデックスのカラムのシーケンスナンバー。

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	接続プロパティ名。
ShortDescription	String	簡単な説明。
Type	String	接続プロパティのデータ型。
Default	String	明示的に設定されていない場合のデフォルト値。
Values	String	可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。
Value	String	設定した値またはあらかじめ設定されたデフォルト。
Required	Boolean	プロパティが接続に必要かどうか。
Category	String	接続プロパティのカテゴリ。
IsSessionProperty	String	プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。
Sensitivity	String	プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。
PropertyName	String	キャメルケースの短縮形の接続プロパティ名。
Ordinal	Int32	パラメータのインデックス。
CatOrdinal	Int32	パラメータカテゴリのインデックス。
Hierarchy	String	このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。
Visible	Boolean	プロパティが接続UI に表示されるかどうかを通知します。
ETC	String	プロパティに関するその他のさまざまな情報。

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠 を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。

名前	説明	有効な値
AGGREGATE_FUNCTIONS	サポートされている集計関数。	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	COUNT 関数がサポートされているかどうか。	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	識別子をエスケープするための開始文字。	[
IDENTIFIER_QUOTE_CLOSE_CHAR	識別子をエスケープするための終了文字。	]
SUPPORTED_OPERATORS	サポートされているSQL 演算子。	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	GROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	サポートされている外部結合の種類。	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	外部結合がサポートされているかどうか。	YES, NO
SUBQUERIES	サブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
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	サポートされている数値関数。	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	サポートされている日付および時刻関数。	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	レプリケーション中にスキップされたテーブルを示します。
REPLICATION_TIMECHECK_COLUMNS	レプリケーション中に更新判断のカラムとして使用するかどうかを、（指定された順に）チェックするカラムのリストを含む文字列の配列。
IDENTIFIER_PATTERN	識別子としてどの文字列が有効かを示す文字列値。
SUPPORT_TRANSACTION	プロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。	YES, NO
DIALECT	使用するSQL ダイアレクトを示します。
KEY_PROPERTIES	Uniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMAS	プロバイダー用に複数のスキームが存在するかどうかを示します。	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	プロバイダー用に複数のカタログが存在するかどうかを示します。	YES, NO
DATASYNCVERSION	このドライバーにアクセスするために必要な、CData Sync のバージョン。	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	このドライバーのCData Sync カテゴリ。	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	API で提供されている以上の、追加SQL 機能がサポートされているかどうか。	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	バッチ操作がサポートされているかどうか。	YES, NO
SQL_CAP	このドライバーでサポートされているすべてのSQL 機能。	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	使用したいcacheOptions を指定する文字列値。
ENABLE_EF_ADVANCED_QUERY	ドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。	YES, NO
PSEUDO_COLUMNS	利用可能な疑似カラムを示す文字列の配列。
MERGE_ALWAYS	値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	レプリケート開始日時を返すSELECT クエリ。
REPLICATION_MIN_FUNCTION	サーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。
REPLICATION_START_DATE	レプリケート開始日を、プロバイダーが指定できるようになります。
REPLICATION_MAX_DATE_QUERY	レプリケート終了日時を返すSELECT クエリ。
REPLICATION_MAX_FUNCTION	サーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。
CHECKCACHE_USE_PARENTID	CheckCache 構文を親キーカラムに対して実行するかどうかを示します。	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	スキーマファイルの生成に使用できる、ストアドプロシージャを示します。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。

Columns

Name	Type	Description
NAME	String	SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE	String	サポートされるSQL またはSQL 構文の詳細。

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity
          

Columns

Name	Type	Description
Id	String	データ変更処理から返された、データベース生成Id。
Batch	String	バッチの識別子。1 は単一処理。
Operation	String	バッチ内の処理の結果：INSERTED、UPDATED、またはDELETED。
Message	String	SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns

Name	Type	Description
Product	String	製品名。
Version	String	製品のバージョン番号。
Datasource	String	製品が接続するデータソースの名前。
NodeId	String	製品がインストールされているマシンの固有識別子。
HelpURL	String	製品のヘルプドキュメントのURL。
License	String	製品のライセンス情報。（この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。）
Location	String	製品のライブラリが格納されているファイルパスの場所。
Environment	String	製品が現在稼働している環境またはランタイムのバージョン。
DataSyncVersion	String	本コネクタを使用するために必要なCData Sync のティア。
DataSyncCategory	String	CData Sync 機能のカテゴリ（例：Source、Destination）。

データ型のマッピング

Cloud は、データソースの型を、スキーマで使用可能な対応するデータ型にマッピングします。以下のテーブルはこれらのマッピングを説明します。

Microsoft Dynamics 365（OData V4）	CData スキーマ
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

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

Authentication

---

プロパティ	説明
AuthScheme	Microsoft Dynamics 365 に接続する際に使用する認証の種類を指定します。このプロパティが空白の場合は、デフォルトの認証が使用されます。
OrganizationURL	Dynamics 365 組織のURL。リソースとも呼ばれます。お使いのMicrosoft Dynamics 365 インスタンスの正確なURL を見つけるには、Web Services ページを検索してください。
Edition	使用しているMicrosoft Dynamics 365 のエディションを指定します。指定されていない場合は、デフォルト（FinOpsOnline）が適用されます。
ApiVersion	使用されているAPI のバージョンを示します。認証時に利用可能なAPI 機能の全範囲にアクセスできるように、この設定を最新の状態に保ってください。

Azure Authentication

---

プロパティ	説明
AzureTenant	データにアクセスするために使用されるMicrosoft Dynamics 365 テナントを、名前（例えば、contoso.omnicrosoft.com）またはID で識別します。（条件付き）
AzureEnvironment	接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。

OAuth

---

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthGrantType	選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。

JWT OAuth

---

プロパティ	説明
OAuthJWTCert	JWT 証明書のストア。
OAuthJWTCertType	JWT 証明書を格納するキーストアの種類。
OAuthJWTCertPassword	OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTCertSubject	OAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。
OAuthJWTIssuer	Java Web Token の発行者。
OAuthJWTSubject	アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

SSL

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Logging

---

プロパティ	説明
Verbosity	ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Schema

---

プロパティ	説明
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

Miscellaneous

---

プロパティ	説明
AllowDuplicateRecords	Notes whether or not the driver will permit the adding of duplicate records during INSERT operations. To create the record (or update it if a duplicate is found), set this to true. To avoid adding duplicate records, set this to false.
ContinueOnError	エラーが発生した後にバッチリクエストを続行するかどうかを指定します。（OData 4.0 以降のみ。）
CrossCompany	Specifies whether data should be pulled only the user's default company, or for all companies. (FinOpsOnline, FinOpsOnPremise, or HumanResources only.)
CustomUrlParams	HTTP リクエストに含めるカスタムURL パラメータの文字列で、field1=value1&field2=value2&field3=value3 の形式。
EnableAtomicBatchOperations	Specifies whether or not batch Create, Update, and Delete (CUD) operations execute independently (if one request fails, the others in the batch continue to execute) or atomically (if one request fails, the whole batch operation fails).
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	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
MinimumColumnSize	Specifies the minimum size of an Edm.String column, expressed as a number of characters. If the column size reported by Microsoft Dynamics 365 has a value lower than this value, the CData ADO.NET Provider for Microsoft Dynamics 365 overrides the service value with the one defined in the connection string.
Pagesize	Microsoft Dynamics 365 から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UseClientSidePaging	Specifies whether or not Microsoft Dynamics 365 should return data using client-side paging, if your source supports it. If set to false, Microsoft Dynamics 365 uses server-side paging.
UseDynamicStoredProcedures	Indicates whether or not stored procedures should be listed dynamically.
UseEntityDefinitions	Specifies that queries should use entity definition metadata endpoints, rather than the standard $metadata endpoint.

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

---

プロパティ	説明
AuthScheme	Microsoft Dynamics 365 に接続する際に使用する認証の種類を指定します。このプロパティが空白の場合は、デフォルトの認証が使用されます。
OrganizationURL	Dynamics 365 組織のURL。リソースとも呼ばれます。お使いのMicrosoft Dynamics 365 インスタンスの正確なURL を見つけるには、Web Services ページを検索してください。
Edition	使用しているMicrosoft Dynamics 365 のエディションを指定します。指定されていない場合は、デフォルト（FinOpsOnline）が適用されます。
ApiVersion	使用されているAPI のバージョンを示します。認証時に利用可能なAPI 機能の全範囲にアクセスできるように、この設定を最新の状態に保ってください。

Microsoft Dynamics 365 に接続する際に使用する認証の種類を指定します。このプロパティが空白の場合は、デフォルトの認証が使用されます。

Possible Values

AzureAD, AzureServicePrincipal, AzureServicePrincipalCert

データ型

string

デフォルト値

"AzureAD"

解説

• AzureAD：Azure Active Directory（ユーザーベース）のOAuth 認証を実行します。
• AzureMSI：Azure VM で実行している際に、Azure AD マネージドサービスID の資格情報を自動的に取得します。
• AzureServicePrincipal：クライアントシークレットを使用してAzure サービスプリンシパル（ロールベース、アプリケーションベース）として認証します。
• AzureServicePrincipalCert：証明書を使用してAzure サービスプリンシパル（ロールベース、アプリケーションベース）として認証します。

Azure AD で認証するためのカスタムアプリケーションの作成方法については、Azure AD アプリケーションの作成 を参照してください。

Azure AD サービスプリンシパルで認証するためのカスタムアプリケーションの作成方法については、サービスプリンシパルによるAzure AD アプリの作成 を参照してください。

Dynamics 365 組織のURL。リソースとも呼ばれます。お使いのMicrosoft Dynamics 365 インスタンスの正確なURL を見つけるには、Web Services ページを検索してください。

データ型

string

デフォルト値

""

解説

リソースのURL 形式は通常https://abc123.cloudax.dynamics.com/ に類似していますが、Edition がHumanResources の場合は異なります。 HumanResources のURL は通常次のようになります：https://{cluster}.hr.talent.dynamics.com/namespaces/{namespace_guid}/。

使用しているMicrosoft Dynamics 365 のエディションを指定します。指定されていない場合は、デフォルト（FinOpsOnline）が適用されます。

Possible Values

CustomerService, FieldService, FinOpsOnline, HumanResources, Marketing, ProjectOperations, Sales, Commerce

データ型

string

デフォルト値

"FinOpsOnline"

解説

エディションがFinOpsOnPremise の場合はADFSServer も指定する必要があります。

使用されているAPI のバージョンを示します。認証時に利用可能なAPI 機能の全範囲にアクセスできるように、この設定を最新の状態に保ってください。

データ型

string

デフォルト値

"9.2"

解説

サービスAPI は、データモデルの新機能にアクセスする手段を提供します。 ApiVersion を変更すると、ドライバーによって公開されるテーブルやカラムを定義するために使用されるサービスドキュメントが変更されます。

このセクションでは、本プロバイダーの接続文字列で設定可能なAzure Authentication プロパティの全リストを提供します。

---

プロパティ	説明
AzureTenant	データにアクセスするために使用されるMicrosoft Dynamics 365 テナントを、名前（例えば、contoso.omnicrosoft.com）またはID で識別します。（条件付き）
AzureEnvironment	接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。

データにアクセスするために使用されるMicrosoft Dynamics 365 テナントを、名前（例えば、contoso.omnicrosoft.com）またはID で識別します。（条件付き）

データ型

string

デフォルト値

""

解説

テナントは、主にドメイン（例えば、microsoft.com）に関連付けられた、組織のデジタル表現です。 テナントは、Tenant ID（ディレクトリID とも呼ばれる）によって管理されます。これは、Azure リソースへのアクセスや管理権限をユーザーに割り当てる際に指定します。

Azure ポータルでディレクトリID を見つけるには、Azure Active Directory -> プロパティに移動します。

AuthScheme = AzureServicePrincipal またはAzureServicePrincipalCert のいずれかである場合、またはAzureTenant = AzureAD であり、ユーザーが複数のテナントに属している場合は、AzureTenant を指定する必要があります。

接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。

Possible Values

GLOBAL, CHINA, USGOVT, USGOVTDOD

データ型

string

デフォルト値

"GLOBAL"

解説

Azure アカウントがGlobal ネットワークとは異なるネットワーク（China、USGOVT、USGOVTDOD など）の一部である場合は、必要です。

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

---

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthGrantType	選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。

データ型

string

デフォルト値

""

解説

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

データ型

string

デフォルト値

""

解説

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。

Possible Values

CODE, CLIENT, PASSWORD

データ型

string

デフォルト値

"CODE"

解説

ほとんどの場合、デフォルトのグラント種別は変更すべきではありません。 最も一般的なOAuth グラント種別とそれぞれのメリット・デメリットについては、https://oauth.net/2/grant-types/ を参照してください。

このセクションでは、本プロバイダーの接続文字列で設定可能なJWT OAuth プロパティの全リストを提供します。

---

プロパティ	説明
OAuthJWTCert	JWT 証明書のストア。
OAuthJWTCertType	JWT 証明書を格納するキーストアの種類。
OAuthJWTCertPassword	OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTCertSubject	OAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。
OAuthJWTIssuer	Java Web Token の発行者。
OAuthJWTSubject	アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

JWT 証明書のストア。

データ型

string

デフォルト値

""

解説

クライアント証明書のための証明書ストア名。

OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword でパスワードを指定します。

OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値がある場合で、OAuthJWTCertSubject が設定されている場合は、証明書の検索が始まります。 詳しくは、OAuthJWTCertSubject フィールドを参照してください。

証明書ストアの指定はプラットフォームに依存します。

Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。

MY	個人証明書と関連付けられた秘密キーを格納している証明書ストア。
CA	証明機関の証明書。
ROOT	ルート証明書。
SPC	ソフトウェア発行元証明書。

Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。

証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。 PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ（例えば、PKCS12証明書ストア）に設定する必要があります。

JWT 証明書を格納するキーストアの種類。

Possible Values

PFXBLOB, JKSBLOB, PEMKEY_BLOB, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_BLOB, XMLBLOB, BCFKSBLOB

データ型

string

デフォルト値

"PEMKEY_BLOB"

解説

このプロパティには次の値の一つを設定できます。

USER	Windows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。 Note：この種類はJava では利用できません。
MACHINE	Windows の場合、この証明書ストアがシステムストアであることを指定します。 Note：この種類はJava では利用できません。
PFXFILE	この証明書ストアは、証明書を含むPFX（PKCS12）ファイルの名前です。
PFXBLOB	この証明書ストアは、PFX（PKCS12）形式の証明書ストアを表すBase-64でエンコードされた文字列です。
JKSFILE	この証明書ストアは、証明書を含むJava key store（JKS）ファイルの名前です。 Note：この種類はJava のみで利用できます。
JKSBLOB	この証明書ストアは、Java key store（JKS）形式の証明書ストアを表すBase-64でエンコードされた文字列です。 Note：この種類はJava のみで利用できます。
PEMKEY_FILE	この証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。
PEMKEY_BLOB	この証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。
PUBLIC_KEY_FILE	この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。
PUBLIC_KEY_BLOB	この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。
SSHPUBLIC_KEY_FILE	この証明書ストアは、SSH 公開キーを含むファイルの名前です。
SSHPUBLIC_KEY_BLOB	この証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。
P7BFILE	この証明書ストアは、証明書を含むPKCS7 ファイルの名前です。
PPKFILE	この証明書ストアは、PuTTY 秘密キー（PPK）を含むファイルの名前です。
XMLFILE	この証明書ストアは、XML 形式の証明書を含むファイルの名前です。
XMLBLOB	この証明書ストアは、XML 形式の証明書を含む文字列の名前です。
BCFKSFILE	この証明書ストアは、Bouncy Castle キーストアを含むファイルの名前です。
BCFKSBLOB	この証明書ストアは、Bouncy Castle キーストアを含む文字列（Base-64エンコード）です。

OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。

データ型

string

デフォルト値

""

解説

このプロパティは、証明書ストアを開くために必要なパスワードを指定します。ただし、ストアの種類がパスワードを必要とする場合に限ります。 パスワードが必要かどうかを判断するには、ご利用の証明書ストアのドキュメントまたは設定を参照してください。

OAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。

データ型

string

デフォルト値

"*"

解説

このプロパティの値は、ストアで一致する証明書を検索するために使用されます。検索プロセスは以下のように動作します。

• サブジェクトに完全に一致する証明書が見つかれば、該当する証明書が選択されます。
• 完全に一致するものがない場合、ストアは、サブジェクトがプロパティ値を含む証明書を検索します。
• 一致する証明書がない場合、証明書は選択されません。

値を '*' に設定すると、ストアの先頭の証明書が自動的に選択されます。 証明書のサブジェクトは識別名フィールドおよび値のカンマ区切りのリストです。 例：CN=www.server.com, OU=test, C=US, [email protected]。一般的なフィールドには以下のものが含まれます。

フィールド	説明
CN	共通名。一般的には、www.server.com のようなホスト名です。
O	法人名
OU	法人の部署名
L	法人の住所（市町村名）
S	法人の住所（都道府県）
C	国名
E	E メールアドレス

フィールド値にカンマが含まれる場合は、引用符で囲んでください。例："O=ACME, Inc."。

Java Web Token の発行者。

データ型

string

デフォルト値

""

解説

Java Web Token の発行者。 通常は、OAuth アプリケーションのクライアントId またはE メールアドレスとなります。

アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。

データ型

string

デフォルト値

""

解説

アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクトです。通常は、ユーザーのアカウント名またはE メールアドレスとなります。

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

データ型

string

デフォルト値

""

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：

説明	例
フルPEM 証明書（例では省略されています）	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint （hex 値はスペースおよびコロン区切り）	ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint （hex 値はスペースおよびコロン区切り）	34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

---

プロパティ	説明
Verbosity	ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

---

プロパティ	説明
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

---

プロパティ	説明
AllowDuplicateRecords	Notes whether or not the driver will permit the adding of duplicate records during INSERT operations. To create the record (or update it if a duplicate is found), set this to true. To avoid adding duplicate records, set this to false.
ContinueOnError	エラーが発生した後にバッチリクエストを続行するかどうかを指定します。（OData 4.0 以降のみ。）
CrossCompany	Specifies whether data should be pulled only the user's default company, or for all companies. (FinOpsOnline, FinOpsOnPremise, or HumanResources only.)
CustomUrlParams	HTTP リクエストに含めるカスタムURL パラメータの文字列で、field1=value1&field2=value2&field3=value3 の形式。
EnableAtomicBatchOperations	Specifies whether or not batch Create, Update, and Delete (CUD) operations execute independently (if one request fails, the others in the batch continue to execute) or atomically (if one request fails, the whole batch operation fails).
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	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
MinimumColumnSize	Specifies the minimum size of an Edm.String column, expressed as a number of characters. If the column size reported by Microsoft Dynamics 365 has a value lower than this value, the CData ADO.NET Provider for Microsoft Dynamics 365 overrides the service value with the one defined in the connection string.
Pagesize	Microsoft Dynamics 365 から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UseClientSidePaging	Specifies whether or not Microsoft Dynamics 365 should return data using client-side paging, if your source supports it. If set to false, Microsoft Dynamics 365 uses server-side paging.
UseDynamicStoredProcedures	Indicates whether or not stored procedures should be listed dynamically.
UseEntityDefinitions	Specifies that queries should use entity definition metadata endpoints, rather than the standard $metadata endpoint.

Notes whether or not the driver will permit the adding of duplicate records during INSERT operations. To create the record (or update it if a duplicate is found), set this to true. To avoid adding duplicate records, set this to false.

データ型

bool

デフォルト値

true

解説

This property only applies when Edition is CustomerService, FieldService, Marketing, ProjectOperations or Sales.

For further information, see https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/manage-duplicate-detection-create-update.

エラーが発生した後にバッチリクエストを続行するかどうかを指定します。（OData 4.0 以降のみ。）

データ型

bool

デフォルト値

false

解説

ContinueOnError がtrue に設定されている場合、エラーが発生したバッチ操作は完了し、エラー応答を含む結果テーブルが作成されます。 ContinueOnError がfalse に設定されている場合、エラーが発生したバッチ操作は中止され、エラーメッセージが表示されます。

Specifies whether data should be pulled only the user's default company, or for all companies. (FinOpsOnline, FinOpsOnPremise, or HumanResources only.)

データ型

bool

デフォルト値

false

解説

This property only applies when Edition is set to FinOpsOnline, FinOpsOnPremise or HumanResources.

HTTP リクエストに含めるカスタムURL パラメータの文字列で、field1=value1&field2=value2&field3=value3 の形式。

データ型

string

デフォルト値

""

解説

このプロパティを使用すると、HTTP リクエストに含まれるカスタムクエリ文字列パラメータを指定できます。 パラメータは、各値がURL エンコードされた形式でfield1=value1&field2=value2&field3=value3 の形式で、クエリ文字列としてエンコードする必要があります。 URL エンコーディングは、以下のようにインターネット上で送信可能な文字列に変換する方法です。

• 非ASCII 文字は、"%" とそれに続く2桁の16進数で表される同等の文字に置き換えられます。
• スペースはプラス記号（+）または%20 で置き換えられます。

Specifies whether or not batch Create, Update, and Delete (CUD) operations execute independently (if one request fails, the others in the batch continue to execute) or atomically (if one request fails, the whole batch operation fails).

データ型

bool

デフォルト値

true

解説

If set to false, batch CUD operations are processed non-atomically, allowing individual operations to succeed or fail independently within the batch.

EnableAtomicBatchOperations is tightly coupled with ContinueOnError.

If ContinueOnError and EnableAtomicBatchOperations are both true, all batch rows are treated as a single unit. If a failure occurs, the API stops processing the remaining rows. The driver reports the remaining rows as failed.

If ContinueOnError is false and EnableAtomicBatchOperations is true, all batch rows are processed as a single unit. If one of the rows fails, the driver breaks the flow and displays an error. No rows are reported in LastResultInfo.

If ContinueOnError is true/false (defaults to true for EnableAtomicBatchOperations = false) and EnableAtomicBatchOperations is false, each row in the batch is treated as a single unit. the API processes all the rows. The driver populates LastResultInfo with information about each row, including their success status.

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 whether the column listing should include the primary keys of navigation properties. (JSON responses only)

データ型

bool

デフォルト値

false

解説

This property is provided to make it simpler to retrieve JSON record references where possible. When true, the $prod; pushes a set of fields for each table relation.

These properties are not available for use in INSERT or UPDATE operations. (Use the Linked* navigation columns for that).

If your service supports both XML/ATOM and JSON and you want to use this property, be sure to set DataFormat to JSON.

Specifies whether the column listing should include navigation properties.

データ型

bool

デフォルト値

false

解説

Navigation properties provide a way to navigate an association between two entity types. Every object can have a navigation property for every relationship in which it participates.

Navigation properties enable you to navigate and manage relationships in two ways:

• Two-directional navigation returns either a reference object (if the relationship is either 1 or 0-or-1) or a collection (if the relationship is 1-to-many).
• One-directional navigation enables you to define the navigation property on just one of the types that participates in the relationship, but not both.

When retrieving data, the navigation properties in a cell do not populate with information. Rather, they act to bind the content to an existing resource during inserts or updates. For example:

INSERT INTO accounts (_primarycontactid_value) VALUES ('123456')

To specify multiple values, use a comma-separated list. For instance:

INSERT INTO accounts (lead_customer_accounts) VALUES ('123,456')

集計やGROUP BY を使用しないクエリで返される最大行数を指定します。

データ型

int

デフォルト値

-1

解説

このプロパティは、集計やGROUP BY 句を含まないクエリに対してCloud が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。

Specifies the minimum size of an Edm.String column, expressed as a number of characters. If the column size reported by Microsoft Dynamics 365 has a value lower than this value, the CData ADO.NET Provider for Microsoft Dynamics 365 overrides the service value with the one defined in the connection string.

データ型

int

デフォルト値

0

解説

For more information about column limits at your site, examine the Manage Limits admin view.

Microsoft Dynamics 365 から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。

データ型

int

デフォルト値

5000

解説

クエリする特定のオブジェクトやサービスエンドポイントの結果を最適化するために、デフォルトのページサイズを調整したい場合があります。 ページサイズを大きくするとパフォーマンスが向上するかもしれませんが、ページあたりのメモリ消費量が増える可能性もあることに注意してください。

テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。

データ型

string

デフォルト値

""

解説

このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"

すべてのテーブルのすべての擬似カラムを含めるには、次のようにします："*=*"

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

データ型

int

デフォルト値

60

解説

このプロパティは、Cloud が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Cloud は操作をキャンセルして例外をスローします。

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

Specifies whether or not Microsoft Dynamics 365 should return data using client-side paging, if your source supports it. If set to false, Microsoft Dynamics 365 uses server-side paging.

データ型

bool

デフォルト値

false

解説

Pagination is the process of batching data so that the data retrieved is displayed in batches of a particular size. (To keep paging through the data, ask for "more". The data continues to display until all the retrieved data has been shown.)

In client-side paging, the client specifies how many records to return in each request, and the order of the requests. If UseClientSidePaging is set to true, the limit/offset is calculated at the client and the requests are sent concurrently, as multiple threads.

In server-side paging, the server returns only a subset of the data requested by the client. It also provides statistics on how large the full set of requested data is, and how much of the requested data set was not displayed. Server-side pagination is best for large data sets.

Note: Server-side paging requires traversing the data set both backward and forward. Not all data sources support that natively. To explicitly enable server-side paging with a data source that does not support it natively, you must configure your server to return a limited number of records per request, along with metadata about the total number of records. For details, see your data source's API documentation.

Indicates whether or not stored procedures should be listed dynamically.

データ型

bool

デフォルト値

false

解説

When UseDynamicStoredProcedures is true, you can pull a stored procedure from the Actions and Functions in the OData service $metadata document and use the EXEC command to list it at runtime.

In all other ways, dynamic stored procedures are just like standard static stored procedures. Like standard stored procedures, they can also be listed using CALL or via edition-specific code.

Specifies that queries should use entity definition metadata endpoints, rather than the standard $metadata endpoint.

データ型

bool

デフォルト値

false

解説

This option is useful when precise column metadata is required, and the default data type attributes cannot be relied upon. Since EntityMetadata entities contain a lot of data, more detailed information is provided, including column length, description, precision, and scale. However, due to the larger metadata payload, response times are slower.