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 |
|---|---|
Adds a Dynamics 365 database from a SQL MDF (raw database file) or a SQL backup file. |
|
Adds a Dynamics 365 server to the specified deployment. |
|
Disables the specified Dynamics 365 organization. |
|
Disables the specified Dynamics 365 server. |
|
Edits properties of the specified Dynamics 365 organization. |
|
Enables the specified Dynamics 365 organization. |
|
Enables the specified Dynamics 365 server. |
|
Retrieves the server licensing and client access license (CAL) licensing information for the Dynamics 365 deployment. |
|
Gets an advanced setting value for Dynamics 365. It is not intended for general use. |
|
Retrieves the certificate information for Dynamics 365. |
|
Retrieves the deployment administrators for the Dynamics 365 deployment. |
|
Retrieves the license properties for Dynamics 365. |
|
Retrieves results from the monitoring service operations tests for the Dynamics 365 deployment. |
|
Retrieves the status on asynchronous operations sitting in the asynchronous operation queue for Dynamics 365. |
|
Retrieves one or all of the organizations in the Dynamics 365 deployment. |
|
Retrieves an XML file used to map users from a Dynamics 365 organization about to be imported to an existing user domain. |
|
Retrieves a server object for one or all Dynamics 365 servers in a deployment. |
|
Retrieves a Dynamics 365 deployment setting object. |
|
Initiates the process to import a Dynamics 365 organization database into the deployment. |
|
Creates a new deployment administrator for the Dynamics 365 deployment. |
|
Initiates the process to create a new organization in the Dynamics 365 deployment. |
|
Removes the specified certificate from Dynamics 365. |
|
Removes the specified deployment administrator from the Dynamics 365 deployment. |
|
Deletes the specified organization from the Dynamics 365 deployment. |
|
Deletes the specified server from the Dynamics 365 deployment. |
|
Sets an advanced setting value for Dynamics 365. It is not intended for general use. |
|
Creates a certificate record or sets the properties of an existing certificate record in the Dynamics 365 configuration database. |
|
Sets the product key for the Dynamics 365 deployment. |
|
Sets the specified Dynamics 365 deployment-wide settings. |
|
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 |
|---|---|
Returns a connection to a Microsoft Dynamics 365 instance. |
|
Returns a list of Microsoft Dynamics 365 online or Microsoft Dynamics 365 on-premises organizations. |
Package Deployment Cmdlets
| Name | Description |
|---|---|
Returns a list of available packages that can be deployed to a Microsoft Dynamics 365 online instance or Dynamics 365 on-premises organization. |
|
Imports a package to a Microsoft Dynamics 365 online instance or Dynamics 365 on-premises organization. |