接続文字列オプション
接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。
接続を確立する方法について詳しくは、接続の確立を参照してください。
プロパティ | 説明 |
URL | URL to the Organization root or the OData services file. For example, http://MySite/MyOrganization. |
AuthScheme | 認証で使用されるスキーム。NTLM、BASIC、DIGEST、NONE、NEGOTIATE、およびSHAREPOINTONLINE が利用可能です。 |
User | 認証で使用されるOData ユーザーアカウント。 |
Password | ユーザーの認証で使用されるパスワード。 |
FeedURL | URL to the OData entity set. For example, http://MySite/MyOrganization/EntitySet. |
SharePointUseSSO | Whether or not to use single sign-on (SSO) to authenticate to SharePoint Online. |
プロパティ | 説明 |
AzureADTenant | The Azure Active Directory tenant to authenticate against (only used with Azure AD OAuth). |
AzureTenant | データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。 |
AzureResource | 認証するAzure Active リソース(Azure OAuth 交換時に使用されます)。 |
プロパティ | 説明 |
SharePointSSODomain | The domain of the user when using single sign-on (SSO). |
プロパティ | 説明 |
InitiateOAuth | 接続時にOAuth アクセストークンを取得またはリフレッシュするプロセスを開始するには、このプロパティを設定します。 |
OAuthVersion | 使われているOAuth のバージョン。 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuthAccessToken | OAuth を使用して接続するためのアクセストークン。 |
OAuthAccessTokenSecret | OAuth を使用して接続するためのアクセストークンのトークン シークレット。 |
OAuthSettingsLocation | InitiateOAuth が GETANDREFRESH 、または REFRESH に設定されているときの設定ファイルの場所。代わりに、'memory://' で始まる値を指定することで、この場所をメモリに保持することができます。 |
CallbackURL | 認証時にリダイレクトされるOAuth コールバックURL。この値をアプリケーションに指定したコールバックURL と同じ値に設定します。 |
OAuthGrantType | OAuth フローのグラント種別。 |
OAuthPasswordGrantMode | OAuth Client Id およびClient Secret を渡す方法を指定します。サポートされるオプション:BASIC およびPOST。 |
OAuthIncludeCallbackURL | アクセストークンリクエストにコールバックURL を含めるかどうか。 |
OAuthAuthorizationURL | OAuth サービスの認可URL。 |
OAuthAccessTokenURL | OAuth アクセストークンを取得するURL。 |
OAuthRefreshTokenURL | OAuth トークンをリフレッシュするURL。 |
OAuthRequestTokenURL | サービスがリクエストトークンを取得するために提供するURL。これは、OAuth 1.0 では必須です。 |
OAuthVerifier | OAuth 認可URL から返された検証コード。 |
AuthToken | OAuth アクセストークンをリクエストおよび取得するために使用される認証トークン。 |
AuthKey | OAuth アクセストークンをリクエストおよび取得するために使用される認証シークレット。 |
OAuthParams | OAuth アクセストークンのリクエストでparamname=value の形式でサブミットするその他のパラメータのカンマ区切りのリスト。 |
OAuthRefreshToken | 対応するOAuth アクセストークンのためのOAuth リフレッシュトークン。 |
OAuthExpiresIn | OAuth アクセストークンの有効期限(秒単位)。 |
OAuthTokenTimestamp | 現在のアクセストークンが作成されたときのUnix エポックタイムスタンプ(ミリ秒)。 |
プロパティ | 説明 |
KerberosKDC | ユーザーの認証で使用されるKerberos キー配布センター(KDC)サービス。 |
KerberosRealm | ユーザー認証に使用されるKerberos 領域。 |
KerberosSPN | Kerberos ドメインコントローラーのサービスプリンシパル名(SPN)。 |
KerberosUser | The principal name for the Kerberos Domain Controller. Used in the format host/user@realm |
KerberosKeytabFile | Kerberos プリンシパルと暗号化されたキーのペアを含むKeytab ファイル。 |
KerberosServiceRealm | サービスのKerberos レルム。 |
KerberosServiceKDC | サービスのKerberos KDC。 |
KerberosTicketCache | MIT Kerberos 資格情報キャッシュファイルへのフルパス。 |
プロパティ | 説明 |
SSLClientCert | SSL クライアント認証(2-way SSL)のためのTLS/SSL クライアント証明書ストア。 |
SSLClientCertType | TLS/SSL クライアント証明書を格納するキーストアの種類。 |
SSLClientCertPassword | TLS/SSL クライアント証明書のパスワード。 |
SSLClientCertSubject | TLS/SSL クライアント証明書のサブジェクト。 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロパティ | 説明 |
ProxyAutoDetect | この接続プロパティをTrue に設定すると、provider は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。特定のプロキシサーバーに接続するためにprovider を手動で構成する場合は、False に設定します。 |
ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
ProxyPort | プロキシサーバー( ProxyServer 接続プロパティで指定)が起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法。 |
ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
ProxyPassword | ProxyUser 接続プロパティで指定されたユーザに紐付けられたパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
プロパティ | 説明 |
Logfile | ログファイルの名前と場所を指定するファイルパス。 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
LogModules | ログファイルに含めるコアモジュール。 |
MaxLogFileSize | ログファイルの最大バイトサイズ(例えば、10MB)を指定する文字列。 |
MaxLogFileCount | ログファイルの最大ファイル数を指定する文字列。 |
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
プロパティ | 説明 |
AutoCache | SELECT クエリの結果を、 CacheLocation 、または CacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。 |
CacheDriver | データのキャッシュに使用されるデータベースドライバー。 |
CacheConnection | キャッシュデータベースの接続文字列。このプロパティは、常に CacheProvider と一緒に使用します。両プロパティを設定すると、データをキャッシュするための CacheLocation のバリューセットがオーバーライドされます。 |
CacheLocation | キャッシュデータベースへのパスとファイル名を指定します。 |
CacheTolerance | AutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。 |
Offline | オフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。 |
CacheMetadata | このプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。 |
プロパティ | 説明 |
BatchSize | 送信する各バッチ処理の最大サイズ。 |
ConnectionLifeTime | 接続の最大有効期間(秒単位)。その時間が経過すると、接続オブジェクトは削除されます。 |
ConnectOnOpen | このプロパティは、接続が開かれたときにOData に接続するかどうかを指定します。 |
ContinueOnError | バッチリクエストのエラー後に処理を続行するかどうか。 |
Cookies | Allows cookies to be manually specified in name=value pairs separated by a semicolon. |
CustomHeaders | ユーザーが決定したその他のヘッダー(オプション)。 |
CustomUrlParams | リクエストに含めるカスタムクエリ文字列。 |
DataFormat | The data format to retrieve data in. Select either ATOM or JSON. |
EnableAtomicBatchOperations | Whether or not the batch CUD operations are executed as atomic OData requests. |
ExcludeControlInformationRootType | Indicates wheather or not the OData should use the odata.type control information for the root element. |
ExpandAsterisk | Indicates whether the asterisk should be expanded in the $select query parameter. |
IncludeNavigationParentColumns | Indicates if navigation parent columns should be included on navigation views. |
IncludeReferenceColumn | Adds a input only ParentReference column for bulk INSERTs to properly associate children during a deep insert with the same parent. |
MaxFilterLength | The maximum number of characters for the $filter query parameter. |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。LIMIT 句は、MaxRows で指定された制限値よりも優先されます。 |
MaxSelectLength | $Select クエリパラメータには最大文字数制限があります。このプロパティを0 に設定すると、ドライバーが$Select パラメータをサービスに送信しなくなるため、このパラメータをサポートしていないサービスに有用です。 |
NavigationPropertiesAsViews | A boolean indicating navigation properties should be promoted to full views. |
ODataVersion | 使用するODataのバージョン。デフォルトでは、providerはバージョンを自動検出しようとします。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
Pagesize | OData から返されるページあたりの結果の最大数。 |
PoolIdleTimeout | 接続が閉じられる前に許容されたアイドル時間。 |
PoolMaxSize | プールの最大接続数。 |
PoolMinSize | プール内の最小接続数。 |
PoolWaitTime | 使用可能な接続を待機する最大秒数。 |
PseudoColumns | カラムとして公開する擬似カラムのセットを指定します。 |
Readonly | このプロパティを使用して、provider からOData へのアクセスを読み取り専用に設定できます。 |
RTK | ライセンス供与で使用されるランタイムキー。 |
ServerTimeZone | The timezone by which the server's Edm.DateTime values are represented. The value of this property will affect how Edm.DateTime filters and results are converted between the server and the client machine. |
StoredProceduresAsViews | A boolean indicating if we should list stored procedures which return a collection of entities as views. |
SupportsExpand | Whether you need to specify the base entity's key to query navigation property views. |
SupportsFilter | Set this to true if your OData service supports filters. |
SupportsFormulas | A boolean indicating if the odata service supports server side formulas. |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UseClientSidePaging | CData ADO.NET Provider for OData がクライアントサイドのページングを使用するかどうか。 |
UseConnectionPooling | このプロパティは、コネクションプーリングを有効にします。 |
UseEtags | ODataソースがEtagsを使用するかどうか。 |
UseIdURL | 特定のエンティティへの直接URLを表すID列を表示するかどうかを決定するboolean。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを決定するboolean。 |