Cmdlets for Microsoft SharePoint Excel

Build 25.0.9434

Parameters (Connect-ExcelServices Cmdlet)

The following is the full list of the parameters of the cmdlet with short descriptions. Click the links for further details.

Authentication


PropertyDescription
AuthSchemeSpecifies the authentication scheme the provider uses to connect. Set this to one of the following values: NTLM, Basic, Digest, Forms, Negotiate, ADFS, or None.
URLSpecifies the base URL of the SharePoint site or site collection the provider connects to.
UserSpecifies the username for the account used to authenticate to the server.
PasswordSpecifies the password for the user account used to authenticate to the server.
SharePointVersionSpecifies the version of the SharePoint server that the provider connects to.
STSURLSpecifies the URL of the security token service (STS) used for single sign-on (SSO) with ADFS.
UseNTLMV1Specifies whether the provider uses the NTLMv1 authentication protocol instead of the default NTLMv2.

Connection


PropertyDescription
DefineTablesSpecifies custom table definitions by mapping table names to sheet ranges in the spreadsheet. Use name-value pairs in the form TableName=SheetName!Range.
FileSpecifies the name of the Excel file to connect to, including the .xlsx extension.
FolderSpecifies the folder path within the document library where the file specified in the File property is located.
HeaderSpecifies whether the first row of the sheet contains column names when using the REST API.
LibrarySpecifies the name of the document library that contains the Excel file you want to connect to.
IgnoreCalcErrorSpecifies whether the provider should ignore formula calculation errors in Excel worksheets.
MaxRowsSpecifies the maximum number of rows the provider returns when a query does not include aggregation or grouping.
TypeDetectionSchemeSpecifies how the provider determines the data types of columns in a worksheet.
UseRESTAPISpecifies whether the provider uses the SharePoint REST API instead of the OData API to retrieve data.

SSO


PropertyDescription
SSOLoginURLID プロバイダーのログインURL。
SSODomainSpecifies the domain associated with the user account when using single sign-on (SSO).
SSOPropertiesID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。

Kerberos


PropertyDescription
KerberosKDCユーザーの認証に使用されるKerberos キー配布センター(KDC)サービスを識別します。(SPNEGO またはWindows 認証のみ)
KerberosRealmユーザーの認証に使用される Kerberos レルムを識別します。
KerberosSPNKerberos ドメインコントローラーのサービスプリンシパル名(SPN)を指定します。
KerberosUserKerberos ドメインコントローラーのプリンシパル名を確認します。形式はhost/user@realm です。
KerberosKeytabFileKerberos のプリンシパルと暗号化されたキーのペアを含むKeytab ファイルを指定します。
KerberosServiceRealmサービスのKerberos レルムをを指定します。(クロスレルム認証のみ)
KerberosServiceKDCサービスのKerberos Key Distribution Center(KDC)を指定します。
KerberosTicketCacheMIT Kerberos 認証情報キャッシュファイルの完全ファイルパスを指定します。

SSL


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

Firewall


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

Proxy


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

Logging


PropertyDescription
Logfileprovider が認証、クエリ実行、接続の詳細などのアクティビティを記録するログファイルのファイルパスを指定します。
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
LogModulesログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。
MaxLogFileSize単一のログファイルの最大サイズをバイト単位で指定します。例えば、'10 MB' です。ファイルが上限に達すると、provider は日付と時刻を名前に付加した新しいログファイルを作成します。
MaxLogFileCountprovider が保持するログファイルの最大数を指定します。上限に達すると、最も古いログファイルが削除され、新しいログファイルのためのスペースが作られます。

Schema


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

Caching


PropertyDescription
AutoCacheSELECT クエリの対象となるテーブルの内容が、指定されたキャッシュデータベースに自動的にキャッシュされるかどうかを指定します。
CacheLocationキャッシュデータベースへのパスとファイル名を指定します。
CacheTolerance指定されたキャッシュデータベース内の失効データに対する許容時間(秒単位)を指定します。AutoCache がTrue に設定されている必要があります。
OfflineライブExcel Services データの代わりに、指定されたキャッシュデータベースからデータを取得します。
CacheMetadataprovider がテーブルメタデータをファイルベースのキャッシュデータベースにキャッシュするかどうかを決定します。

Miscellaneous


PropertyDescription
IncludeNavigationParentColumnsSpecifies whether the provider includes non-key parent columns in views generated from navigation properties.
Other特定のユースケースに対する追加の隠しプロパティを指定します。特定の問題に対処するため、サポートチームが推奨する場合にのみ使用してください。詳細は備考を参照してください。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
RowScanDepthテーブルで利用可能なカラムを探すためにスキャンする行数の最大値。
RTKprovider のライセンスを取得するためのランタイムキーを指定します。設定されていないか無効な場合、provider は標準のライセンス方法をデフォルトとして使用します。このプロパティは、標準のライセンス方法がサポートされていないか、ランタイムキーが必要な環境でのみ必要です。
ShowEmptyRowsSpecifies whether the provider includes empty rows when reading data from a worksheet.
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UserDefinedViewsカスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434