接続プロパティ
接続プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続設定で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。
接続を確立する方法について詳しくは、はじめにを参照してください。
| プロパティ | 説明 |
| URL | OData サービスのルートURL（サービスルートURL とも呼ばれます）を指定します。例：http://services.odata.org/V4/Northwind/Northwind.svc |
| AuthScheme | OData への接続に使用される認証スキームを指定します。 |
| User | 認証するユーザーのユーザーID を指定します。 |
| Password | 認証するユーザーのパスワードを指定します。 |
| FeedURL | URL to the OData entity set. For example, http://MySite/MyOrganization/EntitySet. |
| SharePointUseSSO | Specifies whether to use single sign-on (SSO) to authenticate to SharePoint Online. |
| プロパティ | 説明 |
| AzureADTenant | Specifies the Azure Active Directory tenant to authenticate against. Used only with Azure AD OAuth authentication. |
| AzureTenant | データにアクセスするために使用されているOData テナントを識別します。テナントのドメイン名（例： contoso.onmicrosoft.com ）またはディレクトリ（テナント）ID のいずれかを受け付けます。 |
| AzureResource | 認証するAzure Active リソース（Azure OAuth 交換時に使用されます）。 |
| プロパティ | 説明 |
| SharePointSSODomain | Specifies the user domain for SSO in OData when it differs from the domain configured in the SSO service. |
| プロパティ | 説明 |
| InitiateOAuth | OAuth アクセストークンを取得またはリフレッシュするプロセスを指定します。これにより、認証された認可ユーザーが作業している間、ユーザーアクセスを維持することができます。 |
| OAuthVersion | 使われているOAuth のバージョンを指定します。 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID（コンシューマーキーとも呼ばれます）を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。（カスタムOAuth アプリケーションのみ） |
| OAuthAccessToken | データソースへのリクエストを認証するために使用されるOAuth アクセストークンを指定します。このトークンは、OAuth 交換が正常に完了した後に認可サーバーから発行されます。 |
| OAuthAccessTokenSecret | OAuth を使用して接続するためのアクセストークンのトークンシークレット。 |
| OAuthSettingsLocation | OAuth 値が保存される設定ファイルの場所を指定します。 |
| CallbackURL | OAuth 経由でOData への認証を行った後にユーザーが戻るURL を指定します（カスタムOAuth アプリケーションのみ）。 |
| OAuthPasswordGrantMode | OAuth Client ID およびClient Secret を認可サーバーに送信する方法を指定します。 |
| OAuthIncludeCallbackURL | アクセストークンリクエストにコールバックURL を含めるかどうか。 |
| OAuthAuthorizationURL | OAuth サービスの認可URL。 |
| OAuthAccessTokenURL | OAuth アクセストークンを取得するURL。 |
| OAuthRefreshTokenURL | OAuth トークンをリフレッシュするURL。 |
| OAuthRequestTokenURL | サービスがリクエストトークンを取得するために提供するURL。これは、OAuth 1.0 では必須です。 |
| OAuthVerifier | OAuthAuthorizationURL から返された検証コードを指定します。ブラウザを起動できないヘッドレスサーバーでOAuth 認証を行う場合に使用します。 OAuthSettingsLocation および OAuthVerifier の両方が設定される必要があります。 |
| AuthToken | OAuth アクセストークンをリクエストおよび取得するために使用される認証トークン。 |
| AuthKey | OAuth アクセストークンをリクエストおよび取得するために使用される認証シークレット。 |
| OAuthParams | OAuth アクセストークンのリクエストでparamname=value の形式でサブミットするその他のパラメータのカンマ区切りのリスト。 |
| OAuthRefreshToken | 元のアクセストークンが期限切れになった後に新しいアクセストークンを要求するために使用される、OAuth リフレッシュトークンを指定します。 |
| OAuthExpiresIn | OAuth アクセストークンの有効期間を秒単位で指定します。ユーザーが操作を続けている限り、アクセスを維持するためにトークンを再発行することができます。 |
| OAuthTokenTimestamp | 現在のアクセストークンがいつ作成されたかを示すUnix エポックタイムスタンプをミリ秒単位で表示します。 |
| プロパティ | 説明 |
| KerberosKDC | ユーザーの認証に使用されるKerberos キー配布センター（KDC）サービスを識別します。（SPNEGO またはWindows 認証のみ） |
| KerberosRealm | ユーザーの認証に使用される Kerberos レルムを識別します。 |
| KerberosSPN | Kerberos ドメインコントローラーのサービスプリンシパル名（SPN）を指定します。 |
| KerberosUser | Kerberos ドメインコントローラーのプリンシパル名を確認します。形式はhost/user@realm です。 |
| KerberosKeytabFile | Kerberos のプリンシパルと暗号化されたキーのペアを含むKeytab ファイルを指定します。 |
| KerberosServiceRealm | サービスのKerberos レルムをを指定します。（クロスレルム認証のみ） |
| KerberosServiceKDC | サービスのKerberos Key Distribution Center（KDC）を指定します。 |
| KerberosTicketCache | MIT Kerberos 認証情報キャッシュファイルの完全ファイルパスを指定します。 |
| プロパティ | 説明 |
| 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 を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。 |
| プロパティ | 説明 |
| Logfile | provider が認証、クエリ実行、接続の詳細などのアクティビティを記録するログファイルのファイルパスを指定します。 |
| Verbosity | ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
| MaxLogFileSize | 単一のログファイルの最大サイズをバイト単位で指定します。例えば、'10 MB' です。ファイルが上限に達すると、provider は日付と時刻を名前に付加した新しいログファイルを作成します。 |
| MaxLogFileCount | provider が保持するログファイルの最大数を指定します。上限に達すると、最も古いログファイルが削除され、新しいログファイルのためのスペースが作られます。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| AutoCache | SELECT クエリの対象となるテーブルの内容が、指定されたキャッシュデータベースに自動的にキャッシュされるかどうかを指定します。 |
| CacheProvider | ADO.NET プロバイダーの名前空間。指定されたプロバイダーは、すべてのキャッシュ操作のターゲットデータベースとして使用されます。 |
| CacheConnection | 指定されたキャッシュデータベースの接続文字列を指定します。 |
| CacheLocation | キャッシュデータベースへのパスとファイル名を指定します。 |
| CacheTolerance | 指定されたキャッシュデータベース内の失効データに対する許容時間（秒単位）を指定します。AutoCache がTrue に設定されている必要があります。 |
| Offline | ライブOData データの代わりに、指定されたキャッシュデータベースからデータを取得します。 |
| CacheMetadata | provider がテーブルメタデータをファイルベースのキャッシュデータベースにキャッシュするかどうかを決定します。 |
| プロパティ | 説明 |
| AllowNavigationDisassociation | Specifies whether the provider binds navigation properties to null values. |
| ContinueOnError | エラーが発生した後にバッチリクエストを続行するかどうかを指定します（OData 4.0 以降のみ）。 |
| Cookies | This property can be manually specified in the format of name=value pairs, which are separated by semicolons. |
| CustomHeaders | 他のプロパティ（ContentType やFrom など）から作成されたリクエストヘッダーに追加する、追加HTTP ヘッダーを指定します。このプロパティは、特殊または非標準のAPI 用にリクエストをカスタマイズするために使用します。 |
| CustomURLParams | HTTP リクエストに含めるカスタムURL パラメータの文字列で、field1=value1&field2=value2&field3=value3 の形式。 |
| DataFormat | Specifies the formatting of data when interacting with an OData service. The two formats supported are ATOM and JSON. |
| DecodeXMLNames | Unicode 文字を含むカラム名をデコードするかどうかを指定します。 |
| DirectQueryLimit | DirectQuery モードを使用する場合の行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
| EnableAtomicBatchOperations | This property indicates that all Create, Update, and Delete (CUD) requests in a batch are handled as a single action. The success of the entire batch depends on the outcome of all requests. If any single request fails, the whole batch fails and no changes are applied. |
| EnableForeignKeyDetection | ODBC で外部キーを検出するかどうか。 |
| ExcludeControlInformationRootType | Indicates whether OData should use the odata.type control information for the root element. |
| ExpandAsterisk | The OData service should return everything if the $select query parameter is not specified by default. In certain cases, this functionality can be set to true, allowing retrieval of every column from the specified dataset. This applies specifically to SQL queries. |
| IncludeNavigationParentColumns | Specifies whether the columns that serve as parent navigational elements should be incorporated within the navigation views. |
| IncludeReferenceColumn | バルクINSERT 操作用に設計された入力専用のParentReference カラムを追加し、Deep INSERT プロセス中に子レコードがそれぞれの親レコードに正しくリンクされるようにします。 |
| MaxFilterLength | Specifies the maximum number of characters permitted in the $filter query parameter of a OData request. |
| MaximumColumnSize | カラムの最大サイズ。 |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| MaxSelectLength | このプロパティは、$select クエリオプションで許可される文字数を制限します。生成された$select パラメータの長さが指定した値を超える場合、カラムの選択は代わりにクライアントサイドで処理されます。このプロパティを0 に設定すると、provider が$select パラメータをサービスに送信しなくなるため、このパラメータをサポートしていないサービスに役立ちます。 |
| NavigationPropertiesAsViews | A boolean indicating navigation properties should be promoted to full views. |
| ODataVersion | 使用するOData のバージョン。デフォルトでは、プロバイダーは自動的に適切なバージョンを検出して適応するように設計されており、シームレスな統合と機能性を実現します。 |
| Other | 特定のユースケースに対する追加の隠しプロパティを指定します。特定の問題に対処するため、サポートチームが推奨する場合にのみ使用してください。詳細は備考を参照してください。 |
| Pagesize | provider がOData にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| Readonly | provider からOData への読み取り専用アクセスを切り替えます。 |
| RTK | provider のライセンスを取得するためのランタイムキーを指定します。設定されていないか無効な場合、provider は標準のライセンス方法をデフォルトとして使用します。このプロパティは、標準のライセンス方法がサポートされていないか、ランタイムキーが必要な環境でのみ必要です。 |
| ServerTimeZone | The timezone for representing or interpreting the server's Edm.DateTime values. The value of this property affects how Edm.DateTime filters and results are converted between the server and the client. |
| StoredProceduresAsViews | A boolean value indicating whether stored procedures returning collections of entities should be treated as views. |
| SupportsExpand | Determines whether navigation properties can be retrieved from the base entity set, which is more accurate. If this property is false, it prevents the provider from retrieving navigation properties. |
| SupportsFilter | Specifies whether the OData service supports the $filter query parameter. |
| SupportsFormulas | A boolean indicating if the odata service supports server side formulas. |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| UseClientSidePaging | Specifies whether or not OData should return data using client-side paging, if your source supports it. To use client-side paging, set this to True. To use server-side paging, set this to False. |
| UseEtags | このプロパティの目的は、サービスがEtag カラムの値を返さない場合に、オプションでEtag カラムを非表示にすることです。そうしない場合、その項目は含まれますが空白のままになります。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
| UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを指定します。 |