Cmdlets for Salesforce

Build 20.0.7654

Parameters (Connect-Salesforce Cmdlet)

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

Parameter Required Description
AllOrNone    1つのレコードが失敗しただけで、要求に含まれるすべての挿入、更新、または削除を失敗として処理するかどうかを示すboolean。 
APIVersion    使用されるSalesforce API のバージョン。 
ArchiveMode    標準のSELECT クエリで削除およびアーカイブされたレコードを含めるかどうかを示すboolean。 
AuthScheme    Salesforce に接続する際に使用する認証の種類。 
AutoCache    SELECT クエリの結果を、 CacheLocation 、または&rpCacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。 
BulkAPIVersion    The version of the bulk API to use for processing queries. 
BulkPageSize    UseBulkAPI=true の場合に、ユーザーに結果を返す前に取得するレコード数。 
BulkPollingInterval    一括クエリの応答の可用性を確認するリクエスト間の時間間隔(ミリ秒単位)。デフォルト値は500 ミリ秒です。 
BulkQueryTimeout    provider が一括クエリの応答を待機するタイムアウト(分単位)。デフォルト値は25分です。 
CacheConnection    キャッシュデータベースの接続文字列。このプロパティは、常に CacheProvider と一緒に使用します。両プロパティを設定すると、データをキャッシュするための CacheLocation のバリューセットがオーバーライドされます。 
CacheLocation    キャッシュデータベースへのパスとファイル名を指定します。 
CacheMetadata    このプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。 
CacheProvider    データのキャッシュに使用されるプロバイダーの名前。 
CacheTolerance    AutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。 
CallbackURL    認証時にリダイレクトされるOAuth コールバックURL。この値をアプリケーションに指定したコールバックURL と同じ値に設定します。 
ContinueOnAlterException    ALTER ステートメントが失敗した後に続行するかどうか。 
FilterScope    クエリから返されるレコードを制限するためのオプションのスコープ。 
FirewallPassword    プロキシベースのファイアウォールへの認証に使われるパスワード。 
FirewallPort    プロキシベースのファイアウォールのTCP ポート。 
FirewallServer    プロキシベースのファイアウォールの名前もしくはIP アドレス。 
FirewallType    プロキシベースのファイアウォールで使われるプロトコル。 
FirewallUser    プロキシベースのファイアウォールに認証するために使うユーザー名。 
IncludeMetadataDescription    カラム、テーブル、またはその両方の説明をMetadata API から取得する場合は、このプロパティをNONE 以外の値に設定します。 
InitiateOAuth    接続時にOAuth アクセストークンを取得またはリフレッシュするプロセスを開始するには、このプロパティを設定します。 
Location    テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 
Logfile    ログファイルの名前と場所を指定するファイルパス。 
LoginURL    ログインで使用されるSalesforce サーバーへのURL。 
LogModules    ログファイルに含まれるコアモジュール。 
MaxLogFileCount    ログファイルの最大ファイル数を指定する文字列。サイズリミットを超えると、日付と時刻が末尾に追加された新しいログが同じフォルダ内に作成され、最も古いログファイルが削除されます。 
MaxLogFileSize    ログファイルの最大バイトサイズ(例えば、10MB)を指定する文字列。サイズリミットを超えると、日付と時刻が末尾に追加された新しいログが同じフォルダ内に作成されます。 
MaxRows    クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 
OAuthAccessToken    OAuth を使用して接続するためのアクセストークン。 
OAuthClientId    OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントID。 
OAuthClientSecret    OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 
OAuthExpiresIn    OAuth アクセストークンの有効期限(秒単位)。 
OAuthRefreshToken    対応するOAuth アクセストークンのためのOAuth リフレッシュトークン。 
OAuthServerURL    OAuth でログインする場合に使用するサーバーURL。 
OAuthSettingsLocation    InitiateOAuth がGETANDREFRESH、またはREFRESH に設定されているときの設定ファイルの場所。代わりに、memory:// で始まる値を指定することで、これをメモリに保持することができます。 
OAuthTokenTimestamp    現在のアクセストークンが作成されたときのUnix エポックタイムスタンプ(ミリ秒)。 
OAuthVerifier    OAuth 認可URL から返された検証コード。 
Offline    オフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。 
Other    これらの隠しプロパティは特定のユースケースでのみ使用されます。 
Password  True  ユーザーの認証で使用されるパスワード。 
ProxyAuthScheme    ProxyServer プロキシへの認証で使われる認証タイプ。 
ProxyAutoDetect    これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 
ProxyExceptions    ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 
ProxyPassword    ProxyServer プロキシへの認証に使われるパスワード。 
ProxyPort    ProxyServer プロキシが起動しているTCP ポート。 
ProxyServer    HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 
ProxySSLType    ProxyServer プロキシへの接続時に使用するSSL タイプ。 
ProxyUser    ProxyServer プロキシへの認証に使われるユーザー名。 
PseudoColumns    このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 
Readonly    このプロパティを使用して、provider からSalesforce へのアクセスを読み取り専用に設定できます。 
RTK    ライセンス供与で使用されるランタイムキー。 
SecurityToken    認証で使用されるSalesforce アカウントのセキュリティトークン。 
ServerSideAggregation    サーバー側の集計を使用するかどうかを決定するboolean。 
ServerUrl    Salesforce インスタンスURL。 
SessionTimeout    Salesforce ログインセッションのタイムアウト時間(分単位)。 
SkipFormulaFields    Set to true if formula fields should be skipped when listing columns. 
SSLServerCert    TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 
SSOLoginURL    ID プロバイダーのログインURL。 
SSOProperties    セミコロンで区切られたアイデンティティプロバイダーへの接続に必要な追加プロパティ。 
SSOTokenURL    アイデンティティプロバイダーのためのSalesforce OAuth 2.0 トークンエンドポイント。 
SupportEnhancedSQL    このプロパティは、API から直接サポートされる範囲を超えるSQL 機能の拡張は、インメモリによるクライアントサイド処理を有効にすることで可能になります。 
Tables    このプロパティは、レポートされたテーブルを使用可能なテーブルのサブセットに制限します。例えば、Tables=TableA,TableB,TableC です。 
Timeout    タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 
UseBulkAPI    同期SOAP API を使うか、非同期Bulk API を使うか。 
User  True  認証で使用されるSalesforce ユーザーアカウント。 
UseSandbox  True  Salesforce Sandbox アカウントに接続するかどうかを決定するboolean。 
Verbosity    ログファイルに含まれる詳細の量を決定するメッセージレベル。 
Views    レポートされたビューを使用可能なテーブルのサブセットに制限します。例えば、Views=ViewA,ViewB,ViewC です。 
WaitForBulkResults    非同期API を使用するときにバルク結果を待つかどうか。 UseBulkAPI がtrue の場合にのみアクティブになります。 

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7654