Microsoft Dynamics 365 PowerShell Reference

Applies To: CRM 2016 on-prem, CRM Online, Dynamics 365 (online), Dynamics 365 (on-premises)

This topic lists the Windows PowerShell cmdlets for Microsoft Dynamics 365 and provides links to help topics for the cmdlets. You can use the cmdlets to manage your Dynamics 365 deployment. It also includes cmdlets that enable you to connect to and deploy packages to a Dynamics 365 instance.

Before you can use these PowerShell cmdlets, you must register them. For registering:

• Microsoft Dynamics 365 Management Cmdlets, see Administer the deployment using Windows PowerShell.

• Connector Cmdlets, see Use PowerShell cmdlets for XRM tooling to connect to Dynamics 365.

• Package Deployment Cmdlets, see Use Windows PowerShell to deploy packages.

In this topic

Dynamics 365 Management Cmdlets

Connector Cmdlets

Package Deployment Cmdlets

Dynamics 365 Management Cmdlets

Name	Description
Add-CrmDatabase	Adds a Dynamics 365 database from a SQL MDF (raw database file) or a SQL backup file.
Add-CrmServer	Adds a Dynamics 365 server to the specified deployment.
Disable-CrmOrganization	Disables the specified Dynamics 365 organization.
Disable-CrmServer	Disables the specified Dynamics 365 server.
Edit-CrmOrganization	Edits properties of the specified Dynamics 365 organization.
Enable-CrmOrganization	Enables the specified Dynamics 365 organization.
Enable-CrmServer	Enables the specified Dynamics 365 server.
Get-CrmAccessLicense	Retrieves the server licensing and client access license (CAL) licensing information for the Dynamics 365 deployment.
Get-CrmAdvancedSetting	Gets an advanced setting value for Dynamics 365. It is not intended for general use.
Get-CrmCertificate	Retrieves the certificate information for Dynamics 365.
Get-CrmDeploymentAdministrator	Retrieves the deployment administrators for the Dynamics 365 deployment.
Get-CrmLicenseProperty	Retrieves the license properties for Dynamics 365.
Get-CrmMonitoringResult	Retrieves results from the monitoring service operations tests for the Dynamics 365 deployment.
Get-CrmOperationStatus	Retrieves the status on asynchronous operations sitting in the asynchronous operation queue for Dynamics 365.
Get-CrmOrganization	Retrieves one or all of the organizations in the Dynamics 365 deployment.
Get-CrmOrganizationUserMap	Retrieves an XML file used to map users from a Dynamics 365 organization about to be imported to an existing user domain.
Get-CrmServer	Retrieves a server object for one or all Dynamics 365 servers in a deployment.
Get-CrmSetting	Retrieves a Dynamics 365 deployment setting object.
Import-CrmOrganization	Initiates the process to import a Dynamics 365 organization database into the deployment.
New-CrmDeploymentAdministrator	Creates a new deployment administrator for the Dynamics 365 deployment.
New-CrmOrganization	Initiates the process to create a new organization in the Dynamics 365 deployment.
Remove-CrmCertificate	Removes the specified certificate from Dynamics 365.
Remove-CrmDeploymentAdministrator	Removes the specified deployment administrator from the Dynamics 365 deployment.
Remove-CrmOrganization	Deletes the specified organization from the Dynamics 365 deployment.
Remove-CrmServer	Deletes the specified server from the Dynamics 365 deployment.
Set-CrmAdvancedSetting	Sets an advanced setting value for Dynamics 365. It is not intended for general use.
Set-CrmCertificate	Creates a certificate record or sets the properties of an existing certificate record in the Dynamics 365 configuration database.
Set-CrmProductKey	Sets the product key for the Dynamics 365 deployment.
Set-CrmSetting	Sets the specified Dynamics 365 deployment-wide settings.
Update-CrmOrganization	Updates the specified Dynamics 365 organization with the latest software updates, or upgrades the organization to the latest available Dynamics 365 release.

Connector Cmdlets

Name	Description
Get-CrmConnection	Returns a connection to a Microsoft Dynamics 365 instance.
Get-CrmOrganizations	Returns a list of Microsoft Dynamics 365 online or Microsoft Dynamics 365 on-premises organizations.

Package Deployment Cmdlets

Name	Description
Get-CrmPackages	Returns a list of available packages that can be deployed to a Microsoft Dynamics 365 online instance or Dynamics 365 on-premises organization.
Import-CrmPackage	Imports a package to a Microsoft Dynamics 365 online instance or Dynamics 365 on-premises organization.

See Also

Other Resources

Scripting with Windows PowerShell