CData.DynamicsCRMCmdlets.Commands.dll-help.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
<?xml version="1.0" encoding="utf-8"?>

<helpItems xmlns="http://msh" schema="maml">

<!-- Cmdlet --><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
  
  <command:details>
    <command:name>
      Add-DynamicsCRM
    </command:name>
    <maml:description>
      <maml:para>Inserts Dynamics CRM data.</maml:para>
    </maml:description>
    <maml:copyright>
      <maml:para>Copyright (c) 2017 CData Software, Inc. - All rights reserved.</maml:para>
    </maml:copyright>
    <command:verb>Add</command:verb>
    <command:noun>DynamicsCRM</command:noun>
    <dev:version>16.0</dev:version>
  </command:details>
  
  <maml:description>
    <maml:para>Inserts Dynamics CRM data. The Add-DynamicsCRM cmdlet allows you to use a syntax similar to SQL INSERT statements to create new Dynamics CRM records.</maml:para><maml:para>Add-DynamicsCRM -Connection $connection -Table "Lead" -Columns @("FirstName") -Values @("Jon Doe")</maml:para><maml:para></maml:para><maml:para></maml:para>
  </maml:description>
  
  <!-- Cmdlet syntax section-->    
  <command:syntax>
      <command:syntaxItem>
        <maml:name>Add-DynamicsCRM [parameters]</maml:name>
    
        <command:parameter required="true"
          pipelineInput="true"
          position="named">
          <maml:name>Columns</maml:name>
          <maml:description>
            <maml:para>The columns on which the operation will be performed.</maml:para>
          </maml:description>
          <command:parameterValue >
            string[]
          </command:parameterValue>
        </command:parameter>
    
        <command:parameter required="true"
          pipelineInput="true"
          position="0">
          <maml:name>Connection</maml:name>
          <maml:description>
            <maml:para>The connection object.</maml:para>
          </maml:description>
          <command:parameterValue >
            DataConnection
          </command:parameterValue>
        </command:parameter>
    
        <command:parameter required="true"
          pipelineInput="true"
          position="named">
          <maml:name>Table</maml:name>
          <maml:description>
            <maml:para>The table on which the operation will be performed.</maml:para>
          </maml:description>
          <command:parameterValue >
            string
          </command:parameterValue>
        </command:parameter>
    
        <command:parameter required="true"
          pipelineInput="false"
          position="named">
          <maml:name>Values</maml:name>
          <maml:description>
            <maml:para>The values that will be used to update the table.</maml:para>
          </maml:description>
          <command:parameterValue >
            string[]
          </command:parameterValue>
        </command:parameter>

      </command:syntaxItem>
    </command:syntax>

  <!-- Cmdlet parameter section  --> 
    <command:parameters>
  <command:parameter required="true"
  pipelineInput="true"
  position="named" >
      <maml:name>Columns</maml:name>
      <maml:description>
        <maml:para>The columns on which the operation will be performed.</maml:para>
      </maml:description>
      <command:parameterValue required="true" >
        string[]
      </command:parameterValue>

      <dev:type>
        <maml:name>System.String</maml:name>
        <maml:uri/>
      </dev:type>
      <dev:defaultValue>
        null
      </dev:defaultValue>
    </command:parameter>    
      <command:parameter required="true"
  pipelineInput="true"
  position=0 >
      <maml:name>Connection</maml:name>
      <maml:description>
        <maml:para>The connection object.</maml:para>
      </maml:description>
      <command:parameterValue required="true" >
        DataConnection
      </command:parameterValue>

      <dev:type>
        <maml:name>System.String</maml:name>
        <maml:uri/>
      </dev:type>
      <dev:defaultValue>
        null
      </dev:defaultValue>
    </command:parameter>    
      <command:parameter required="true"
  pipelineInput="true"
  position="named" >
      <maml:name>Table</maml:name>
      <maml:description>
        <maml:para>The table on which the operation will be performed.</maml:para>
      </maml:description>
      <command:parameterValue required="true" >
        string
      </command:parameterValue>

      <dev:type>
        <maml:name>System.String</maml:name>
        <maml:uri/>
      </dev:type>
      <dev:defaultValue>
        ""
      </dev:defaultValue>
    </command:parameter>    
      <command:parameter required="true"
  pipelineInput="false"
  position="named" >
      <maml:name>Values</maml:name>
      <maml:description>
        <maml:para>The values that will be used to update the table.</maml:para>
      </maml:description>
      <command:parameterValue required="true" >
        string[]
      </command:parameterValue>

      <dev:type>
        <maml:name>System.String</maml:name>
        <maml:uri/>
      </dev:type>
      <dev:defaultValue>
        null
      </dev:defaultValue>
    </command:parameter>    
    

  </command:parameters>

  <!-- Input - Output section-->  <command:inputTypes>

  </command:inputTypes>

  <command:returnValues>
      <command:returnValue>
      <dev:type>
        <maml:name>InsertedRowId</maml:name>
        <maml:uri />
        <maml:description>
          <maml:para>
            The unique Id of the inserted row.
          </maml:para>
        </maml:description>
      </dev:type>   
      <maml:description>
        The unique Id of the inserted row.
      </maml:description> 
    </command:returnValue>
  
  </command:returnValues>

  <command:terminatingErrors />

  <command:nonTerminatingErrors />

  <!-- Example section  --> 

  <command:examples />

  <!-- Link section  -->  <maml:relatedLinks>
    <maml:navigationLink>
      <maml:linkText></maml:linkText>
      <maml:uri/>
    </maml:navigationLink>
  </maml:relatedLinks>
</command:command>
<!-- Cmdlet --><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
  
  <command:details>
    <command:name>
      Disconnect-DynamicsCRM
    </command:name>
    <maml:description>
      <maml:para>Closes a connection to Dynamics CRM.</maml:para>
    </maml:description>
    <maml:copyright>
      <maml:para>Copyright (c) 2017 CData Software, Inc. - All rights reserved.</maml:para>
    </maml:copyright>
    <command:verb>Disconnect</command:verb>
    <command:noun>DynamicsCRM</command:noun>
    <dev:version>16.0</dev:version>
  </command:details>
  
  <maml:description>
    <maml:para>Closes a connection to Dynamics CRM The Disconnect-DynamicsCRM cmdlet is used to close a connection that was opened by the Connect-DynamicsCRM cmdlet.</maml:para><maml:para>Disconnect-DynamicsCRM -Connection $connection</maml:para><maml:para></maml:para><maml:para></maml:para>
  </maml:description>
  
  <!-- Cmdlet syntax section-->    
  <command:syntax>
      <command:syntaxItem>
        <maml:name>Disconnect-DynamicsCRM [parameters]</maml:name>
    
        <command:parameter required="true"
          pipelineInput="true"
          position="0">
          <maml:name>Connection</maml:name>
          <maml:description>
            <maml:para>The connection object.</maml:para>
          </maml:description>
          <command:parameterValue >
            DataConnection
          </command:parameterValue>
        </command:parameter>

      </command:syntaxItem>
    </command:syntax>

  <!-- Cmdlet parameter section  --> 
    <command:parameters>
  <command:parameter required="true"
  pipelineInput="true"
  position=0 >
      <maml:name>Connection</maml:name>
      <maml:description>
        <maml:para>The connection object.</maml:para>
      </maml:description>
      <command:parameterValue required="true" >
        DataConnection
      </command:parameterValue>

      <dev:type>
        <maml:name>System.String</maml:name>
        <maml:uri/>
      </dev:type>
      <dev:defaultValue>
        null
      </dev:defaultValue>
    </command:parameter>    
    

  </command:parameters>

  <!-- Input - Output section-->  <command:inputTypes>

  </command:inputTypes>

  <command:returnValues>
  
  </command:returnValues>

  <command:terminatingErrors />

  <command:nonTerminatingErrors />

  <!-- Example section  --> 

  <command:examples />

  <!-- Link section  -->  <maml:relatedLinks>
    <maml:navigationLink>
      <maml:linkText></maml:linkText>
      <maml:uri/>
    </maml:navigationLink>
  </maml:relatedLinks>
</command:command>
<!-- Cmdlet --><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
  
  <command:details>
    <command:name>
      Invoke-DynamicsCRM
    </command:name>
    <maml:description>
      <maml:para>Searches and updates Dynamics CRM data.</maml:para>
    </maml:description>
    <maml:copyright>
      <maml:para>Copyright (c) 2017 CData Software, Inc. - All rights reserved.</maml:para>
    </maml:copyright>
    <command:verb>Invoke</command:verb>
    <command:noun>DynamicsCRM</command:noun>
    <dev:version>16.0</dev:version>
  </command:details>
  
  <maml:description>
    <maml:para>Searches and updates Dynamics CRM data. The Invoke-DynamicsCRM cmdlet allows you to use SQL statements to execute any SQL statement directly. Below is the syntax for a parameterized query:</maml:para><maml:para>$query = Invoke-DynamicsCRM -Connection $connection -Query 'SELECT * FROM Lead WHERE FirstName=@FirstName' -Params @{'@FirstName'='Bob'}</maml:para><maml:para></maml:para><maml:para>This cmdlet is also useful for executing stored procedures. Use the EXEC keyword to call a stored procedure:</maml:para><maml:para></maml:para><maml:para>$query = Invoke-DynamicsCRM -Connection $connection -Query 'EXEC Assign Table = @exStoredProcInput;' -Params @{"Task"'</maml:para><maml:para></maml:para><maml:para></maml:para>
  </maml:description>
   
  <!-- Cmdlet syntax section-->
  <command:syntax>
      <command:syntaxItem>
  <maml:name>Invoke-DynamicsCRM [parameters]</maml:name>
     
        <command:parameter required="true"
          pipelineInput="true"
          position="0">
          <maml:name>Connection</maml:name>
          <maml:description>
            <maml:para>The connection object.</maml:para>
          </maml:description>
          <command:parameterValue >
            DataConnection
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="false"
          pipelineInput="false"
          position="named">
          <maml:name>Params</maml:name>
          <maml:description>
            <maml:para>The parameters that will be used for the query.</maml:para>
          </maml:description>
          <command:parameterValue >
            Hashtable
          </command:parameterValue>
        </command:parameter>
     
        <command:parameter required="true"
          pipelineInput="false"
          position="named">
          <maml:name>Query</maml:name>
          <maml:description>
            <maml:para>The SQL query to execute.</maml:para>
          </maml:description>
          <command:parameterValue >
            string
          </command:parameterValue>
        </command:parameter>
 
      </command:syntaxItem>
    </command:syntax>
 
  <!-- Cmdlet parameter section -->
    <command:parameters>
  <command:parameter required="true"
  pipelineInput="true"
  position=0 >
      <maml:name>Connection</maml:name>
      <maml:description>
        <maml:para>The connection object.</maml:para>
      </maml:description>
      <command:parameterValue required="true" >
        DataConnection
      </command:parameterValue>
 
      <dev:type>
        <maml:name>System.String</maml:name>
        <maml:uri/>
      </dev:type>
      <dev:defaultValue>
        null
      </dev:defaultValue>
    </command:parameter>
      <command:parameter
  pipelineInput="false"
  position="named" >
      <maml:name>Params</maml:name>
      <maml:description>
        <maml:para>The parameters that will be used for the query.</maml:para>
      </maml:description>
      <command:parameterValue >
        Hashtable
      </command:parameterValue>
 
      <dev:type>
        <maml:name>System.String</maml:name>
        <maml:uri/>
      </dev:type>
      <dev:defaultValue>
        null
      </dev:defaultValue>
    </command:parameter>
      <command:parameter required="true"
  pipelineInput="false"
  position="named" >
      <maml:name>Query</maml:name>
      <maml:description>
        <maml:para>The SQL query to execute.</maml:para>
      </maml:description>
      <command:parameterValue required="true" >
        string
      </command:parameterValue>
 
      <dev:type>
        <maml:name>System.String</maml:name>
        <maml:uri/>
      </dev:type>
      <dev:defaultValue>
        ""
      </dev:defaultValue>
    </command:parameter>
     
 
  </command:parameters>
 
  <!-- Input - Output section--> <command:inputTypes>
 
  </command:inputTypes>
 
  <command:returnValues>
      <command:returnValue>
      <dev:type>
        <maml:name>AffectedRowsCount</maml:name>
        <maml:uri />
        <maml:description>
          <maml:para>
            The number of rows affected by the operation.
          </maml:para>
        </maml:description>
      </dev:type>
      <maml:description>
        The number of rows affected by the operation.
      </maml:description>
    </command:returnValue>
      <command:returnValue>
      <dev:type>
        <maml:name>InsertedRowId</maml:name>
        <maml:uri />
        <maml:description>
          <maml:para>
            The unique Id of the inserted row.
          </maml:para>
        </maml:description>
      </dev:type>
      <maml:description>
        The unique Id of the inserted row.
      </maml:description>
    </command:returnValue>
      <command:returnValue>
      <dev:type>
        <maml:name>QueryResults</maml:name>
        <maml:uri />
        <maml:description>
          <maml:para>
            The results of the query.
          </maml:para>
        </maml:description>
      </dev:type>
      <maml:description>
        The results of the query.
      </maml:description>
    </command:returnValue>
   
  </command:returnValues>
 
  <command:terminatingErrors />
 
  <command:nonTerminatingErrors />
 
  <!-- Example section -->
 
  <command:examples />
 
  <!-- Link section --> <maml:relatedLinks>
    <maml:navigationLink>
      <maml:linkText></maml:linkText>
      <maml:uri/>
    </maml:navigationLink>
  </maml:relatedLinks>
</command:command>
<!-- Cmdlet --><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
   
  <command:details>
    <command:name>
      Remove-DynamicsCRM
    </command:name>
    <maml:description>
      <maml:para>Deletes Dynamics CRM data.</maml:para>
    </maml:description>
    <maml:copyright>
      <maml:para>Copyright (c) 2017 CData Software, Inc. - All rights reserved.</maml:para>
    </maml:copyright>
    <command:verb>Remove</command:verb>
    <command:noun>DynamicsCRM</command:noun>
    <dev:version>16.0</dev:version>
  </command:details>
   
  <maml:description>
    <maml:para>Deletes Dynamics CRM data. The Remove-DynamicsCRM cmdlet allows you to use a syntax similar to SQL DELETE statements to delete Dynamics CRM data.</maml:para><maml:para>$conn = Connect-DynamicsCRM -CRMVersion "CRM2011+" -Url "http://MySite/MyOrganization" -User "MyUser" -Password "MyPassword"</maml:para><maml:para>Remove-DynamicsCRM -Connection $conn -Table "Lead" -Id "1045625d-99ee-e011-a272-00155d01ad6b"</maml:para><maml:para></maml:para><maml:para>The Where parameter can also be used to specify the primary key:</maml:para><maml:para></maml:para><maml:para>Remove-DynamicsCRM -Connection $conn -Table "exTable;" -Where "Id = 1045625d-99ee-e011-a272-00155d01ad6b"</maml:para><maml:para></maml:para><maml:para>The primary key can also be passed to the cmdlet along the pipeline:</maml:para><maml:para></maml:para><maml:para>Select-DynamicsCRM -Connection $conn -Table Lead -Where "FirstName = '
Bob'" | Remove-DynamicsCRM</maml:para><maml:para></maml:para><maml:para></maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem>         <maml:name>Remove-DynamicsCRM [parameters]</maml:name> <command:parameter required="true" pipelineInput="true" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection object.</maml:para> </maml:description> <command:parameterValue > DataConnection </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="true" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the item on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position="named"> <maml:name>Table</maml:name> <maml:description> <maml:para>The table on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Where</maml:name> <maml:description> <maml:para>The SQL WHERE clause that will be used for the operation.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="true" pipelineInput="true" position=0 > <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection object.</maml:para> </maml:description> <command:parameterValue required="true" > DataConnection </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> null </dev:defaultValue> </command:parameter> <command:parameter pipelineInput="true" position="named" > <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the item on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position="named" > <maml:name>Table</maml:name> <maml:description> <maml:para>The table on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue required="true" > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter pipelineInput="false" position="named" > <maml:name>Where</maml:name> <maml:description> <maml:para>The SQL WHERE clause that will be used for the operation.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AffectedRowsCount</maml:name> <maml:uri /> <maml:description> <maml:para> The number of rows affected by the operation. </maml:para> </maml:description> </dev:type> <maml:description> The number of rows affected by the operation. </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Example section --> <command:examples /> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet --><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name> Connect-DynamicsCRM </command:name> <maml:description> <maml:para>Opens a new connection to Dynamics CRM</maml:para> </maml:description> <maml:copyright> <maml:para>Copyright (c) 2017 CData Software, Inc. - All rights reserved.</maml:para> </maml:copyright> <command:verb>Connect</command:verb> <command:noun>DynamicsCRM</command:noun> <dev:version>16.0</dev:version> </command:details> <maml:description> <maml:para>The Connect-DynamicsCRM cmdlet is used to create a persistent connection object to be used with related cmdlets. When executing the cmdlet a connection object is returned. Pass this object to the Connection parameter of related cmdlets to use the newly created connection object. To disconnect, call Disconnect-DynamicsCRM.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem>         <maml:name>$conn = Connect-DynamicsCRM</maml:name> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>AuthScheme</maml:name> <maml:description> <maml:para>The authentication scheme used. Accepted entries are NTLM, BASIC, DIGEST, NONE, and KERBEROSDELEGATION.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>AutoCache</maml:name> <maml:description> <maml:para>Persists the results of SELECT queries, allowing real-time reporting while online and offline use.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>CacheConnection</maml:name> <maml:description> <maml:para>The connection string for the cache database.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>CacheLocation</maml:name> <maml:description> <maml:para>Specifies the path to the cache when caching to a file.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>CacheMetadata</maml:name> <maml:description> <maml:para>Whether or not to cache the table metadata. The cache will be stored in memory unless CacheConnection or CacheLocation are set.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>CacheProvider</maml:name> <maml:description> <maml:para>The name of the provider to be used to cache data.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>CallerId</maml:name> <maml:description> <maml:para>The Id of a user to impersonate when inserting or updating new records.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="false" position="named"> <maml:name>CRMVersion</maml:name> <maml:description> <maml:para>The type of Dynamics CRM server to which you are connecting. Accepted entries are CRM2011+, CRMOnline.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>DefaultPrecision</maml:name> <maml:description> <maml:para>The currency precision that is used for pricing throughout the system. Valid values are 0-4 and Auto. If the value is Auto, the default value will be retrieved from the Dynamics CRM server.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>DeviceCredentialLocation</maml:name> <maml:description> <maml:para>The path to a file where device credentials are stored. If the file does not exist or is empty a new set of credentials will be generated and stored in that file.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>DeviceCredentialPassword</maml:name> <maml:description> <maml:para>The password used to encrypt or decrypt the credentials stored in the credentials file.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>DeviceName</maml:name> <maml:description> <maml:para>The device name used to authenticate along with a Windows Live Id.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>DevicePassword</maml:name> <maml:description> <maml:para>The device password used to authenticate along with a Windows Live Id.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>FirewallPassword</maml:name> <maml:description> <maml:para>A password, if authentication is required to connect through a firewall.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>FirewallPort</maml:name> <maml:description> <maml:para>The TCP port for the firewall FirewallServer -- see the description of the FirewallServer option for details.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>FirewallServer</maml:name> <maml:description> <maml:para>Specify a firewall name or IP address to authenticate requested connections, if necessary.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>FirewallType</maml:name> <maml:description> <maml:para>The type of firewall to connect through.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>FirewallUser</maml:name> <maml:description> <maml:para>The user name to authenticate with the firewall.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>IncludeCalculatedColumns</maml:name> <maml:description> <maml:para>This option controls whether the driver returns the Calculated Columns defined on a table. Only applicable for CRM 2015+.</maml:para> </maml:description> <command:parameterValue > bool </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>InternetFacingDeployment</maml:name> <maml:description> <maml:para>Whether you are connecting to an Internet Facing Deployment (IFD) for CRM.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>A path to the directory that contains the schema files defining tables, views, and stored procedures.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Logfile</maml:name> <maml:description> <maml:para>A path to the log file.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>MaxLogFileSize</maml:name> <maml:description> <maml:para>A string specifying the maximum size in bytes for a log file (ex: 10MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Offline</maml:name> <maml:description> <maml:para>Use offline mode to get the data from the cache instead of the live source.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>OrganizationName</maml:name> <maml:description> <maml:para>The name of the organization. In Dynamics CRM 4.0 without IFD, the organization is specified in the URL; for example, http://website/organizationname. In Dynamics CRM 4.0 with IFD, this property must be set. In other versions of CRM, this property is optional.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Other</maml:name> <maml:description> <maml:para>The other parameters necessary to connect to a data source, such as username and password, when applicable.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Pagesize</maml:name> <maml:description> <maml:para>The number of rows to return per page from the data source.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password used to authenticate to the Dynamics CRM site.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>ProxyAuthScheme</maml:name> <maml:description> <maml:para>The proxy server authorization scheme (default: BASIC).</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>ProxyAutoDetect</maml:name> <maml:description> <maml:para>This indicates whether to use the default system proxy settings or not. Set ProxyAutoDetect to FALSE to use custom proxy settings. This takes precedence over other proxy settings.</maml:para> </maml:description> <command:parameterValue > bool </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>ProxyPassword</maml:name> <maml:description> <maml:para>A password, if authenticating with a proxy server.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>The TCP port for the proxy ProxyServer (default: 80).</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>If a proxy server is given, then the HTTP request is sent to the proxy instead of the specified server.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>ProxySSLType</maml:name> <maml:description> <maml:para>The SSL type to use when connecting to the proxy server (default: AUTO).</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>ProxyUser</maml:name> <maml:description> <maml:para>A user name, if authentication is to be used for the proxy.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>PseudoColumns</maml:name> <maml:description> <maml:para>Indicates whether or not to include pseudo columns as columns to the table.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>QueryCache</maml:name> <maml:description> <maml:para>The time duration, in seconds, for which the in-memory cached data is reused.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>QueryMethod</maml:name> <maml:description> <maml:para>The method to use when querying data from Dynamics CRM. In most cases FetchXML will work with all tables.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>QueryPassthrough</maml:name> <maml:description> <maml:para>This option passes the Fetch Xml query to Dynamics CRM as-is.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Readonly</maml:name> <maml:description> <maml:para>You can use this property to enforce read-only access to Dynamics CRM from the provider.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>SSLCert</maml:name> <maml:description> <maml:para>The certificate used for client authentication.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>SSLServerCert</maml:name> <maml:description> <maml:para>The certificate to be accepted from the server when connecting using TLS/SSL.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>STSURL</maml:name> <maml:description> <maml:para>The URL of the security token service (STS).This value only needs to be set for IFD instances of CRM or CRM Online with local AD FS.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>SupportEnhancedSQL</maml:name> <maml:description> <maml:para>If set to true, the provider will cache the entire table in memory and issue the current query against the memory cache. Allows queries with aggregate functions that are otherwise unsupported. The entire memory cache is discarded after the query is executed, unlike QueryCache.</maml:para> </maml:description> <command:parameterValue > bool </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Tables</maml:name> <maml:description> <maml:para>Comma-separated list of tables to be listed. For example: Tables=TableA,TableB,TableC.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The value in seconds until the timeout error is thrown, canceling the operation.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>The root URL of the organization. For example, a CRM 4.0 or CRM 2011 URL will resemble http://MySite/MyOrganization. For CRM Online, the URL will resemble https://myOrg.crm.dynamics.com/.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>UseDisplayNames</maml:name> <maml:description> <maml:para>Boolean determining if the display names for the columns should be used instead of the API names.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>UseNameForPicklistValue</maml:name> <maml:description> <maml:para>Boolean determining if the string value should be used for picklist field values instead of integers.</maml:para> </maml:description> <command:parameterValue > bool </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="false" position="named"> <maml:name>User</maml:name> <maml:description> <maml:para>The user who is authenticating to the Dynamics CRM site.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>UseSimpleNames</maml:name> <maml:description> <maml:para>Boolean determining if simple names should be used for tables and columns.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Verbosity</maml:name> <maml:description> <maml:para>The verbosity level that determines the amount of detail included in the log file.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter > <maml:name>AuthScheme</maml:name> <maml:description> <maml:para>The authentication scheme used. Accepted entries are NTLM, BASIC, DIGEST, NONE, and KERBEROSDELEGATION.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:possibleValues> <dev:possibleValue> <dev:value>NTLM</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>BASIC</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>DIGEST</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>NONE</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>KERBEROSDELEGATION</dev:value> </dev:possibleValue> </dev:possibleValues> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "NTLM" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>AutoCache</maml:name> <maml:description> <maml:para>Persists the results of SELECT queries, allowing real-time reporting while online and offline use.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> false </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>CacheConnection</maml:name> <maml:description> <maml:para>The connection string for the cache database.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>CacheLocation</maml:name> <maml:description> <maml:para>Specifies the path to the cache when caching to a file.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>CacheMetadata</maml:name> <maml:description> <maml:para>Whether or not to cache the table metadata. The cache will be stored in memory unless CacheConnection or CacheLocation are set.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> false </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>CacheProvider</maml:name> <maml:description> <maml:para>The name of the provider to be used to cache data.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>CallerId</maml:name> <maml:description> <maml:para>The Id of a user to impersonate when inserting or updating new records.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter required="true"> <maml:name>CRMVersion</maml:name> <maml:description> <maml:para>The type of Dynamics CRM server to which you are connecting. Accepted entries are CRM2011+, CRMOnline.</maml:para> </maml:description> <command:parameterValue required="true" > string </command:parameterValue> <dev:possibleValues> <dev:possibleValue> <dev:value>CRM2011+</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>CRMOnline</dev:value> </dev:possibleValue> </dev:possibleValues> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "CRM2011+" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>DefaultPrecision</maml:name> <maml:description> <maml:para>The currency precision that is used for pricing throughout the system. Valid values are 0-4 and Auto. If the value is Auto, the default value will be retrieved from the Dynamics CRM server.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "2" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>DeviceCredentialLocation</maml:name> <maml:description> <maml:para>The path to a file where device credentials are stored. If the file does not exist or is empty a new set of credentials will be generated and stored in that file.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>DeviceCredentialPassword</maml:name> <maml:description> <maml:para>The password used to encrypt or decrypt the credentials stored in the credentials file.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>DeviceName</maml:name> <maml:description> <maml:para>The device name used to authenticate along with a Windows Live Id.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>DevicePassword</maml:name> <maml:description> <maml:para>The device password used to authenticate along with a Windows Live Id.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>FirewallPassword</maml:name> <maml:description> <maml:para>A password, if authentication is required to connect through a firewall.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>FirewallPort</maml:name> <maml:description> <maml:para>The TCP port for the firewall FirewallServer -- see the description of the FirewallServer option for details.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>FirewallServer</maml:name> <maml:description> <maml:para>Specify a firewall name or IP address to authenticate requested connections, if necessary.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>FirewallType</maml:name> <maml:description> <maml:para>The type of firewall to connect through.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:possibleValues> <dev:possibleValue> <dev:value>NONE</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>TUNNEL</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>SOCKS4</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>SOCKS5</dev:value> </dev:possibleValue> </dev:possibleValues> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "NONE" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>FirewallUser</maml:name> <maml:description> <maml:para>The user name to authenticate with the firewall.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>IncludeCalculatedColumns</maml:name> <maml:description> <maml:para>This option controls whether the driver returns the Calculated Columns defined on a table. Only applicable for CRM 2015+.</maml:para> </maml:description> <command:parameterValue > bool </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> true </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>InternetFacingDeployment</maml:name> <maml:description> <maml:para>Whether you are connecting to an Internet Facing Deployment (IFD) for CRM.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "false" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>Location</maml:name> <maml:description> <maml:para>A path to the directory that contains the schema files defining tables, views, and stored procedures.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>Logfile</maml:name> <maml:description> <maml:para>A path to the log file.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>MaxLogFileSize</maml:name> <maml:description> <maml:para>A string specifying the maximum size in bytes for a log file (ex: 10MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>Offline</maml:name> <maml:description> <maml:para>Use offline mode to get the data from the cache instead of the live source.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> false </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>OrganizationName</maml:name> <maml:description> <maml:para>The name of the organization. In Dynamics CRM 4.0 without IFD, the organization is specified in the URL; for example, http://website/organizationname. In Dynamics CRM 4.0 with IFD, this property must be set. In other versions of CRM, this property is optional.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>Other</maml:name> <maml:description> <maml:para>The other parameters necessary to connect to a data source, such as username and password, when applicable.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>Pagesize</maml:name> <maml:description> <maml:para>The number of rows to return per page from the data source.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "500" </dev:defaultValue> </command:parameter> <command:parameter required="true"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password used to authenticate to the Dynamics CRM site.</maml:para> </maml:description> <command:parameterValue required="true" > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>ProxyAuthScheme</maml:name> <maml:description> <maml:para>The proxy server authorization scheme (default: BASIC).</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:possibleValues> <dev:possibleValue> <dev:value>BASIC</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>DIGEST</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>NONE</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>NEGOTIATE</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>NTLM</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>PROPRIETARY</dev:value> </dev:possibleValue> </dev:possibleValues> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "BASIC" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>ProxyAutoDetect</maml:name> <maml:description> <maml:para>This indicates whether to use the default system proxy settings or not. Set ProxyAutoDetect to FALSE to use custom proxy settings. This takes precedence over other proxy settings.</maml:para> </maml:description> <command:parameterValue > bool </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> true </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>ProxyPassword</maml:name> <maml:description> <maml:para>A password, if authenticating with a proxy server.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>The TCP port for the proxy ProxyServer (default: 80).</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "80" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>If a proxy server is given, then the HTTP request is sent to the proxy instead of the specified server.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>ProxySSLType</maml:name> <maml:description> <maml:para>The SSL type to use when connecting to the proxy server (default: AUTO).</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:possibleValues> <dev:possibleValue> <dev:value>AUTO</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>ALWAYS</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>NEVER</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>TUNNEL</dev:value> </dev:possibleValue> </dev:possibleValues> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "AUTO" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>ProxyUser</maml:name> <maml:description> <maml:para>A user name, if authentication is to be used for the proxy.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>PseudoColumns</maml:name> <maml:description> <maml:para>Indicates whether or not to include pseudo columns as columns to the table.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>QueryCache</maml:name> <maml:description> <maml:para>The time duration, in seconds, for which the in-memory cached data is reused.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>QueryMethod</maml:name> <maml:description> <maml:para>The method to use when querying data from Dynamics CRM. In most cases FetchXML will work with all tables.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:possibleValues> <dev:possibleValue> <dev:value>FetchXML</dev:value> </dev:possibleValue> <dev:possibleValue> <dev:value>QueryExpression</dev:value> </dev:possibleValue> </dev:possibleValues> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "FetchXML" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>QueryPassthrough</maml:name> <maml:description> <maml:para>This option passes the Fetch Xml query to Dynamics CRM as-is.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> false </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>Readonly</maml:name> <maml:description> <maml:para>You can use this property to enforce read-only access to Dynamics CRM from the provider.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> false </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>RTK</maml:name> <maml:description> <maml:para>The runtime key used for licensing.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>SSLCert</maml:name> <maml:description> <maml:para>The certificate used for client authentication.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>SSLServerCert</maml:name> <maml:description> <maml:para>The certificate to be accepted from the server when connecting using TLS/SSL.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>STSURL</maml:name> <maml:description> <maml:para>The URL of the security token service (STS).This value only needs to be set for IFD instances of CRM or CRM Online with local AD FS.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>SupportEnhancedSQL</maml:name> <maml:description> <maml:para>If set to true, the provider will cache the entire table in memory and issue the current query against the memory cache. Allows queries with aggregate functions that are otherwise unsupported. The entire memory cache is discarded after the query is executed, unlike QueryCache.</maml:para> </maml:description> <command:parameterValue > bool </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> true </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>Tables</maml:name> <maml:description> <maml:para>Comma-separated list of tables to be listed. For example: Tables=TableA,TableB,TableC.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>Timeout</maml:name> <maml:description> <maml:para>The value in seconds until the timeout error is thrown, canceling the operation.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "60" </dev:defaultValue> </command:parameter> <command:parameter required="true"> <maml:name>Url</maml:name> <maml:description> <maml:para>The root URL of the organization. For example, a CRM 4.0 or CRM 2011 URL will resemble http://MySite/MyOrganization. For CRM Online, the URL will resemble https://myOrg.crm.dynamics.com/.</maml:para> </maml:description> <command:parameterValue required="true" > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>UseDisplayNames</maml:name> <maml:description> <maml:para>Boolean determining if the display names for the columns should be used instead of the API names.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> false </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>UseNameForPicklistValue</maml:name> <maml:description> <maml:para>Boolean determining if the string value should be used for picklist field values instead of integers.</maml:para> </maml:description> <command:parameterValue > bool </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> true </dev:defaultValue> </command:parameter> <command:parameter required="true"> <maml:name>User</maml:name> <maml:description> <maml:para>The user who is authenticating to the Dynamics CRM site.</maml:para> </maml:description> <command:parameterValue required="true" > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>UseSimpleNames</maml:name> <maml:description> <maml:para>Boolean determining if simple names should be used for tables and columns.</maml:para> </maml:description> <command:parameterValue > SwitchParameter </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> false </dev:defaultValue> </command:parameter> <command:parameter > <maml:name>Verbosity</maml:name> <maml:description> <maml:para>The verbosity level that determines the amount of detail included in the log file.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "1" </dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>CData.DynamicsCRMCmdlets.Commands.DynamicsCRMPSConnection</maml:name> <maml:uri /> <maml:description> <maml:para> The Dynamics CRM connection object. </maml:para> </maml:description> </dev:type> <maml:description> The DynamicsCRMConnection object may be passed to related cmdlets to use the connection. </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Example section --> <command:examples /> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet --><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name> Select-DynamicsCRM </command:name> <maml:description> <maml:para>Searches Dynamics CRM data.</maml:para> </maml:description> <maml:copyright> <maml:para>Copyright (c) 2017 CData Software, Inc. - All rights reserved.</maml:para> </maml:copyright> <command:verb>Select</command:verb> <command:noun>DynamicsCRM</command:noun> <dev:version>16.0</dev:version> </command:details> <maml:description> <maml:para>Searches Dynamics CRM data. The Select-DynamicsCRM cmdlet allows you to use a syntax similar to SQL SELECT statements to search Dynamics CRM data.</maml:para><maml:para>$conn = Connect-DynamicsCRM -CRMVersion "CRM2011+" -Url "http://MySite/MyOrganization" -User "MyUser" -Password "MyPassword"</maml:para><maml:para>Select-DynamicsCRM -Connection $conn -Table "Lead" -Columns @("Id","FirstName") -Where "FirstName='Bob'"</maml:para><maml:para></maml:para><maml:para></maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem>         <maml:name>Select-DynamicsCRM [parameters]</maml:name> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Columns</maml:name> <maml:description> <maml:para>The columns to return.</maml:para> </maml:description> <command:parameterValue > string[] </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection object.</maml:para> </maml:description> <command:parameterValue > DataConnection </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>GroupBy</maml:name> <maml:description> <maml:para>A comma-separated list of columns that the result set will be grouped by.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>The order in which columns will be returned.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Params</maml:name> <maml:description> <maml:para>The parameters that will be used for the query.</maml:para> </maml:description> <command:parameterValue > Hashtable </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position="named"> <maml:name>Table</maml:name> <maml:description> <maml:para>The table on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Where</maml:name> <maml:description> <maml:para>The SQL WHERE clause that will be used for the operation.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter pipelineInput="false" position="named" > <maml:name>Columns</maml:name> <maml:description> <maml:para>The columns to return.</maml:para> </maml:description> <command:parameterValue > string[] </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> null </dev:defaultValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position=0 > <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection object.</maml:para> </maml:description> <command:parameterValue required="true" > DataConnection </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> null </dev:defaultValue> </command:parameter> <command:parameter pipelineInput="false" position="named" > <maml:name>GroupBy</maml:name> <maml:description> <maml:para>A comma-separated list of columns that the result set will be grouped by.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter pipelineInput="false" position="named" > <maml:name>OrderBy</maml:name> <maml:description> <maml:para>The order in which columns will be returned.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter pipelineInput="false" position="named" > <maml:name>Params</maml:name> <maml:description> <maml:para>The parameters that will be used for the query.</maml:para> </maml:description> <command:parameterValue > Hashtable </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> null </dev:defaultValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position="named" > <maml:name>Table</maml:name> <maml:description> <maml:para>The table on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue required="true" > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter pipelineInput="false" position="named" > <maml:name>Where</maml:name> <maml:description> <maml:para>The SQL WHERE clause that will be used for the operation.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>QueryResults</maml:name> <maml:uri /> <maml:description> <maml:para> The results of the query. </maml:para> </maml:description> </dev:type> <maml:description> The results of the query. </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Example section --> <command:examples /> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet --><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name> Sync-DynamicsCRM </command:name> <maml:description> <maml:para>Syncs Dynamics CRM data.</maml:para> </maml:description> <maml:copyright> <maml:para>Copyright (c) 2017 CData Software, Inc. - All rights reserved.</maml:para> </maml:copyright> <command:verb>Sync</command:verb> <command:noun>DynamicsCRM</command:noun> <dev:version>16.0</dev:version> </command:details> <maml:description> <maml:para>Syncs Dynamics CRM data. The Sync-DynamicsCRM cmdlet allows you to replicate a data source locally and maintain it with the full caching functionality of the provider.</maml:para><maml:para>$conn = Connect-DynamicsCRM -CRMVersion "CRM2011+" -Url "http://MySite/MyOrganization" -User "MyUser" -Password "MyPassword"</maml:para><maml:para>Sync-DynamicsCRM -Connection $conn -Table "Lead"</maml:para><maml:para></maml:para><maml:para></maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem>         <maml:name>Sync-DynamicsCRM [parameters]</maml:name> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Columns</maml:name> <maml:description> <maml:para>The columns to sync.</maml:para> </maml:description> <command:parameterValue > string[] </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection object.</maml:para> </maml:description> <command:parameterValue > DataConnection </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="true" position="named"> <maml:name>DestinationTable</maml:name> <maml:description> <maml:para>The table where the data will be placed.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Params</maml:name> <maml:description> <maml:para>The parameters that will be used for the query.</maml:para> </maml:description> <command:parameterValue > Hashtable </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position="named"> <maml:name>Table</maml:name> <maml:description> <maml:para>The table on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter pipelineInput="false" position="named" > <maml:name>Columns</maml:name> <maml:description> <maml:para>The columns to sync.</maml:para> </maml:description> <command:parameterValue > string[] </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> null </dev:defaultValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position=0 > <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection object.</maml:para> </maml:description> <command:parameterValue required="true" > DataConnection </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> null </dev:defaultValue> </command:parameter> <command:parameter pipelineInput="true" position="named" > <maml:name>DestinationTable</maml:name> <maml:description> <maml:para>The table where the data will be placed.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter pipelineInput="false" position="named" > <maml:name>Params</maml:name> <maml:description> <maml:para>The parameters that will be used for the query.</maml:para> </maml:description> <command:parameterValue > Hashtable </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> null </dev:defaultValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position="named" > <maml:name>Table</maml:name> <maml:description> <maml:para>The table on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue required="true" > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AffectedRowsCount</maml:name> <maml:uri /> <maml:description> <maml:para> The number of rows affected by the operation. </maml:para> </maml:description> </dev:type> <maml:description> The number of rows affected by the operation. </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Example section --> <command:examples /> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet --><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name> Update-DynamicsCRM </command:name> <maml:description> <maml:para>Updates Dynamics CRM data.</maml:para> </maml:description> <maml:copyright> <maml:para>Copyright (c) 2017 CData Software, Inc. - All rights reserved.</maml:para> </maml:copyright> <command:verb>Update</command:verb> <command:noun>DynamicsCRM</command:noun> <dev:version>16.0</dev:version> </command:details> <maml:description> <maml:para>Updates Dynamics CRM data. The Update-DynamicsCRM cmdlet allows you to use a syntax similar to SQL UPDATE statements to update Dynamics CRM data.</maml:para><maml:para>$conn = Connect-DynamicsCRM -CRMVersion "CRM2011+" -Url "http://MySite/MyOrganization" -User "MyUser" -Password "MyPassword"</maml:para><maml:para>Update-DynamicsCRM -Connection $conn -Table "Lead" -Columns @("FirstName") -Values @("Jon Doe") -Id "1045625d-99ee-e011-a272-00155d01ad6b"</maml:para><maml:para></maml:para><maml:para>The Where parameter can also be used to specify the primary key of the table:</maml:para><maml:para></maml:para><maml:para>Update-DynamicsCRM -Connection $conn -Table "Lead" -Columns @("FirstName") -Values @("Jon Doe") -Where "Id = '1045625d-99ee-e011-a272-00155d01ad6b'"</maml:para><maml:para></maml:para><maml:para>The primary key can also be passed to the cmdlet along the pipeline:</maml:para><maml:para></maml:para><maml:para>Select-DynamicsCRM -Connection $conn -Table Lead -Where "FirstName = 'Bob'" | Update-DynamicsCRM -Columns @("FirstName") -Values @("Bob 2")</maml:para><maml:para></maml:para><maml:para></maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem>         <maml:name>Update-DynamicsCRM [parameters]</maml:name> <command:parameter required="true" pipelineInput="true" position="named"> <maml:name>Columns</maml:name> <maml:description> <maml:para>The columns on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue > string[] </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection object.</maml:para> </maml:description> <command:parameterValue > DataConnection </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="true" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the item on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position="named"> <maml:name>Table</maml:name> <maml:description> <maml:para>The table on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> <command:parameter required="true" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>The values that will be used to update the table.</maml:para> </maml:description> <command:parameterValue > string[] </command:parameterValue> </command:parameter> <command:parameter required="false" pipelineInput="false" position="named"> <maml:name>Where</maml:name> <maml:description> <maml:para>The SQL WHERE clause that will be used for the operation.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="true" pipelineInput="true" position="named" > <maml:name>Columns</maml:name> <maml:description> <maml:para>The columns on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue required="true" > string[] </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> null </dev:defaultValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position=0 > <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection object.</maml:para> </maml:description> <command:parameterValue required="true" > DataConnection </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> null </dev:defaultValue> </command:parameter> <command:parameter pipelineInput="true" position="named" > <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the item on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter required="true" pipelineInput="true" position="named" > <maml:name>Table</maml:name> <maml:description> <maml:para>The table on which the operation will be performed.</maml:para> </maml:description> <command:parameterValue required="true" > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> <command:parameter required="true" pipelineInput="false" position="named" > <maml:name>Values</maml:name> <maml:description> <maml:para>The values that will be used to update the table.</maml:para> </maml:description> <command:parameterValue required="true" > string[] </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> null </dev:defaultValue> </command:parameter> <command:parameter pipelineInput="false" position="named" > <maml:name>Where</maml:name> <maml:description> <maml:para>The SQL WHERE clause that will be used for the operation.</maml:para> </maml:description> <command:parameterValue > string </command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> "" </dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>AffectedRowsCount</maml:name> <maml:uri /> <maml:description> <maml:para> The number of rows affected by the operation. </maml:para> </maml:description> </dev:type> <maml:description> The number of rows affected by the operation. </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Example section --> <command:examples /> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems>