Microsoft.Xrm.Data.PowerShell

Overview

Microsoft.Xrm.Data.Powershell.zip contains one primary module, Microsoft.Xrm.Data.Powershell, but also relies on an included dll module Microsoft.Xrm.Tooling.CrmConnector.Powershell.

Version 1.xx is Dynamics CRM 2015 SDK base.

Version 2.xx is Dynamics CRM 2016 SDK base and it is compatibile with Azure Automation. For more information about v2.xx, go to v2.0 branch

Releases are found on the Release Page

Microsoft.Xrm.Data.Powershell

This module uses the CRM connection from Microsoft.Xrm.Tooling.CrmConnector.Powershell and provides common functions to create, delete, query, and update data as well as functions for common tasks such as publishing, and manipulating System & CRM User Settings, etc. The module should function for both Dynamics CRM Online and On-Premise environment.

Microsoft.Xrm.Tooling.CrmConnector.Powershell

This module comes from Dynamics CRM SDK and it exposes two functions, Get-CrmOrganizations and Get-CrmConnection. See the link for more detail.

Use PowerShell cmdlets for XRM tooling to connect to CRM

###How to setup modules

1. Download Microsoft.Xrm.Data.Powershell.zip.

2. Right click the downloaded zip file and click "Properties".

3. Check "Unblock" checkbox and click "OK", or simply click "Unblock" button depending on OS versions.


4. Extract the zip file and copy "Microsoft.Xrm.Data.PowerShell" folder to one of the following folders:
* %USERPROFILE%\Documents\WindowsPowerShell\Modules
* %WINDIR%\System32\WindowsPowerShell\v1.0\Modules
Following image shows this module copied to User Profile. If you want anyone to use the module on the computer, copy them to System Wide PowerShell module folder instead. If you do not have the folder, you can manually create them.


5. As this module is not signed, you may need to change Execution Policy to load the module. You can do so by executing following command.

```PowerShell Set-ExecutionPolicy –ExecutionPolicy RemoteSigned –Scope CurrentUser ``` Please refer to [Set-ExecutionPolicy](https://technet.microsoft.com/en-us/library/ee176961.aspx) for more information.

6. Open PowerShell and run following command to load the module.

```PowerShell # Import Micrsoft.Xrm.Data.Powershell module Import-Module Microsoft.Xrm.Data.Powershell ``` *The module requires PowerShell v4.0.

###How module works Microsoft.Xrm.Data.Powershell module exposes many functions, but you can use Connect-CrmOnlineDiscovery and/or Connect-CrmOnpremDiscovery to connect to any CRM Online/OnPrem organization. By executing the function, it creates $conn global variable. Any other functions which needs to connect to the CRM Organization takes connection parameter. You can explicitly specify the connection by using -conn parameter, but if you omit the connection, functions retrieve connection from global variable.

Alternatively, you can create multiple connection objects and pass them into each function under the –conn parameter.

$global:conn = Get-CrmConnection -InteractiveMode

See more detail about Get-CrmConnection function.

###Example This example shows how to create connection and do CRUD operation as well as manipulate System Settings.

1. Run following command to connect to Dynamics CRM Organization via the Xrm Tooling GUI.

```PowerShell # Online Connect-CrmOnlineDiscovery -InteractiveMode # OnPrem Connect-CrmOnpremDiscovery -InteractiveMode ```

2. Run following command to test CRUD.

```PowerShell # Create an account and store record Guid to a variable $accountId = New-CrmRecord -conn $conn -EntityLogicalName account -Fields @{"name"="Sample Account";"telephone1"="555-5555"}

Display the Guid

$accountid

Retrieve a record and store record to a variable

$account = Get-CrmRecord -conn $conn -EntityLogicalName account -Id $accountId -Fields name,telephone1

Display the record

$account

Set new name value for the record

$account.name = "Sample Account Updated"

Update the record

Set-CrmRecord -conn $conn -CrmRecord $account

Retrieve the record again and display the result

Get-CrmRecord -conn $conn -EntityLogicalName account -Id $accountId -Fields name

Delete the record

Remove-CrmRecord -conn $conn -CrmRecord $account

<p>3. Run following command to manipulate SystemSettings.</p>
```PowerShell
# Display the current setting 
Get-CrmSystemSettings -conn $conn -ShowDisplayName 
 
# Change the PricingDecimalPrecision system setting from 0 to 1 
Set-CrmSystemSettings -conn $conn -PricingDecimalPrecision 1 
 
# Display the current setting 
Get-CrmSystemSettings -conn $conn -ShowDisplayName

###How to get command details Each command has detail explanation.

1. Run following command to get all commands.

```PowerShell Get-Command *crm* ```

2. Run following command to get help.

```PowerShell Get-Help New-CrmRecord -Detailed ``` ####About Authors This module is implemented by Sean McNellis and Kenichiro Nakamura.

Sean McNellis, Sr. Premier Field Engineer, is based out of North America and works supporting Dynamics CRM customers.
Kenichiro Nakamura, Sr. Premier Mission Critical Specialist, is based out of Japan and works supporting PMC customers.

Blog (English): http://blogs.msdn.com/CrmInTheField
Blog (Japanese): http://blogs.msdn.com/CrmJapan
Twitter: @pfedynamics

Initial Release to GitHub. Refer to previous release information here.