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.
Property | Description |
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 です。 |
InternetFacingDeployment | CRM のInternet Facing Deployment (IFD) に接続するかどうか。 |
User | The SharePoint user account used to authenticate. |
Password | The password used to authenticate the user. |
OrganizationName | 組織の名前。IFD を使用しないDynamics CRM 4.0では、組織はURL で指定されます(例:http://website/organizationname)。IFD を使用するDynamics CRM 4.0では、このプロパティを設定する必要があります。他のCRM バージョンでは、このプロパティの設定はオプションです。 |
ServerVersion | The Server SDK version of DynamicsCRM. |
Property | Description |
AzureTenant | データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。 |
AzureEnvironment | 接続を確立するときに使用するAzure 環境。 |
Property | Description |
InitiateOAuth | 接続時にOAuth アクセストークンを取得またはリフレッシュするプロセスを開始するには、このプロパティを設定します。 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuthAccessToken | OAuth を使用して接続するためのアクセストークン。 |
OAuthSettingsLocation | InitiateOAuth が GETANDREFRESH 、または REFRESH に設定されているときの設定ファイルの場所。代わりに、'memory://' で始まる値を指定することで、この場所をメモリに保持することができます。 |
CallbackURL | 認証時にリダイレクトされるOAuth コールバックURL。この値をアプリケーションに指定したコールバックURL と同じ値に設定します。 |
ADFSServer | The ADFS Server used for authentication. |
OAuthGrantType | OAuth フローのグラント種別。 |
OAuthVerifier | OAuth 認可URL から返された検証コード。 |
OAuthRefreshToken | 対応するOAuth アクセストークンのためのOAuth リフレッシュトークン。 |
OAuthExpiresIn | OAuth アクセストークンの有効期限(秒単位)。 |
OAuthTokenTimestamp | 現在のアクセストークンが作成されたときのUnix エポックタイムスタンプ(ミリ秒)。 |
Property | Description |
OAuthJWTCert | JWT 証明書のストア。 |
OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。 |
OAuthJWTCertSubject | OAuth JWT 証明書のサブジェクト。 |
Property | Description |
KerberosKDC | ユーザーの認証で使用されるKerberos キー配布センター(KDC)サービス。 |
KerberosRealm | ユーザー認証に使用されるKerberos 領域。 |
KerberosSPN | Kerberos ドメインコントローラーのサービスプリンシパル名(SPN)。 |
KerberosUser | The principal name for the Kerberos Domain Controller. Used in the format host/user@realm |
KerberosKeytabFile | Kerberos プリンシパルと暗号化されたキーのペアを含むKeytab ファイル。 |
KerberosServiceRealm | サービスのKerberos レルム。 |
KerberosServiceKDC | サービスのKerberos KDC。 |
KerberosTicketCache | MIT Kerberos 資格情報キャッシュファイルへのフルパス。 |
Property | Description |
SSLClientCert | SSL クライアント認証(2-way SSL)のためのTLS/SSL クライアント証明書ストア。 |
SSLClientCertType | TLS/SSL クライアント証明書を格納するキーストアの種類。 |
SSLClientCertPassword | TLS/SSL クライアント証明書のパスワード。 |
SSLClientCertSubject | TLS/SSL クライアント証明書のサブジェクト。 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
Property | Description |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
Property | Description |
ProxyAutoDetect | この接続プロパティをTrue に設定すると、provider は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。特定のプロキシサーバーに接続するためにprovider を手動で構成する場合は、False に設定します。 |
ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
ProxyPort | プロキシサーバー( ProxyServer 接続プロパティで指定)が起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法。 |
ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
ProxyPassword | ProxyUser 接続プロパティで指定されたユーザに紐付けられたパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
Property | Description |
Logfile | ログファイルの名前と場所を指定するファイルパス。 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
LogModules | ログファイルに含めるコアモジュール。 |
MaxLogFileSize | ログファイルの最大バイトサイズ(例えば、10MB)を指定する文字列。 |
MaxLogFileCount | ログファイルの最大ファイル数を指定する文字列。 |
Property | Description |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
Property | Description |
AutoCache | SELECT クエリの結果を、 CacheLocation 、または CacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。 |
CacheLocation | キャッシュデータベースへのパスとファイル名を指定します。 |
CacheTolerance | AutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。 |
Offline | オフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。 |
CacheMetadata | このプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。 |
Property | Description |
CallerId | 新しいレコードを挿入または更新する際に偽装するユーザーのId。 |
DefaultPrecision | システム全体で価格設定に使用される通貨精度。有効な値は、0~4 およびAuto です。値がAuto の場合は、Microsoft Dynamics CRM サーバーからデフォルト値が取得されます。 |
ExposeVirtualSubColumn | Boolean that exposes a virtual subcolumn to return data in a different format. |
IncludeCalculatedColumns | このオプションは、ドライバーがテーブルに定義されたCalculated Columns を返すかどうかを制御します。CRM 2015 以上にのみ適用されます。 |
LanguageCode | The code indicating the language |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
Pagesize | Microsoft Dynamics CRM から返されるページあたりの結果の最大数。 |
PseudoColumns | カラムとして公開する擬似カラムのセットを指定します。 |
QueryMethod | Dynamics CRM からデータをクエリする際に使用される方法。多くの場合は、FetchXML ですべてのテーブルを処理できます。 |
QueryPassthrough | このオプションは、クエリをMicrosoft Dynamics CRM サーバーにas-is で渡します。 |
Readonly | このプロパティを使用して、provider からMicrosoft Dynamics CRM へのアクセスを読み取り専用に設定できます。 |
RTK | ライセンス供与で使用されるランタイムキー。 |
SavedQueryFilter | 保存済みクエリをビューとして表示するためのフィルタのカンマ区切りリスト(例:Accounts%,Contacts%)。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UseDisplayNames | API 名の代わりに列の表示名を使用するかどうかを決定するBoolean。UseDisplayNames とUseSchemaNames は相互に排他的です。 |
UseDisplayTableNames | Boolean determining if the display names for the table should be used instead of the API names. |
UseNameForPicklistValue | Picklist フィールド値に、整数の代わりに文字列値を使用するかどうかを決定するboolean。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
UseSchemaNames | API 名の代わりにテーブルのスキーマ名を使用するかどうかを決定するBoolean。UseDisplayNames とUseSchemaNames は相互に排他的です。 |
UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを決定するboolean。 |