Microsoft SharePoint への接続を追加

Microsoft SharePoint への接続を追加するには：

1. アプリケーションコンソールで、接続ページに移動します。
2. 接続の追加パネルで、追加したい接続のアイコンを選択します。
3. Microsoft SharePoint アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからMicrosoft SharePoint コネクタをダウンロードおよびインストールします。

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

Microsoft SharePoint への接続

オンラインまたはオンプレミスのどちらで接続するか、どのようなアーキテクチャを使用するか、どのリストやドキュメントにアクセスするかに関わらず、Microsoft SharePoint への接続には次の2つの設定が必要です。

• URL 接続プロパティを設定します。
• 使用環境に適した認証プロパティを設定します。

URL の設定：

Microsoft SharePoint は、グローバルなMicrosoft SharePoint サイト内のすべてのリストとドキュメント、または個々のサイトのすべてのリストとドキュメントで機能します。

グローバルなMicrosoft SharePoint サイトですべてのリストおよびドキュメントを操作するには、URL 接続プロパティをサイトコレクションURL に設定します。次に例を示します。

https://teams.contoso.com

個々のサイトですべてのリストおよびドキュメントを操作するには、URL 接続プロパティを個々のサイトURL に設定します。次に例を示します。

 https://teams.contoso.com/TeamA

以下のセクションでは、使用環境に適した認証プロパティの設定方法について説明します。カスタムOAuth アプリケーション（Web アプリケーションでAzureAD を使用する場合は必須、デスクトップアプリケーションまたはヘッドレスサーバー経由でAzureAD にアクセスする場合はオプション）の作成については、カスタムOAuth アプリケーションの作成 を参照してください。

Microsoft SharePoint Online

SharePointEdition を"SharePoint Online" に設定し、User およびPassword をSharePoint へのログオンに使用するクレデンシャルに設定します。例えば、Microsoft Online Services アカウントへのクレデンシャルです。

Microsoft SharePoint Online は、多くのクラウドベースのアーキテクチャをサポートし、各アーキテクチャは、それぞれ異なる認証スキームをサポートしています。

• AzureAD
• ADFS、Okta、OneLogin、またはPingFederate SSO ID プロバイダーを介したシングルサインオン（SSO）
• Azure MSI
• Azure パスワード
• OAuthJWT
• SharePointOAuth

もしユーザーアカウントのドメインがID プロバイダーに設定されたドメインと異なる場合には、SSODomain を後者に設定します。このプロパティは、すべてのSSO で必要になる可能性があります。

AzureAD

Azure Active Directory（AzureAD）は、OAuth を使用して認証する接続タイプです。OAuth では認証するユーザーにインターネットブラウザでMicrosoft SharePoint との通信を要求します。下記で説明するとおり、本ドライバーはさまざまな方法でこれをサポートします。AuthScheme をAzureAD に設定します。以下で説明するAzure AD フローは、すでに設定済みであることを前提として書かれています。

Azure テナントの新しいAzureAD アプリケーションを承認する際、組織による管理者の同意が必要になる場合があります。すべてのAzureAD フローにおいて、AzureAD アプリケーションの初期インストールと使用の際は、管理者がそのAzure テナントのアプリケーションを承認する必要があります。詳細はカスタムOAuth アプリケーションの作成 を参照してください。

シングルサインオンID プロバイダー

ADFS

AuthScheme をADFS に設定します。次の接続プロパティを設定する必要があります。

• User：ADFS ユーザー。
• Password：ユーザーのADFS パスワード。
• SSODomain（オプション）：ADFS のID プロバイダーで設定されたドメイン。

接続文字列の例：

AuthScheme=ADFS;User=ADFSUserName;Password=ADFSPassword;URL='http://sharepointserver/mysite';

Okta

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

• User：Okta ユーザー。
• Password：ユーザーのOkta パスワード。
• SSODomain（オプション）：Okta のID プロバイダーで設定されたドメイン。

接続文字列の例：

AuthScheme=Okta;User=oktaUserName;Password=oktaPassword;URL='http://sharepointserver/mysite';

OneLogin

AuthScheme をOneLogin に設定します。OneLogin への接続には、次の接続プロパティを使用します。

• User：OneLogin ユーザー。
• Password：ユーザーのOneLogin パスワード。
• SSODomain（オプション）：OneLogin のID プロバイダーで設定されたドメイン。

接続文字列の例：

AuthScheme=OneLogin;User=OneLoginUserName;Password=OneLoginPassword;URL='http://sharepointserver/mysite';

PingFederate

AuthScheme をPingFederate に設定します。PingFederate への接続には、次の接続プロパティを使用します。

• User：PingFederate ユーザー。
• Password：ユーザーのPingFederate パスワード。
• SSODomain（オプション）：PingFederate のID プロバイダーで設定されたドメイン。

接続文字列の例：

AuthScheme=PingFederate;User=PingFederateUserName;Password=PingFederatePassword;URL='http://sharepointserver/mysite';

Azure MSI

Azure VM 上でMicrosoft SharePoint を実行している場合は、Azure Managed Service Identity（MSI）の資格情報を利用して接続が可能です。

• AuthScheme：AzureMSI。

MSI 資格情報が認証用に自動的に取得されます。

Azure パスワード

Azure 資格情報を使用して直接接続するには、次の接続プロパティを指定します。

• AuthScheme： AzurePassword
• User：Azure への接続に使用するユーザーアカウント
• Password：Azure への接続に使用するパスワード
• AzureTenant：Azure 上のMicrosoft SharePoint への認証に使用するOAuth アプリケーションの概要ページにある、Directory (tenant) ID。

OAuthJWT 証明書

AuthScheme をOAuthJWT に設定します。Microsoft SharePoint への接続には、次の接続プロパティを使用します。

• AzureTenant：接続するテナント。
• OAuthJWTCert：JWT 証明書のストア。
• OAuthJWTCertType：JWT 証明書を格納するキーストアの種類。
• OAuthJWTIssuer：OAuth クライアントId。
• OAuthJWTCertPassword：JWT 証明書に関連付けられたパスワード。証明書タイプにパスワードが必要な場合は、これを設定します。

SharePointOAuth

AuthScheme をSharePointOAuth に設定します。SharePointOAuth への接続には、次の接続プロパティを使用します。

• Schema：REST。
• InitiateOAuth：GETANDREFRESH。
• OAuthClientId：アプリケーションのId / クライアントId。
• OAuthClientSecret：アプリケーションのクライアントシークレット。

接続文字列の例：

SharePointEdition='SharepointOnline';URL=https://rssbuscrm.sharepoint.com;Schema=REST;AuthScheme=SharepointOAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=11111111-1111-1111-1111-111111111111;OAuthClientSecret=1111111111111/11111111111111/11111111111111=;

このAuthScheme はカスタムOAuth アプリケーションで動作します。カスタムOAuth アプリケーションから認証情報を生成するには、カスタムOAuth アプリケーションの作成 を参照してください。

Microsoft SharePoint REST API はSharePoint OnPremise とSharePoint Online の両方でサポートされています。REST API を使用して接続するには、Schema をREST に設定してください。

SharePointEdition プロパティは、SharePoint のエディションの定義に使用できます。

SharePoint Online

SharePoint Online はOAuth 標準を使用して認証します。詳しくは、接続の確立 の「SharePoint Online への認証」の手順でご確認ください。

SharePoint OnPremise

詳しくは、接続の確立 の「SharePoint On Premises への認証」の手順でご確認ください。

Kerberos

Kerberos でMicrosoft SharePoint への認証を行うには、AuthScheme をNEGOTIATE に設定します。

Kerberos 経由でMicrosoft SharePoint への認証を行うには、認証プロパティを定義し、Kerberos が認証チケットを取得する方法を選択する必要があります。

Kerberos チケットの取得

Kerberos チケットは、依頼者のID を認証するために使用されます。正式なログイン / パスワードの代わりにチケットを使用することで、パスワードをローカルに保存したり、ネットワーク経由で送信したりする必要がなくなります。 ユーザーは、ローカルコンピュータでログインするか、 コマンドプロンプトでkinit USER と入力するたびに、再認証されます（チケットはリフレッシュされます）。

Sync App は、 KRB5CCNAME および / またはKerberosKeytabFile 変数が存在するかどうかに応じて、必要なKerberos チケットを取得する3 つの方法を提供します。

MIT Kerberos 資格情報キャッシュファイル

このオプションを使用すると、MIT Kerberos チケットマネージャーまたはkinit コマンドを使ってチケットを取得できます。このオプションでは、User またはPassword 接続プロパティを設定する必要はありません。

このオプションは、KRB5CCNAME がシステムに作成されている必要があります。

MIT Kerberos 資格情報キャッシュファイル経由でチケット検索を有効にするには：

1. お使いの環境にKRB5CCNAME 変数が存在することを確認します。
2. KRB5CCNAME を資格情報キャッシュファイルを指すパスに設定します。（例えば、C:\krb_cache\krb5cc_0 または/tmp/krb5cc_0 です。）資格情報キャッシュファイルは、MIT Kerberos チケットマネージャーを使用してチケットを生成するときに作成されます。
3. チケットを取得するには：
   1. MIT Kerberos チケットマネージャーアプリケーションを開きます。
   2. Get Ticket をクリックします。
   3. プリンシパル名とパスワードを入力します。
   4. OK をクリックします。

   チケットの取得に成功すると、チケット情報がKerberos チケットマネージャーに表示され、クレデンシャルキャッシュファイルに保存されます。

Sync App はキャッシュファイルを使用してMicrosoft SharePoint に接続するためのKerberos チケットを取得します。

Note： KRB5CCNAME を編集したくない場合は、KerberosTicketCache プロパティを使用してファイルパスを手動で設定することができます。この設定後に、Sync App は指定されたキャッシュファイルを使用してMicrosoft SharePoint に接続するためのKerberos チケットを取得します。

Keytab ファイル

お使いの環境にKRB5CCNAME 環境変数がない場合、Keytab ファイルを使用してKerberos チケットを取得できます。

この方法を使用するには、User プロパティを目的のユーザー名に設定し、KerberosKeytabFile プロパティをユーザーに関連付けられたキータブファイルを指すファイルパスに設定します。

User およびPassword

お使いの環境にKRB5CCNAME 環境変数およびKerberosKeytabFile プロパティが設定されていない場合、ユーザーとパスワードの組み合わせを使用してチケットを取得できます。

この方法を使用するには、User およびPassword プロパティを、Microsoft SharePoint での認証に使用するユーザー / パスワードの組み合わせに設定します。

クロスレルム認証の有効化

より複雑なKerberos 環境では、複数のレルムおよびKDC サーバーが使用されるクロスレルム認証が必要になる場合があります。例えば、1つのレルム / KDC がユーザー認証に使用され、別のレルム / KDC がサービスチケットの取得に使用される場合です。

このようなクロスレルム認証を有効にするには、KerberosRealm およびKerberosKDC プロパティをユーザー認証に必要な値に設定します。また、KerberosServiceRealm およびKerberosServiceKDC プロパティを、 サービスチケットの取得に必要な値に設定します。

Microsoft SharePoint 接続の調整

高度なインテグレーションで簡単にデータにアクセスできるようにするには、次の接続プロパティを使って列名識別子および他のデータ接続の設定を調整します。

• UseDisplayNames：これをtrue に設定すると、基底のAPI のフィールド名と合致する列名を返します。
  デフォルトでは、Sync App はSharePoint で定義されたフィールド名と合致する列名を使います。
• UseSimpleNames：これをtrue に設定すると、SharePoint が許容するが他のデータベースでは通常許容されない特殊文字を含む列名の代替を行います。
• ShowPredefinedColumns：これをfalse に設定するとリスト内のフィールドから派生しているフィールドを除外します。例えば、Author とCreatedAt です。
  この設定は、SELECT * 構文およびスキーマ検出で、事前に定義されたフィールドが返されないようにします。
• ShowHiddenColumns:これをtrue に設定すると、SharePoint で非表示に設定されている列がSync App で表示されます。

このセクションでは、Microsoft SharePoint Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。

SSL の設定

SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、Microsoft SharePoint にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくは、クエリ処理 を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングに必要なのは2つの接続プロパティだけですが、より詳細なロギングをサポートする多くの機能があり、LogModules 接続プロパティを使用してロギングする情報のサブセットを指定することができます。

SSL 設定のカスタマイズ

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

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

クライアントSSL 証明書

Microsoft SharePoint Sync App はクライアント証明書の設定もサポートしています。次を設定すれば、クライアント証明書を使って接続できます。

• SSLClientCert：クライアント証明書のための証明書ストア名。
• SSLClientCertType：TLS / SSL クライアント証明書を格納するキーストアの種類。
• SSLClientCertPassword：TLS / SSL クライアント証明書のパスワード。
• SSLClientCertSubject：TLS / SSL クライアント証明書のサブジェクト。

Firewall またはProxy 経由の接続

HTTP プロキシ

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

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

その他のプロキシ

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

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

CData Sync App は、Microsoft SharePoint エンティティをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。テーブル定義は、Microsoft SharePoint サイトに基づいて 動的に取得されます。カスタムフィールドの追加や、フィールドのデータ型の変更などのあらゆる変更は、接続時に自動的に反映されます。

データモデルのカスタマイズ

Sync App は最大数のインテグレーションを行うようにデフォルトで設定されていますが、次の接続プロパティは、高度なインテグレーションで有用な、より粒度の細かいカスタマイズを可能にします。

• CalculatedDataType：計算フィールドで使用されるデータ型。
• CreateIDColumns：他のリストに格納されている情報からの値を使っているSharePoint 列に補助的Id 列を作成するかしないかを示します。
• FolderOption：結果にフォルダを表示する方法を決定するオプション。FilesOnly、FilesAndFolders、Recursive、RecursiveAll のいずれかを入力します。
• PseudoColumns：疑似列をテーブルメタデータの列としてレポートするかどうかを示します。

テーブル

テーブル では、利用可能なテーブルを説明します。

Sync App は、テーブル にないカスタムリストをMicrosoft SharePoint から公開できます。 データモデルは、SharePoint サイトの外観のサンプルを示します。実際のデータモデルは、ユーザー資格情報とSharePoint サイトに基づいて動的に取得されます。

ビュー

一般的に、変更ができないエンティティはビュー、または読み取り専用のテーブルとして表示されます。また、リストのカスタムビューをリレーショナルビューとしてアクセスすることができます。

リストのカスタムビューからデータを取得するには、ViewID 疑似列をWHERE 句に設定します。

SELECT * FROM ListName WHERE ViewID='ID of the view'

Views リストからビューのID を取得できます。そのリストビューのリストを取得するには、List 疑似列を指定する必要があります。 次に例を示します。

SELECT * FROM Views WHERE List ='ListName'

ストアドプロシージャ

ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。情報の検索、更新、変更など、Microsoft SharePoint API の追加機能を利用可能にします。

The Sync App maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.

Microsoft SharePoint	CData Schema
Choice (menu)	string
Currency	float
Date and Time	datetime
Hyperlink or Picture	string
Lookup	string
Multiple lines of text	string
Number	float
Person or Group	string
Single line of text	string
Task Outcome	string
Yes/No	bool

Sync App はMicrosoft SharePoint のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

Microsoft SharePoint Connector for CData Sync テーブル

Name	Description
Attachments	指定されたリストにある指定された項目の添付ファイルを読み取るか、削除します。
Groups	SharePoint のグループを作成、更新、削除、およびクエリします。
Roles	SharePoint のロールを作成、更新、削除、およびクエリします。
Users	SharePoint のユーザーを更新、削除、およびクエリします。
Views	SharePoint 内にあるリストを作成、更新、削除、およびクエリします。

指定されたリストにある指定された項目の添付ファイルを読み取るか、削除します。

Table Specific Information

Select

List and ItemId are required to return Attachments.

Insert

Call the AddAttachments stored procedure to add new attachments to a list item.

Columns

Name	Type	ReadOnly	Description
Url [KEY]	String	True	用語セットの説明。
List	String	True	添付ファイルの取得元になるリストの内部名。
ListDisplayName	String	True	添付ファイルの取得元になるリストの表示名。
ItemID	String	True	添付ファイルの取得元になるリスト内の項目のId。
Name	String	True	項目の添付ファイルの名前。

SharePoint のグループを作成、更新、削除、およびクエリします。

テーブル固有の情報

Insert

このテーブルに挿入するにはName、DefaultLogin、およびOwnerLogin カラムが必要です。

UserName 疑似カラムを使用するには、ユーザーのLoginName に値を設定する必要があります。Users テーブルにクエリすることでLoginName を取得できます。

Columns

Name	Type	ReadOnly	Description
Name# [KEY]	String	False	グループの名前。
Description#	String	False	グループの説明。
OwnerLogin#	String	False	グループのオーナーのユーザー名。この値は、DOMAIN\\username の形式で指定する必要があります。
OwnerType#	String	False	オーナーのタイプ。ユーザーまたはグループ。
DefaultLogin#	String	False	グループのデフォルトユーザーのユーザー名。この値は、DOMAIN\\username の形式で指定する必要があります。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
UserName	String	グループを取得する対象になるユーザーの論理名。指定したユーザーのグループだけを返すには、SELECTステートメントでこの値を指定します。

SharePoint のロールを作成、更新、削除、およびクエリします。

Table Specific Information

Select

To use the UserName pseudo column, you must set the value to the LoginName of the user. You can obtain the LoginName by querying the Users table.

Insert

To insert a Role, at a minimum the Name is required:

INSERT INTO Roles (Name) VALUES ('My Role')

Columns

Name	Type	ReadOnly	Description
Name# [KEY]	String	False	ロールの名前。
Description#	String	False	ロールの説明。
Permissions#	String	False	ロールの権限を表すlong。
RoleType	String	True	ロールのタイプ。
IsHidden	Boolean	True	ロールが非表示かどうかを示すboolean。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
UserName	String	ロールを取得する対象になるユーザーのログイン名。指定したユーザーに割り当てられたロールだけを返すには、SELECTステートメントでこの値を指定します。
GroupName	String	ロールを取得する対象になるグループ名。指定したグループに割り当てられたロールだけを返すには、SELECT ステートメントでこの値を指定します。

SharePoint のユーザーを更新、削除、およびクエリします。

Table Specific Information

Select

Retrieves all users created for the SharePoint Account:

SELECT * FROM Users

You can retrieve Users that belong to a specific Group. In this case specify the Group Name:

SELECT * FROM Users WHERE [Group] = "GroupName"

Or you can retrieve Users that have a specific Role. In this case specify the Role Name:

SELECT * FROM Users WHERE [Role] = "RoleName"

Columns

Name	Type	ReadOnly	Description
ID	String	True	ユーザーのId。
LoginName# [KEY]	String	False	ユーザーのログイン名。
Name#	String	False	ユーザーの名前。
Email#	String	False	ユーザーのE メールアドレス。
IsInDomainGroup	Boolean	True	ユーザーがドメイングループに属するかどうかを示すboolean。
IsSiteAdmin	Boolean	True	ユーザーがサイト管理者であるかどうかを示すboolean。
Notes#	String	False	ユーザーに関するオプションのメモ。
SecurityId	String	True	ユーザーのセキュリティId（SID）。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
Group	String	ユーザーを追加、および選択/削除する先のグループ。これは入力専用の値です。挿入および選択の場合はGroup またはRole を指定する必要がありますが、削除の場合はオプションです。
Role	String	ユーザーを追加、および選択/削除する先のロール。これは入力専用の値です。挿入および選択の場合はGroup またはRole を指定する必要がありますが、削除の場合はオプションです。

SharePoint 内にあるリストを作成、更新、削除、およびクエリします。

Table Specific Information

Views is a special table. It may be used to get, update, insert, and delete views from a specified List.

Select

To return results from Views, yout must specify either the ID or List in the SELECT statement. For example,

SELECT * FROM Views WHERE List = 'MyListName'

Insert

The List, Name, and Fields columns are required to insert to this table.

Columns

Name	Type	ReadOnly	Description
ID [KEY]	String	True	ビューのId。
List	String	True	ビューを関連付けるリスト。SELECTステートメントの実行時にIdを指定しない場合は、リストを指定する必要があります。
ViewID	String	True	ビューのId。特定のリストに対して一意であれば十分です。
Name	String	False	ビューの名前。
Type	String	False	ビューのタイプ。挿入および更新では、この値を指定する必要があります。 使用できる値は次のとおりです。CALENDAR, GRID, HTML デフォルト値はHTMLです。
Fields	String	False	ビューに関連付けられたフィールドのカンマ区切りリスト。これは、スペースを文字と認識します。
IsDefault	Boolean	False	ビューがリストのデフォルトビューかどうかを示すboolean。
Query	String	False	ビューのクエリ。

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

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

Microsoft SharePoint Connector for CData Sync ビュー

Name	Description
FileVersions	SharePoint内のファイルのバージョンをリストします。
GetValidTerms	指定されたテーブルの指定された列に対して有効な用語のリストを取得します。
Lists	SharePoint 内にあるリストをリストします。
Permissions	サイト、もしくはリストへの許可。 Note：ItemId が空の場合は、ObjectType をList またはweb に設定します（ObjectType がlist の場合はObjectName を指定する必要があります）。そうでない場合は、ItemID とともにObjectName を指定する必要があります。
Subsites	使用可能なサブサイトをリストします。

SharePoint内のファイルのバージョンをリストします。

ビュー固有の情報

このビューから結果を返すには、Library およびFile を指定する必要があります。

Columns

Name	Type	Description
ID [KEY]	String	バージョンのId。
Comments	String	特定のバージョンに関するコメント。
CreateBy	String	このバージョンのファイルを変更したSharePointユーザーのユーザー名。
Date	Datetime	ファイルの変更日。
Size	String	このバージョンのファイルのサイズ。
Url	String	このバージョンのファイルのURL。
Library	String	リストするバージョンがあるSharePoint内のライブラリ名。ファイルのバージョンを取得するには、ライブラリを指定する必要があります。 デフォルト値はShared Documentsです。
File	String	バージョンをリストするSharePoint内のファイルの名前。ファイルのバージョンを取得するには、ファイルを指定する必要があります。

指定されたテーブルの指定された列に対して有効な用語のリストを取得します。

Columns

Name	Type	Description
ID [KEY]	String	用語の識別子。
TermLabelValue	String	用語のラベル。
Description	String	用語セットの説明。
NameInRequestedLang	String	クライアントから要求された言語による用語セットの名前。
IsOpen	Boolean	用語セットが開いているかどうかを示すBoolean。
Deprecated	Boolean	用語が廃止されているかどうかを示すBoolean。
InternalId	String	用語の内部識別子。
TermSetContact	String	用語セットの連絡先。
ContainerDesc	String	説明のコンテナーノード。
SingleTermLabelDesc	String	これは、1つの用語ラベルを完全に記述します。
IsDefaultLabel	Boolean	用語ラベルがデフォルトの用語ラベルの場合はtrue。
BelongsTo	String	この項目は、用語が所属する用語セットを記述します。
IsTaggingAvailable	Boolean	用語セットをタグ付けに使用できる場合、この値はtrueです。
TermPath	String	用語ラベルを含む用語の用語パス。
TermpathoftermwithIds	String	識別子を含む用語の用語パス。
ChildTerms	String	PertainingToTermで指定された用語の子用語のカスタムソート順を示す文字列値。
HasChildTerms	Boolean	用語に子用語が含まれる場合はtrue。
PertainingToTerm	String	この用語セット情報の関連先の用語の識別子。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
List	String	有効な用語の取得元になるリストの名前。
ColumnName	String	有効な用語の取得元になる列の名前。
LocaleId	String	用語のロケールId。デフォルトは1033です。

SharePoint 内にあるリストをリストします。

View Specific Information

Lists can be used to list the tables in SharePoint. This will only return actual lists in SharePoint and not any special tables associated with the Sync App.

The following columns can be used in the WHERE clause: Title and BaseTemplate.

Columns

Name	Type	Description
ID [KEY]	String	リストのId。
Title	String	リストのタイトル。この列は、WHERE句内で使用したり、ワイルドカード（*）文字と組み合わせて使用することができます。
Description	String	リストの説明。
BaseTemplate	String	リストの作成に使用されるテンプレートのタイプを示す。この列は、WHERE句内で使用できます。
Version	Double	リストのバージョン。
Url	String	リストのデフォルトURL。
EmailAlias	String	リストのE メールエイリアス。
ImageUrl	String	リストの画像URL。
ItemCount	Integer	リスト内の項目の数。
Item_Deleted	Datetime	このリスト内の項目が最後に削除された時刻。
Item_Modified	Datetime	このリスト内の項目が最後に変更された時刻。
SendToUrl	String	リストの送信先URL。
Created	Datetime	リストの作成時刻。
AllowDeletion	String	項目を削除できるかどうか。
AllowMultiResponses	Boolean	アンケートに対して複数の回答が可能かどうかを示すBoolean。
Direction	String	読みの方向を示す文字列。LTR（左から右）、RTL（右から左）、またはNone。
EnableAssignedToEmail	Boolean	割り当てE メールが有効かどうかを示すBoolean。案件リストにのみ適用されます。
EnableAttachments	Boolean	リスト内の項目に添付ファイルを追加できるかどうかを示すBoolean。ドキュメントライブラリには適用されません。
EnableModeration	Boolean	リストにコンテンツの承認が有効かどうかを示すBoolean。
EnableVersioning	Boolean	リストにバージョン管理が有効かどうかを示すBoolean。
Hidden	Boolean	リストが非表示かどうかを示すBoolean。非表示のリストは、［ドキュメントとリスト］ページ、クイック起動バー、［サイトコンテンツの変更］ページ、および［列の追加］ページにルックアップフィールドのオプションとして表示されません。
MultipleDataList	Boolean	会議ワークスペースサイトに、サイト内で複数の会議インスタンスに対応するデータが含まれているかどうかを示すBoolean。
Ordered	Boolean	［ビューの編集］ページでリスト内の項目をソートできるかどうかを示すBoolean。
Showuser	Boolean	アンケートの結果にユーザーの名前が表示されるかどうかを示すBoolean。

サイト、もしくはリストへの許可。 Note：ItemId が空の場合は、ObjectType をList またはweb に設定します（ObjectType がlist の場合はObjectName を指定する必要があります）。そうでない場合は、ItemID とともにObjectName を指定する必要があります。

Columns

Name	Type	Description
MemberID [KEY]	String	許可のId。
Mask	Long	Microsoft.SharePoint.SPRights 値を表し、許可を定義する0x00000000 形式の32-bit 整数。許可を合成するカスタム許可マスクを作成する場合には、C# では'|' を、Microsoft Visual Basic では'Or' を使って区切ります。
MemberIsUser	Bool	ユーザーの許可かどうかを示します。
MemberGlobal	Bool	グループの許可かどうかを示します。
RoleName	String	サイトグループ名、クロスサイトグループ名、もしくは許可が適用されるユーザーのユーザー名（DOMAIN\User_Alias）を含む文字列。

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
ObjectName	String	リスト名もしくはサイトの名前が含まれる文字列。
ObjectType	String	リスト、もしくはウェブを指定する文字列。
ItemID	String	アイテムのId。

使用可能なサブサイトをリストします。

Columns

Name	Type	Description
Title	String	サブサイトの名前。
Url	String	サブサイトのURL。

CData Sync App は、Microsoft SharePoint エンティティをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。テーブル定義は、Microsoft SharePoint サイトに基づいて 動的に取得されます。カスタムフィールドの追加や、フィールドのデータ型の変更などのあらゆる変更は、接続時に自動的に反映されます。

テーブル

Microsoft SharePoint サイトのリストは、リレーショナルテーブルとして動的に生成されます。そのため、新しいリストやフィールドを加えるなどの変更をリスト内で行うと、ドライバーにも反映されます。

テーブルは動的に生成されるため、特定のテーブルに関するドキュメントはありません。

ビュー

ビューは変更ができないテーブルです。一般的に、読み取り専用のデータはビューとして表示されます。

ストアドプロシージャ

ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。情報の検索、更新、変更など、Microsoft SharePoint API の追加機能を利用可能にします。

OData 標準の使用

REST API はOData に準拠しているため、サーバーサイドフィルタはOData 標準を使用して実行されます。そのためドライバーは、メタデータファイルを読み取ってどのフィルタがサーバーで実行できるかを決定することで、サーバーフィルタリングを最大限に活用します。

NOTE： "SELECT *" クエリを実行する際には、Microsoft SharePoint REST API レスポンスは利用可能なすべてのフィールドを返すわけではありません。そこで、大量にnull 値が発生してしまうことを避けるためプロバイダーは、明示的に $select フィルタを使用しているカラムをすべて選択します。ただし、URL の長さに関するMicrosoft SharePoint REST API からのエラーを避けるため、$select フィルタの長さが1500以下である場合のみ、プロバイダーはこの操作を実行します。これはMicrosoft SharePoint REST API の制限であり、こうした場合にはいくつかのカラムの実際の値を見るには、クエリ内で明示的に選択する以外に方法はありません。

The Sync App maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.

Microsoft SharePoint	CData Schema
Choice (menu)	string
Currency	float
Date and Time	datetime
Hyperlink or Picture	string
Lookup	string
Multiple lines of text	string
Number	float
Person or Group	string
Single line of text	string
Task Outcome	string
Yes/No	bool

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

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

Microsoft SharePoint Connector for CData Sync ビュー

Name	Description
Attachments	Reads attachments to the specified item to the specified list.
Comments	This view represents comments within SharePoint, detailing their authors, content, replies, and associated metadata.
Files	Reads attachments to the specified item to the specified list.
Groups	Retrieve group information from the specified SharePoint Site, including membership settings, permissions, and ownership details.
Lists	Query the available lists on your sharepoint site.
ListItems	This view represents general SharePoint items containing standard columns across various SharePoint lists.
RoleAssignmentMember	Get Web RoleAssignments member.
RoleAssignments	Acquires Web RoleAssignments.
RoleDefinitionBindings	Get Web Role definition binding.
Roles	Contains details about role definitions available in the SharePoint site collection.
Subsites	This lists the available subsites.
Users	Represents users and their roles in the SharePoint site or group.

Reads attachments to the specified item to the specified list.

Table Specific Information

Select

Note: List and ItemId are required to return Attachments.

List can be fetched from the Lists view(Title column).

SELECT * FROM Attachments WHERE List = 'TestApp' AND ItemID = 1

Columns

Name	Type	References	Description
Id [KEY]	String		The Id of the attachment to the item.
Updated	Datetime		The updated date of the attachment to the item.
FileName	String		The FileName of the attachment to the item.
ServerRelativePath_DecodedUrl	String		The ServerRelativePath DecodedUrl of the attachment to the item.
FileNameAsPath_DecodedUrl	String		The FileNameAsPath DecodedUrl of the attachment to the item.
ServerRelativeUrl	String		The ServerRelativeUrl of the attachment to the item.
List	String	Lists.Title	The internal name of the list to retrieve attachments from.
ItemID	Int		The Id of the item in the list to retrieve attachments from.

This view represents comments within SharePoint, detailing their authors, content, replies, and associated metadata.

Columns

Name	Type	References	Description
Id [KEY]	Int		A unique identifier for each comment.
ItemId [KEY]	Int	ListItems.Id	The ID of the item associated with the comment.
List	String	Lists.Title	The name of the SharePoint list containing the item and its comments.
ListId	String		The unique ID of the list the comment belongs to.
AuthorId	Int		The unique identifier of the comment's author.
AuthorEmail	String		The email address of the comment's author.
IsReply	Bool		Indicates whether the comment is a reply to another comment.
ParentId	Int	Comments.Id	The unique ID of the parent comment if this is a reply.
ReplyCount	Int		The total number of replies to the comment.
LikeCount	Int		The total number of likes on the comment.
IsLikedByUser	Bool		Indicates whether the comment is liked by the current user.
Text	String		The text content of the comment.
Mentions	String		A list of users mentioned in the comment, if any.
CreatedDate	Datetime		The date and time when the comment was originally created.
ModifiedDate	Datetime		The date and time when the comment was last modified.

Reads attachments to the specified item to the specified list.

Columns

Name	Type	References	Description
Id [KEY]	String		Unique identifier
CreatedBy_Id	String		The ID of the user that added the file
CreatedBy_Name	String		The name of the user that added the file
CreatedBy_Puid	String		The personal ID of the user that added the file
ETag	String		ETag value
LastModifiedBy_Id	String		The ID of the user that last modified the file
LastModifiedBy_Name	String		The name of the user that last modified the file
LastModifiedBy_Puid	String		The personal ID of the user that last modified the file
Name	String		Name of the file including the extension
Size	Long		The size of the file in bytes, excluding the size of any Web Parts that are used in the file.
TimeCreated	Datetime		Specifies when the file was created.
TimeLastModified	Datetime		Specifies when the file was last modified.
Url	String		URL of the file
List	String		The display name of the list to retrieve files from.

Retrieve group information from the specified SharePoint Site, including membership settings, permissions, and ownership details.

Columns

Name	Type	References	Description
Id [KEY]	Int		The unique identifier for the group.
LoginName	String		The login name or alias associated with the group.
Title	String		The display name of the group or principal.
AllowMembersEditMembership	Bool		Indicates whether group members are allowed to modify the membership of the group.
AllowRequestToJoinLeave	Bool		Indicates whether users can request to join or leave the group.
AutoAcceptRequestToJoinLeave	Bool		Indicates whether requests to join or leave the group are automatically accepted.
CanCurrentUserEditMembership	Bool		Indicates whether the current user has permissions to edit the group's membership.
CanCurrentUserManageGroup	Bool		Indicates whether the current user has permissions to manage the group.
CanCurrentUserViewMembership	Bool		Indicates whether the current user can view the group's membership details.
Description	String		A brief description or summary of the group's purpose or function.
IsHiddenInUI	Bool		Indicates whether the group is hidden from the user interface.
OnlyAllowMembersViewMembership	Bool		Indicates whether only members of the group are allowed to view its membership details.
OwnerTitle	String		The display name of the group's owner.
RequestToJoinLeaveEmailSetting	String		The email address where membership requests (to join or leave) are sent.
PrincipalType	Int		Specifies the type of principal. This is a bitwise value where possible. Types include: None = 0; User = 1; DistributionList = 2; SecurityGroup = 4; SharePointGroup = 8; All = 15.

Query the available lists on your sharepoint site.

Table Specific Information

Lists can be used to list the tables in SharePoint. This will only return actual lists in SharePoint and not any special tables associated with the Sync App.

The following columns can be used in the WHERE clause: Title and BaseTemplate.

Columns

Name	Type	References	Description
HasUniqueRoleAssignments [KEY]	Bool
LinkedFirstUniqueAncestorSecurableObject	String
LinkedRoleAssignments	String
ServerRelativeUrl	String		The relative URL of the file based on the URL for the server. This column is available when the URL is a subsite.
Id [KEY]	String
AllowContentTypes	Bool
AllowDeletion	Bool
BaseTemplate	Int
BaseType	Int
BrowserFileHandling	Int
ContentTypesEnabled	Bool
CrawlNonDefaultViews	Bool
Created	Datetime
CurrentChangeToken_StringValue	String
CustomActionElements_Items	String
DataSource_Properties	String
DefaultContentApprovalWorkflowId	String
DefaultDisplayFormUrl	String
DefaultEditFormUrl	String
DefaultItemOpenUseListSetting	Bool
DefaultNewFormUrl	String
DefaultViewPath_DecodedUrl	String
DefaultViewUrl	String
Description	String
Direction	String
DisableGridEditing	Bool
DocumentTemplateUrl	String
DraftVersionVisibility	Int
EffectiveBasePermissions_High	Long
EffectiveBasePermissions_Low	Long
EffectiveBasePermissionsForUI_High	Long
EffectiveBasePermissionsForUI_Low	Long
EnableAssignToEmail	Bool
EnableAttachments	Bool
EnableFolderCreation	Bool
EnableMinorVersions	Bool
EnableModeration	Bool
EnableRequestSignOff	Bool
EnableVersioning	Bool
EntityTypeName	String
ExcludeFromOfflineClient	Bool
ExemptFromBlockDownloadOfNonViewableFiles	Bool
FileSavePostProcessingEnabled	Bool
ForceCheckout	Bool
HasExternalDataSource	Bool
Hidden	Bool
ImagePath_DecodedUrl	String
ImageUrl	String
IrmEnabled	Bool
IrmExpire	Bool
IrmReject	Bool
IsApplicationList	Bool
IsCatalog	Bool
IsEnterpriseGalleryLibrary	Bool
IsPrivate	Bool
IsSiteAssetsLibrary	Bool
IsSystemList	Bool
ItemCount	Int
LastItemDeletedDate	Datetime
LastItemModifiedDate	Datetime
LastItemUserModifiedDate	Datetime
ListExperienceOptions	Int
ListItemEntityTypeFullName	String
MajorVersionLimit	Int
MajorWithMinorVersionsLimit	Int
MultipleDataList	Bool
NoCrawl	Bool
OnQuickLaunch	Bool
PageRenderType	Int
ParentWebPath_DecodedUrl	String
ParentWebUrl	String
ParserDisabled	Bool
ReadSecurity	Int
SchemaXml	String
ServerTemplateCanCreateFolders	Bool
TemplateFeatureId	String
Title	String
ValidationFormula	String
ValidationMessage	String
WriteSecurity	Int
LinkedContentTypes	String
LinkedCreatablesInfo	String
LinkedDefaultView	String
LinkedDescriptionResource	String
LinkedEventReceivers	String
LinkedFields	String
LinkedForms	String
LinkedInformationRightsManagementSettings	String
LinkedItems	String
LinkedParentWeb	String
LinkedRootFolder	String
LinkedSubscriptions	String
LinkedTitleResource	String
LinkedUserCustomActions	String
LinkedViews	String
LinkedWorkflowAssociations	String

This view represents general SharePoint items containing standard columns across various SharePoint lists.

Columns

Name	Type	References	Description
ID [KEY]	Int		Unique identifier for the list item.
Title	String		Title of the list item.
Attachments	Bool		Indicates if the item has attachments.
Description	String		Detailed description of the item.
List [KEY]	String	Lists.Title	The display name of the list to retrieve items from.
ContentTypeID	String		Identifier for the content type of the item.
FileSystemObjectType	Int		Indicates the type of object in the file system, such as: '-1': Invalid, '0': File, '1': Folder, '2': Web.
GUID	String		Globally unique identifier for the item.
Version	String		The version string of the item indicates its version history.
CreatedBy	Int	Users.Id	Identifier for the author of the item.
ModifiedBy	Int	Users.Id	Identifier for the last editor of the item.
Created	Datetime		Date and time when the item was created.
Modified	Datetime		Date and time when the item was last modified.

Get Web RoleAssignments member.

Table Specific Information

Select

Note: PrincipalId is required to return RoleAssignmentMember.

SELECT * FROM RoleAssignmentMember WHERE PrincipalId = 3
SELECT * FROM RoleAssignmentMember WHERE List = 'TestApp' AND PrincipalId = 3
SELECT * FROM RoleAssignmentMember WHERE PrincipalId = 5 AND list = 'MyTestList' AND ItemId = '3'

Columns

Name	Type	References	Description
ID [KEY]	Int		The ID of the role assigned member.
Updated	Datetime		The updated date for role assigned member.
IsHiddenInUI	Boolean		A Boolean indicating if the assigned role member is hidden in UI.
LoginName	String		The login name of the role assigned member.
Title	String		The title of the role assigned member.
PrincipalType	Int		The principal type of the role assigned member. None = 0; User = 1; DistributionList = 2; SecurityGroup = 4; SharePointGroup = 8; All principal types = 15.
AllowMembersEditMembership	Boolean		A Boolean indicating whether to allow members edit membership.
AllowRequestToJoinLeave	Boolean		A Boolean indicating whether to allow request to join leave.
AutoAcceptRequestToJoinLeave	Boolean		A Boolean indicating whether to auto accept request to join leave.
Description	String		The description of the role assigned member.
OnlyAllowMembersViewMembership	Boolean		A Boolean indicating whether to only allow members view membership.
OwnerTitle	String		The owner title of the role assigned member.
RequestToJoinLeaveEmailSetting	String		The request to join leave email setting of the role assigned member.
List	String	Lists.Title	The display name of the list to retrieve role assigned member from.
ItemId	Int		List item id for role assignment.
PrincipalId	Int	RoleAssignments.PrincipalId	The Principal Id.

Acquires Web RoleAssignments.

Table Specific Information

Select

SELECT * FROM RoleAssignments WHERE List = 'TestApp'
SELECT * FROM RoleAssignments WHERE PrincipalId = 5 AND list = 'MyListName' AND ItemId = '3'

Columns

Name	Type	References	Description
ID [KEY]	String		The Id of the role assigned.
PrincipalId	Int		The Principal ID for role assigned.
Updated	Datetime		The updated date for role assigned.
List	String	Lists.Title	The display name of the list to retrieve role assigned from.
ItemId	Int		List item id for role assignments.

Get Web Role definition binding.

Table Specific Information

Select

NOTE: PrincipalId is required to return RoleDefinitionBindings.

SELECT * FROM RoleDefinitionBindings WHERE PrincipalId = 3
SELECT * FROM RoleDefinitionBindings WHERE List = 'TestApp' AND PrincipalId = 3
SELECT * FROM RoleDefinitionBindings WHERE PrincipalId = 5 AND list = 'KatsunariMatsumoto' AND ItemId = '3'

Columns

Name	Type	References	Description
PrincipalId [KEY]	Int	RoleAssignments.PrincipalId	The Principal Id.
ID [KEY]	Int		The ID of the role assigned member.
BasePermissions_High	Long		The base permissions high.
BasePermissions_Low	Long		The base permissions low.
Description	String		The description.
Hidden	Boolean		A Boolean indicating if it is hidden.
Name	String		The name.
Order	Int		The order.
RoleTypeKind	Int		The role type kind.
List	String	Lists.Title	The display name of the list to retrieve role assigned member from.
ItemId	Int		List item id for role defintion.

Contains details about role definitions available in the SharePoint site collection.

Columns

Name	Type	References	Description
Id [KEY]	Int		Specifies the unique identifier of the role definition.
BasePermissions_High	Long		Specifies the high-level base permissions set for the role definition.
BasePermissions_Low	Long		Specifies the low-level base permissions set for the role definition.
Description	String		Provides a description of the role definition's purpose and permissions.
Hidden	Bool		Indicates whether the role definition is hidden from the Permission Levels page.
Name	String		Defines the name assigned to the role definition.
Order	Int		Specifies the display order of the role definition on the Permission Levels page in the site collection.
RoleTypeKind	Int		Represents the type of role definition, mapping to an SP.RoleType enumeration.

This lists the available subsites.

Columns

Name	Type	References	Description
Id [KEY]	String		The Id of the subsite.
AllowRssFeeds	Boolean		The AllowRssFeeds of the subsite.
AlternateCssUrl	String		The AlternateCssUrl of the subsite.
AppInstanceId	String		The AppInstanceId of the subsite.
ClassicWelcomePage	String		The ClassicWelcomePage of the subsite.
Configuration	Int		The Configuration of the subsite.
Created	Datetime		The Created of the subsite.
CurrentChangeToken_StringValue	String		The CurrentChangeToken_StringValue of the subsite.
CustomMasterUrl	String		The CustomMasterUrl of the subsite.
Description	String		The Description of the subsite.
DesignPackageId	String		The DesignPackageId of the subsite.
DocumentLibraryCalloutOfficeWebAppPreviewersDisabled	Boolean		The DocumentLibraryCalloutOfficeWebAppPreviewersDisabled of the subsite.
EnableMinimalDownload	Boolean		The EnableMinimalDownload of the subsite.
FooterEmphasis	Int		The FooterEmphasis of the subsite.
FooterEnabled	Boolean		The FooterEnabled of the subsite.
FooterLayout	Int		The FooterLayout of the subsite.
HeaderEmphasis	Int		The HeaderEmphasis of the subsite.
HeaderLayout	Int		The HeaderLayout of the subsite.
HideTitleInHeader	Boolean		The HideTitleInHeader of the subsite.
HorizontalQuickLaunch	Boolean		The HorizontalQuickLaunch of the subsite.
IsHomepageModernized	Boolean		The IsHomepageModernized of the subsite.
IsMultilingual	Boolean		The IsMultilingual of the subsite.
IsRevertHomepageLinkHidden	Boolean		The IsRevertHomepageLinkHidden of the subsite.
Language	Int		The Language of the subsite.
LastItemModifiedDate	Datetime		The LastItemModifiedDate of the subsite.
LastItemUserModifiedDate	Datetime		The LastItemUserModifiedDate of the subsite.
LogoAlignment	Int		The LogoAlignment of the subsite.
MasterUrl	String		The MasterUrl of the subsite.
MegaMenuEnabled	Boolean		The MegaMenuEnabled of the subsite.
NavAudienceTargetingEnabled	Boolean		The NavAudienceTargetingEnabled of the subsite.
NoCrawl	Boolean		The NoCrawl of the subsite.
ObjectCacheEnabled	Boolean		The ObjectCacheEnabled of the subsite.
OverwriteTranslationsOnChange	Boolean		The OverwriteTranslationsOnChange of the subsite.
ResourcePath_DecodedUrl	String		The ResourcePath_DecodedUrl of the subsite.
QuickLaunchEnabled	Boolean		The QuickLaunchEnabled of the subsite.
RecycleBinEnabled	Boolean		The RecycleBinEnabled of the subsite.
SearchScope	Int		The SearchScope of the subsite.
ServerRelativeUrl	String		The ServerRelativeUrl of the subsite.
SiteLogoUrl	String		The SiteLogoUrl of the subsite.
SyndicationEnabled	Boolean		The SyndicationEnabled of the subsite.
TenantAdminMembersCanShare	Int		The TenantAdminMembersCanShare of the subsite.
Title	String		The Title of the subsite.
TreeViewEnabled	Boolean		The TreeViewEnabled of the subsite.
UIVersion	Int		The UIVersion of the subsite.
UIVersionConfigurationEnabled	Boolean		The UIVersionConfigurationEnabled of the subsite.
Url	String		The Url of the subsite.
WebTemplate	String		The WebTemplate of the subsite.
WelcomePage	String		The WelcomePage of the subsite.
AccessRequestListUrl	String		The AccessRequestListUrl of the subsite.
AccessRequestSiteDescription	String		The AccessRequestSiteDescription of the subsite.
Acronym	String		The Acronym of the subsite.
AllowAutomaticASPXPageIndexing	Boolean		The AllowAutomaticASPXPageIndexing of the subsite.
AllowCreateDeclarativeWorkflowForCurrentUser	Boolean		The AllowCreateDeclarativeWorkflowForCurrentUser of the subsite.
AllowDesignerForCurrentUser	Boolean		The AllowDesignerForCurrentUser of the subsite.
AllowMasterPageEditingForCurrentUser	Boolean		The AllowMasterPageEditingForCurrentUser of the subsite.
AllowRevertFromTemplateForCurrentUser	Boolean		The AllowRevertFromTemplateForCurrentUser of the subsite.
AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser	Boolean		The AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser of the subsite.
AllowSavePublishDeclarativeWorkflowForCurrentUser	Boolean		The AllowSavePublishDeclarativeWorkflowForCurrentUser of the subsite.
CommentsOnSitePagesDisabled	Boolean		The CommentsOnSitePagesDisabled of the subsite.
ContainsConfidentialInfo	Boolean		The ContainsConfidentialInfo of the subsite.
CustomSiteActionsDisabled	Boolean		The CustomSiteActionsDisabled of the subsite.
DefaultNewPageTemplateId	String		The DefaultNewPageTemplateId of the subsite.
DescriptionForExistingLanguage	String		The DescriptionForExistingLanguage of the subsite.
DescriptionTranslations	String		The DescriptionTranslations of the subsite.
DesignerDownloadUrlForCurrentUser	String		The DesignerDownloadUrlForCurrentUser of the subsite.
DisableAppViews	Boolean		The DisableAppViews of the subsite.
DisableFlows	Boolean		The DisableFlows of the subsite.
DisableRecommendedItems	Boolean		The DisableRecommendedItems of the subsite.
EffectiveBasePermissions_High	Long		The EffectiveBasePermissions_High of the subsite.
EffectiveBasePermissions_Low	Long		The EffectiveBasePermissions_Low of the subsite.
ExcludeFromOfflineClient	Boolean		The ExcludeFromOfflineClient of the subsite.
HasWebTemplateExtension	Boolean		The HasWebTemplateExtension of the subsite.
IsEduClass	Boolean		The IsEduClass of the subsite.
IsEduClassProvisionChecked	Boolean		The IsEduClassProvisionChecked of the subsite.
IsEduClassProvisionPending	Boolean		The IsEduClassProvisionPending of the subsite.
IsProvisioningComplete	Boolean		The IsProvisioningComplete of the subsite.
LastItemModifiedDate	Datetime		The LastItemModifiedDate of the subsite.
LastItemUserModifiedDate	Datetime		The LastItemUserModifiedDate of the subsite.
LogoAlignment	Int		The LogoAlignment of the subsite.
NotificationsInOneDriveForBusinessEnabled	Boolean		The NotificationsInOneDriveForBusinessEnabled of the subsite.
NotificationsInSharePointEnabled	Boolean		The NotificationsInSharePointEnabled of the subsite.
PrimaryColor	String		The PrimaryColor of the subsite.
RelatedHubSiteIds	String		The RelatedHubSiteIds of the subsite.
RequestAccessEmail	String		The RequestAccessEmail of the subsite.
SaveSiteAsTemplateEnabled	Boolean		The SaveSiteAsTemplateEnabled of the subsite.
SearchBoxInNavBar	Int		The SearchBoxInNavBar of the subsite.
SearchBoxPlaceholderText	String		The SearchBoxPlaceholderText of the subsite.
ServerRelativePath_DecodedUrl	String		The ServerRelativePath_DecodedUrl of the subsite.
ShowUrlStructureForCurrentUser	Boolean		The ShowUrlStructureForCurrentUser of the subsite.
SiteLogoDescription	String		The SiteLogoDescription of the subsite.
SupportedUILanguageIds	String		The SupportedUILanguageIds of the subsite.
TenantTagPolicyEnabled	Bit		The TenantTagPolicyEnabled of the subsite.
ThemeData	String		The ThemeData of the subsite.
ThemedCssFolderUrl	String		The ThemedCssFolderUrl of the subsite.
ThirdPartyMdmEnabled	Boolean		The ThirdPartyMdmEnabled of the subsite.
TitleForExistingLanguage	String		The TitleForExistingLanguage of the subsite.
TitleTranslations	String		The TitleTranslations of the subsite.
WebTemplateConfiguration	String		The WebTemplateConfiguration of the subsite.
WebTemplatesGalleryFirstRunEnabled	Boolean		The WebTemplatesGalleryFirstRunEnabled of the subsite.
WebTemplatesGalleryFirstRunComplete	Boolean		The WebTemplatesGalleryFirstRunComplete of the subsite.

Represents users and their roles in the SharePoint site or group.

Table Specific Information

Select

SELECT * FROM Users // Fetch all the Users
SELECT * FROM Users WHERE GroupId = 5 // Fetch a user for a particular Group

Columns

Name	Type	References	Description
Id [KEY]	Int		Unique identifier for each user in the SharePoint environment.
LoginName	String		The unique login name used by the user to access the SharePoint environment.
Title	String		The display name or title associated with the user.
IsHiddenInUI	Bool		Indicates whether the user is hidden from the SharePoint user interface.
GroupId	Int		The identifier of the group to which the user belongs.
AadObjectId_NameId	String		Azure Active Directory (AAD) object ID representing the user's unique identifier.
AadObjectId_NameIdIssuer	String		The issuer of the Azure Active Directory (AAD) NameId for the user.
Email	String		Primary email address associated with the user.
EmailWithFallback	String		An alternate or fallback email address for the user if the primary is unavailable.
Expiration	String		Specifies the expiration date of the user's access, if applicable.
HexCid	String		A hexadecimal representation of the user's client ID.
IsEmailAuthenticationGuestUser	Bool		Indicates if the user is a guest authenticated via email.
IsShareByEmailGuestUser	Bool		Indicates if the user is a guest invited via email for sharing purposes.
IsSiteAdmin	Bool		Specifies whether the user has administrative rights for the site collection.
UserId_NameId	String		The unique identifier for the user in SharePoint's user ID system.
UserId_NameIdIssuer	String		The issuer of the user's ID in SharePoint's user ID system.
UserPrincipalName	String		User Principal Name (UPN) for the user, usually an email-style identifier.
PrincipalType	Int		Defines the type of principal, using bitwise values: None=0, User=1, DistributionList=2, SecurityGroup=4, SharePointGroup=8, All=15.

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

接続を確立する方法について詳しくは、接続の確立を参照してください。

Authentication

---

プロパティ	説明
AuthScheme	SharePoint への認証に使用されるスキーム。
URL	サイトのベースURL。
SharePointEdition	使用されているSharePoint のエディション。SharePoint Online またはSharePoint On-Premise のいずれかを設定します。
User	認証で使用されるSharePoint ユーザーアカウント。
Password	ユーザーの認証で使用されるパスワード。

Azure Authentication

---

プロパティ	説明
AzureTenant	データにアクセスするために使用されるMicrosoft SharePoint テナントを、名前（例えば、contoso.omnicrosoft.com）またはID で識別します。（条件付き）
AzureEnvironment	接続を確立するときに使用するAzure 環境。

SSO

---

プロパティ	説明
SSOLoginURL	ID プロバイダーのログインURL。
SSODomain	シングルサインオン（SSO）を使用する場合のユーザーのドメイン。
SSOProperties	ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。

OAuth

---

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

JWT OAuth

---

プロパティ	説明
OAuthJWTCert	JWT 証明書のストア。
OAuthJWTCertType	JWT 証明書を格納するキーストアの種類。
OAuthJWTCertPassword	OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTIssuer	Java Web Token の発行者。

Kerberos

---

プロパティ	説明
KerberosKDC	ユーザーの認証で使用されるKerberos キー配布センター（KDC）サービス。
KerberosRealm	ユーザー認証に使用されるKerberos 領域。
KerberosSPN	Kerberos ドメインコントローラーのサービスプリンシパル名（SPN）。
KerberosUser	Kerberos ドメインコントローラーのプリンシパル名。host/user@realm の形式で使用されます。
KerberosKeytabFile	Kerberos プリンシパルと暗号化されたキーのペアを含むKeytab ファイル。
KerberosServiceRealm	サービスのKerberos レルム。
KerberosServiceKDC	サービスのKerberos KDC。
KerberosTicketCache	MIT Kerberos 資格情報キャッシュファイルへのフルパス。

SSL

---

プロパティ	説明
SSLClientCert	SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。
SSLClientCertType	SSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。
SSLClientCertPassword	TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。
SSLClientCertSubject	TLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Firewall

---

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

Proxy

---

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

Schema

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
Schema	使用するスキーマの種類。

Miscellaneous

---

プロパティ	説明
CalculatedDataType	計算フィールドで使用されるデータ型。このプロパティはSOAP スキーマにのみ適用されます。
ContinueOnError	エラー後にバッチ内の項目の更新を続行するかどうかを示します。
CreateIDColumns	他のリストに格納されている情報からの値を使っているSharePoint 列に補助的ID 列を作成します。このプロパティはSOAP スキーマにのみ適用されます。
DisableFilterLimit	Microsoft SharePoint natively supports listing up to 5000 records as they appear in your list filter. Use this property to pull more than 5000 records from the list filter at the cost of additional performance overhead. This property applies only to the REST schema.
FolderOption	結果にフォルダを表示する方法を決定するオプション。FilesOnly、FilesAndFolders、Recursive、RecursiveAll のいずれかを入力します。このプロパティはSOAP スキーマにのみ適用されます。
GetColumnsMetadata	Specifies when the provider should retrieve column metadata. This property applies only to the REST schema.
IncludeLookupColumns	このオプションは、ドライバーがテーブルで定義されたルックアップ列を返すかどうかを設定します。このプロパティはSOAP スキーマにのみ適用されます。
IncludeLookupDisplayValueColumns	Determines whether the display values for lookup columns should be included. This property applies only to the REST schema.
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Pagesize	Microsoft SharePoint から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
ShowHiddenColumns	非表示の列を表示するかどうかを決定するboolean。false の場合は、すべての非表示の列が列リストから削除されます。
ShowPredefinedColumns	定義済みの列を表示するかどうかを決定するboolean。false の場合は、基本型から派生されたすべての列が列リストから削除されます。
ShowVersionViews	メタデータの検出時にリストバージョンのビューを含めるかどうかを示します。このプロパティはSOAP スキーマにのみ適用されます。
STSURL	シングルサインオン（SSO）を使用する場合のセキュリティトークンサービス（STS）のURL。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UseDisplayNames	API 名の代わりにカラムの表示名を使用するかどうかを決定するboolean。
UseEntityTypeName	Boolean determining if the list's EntityTypeName field should be used as the table name during metadata discovery instead of the Title field. This property applies only to the REST schema.
UseNTLMV1	ドライバーが、NTLMv1 かNTLMv2（デフォルト）のどちらで接続するかを決定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
UseSimpleNames	テーブルとカラムに簡略名を使用するかどうかを決定するboolean。

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

---

プロパティ	説明
AuthScheme	SharePoint への認証に使用されるスキーム。
URL	サイトのベースURL。
SharePointEdition	使用されているSharePoint のエディション。SharePoint Online またはSharePoint On-Premise のいずれかを設定します。
User	認証で使用されるSharePoint ユーザーアカウント。
Password	ユーザーの認証で使用されるパスワード。

SharePoint への認証に使用されるスキーム。

解説

SharePoint オンプレミスインスタンスに対して認証を行う場合、Password およびUser とともにこのフィールドはサーバーに対する認証に使用されます。デフォルトのオプションはNTLM です。次のオプションを使って、認証スキームを選択してください。

• NTLM：認証にWindows クレデンシャルを使う場合に設定。
• Negotiate：AuthScheme がNegotiate に設定された場合、Sync App は認証メカニズムをサーバーとネゴシエートします。Kerberos 認証を使いたい場合はAuthScheme をNegotiate に設定します。
• None：匿名認証を使用する場合に設定。例えばパブリックサイトにアクセスする場合です。
• Basic：HTTP Basic 認証を使う場合に設定。
• ADFS：ADFS でシングルサインオン認証を使う場合に設定。

SharePoint Online に認証する場合、AzureAD がデフォルトのオプションです。次のオプションを使って、認証スキームを選択してください。

• AzureAD：Azure Active Directory OAuth 認証を実行する場合に設定。
• AzureServicePrincipalCert：証明書を使用してAzure サービスプリンシパルとして認証する場合に設定。
• AzurePassword：Password GrantType でOAuth 認証を使う場合に設定。
• PingFederate：PingFederate でシングルサインオン認証を使う場合に設定。
• ADFS：ADFS でシングルサインオン認証を使う場合に設定。
• OneLogin：OneLogin でシングルサインオン認証を使う場合に設定。
• OKTA：OKTA でシングルサインオン認証を使う場合に設定。
• AzureMSI：Azure VM で実行しているときに、マネージドサービスID の資格情報を自動的に取得するために設定。
• SharePointOAuth：Sharepoint アプリクライアントクレデンシャルによるOAuth 認証を使う場合に設定。

サイトのベースURL。

解説

以下は有効なURL の例です。

• http://server/SharePoint/
• http://server/Sites/mysite/
• http://server:90/

プロバイダーは、URL を使用して、他のサーバー呼び出しのためのURL を派生します。

使用されているSharePoint のエディション。SharePoint Online またはSharePoint On-Premise のいずれかを設定します。

解説

使用されているSharePoint のエディション。SharePoint Online またはSharePoint On-Premise のいずれかを設定します。

認証で使用されるSharePoint ユーザーアカウント。

解説

このフィールドは、Password とともに、SharePoint サーバーに対して認証をするために使われます。

SharePoint On-Premise では、User にドメインを含める必要があり、User は"DOMAIN\Username" のようになります。

SharePoint Onlineでは、User は"[email protected]" のようになります。

ユーザーの認証で使用されるパスワード。

解説

User およびPassword を一緒に使用してサーバーで認証を行います。

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

---

プロパティ	説明
AzureTenant	データにアクセスするために使用されるMicrosoft SharePoint テナントを、名前（例えば、contoso.omnicrosoft.com）またはID で識別します。（条件付き）
AzureEnvironment	接続を確立するときに使用するAzure 環境。

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

解説

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

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

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

接続を確立するときに使用するAzure 環境。

解説

ほとんどの場合、環境をグローバルに設定したままにしておくとうまく機能します。ただし、Azure アカウントを別の環境に追加している場合は、AzureEnvironment を使用してどの環境かを指定できます。利用可能な値はGLOBAL、CHINA、USGOVT、およびUSGOVTDOD です。

このプロパティを使って、使用しているクラウドに基づいてURL サフィックスの問題を解決します（例えば、URL が.us で終わる場合はUSGOVT に設定）。設定についての詳細は、こちらからご覧いただけます： 「各国のクラウド」についてのMicrosoft ドキュメント。

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

---

プロパティ	説明
SSOLoginURL	ID プロバイダーのログインURL。
SSODomain	シングルサインオン（SSO）を使用する場合のユーザーのドメイン。
SSOProperties	ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。

ID プロバイダーのログインURL。

解説

ID プロバイダーのログインURL。

シングルサインオン（SSO）を使用する場合のユーザーのドメイン。

解説

このプロパティは、シングルサインオンを使用する場合（UseSSO がSSO 認証スキームを使用するように設定されている場合）でUser のドメイン（例：[email protected]）がSSO サービスで設定されたドメイン（例：[email protected]）と異なる場合のみ適用可能です。

このプロパティは、ADFS、OneLogin またはOKTA SSO サービス使用時に必要になる場合があります。

ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。

解説

ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。SSOLoginURL と一緒に使用します。

SSO 設定については、 で詳しく説明します。

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

---

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

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

解説

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

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

解説

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

The scope used for the OAuth flow to access data from the Application.

解説

The scope used for the OAuth flow to access data from the Application.

Note: If not specified or left to 'NONE', the Sync App sets the default scope dependant upon OAuthGrantType. Defaults to 'AllSites.Manage' unless using JWT OAuth, Azure Service Principal, or CLIENT grant type. The available values are:

• AllSites.Read: Enables reading custom lists
• AllSites.Write: Enables reading & writing custom lists
• AllSites.Manage: Enables reading, writing and creating custom lists
• .default: Requests application permissions without a user context. All the application permissions that have been granted for that web API are included in the retrieved OAuthAccessToken.

追加のOAuth ステート情報を表すオプションの値。

解説

追加のOAuth ステート情報を表すオプションの値。

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

解説

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

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

---

プロパティ	説明
OAuthJWTCert	JWT 証明書のストア。
OAuthJWTCertType	JWT 証明書を格納するキーストアの種類。
OAuthJWTCertPassword	OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTIssuer	Java Web Token の発行者。

JWT 証明書のストア。

解説

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

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

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

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

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

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

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

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

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

解説

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

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

解説

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

Java Web Token の発行者。

解説

Java Web Token の発行者。 ほとんどの場合、これはOAuth App Id（クライアントId）接続プロパティの値を使用するため、個別に設定する必要はありません。

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

---

プロパティ	説明
KerberosKDC	ユーザーの認証で使用されるKerberos キー配布センター（KDC）サービス。
KerberosRealm	ユーザー認証に使用されるKerberos 領域。
KerberosSPN	Kerberos ドメインコントローラーのサービスプリンシパル名（SPN）。
KerberosUser	Kerberos ドメインコントローラーのプリンシパル名。host/user@realm の形式で使用されます。
KerberosKeytabFile	Kerberos プリンシパルと暗号化されたキーのペアを含むKeytab ファイル。
KerberosServiceRealm	サービスのKerberos レルム。
KerberosServiceKDC	サービスのKerberos KDC。
KerberosTicketCache	MIT Kerberos 資格情報キャッシュファイルへのフルパス。

ユーザーの認証で使用されるKerberos キー配布センター（KDC）サービス。

解説

Kerberos のプロパティは、SPNEGO またはWindows 認証を使用する場合に使用されます。Sync App は、Kerberos KDC サービスにセッションチケットと一時セッションキーを要求します。Kerberos KDC サービスは、通常、ドメインコントローラーと同じコンピュータに置かれています。

Kerberos KDC が指定されていない場合、Sync App は、これらのプロパティを自動的に次の場所から検出しようとします。

• KRB5 Config File (krb5.ini/krb5.conf)： KRB5_CONFIG 環境変数が設定され、ファイルが存在する場合、Sync App は指定されたファイルからKDC を取得します。それ以外の場合は、OS に基づいてデフォルトのMIT ロケーションからの読み取りを試みます：C:\ProgramData\MIT\Kerberos5\krb5.ini (Windows) または/etc/krb5.conf (Linux)。
• ドメイン名およびホスト： Kerberos 領域およびKerberos KDC が別の場所から推測できなかった場合、Sync App は設定されているドメイン名およびホストからそれらを推測します。

Kerberos のプロパティは、SPNEGO またはWindows 認証を使用する場合に使用されます。Sync App は、Kerberos KDC サービスにセッションチケットと一時セッションキーを要求します。Kerberos KDC サービスは、通常、ドメインコントローラーと同じコンピュータに置かれています。

Kerberos KDC が指定されていない場合、Sync App は、これらのプロパティを自動的に次の場所から検出しようとします。

• KRB5 Config File (krb5.ini/krb5.conf)： KRB5_CONFIG 環境変数が設定され、ファイルが存在する場合、Sync App は指定されたファイルからKDC を取得します。それ以外の場合は、OS に基づいてデフォルトのMIT ロケーションからの読み取りを試みます：C:\ProgramData\MIT\Kerberos5\krb5.ini (Windows) または/etc/krb5.conf (Linux)。
• ドメイン名およびホスト： Kerberos 領域およびKerberos KDC が別の場所から推測できなかった場合、Sync App は設定されているドメイン名およびホストからそれらを推測します。

ユーザー認証に使用されるKerberos 領域。

解説

Kerberos のプロパティは、SPNEGO またはWindows 認証を使用する場合に使用されます。Kerberos 領域は、Kerberos キー配布センター（KDC）サービスを使用してユーザーを認証するために使用されます。Kerberos 領域は、管理者が任意の文字列に設定できますが、通常はドメイン名に基づいて設定されます。

Kerberos 領域が指定されていない場合、Sync App は、これらのプロパティを自動的に次の場所から検出しようとします。

• KRB5 Config File (krb5.ini/krb5.conf)： KRB5_CONFIG 環境変数が設定され、ファイルが存在する場合、Sync App は指定されたファイルからデフォルトレルムを取得します。それ以外の場合は、OS に基づいてデフォルトのMIT ロケーションからの読み取りを試みます：C:\ProgramData\MIT\Kerberos5\krb5.ini (Windows) または/etc/krb5.conf (Linux)
• ドメイン名およびホスト： Kerberos 領域およびKerberos KDC が別の場所から推測できなかった場合、Sync App はユーザー設定されているドメイン名およびホストからそれらを推測します。これは、一部のWindows 環境で機能します。

Kerberos ドメインコントローラーのサービスプリンシパル名（SPN）。

解説

Kerberos ドメインコントローラーのSPN が認証先のURL と異なる場合は、このプロパティを使用してSPN を設定します。

Kerberos ドメインコントローラーのSPN が認証先のURL と異なる場合は、このプロパティを使用してSPN を設定します。

Kerberos ドメインコントローラーのプリンシパル名。host/user@realm の形式で使用されます。

解説

データベースに使用しているユーザーがKerberos データベース内のユーザーと一致しない場合、これをKerberos プリンシパル名に設定する必要があります。

Kerberos プリンシパルと暗号化されたキーのペアを含むKeytab ファイル。

解説

Kerberos のプリンシパルと暗号化されたキーのペアを含むKeytab ファイル。

サービスのKerberos レルム。

解説

KerberosServiceRealm は、クロスレルムKerberos 認証を使用するときにサービスKerberos レルムを指定するために使われます。

ほとんどの場合、単一のレルムとKDC マシンがKerberos 認証を実行するために使用され、このプロパティは必要ありません。

このプロパティは、異なるレルムとKDC マシンを使用して認証チケット（AS リクエスト）およびサービスチケット（TGS リクエスト）を取得する、より複雑な設定で使用できます。

サービスのKerberos KDC。

解説

KerberosServiceKDC は、クロスレルムKerberos 認証を使用するときにサービスKerberos KDC を指定するために使われます。

ほとんどの場合、単一のレルムとKDC マシンがKerberos 認証を実行するために使用され、このプロパティは必要ありません。

このプロパティは、異なるレルムとKDC マシンを使用して認証チケット（AS リクエスト）およびサービスチケット（TGS リクエスト）を取得する、より複雑な設定で使用できます。

MIT Kerberos 資格情報キャッシュファイルへのフルパス。

解説

このプロパティは、MIT Kerberos チケットマネージャーまたはkinit コマンドを使用して作成された資格情報キャッシュファイルを使用する場合に設定できます。

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

---

プロパティ	説明
SSLClientCert	SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。
SSLClientCertType	SSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。
SSLClientCertPassword	TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。
SSLClientCertSubject	TLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。

解説

このプロパティは、SSL クライアント認証のためのクライアント証明書ストアを指定します。 このプロパティは、証明書ストアの種類を定義するSSLClientCertType、およびパスワードで保護されたストア用のパスワードを指定するSSLClientCertPassword と一緒に使用します。 SSLClientCert が設定され、SSLClientCertSubject が設定されている場合、ドライバーは指定されたサブジェクトに一致する証明書を検索します。

証明書ストアの指定はプラットフォームによって異なります。 Windowsでは、証明書ストアはMY（個人証明書）などの名前で識別されますが、Java では、証明書ストアは通常、証明書とオプションの秘密キーを含むファイルです。

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

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

PFXFile タイプの場合、このプロパティをファイル名に設定します。PFXBlob タイプの場合は、このプロパティをPKCS12 形式のファイルのバイナリコンテンツに設定します。

SSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。

解説

このプロパティは、クライアント証明書を指定するために使用されるキーストアの形式と場所を決定します。 サポートされている値には、プラットフォーム固有およびユニバーサルなキーストア形式があります。 有効な値と使用方法は以下のとおりです。

USER - デフォルト	Windows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。この種類はJava では利用できませんので注意してください。
MACHINE	Windows の場合、この証明書ストアがシステムストアであることを指定します。この種類はJava では利用できませんので注意してください。
PFXFILE	この証明書ストアは、証明書を含むPFX（PKCS12）ファイルの名前です。
PFXBLOB	この証明書ストアは、PFX（PKCS12）形式の証明書ストアを表すBase-64でエンコードされた文字列です。
JKSFILE	この証明書ストアは、証明書を含むJava key store（JKS）ファイルの名前です。この種類はJava でのみ利用できますので注意してください。
JKSBLOB	この証明書ストアは、Java key store（JKS）形式の証明書ストアを表すBase-64でエンコードされた文字列です。この種類は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エンコード）です。

TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。

解説

このプロパティは、パスワードで保護された証明書ストアを開くために必要なパスワードを指定します。 このプロパティは、PFX やJKS タイプのストアによく推奨されるように、復号化のためにパスワードを必要とする証明書ストアを使用する場合に必要です。

証明書ストアの種類がパスワードを必要としない場合（Windows のUSER やMACHINE など）、このプロパティは空白のままにできます。 認証エラーを回避するため、パスワードが指定された証明書ストアに関連付けられたものと一致していることを確認してください。

TLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。

解説

このプロパティは、サブジェクトに基づいてロードするクライアント証明書を決定します。Sync App は、指定されたサブジェクトに完全に一致する証明書を検索します。 完全に一致するものが見つからない場合、Sync App はサブジェクトの値を含む証明書を検索します。 一致する証明書がない場合、証明書は選択されません。

サブジェクトは、識別名フィールドと値のカンマ区切りリストという標準の形式に従うべきです。 例えば、CN=www.server.com, OU=Test, C=US です。一般的なフィールドには以下のものが含まれます。

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

Note： フィールドにカンマなどの特殊文字が含まれている場合は、値を引用符で囲む必要があります。例：CN="Example, Inc.", C=US。

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

解説

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

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

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

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

---

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Note：デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。

次の表は、サポートされている各プロトコルのポート番号情報です。

プロトコル	デフォルトポート	説明
TUNNEL	80	Sync App がMicrosoft SharePoint への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。
SOCKS4	1080	Sync App がMicrosoft SharePoint への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	Sync App がMicrosoft SharePoint にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールで使用するTCP ポートを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

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

---

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。

解説

この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします（プロキシサーバーの詳細を手動で入力する必要はありません）。

この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。

クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。

その他のプロキシタイプについては、FirewallType を参照してください。

ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。

解説

認証タイプは次のいずれかです。

• BASIC：Sync App はHTTP BASIC 認証を行います。
• DIGEST：Sync App はHTTP DIGEST 認証を行います。
• NTLM：Sync App はNTLM トークンを取得します。
• NEGOTIATE：Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
• NONE：ProxyServer が認証を必要としない場合に設定します。

"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

ProxyAuthScheme の値	ProxyUser に設定する値
BASIC	プロキシサーバーに登録されているユーザーのユーザー名。
DIGEST	プロキシサーバーに登録されているユーザーのユーザー名。
NEGOTIATE	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。
NTLM	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。
NONE	ProxyPassword 接続プロパティは設定しないでください。

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。

ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

ProxyAuthScheme の値	ProxyPassword に設定する値
BASIC	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
DIGEST	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
NEGOTIATE	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NTLM	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NONE	ProxyPassword 接続プロパティは設定しないでください。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。

ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。

AUTO	デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。

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

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

解説

このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。 ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。 各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。

例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。 複数のモジュールを含めるには、次のように名前をセミコロンで区切ります：INFO;EXEC;SSL。

Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。 利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。

利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログ の「高度なログの記録」セクションを参照してください。

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

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
Schema	使用するスキーマの種類。

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。

解説

Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

Note： Sync App は複数のスキーマをサポートするため、Microsoft SharePoint のカスタムスキーマファイルは以下のような構造にになります。

• 各スキーマには、そのスキーマ名に対応するフォルダが作られます。
• すべてのスキーマフォルダは、親フォルダに含まれる必要があります。

Location は常に親フォルダに設定されるべきで、個々のスキーマのフォルダに設定すべきではありません。

指定しない場合、デフォルトの場所は%APPDATA%\\CData\\SharePoint Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます：

プラットフォーム	%APPDATA%
Windows	APPDATA 環境変数の値
Linux	~/.config

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

解説

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

レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。

解説

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

利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。

レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

解説

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

利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。

使用するスキーマの種類。

解説

利用可能なスキーマは、REST（Sharepoint のREST API を使う場合）およびSOAP（Sharepoint のSOAP API を使う場合）です。

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

---

プロパティ	説明
CalculatedDataType	計算フィールドで使用されるデータ型。このプロパティはSOAP スキーマにのみ適用されます。
ContinueOnError	エラー後にバッチ内の項目の更新を続行するかどうかを示します。
CreateIDColumns	他のリストに格納されている情報からの値を使っているSharePoint 列に補助的ID 列を作成します。このプロパティはSOAP スキーマにのみ適用されます。
DisableFilterLimit	Microsoft SharePoint natively supports listing up to 5000 records as they appear in your list filter. Use this property to pull more than 5000 records from the list filter at the cost of additional performance overhead. This property applies only to the REST schema.
FolderOption	結果にフォルダを表示する方法を決定するオプション。FilesOnly、FilesAndFolders、Recursive、RecursiveAll のいずれかを入力します。このプロパティはSOAP スキーマにのみ適用されます。
GetColumnsMetadata	Specifies when the provider should retrieve column metadata. This property applies only to the REST schema.
IncludeLookupColumns	このオプションは、ドライバーがテーブルで定義されたルックアップ列を返すかどうかを設定します。このプロパティはSOAP スキーマにのみ適用されます。
IncludeLookupDisplayValueColumns	Determines whether the display values for lookup columns should be included. This property applies only to the REST schema.
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Pagesize	Microsoft SharePoint から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
ShowHiddenColumns	非表示の列を表示するかどうかを決定するboolean。false の場合は、すべての非表示の列が列リストから削除されます。
ShowPredefinedColumns	定義済みの列を表示するかどうかを決定するboolean。false の場合は、基本型から派生されたすべての列が列リストから削除されます。
ShowVersionViews	メタデータの検出時にリストバージョンのビューを含めるかどうかを示します。このプロパティはSOAP スキーマにのみ適用されます。
STSURL	シングルサインオン（SSO）を使用する場合のセキュリティトークンサービス（STS）のURL。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UseDisplayNames	API 名の代わりにカラムの表示名を使用するかどうかを決定するboolean。
UseEntityTypeName	Boolean determining if the list's EntityTypeName field should be used as the table name during metadata discovery instead of the Title field. This property applies only to the REST schema.
UseNTLMV1	ドライバーが、NTLMv1 かNTLMv2（デフォルト）のどちらで接続するかを決定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
UseSimpleNames	テーブルとカラムに簡略名を使用するかどうかを決定するboolean。

計算フィールドで使用されるデータ型。このプロパティはSOAP スキーマにのみ適用されます。

解説

デフォルト（Calculated）では、SharePoint の計算フィールドの型によってデータ型が判定されます。ただし、これらの計算フィールドが、指定された型に合わない値を返す場合があります。このような場合は、CalculatedDataType を適切な型に設定できます。

エラー後にバッチ内の項目の更新を続行するかどうかを示します。

解説

このプロパティをTrue（デフォルト）に設定すると、項目の1つでエラーが発生した場合も、Sync App は引き続き項目の追加、更新、削除を行います。False に設定すると、エラーが発生した後、Sync App は項目の追加、更新、削除を停止します（問題があるエントリの前にあるエントリは、引き続き追加、更新、削除されます）。

このプロパティはSOAP とREST スキーマの両方に適用されます。

他のリストに格納されている情報からの値を使っているSharePoint 列に補助的ID 列を作成します。このプロパティはSOAP スキーマにのみ適用されます。

解説

true の場合、Sync App は他のリストに格納されている情報からの値を使っている（"Lookup" または"Person or Group" 列のように）SharePoint 列に補助的ID 列を作成します。作成されたID 列は関連するエントリーのID をオリジナルリストのコンテキストの中で保有します。

false に設定されている場合にはID は作成されず、ID は無視されID は参照列の値のみが返されます。

Microsoft SharePoint natively supports listing up to 5000 records as they appear in your list filter. Use this property to pull more than 5000 records from the list filter at the cost of additional performance overhead. This property applies only to the REST schema.

解説

Regardless of whether this property is set to true or false, for list filters with 5000 or fewer records, server-side processing of list filter queries is supported by Microsoft SharePoint, leading to the fastest possible performance.

When this property is set to true and the list filter exceeds 5000 entries, the Sync App will delegate the filters to the server, and they will be processed server-side. Note that trying to pull more than 5000 entries this way will likely result in a server error.

However, if this property is set to false (the default behavior) and the list filter exceeds 5000 entries, the Sync App will query from the list itself (as opposed to the list filter) and the filtering will be done client-side, which has an extra cost to performance.

結果にフォルダを表示する方法を決定するオプション。FilesOnly、FilesAndFolders、Recursive、RecursiveAll のいずれかを入力します。このプロパティはSOAP スキーマにのみ適用されます。

解説

• FilesOnly は、指定されたリストまたはライブラリ内のファイルだけを表示します。
• FilesAndFolders は、指定されたリスト内のファイルとフォルダを表示します。
• RecursiveAll は、指定されたリストとすべてのサブフォルダ内のファイルを表示します。

Specifies when the provider should retrieve column metadata. This property applies only to the REST schema.

解説

Available settings:

• OnStart: The Sync App retrieves and caches metadata for all columns in every table before executing the first statement.
• OnUse: The Sync App retrieves table-specific metadata the first time the table is referenced, if the metadata is not already cached.

このオプションは、ドライバーがテーブルで定義されたルックアップ列を返すかどうかを設定します。このプロパティはSOAP スキーマにのみ適用されます。

解説

SharePoint サーバーは、1つのクエリに多数のルックアップ列が含まれている場合、リクエストを拒否します。

Determines whether the display values for lookup columns should be included. This property applies only to the REST schema.

解説

For the REST schema, the driver will by default push the record identifiers from which a list lookup column retrieves the data from. For example:

MultiLookUpColumn=1, 2

When this property is enabled (true), an additional column (name is suffixed with _DisplayValue) for each lookup column will be listed during metadata retrieval, from which the actual data of the looked-up column can be queried. For example:

MultiLookUpColumn=1, 2
MultiLookUpColumn_DisplayValue=United States, United Kingdom

Note that enabling this connection property will likely result in worse performance, because the server will need more time and resources to retrieve the values of the look up columns.

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

解説

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

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

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

特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

解説

このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティをセミコロン区切りのリストで定義できます。

Note： 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット

DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

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

解説

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

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

解説

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

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

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

非表示の列を表示するかどうかを決定するboolean。false の場合は、すべての非表示の列が列リストから削除されます。

解説

このプロパティはSOAP とREST スキーマの両方に適用されます。

定義済みの列を表示するかどうかを決定するboolean。false の場合は、基本型から派生されたすべての列が列リストから削除されます。

解説

定義済みの列を表示するかどうかを決定するboolean。false の場合は、基本型から派生されたすべての列が列リストから削除されます。 通常、これはCreatedBy やAuthor などのシステム列です。ただし、定義済みの列にはTitle などの一般的な列が含まれることもあります。

このプロパティはSOAP とREST スキーマの両方に適用されます。

メタデータの検出時にリストバージョンのビューを含めるかどうかを示します。このプロパティはSOAP スキーマにのみ適用されます。

解説

リストバージョンをビューとして含めるかどうかを示します（例：ListA_Versions）。

シングルサインオン（SSO）を使用する場合のセキュリティトークンサービス（STS）のURL。

解説

シングルサインオン（SSO）を使用する場合のセキュリティトークンサービス（STS）のURL。これを明示的に設定する必要はめったにありません。

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

解説

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

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

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

API 名の代わりにカラムの表示名を使用するかどうかを決定するboolean。

解説

このプロパティはSOAP とREST スキーマの両方に適用されます。

Boolean determining if the list's EntityTypeName field should be used as the table name during metadata discovery instead of the Title field. This property applies only to the REST schema.

解説

Boolean determining if the list's EntityTypeName field should be used as the table name during metadata discovery instead of the Title field.

ドライバーが、NTLMv1 かNTLMv2（デフォルト）のどちらで接続するかを決定します。

解説

ドライバーが、NTLMv1 かNTLMv2（デフォルト）のどちらで接続するかを決定します。

カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

解説

このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。

{
	"MyView": {
		"query": "SELECT * FROM Calendar WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 例：UserDefinedViews=C:\Path\To\UserDefinedViews.json。 このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

詳しくは、ユーザー定義ビュー を参照してください。

テーブルとカラムに簡略名を使用するかどうかを決定するboolean。

解説

Microsoft SharePoint テーブルおよびカラムでは、 通常のデータベースでは使うことが認められていない特殊記号・文字を名前に使うことができます。UseSimpleNames を使用すると、Sync App を従来のデータベースツールでより簡単に使用できるようになります。

UseSimpleNames をtrue に設定し、返されるテーブル名およびカラム名をシンプルにします。表示されるテーブル名 およびカラム名においてアルファベット文字およびアンダースコアのみを有効とするネーミングスキームを強制します。 英数字以外の文字はすべて、アンダースコアに変換されます。