Cmdlets for Kintone

Build 23.0.8839

Parameters (Connect-Kintone Cmdlet)

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

Authentication


PropertyDescription
AuthSchemeKintone にUser / Password で接続するかAPIToken で接続するか。
URLKintone URL。次に例を示します。 https://SUBDOMAIN_NAME.cybozu.com
User認証で使用されるKintone ユーザーアカウント。
Passwordユーザーの認証で使用されるパスワード。
BasicAuthUserBasic 認証を使用するドメインに必要な追加のユーザー名。
BasicAuthPasswordBasic 認証を使用するドメインに必要な追加のパスワード。
AppId認証時にAPI トークンとともに使用するアプリID。
APIToken認証時に使用するAPI トークン。

SSL


PropertyDescription
SSLClientCertSSL クライアント認証(2-way SSL)のためのTLS/SSL クライアント証明書ストア。
SSLClientCertTypeTLS/SSL クライアント証明書を格納するキーストアの種類。
SSLClientCertPasswordTLS/SSL クライアント証明書のパスワード。
SSLClientCertSubjectTLS/SSL クライアント証明書のサブジェクト。

Firewall


PropertyDescription
FirewallTypeプロキシベースのファイアウォールで使われるプロトコル。
FirewallServerプロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPortプロキシベースのファイアウォールのTCP ポート。
FirewallUserプロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPasswordプロキシベースのファイアウォールへの認証に使われるパスワード。

Proxy


PropertyDescription
ProxyAutoDetectこれは、システムプロキシ設定を使用するかどうかを示します。
ProxyServerHTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPortProxyServer プロキシが起動しているTCP ポート。
ProxyAuthSchemeProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUserProxyServer プロキシへの認証に使われるユーザー名。
ProxyPasswordProxyServer プロキシへの認証に使われるパスワード。
ProxySSLTypeProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptionsProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging


PropertyDescription
Logfileログファイルの名前と場所を指定するファイルパス。
Verbosityログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。
LogModulesログファイルに含めるコアモジュール。
MaxLogFileSizeログファイルの最大バイトサイズ(例えば、10MB)を指定する文字列。
MaxLogFileCountログファイルの最大ファイル数を指定する文字列。

Schema


PropertyDescription
Locationテーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemasこのプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tablesこのプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Caching


PropertyDescription
AutoCacheSELECT クエリの結果を、 CacheLocation 、または CacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。
CacheLocationキャッシュデータベースへのパスとファイル名を指定します。
CacheToleranceAutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。
Offlineオフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。
CacheMetadataこのプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。

Miscellaneous


PropertyDescription
AllowSpecialCharacters特殊文字を許容するかどうかを決定します。True の場合、特殊文字は置き換えられません。
CheckForSubtablesInサブテーブルを取得するKintone アプリのカンマ区切りリスト。
GuestSpaceIdクエリ結果をゲストスペースに制限します。
MaxRowsクエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
NumberMapToDouble数値フィールドのデータ型をdecimal からdouble に変更するかどうかを決定します。
Otherこれらの隠しプロパティは特定のユースケースでのみ使用されます。
PagesizeKintone から返されるページあたりの結果の最大数。
Readonlyこのプロパティを使用して、provider からKintone へのアクセスを読み取り専用に設定できます。
RTKライセンス供与で使用されるランタイムキー。
SubtableSeparatorCharactertablename + char + subtable 形式のサブテーブルからテーブルを分割するために使用される文字。
Timeoutタイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UseCodeForFieldNameフィールド名にLabel かCode のどちらを使用するかを決定します。
UseCursorカーソルを使用してレコードを取得するかどうかを決定するboolean。
UserDefinedViewsカスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
UseSimpleNamesテーブルとカラムに簡略名を使用するかどうかを決定するboolean。
UseUnitForNumericFieldフィールド名に単位を表示するかどうかを決定します。

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839