Cmdlets for Microsoft Dynamics CRM

Build 24.0.9062

Parameters (Connect-DynamicsCRM Cmdlet)

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

Authentication


PropertyDescription
AuthScheme使用される認証スキーム。OAuth、AzureAD、AzureServicePrincipal、AzureServicePrincipalCert、NTLM、Kerberos のエントリーが許容されます。
URL組織のルートURL。例えば、CRM 4.0またはCRM 2011のURL は、「http://MySite/MyOrganization」のようになります。CRM Online の場合は、URL は「https://myOrg.crm.dynamics.com/」のようになります。
CRMVersion接続しているDynamics CRM サーバーの種類。有効な入力値は、CRM2011+、およびCRMOnline です。
InternetFacingDeploymentCRM のInternet Facing Deployment (IFD) に接続するかどうか。
UserThe SharePoint user account used to authenticate.
PasswordThe password used to authenticate the user.
OrganizationName組織の名前。IFD を使用しないDynamics CRM 4.0では、組織はURL で指定されます(例:http://website/organizationname)。IFD を使用するDynamics CRM 4.0では、このプロパティを設定する必要があります。他のCRM バージョンでは、このプロパティの設定はオプションです。
ServerVersionThe Server SDK version of DynamicsCRM.

AzureAuthentication


PropertyDescription
AzureTenantデータにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。
AzureEnvironment接続を確立するときに使用するAzure 環境。

OAuth


PropertyDescription
InitiateOAuth接続時にOAuth アクセストークンを取得またはリフレッシュするプロセスを開始するには、このプロパティを設定します。
OAuthClientIdOAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecretOAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuthAccessTokenOAuth を使用して接続するためのアクセストークン。
OAuthSettingsLocationInitiateOAuth が GETANDREFRESH 、または REFRESH に設定されているときの設定ファイルの場所。代わりに、'memory://' で始まる値を指定することで、この場所をメモリに保持することができます。
CallbackURL認証時にリダイレクトされるOAuth コールバックURL。この値をアプリケーションに指定したコールバックURL と同じ値に設定します。
ADFSServerThe ADFS Server used for authentication.
OAuthGrantTypeOAuth フローのグラント種別。
OAuthVerifierOAuth 認可URL から返された検証コード。
OAuthRefreshToken対応するOAuth アクセストークンのためのOAuth リフレッシュトークン。
OAuthExpiresInOAuth アクセストークンの有効期限(秒単位)。
OAuthTokenTimestamp現在のアクセストークンが作成されたときのUnix エポックタイムスタンプ(ミリ秒)。

JWTOAuth


PropertyDescription
OAuthJWTCertJWT 証明書のストア。
OAuthJWTCertTypeJWT 証明書を格納するキーストアの種類。
OAuthJWTCertPasswordOAuth JWT 証明書のパスワード。
OAuthJWTCertSubjectOAuth JWT 証明書のサブジェクト。

Kerberos


PropertyDescription
KerberosKDCユーザーの認証で使用されるKerberos キー配布センター(KDC)サービス。
KerberosRealmユーザー認証に使用されるKerberos 領域。
KerberosSPNKerberos ドメインコントローラーのサービスプリンシパル名(SPN)。
KerberosUserThe principal name for the Kerberos Domain Controller. Used in the format host/user@realm
KerberosKeytabFileKerberos プリンシパルと暗号化されたキーのペアを含むKeytab ファイル。
KerberosServiceRealmサービスのKerberos レルム。
KerberosServiceKDCサービスのKerberos KDC。
KerberosTicketCacheMIT Kerberos 資格情報キャッシュファイルへのフルパス。

SSL


PropertyDescription
SSLClientCertSSL クライアント認証(2-way SSL)のためのTLS/SSL クライアント証明書ストア。
SSLClientCertTypeTLS/SSL クライアント証明書を格納するキーストアの種類。
SSLClientCertPasswordTLS/SSL クライアント証明書のパスワード。
SSLClientCertSubjectTLS/SSL クライアント証明書のサブジェクト。
SSLServerCertTLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

Firewall


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

Proxy


PropertyDescription
ProxyAutoDetectこの接続プロパティをTrue に設定すると、provider は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。特定のプロキシサーバーに接続するためにprovider を手動で構成する場合は、False に設定します。
ProxyServerHTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPortプロキシサーバー( ProxyServer 接続プロパティで指定)が起動しているTCP ポート。
ProxyAuthSchemeProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法。
ProxyUserProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPasswordProxyUser 接続プロパティで指定されたユーザに紐付けられたパスワード。
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
CallerId新しいレコードを挿入または更新する際に偽装するユーザーのId。
DefaultPrecisionシステム全体で価格設定に使用される通貨精度。有効な値は、0~4 およびAuto です。値がAuto の場合は、Microsoft Dynamics CRM サーバーからデフォルト値が取得されます。
ExposeVirtualSubColumnBoolean that exposes a virtual subcolumn to return data in a different format.
IncludeCalculatedColumnsこのオプションは、ドライバーがテーブルに定義されたCalculated Columns を返すかどうかを制御します。CRM 2015 以上にのみ適用されます。
LanguageCodeThe code indicating the language
MaxRowsクエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Otherこれらの隠しプロパティは特定のユースケースでのみ使用されます。
PagesizeMicrosoft Dynamics CRM から返されるページあたりの結果の最大数。
PseudoColumnsカラムとして公開する擬似カラムのセットを指定します。
QueryMethodDynamics CRM からデータをクエリする際に使用される方法。多くの場合は、FetchXML ですべてのテーブルを処理できます。
QueryPassthroughこのオプションは、クエリをMicrosoft Dynamics CRM サーバーにas-is で渡します。
Readonlyこのプロパティを使用して、provider からMicrosoft Dynamics CRM へのアクセスを読み取り専用に設定できます。
RTKライセンス供与で使用されるランタイムキー。
SavedQueryFilter保存済みクエリをビューとして表示するためのフィルタのカンマ区切りリスト(例:Accounts%,Contacts%)。
Timeoutタイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UseDisplayNamesAPI 名の代わりに列の表示名を使用するかどうかを決定するBoolean。UseDisplayNames とUseSchemaNames は相互に排他的です。
UseDisplayTableNamesBoolean determining if the display names for the table should be used instead of the API names.
UseNameForPicklistValuePicklist フィールド値に、整数の代わりに文字列値を使用するかどうかを決定するboolean。
UserDefinedViewsカスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
UseSchemaNamesAPI 名の代わりにテーブルのスキーマ名を使用するかどうかを決定するBoolean。UseDisplayNames とUseSchemaNames は相互に排他的です。
UseSimpleNamesテーブルとカラムに簡略名を使用するかどうかを決定するboolean。

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