Microsoft Dynamics CRM PowerShell Reference

  • [アーティクル]

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

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

In This Topic

CRM Management Cmdlets

Connector Cmdlets

Package Deployment Cmdlets

CRM Management Cmdlets

Name Description

Add-CrmDatabase

Adds a Microsoft Dynamics CRM database from a SQL MDF (raw database file) or a SQL backup file.

Add-CrmServer

Adds a Microsoft Dynamics CRM server to the specified deployment.

Disable-CrmOrganization

Disables the specified Microsoft Dynamics CRM organization.

Disable-CrmServer

Disables the specified Microsoft Dynamics CRM server.

Edit-CrmOrganization

Edits properties of the specified Microsoft Dynamics CRM organization.

Enable-CrmOrganization

Enables the specified Microsoft Dynamics CRM organization.

Enable-CrmServer

Enables the specified Microsoft Dynamics CRM server.

Get-CrmAccessLicense

Retrieves the server licensing and client access license (CAL) licensing information for the Microsoft Dynamics CRMdeployment.

Get-CrmAdvancedSetting

Gets an advanced setting value for Microsoft Dynamics CRM. It is not intended for general use.

Get-CrmCertificate

Retrieves the certificate information for Microsoft Dynamics CRM.

Get-CrmDeploymentAdministrator

Retrieves the deployment administrators for the Microsoft Dynamics CRM deployment.

Get-CrmLicenseProperty

Retrieves the license properties for Microsoft Dynamics CRM.

Get-CrmMonitoringResult

Retrieves results from the monitoring service operations tests for the Microsoft Dynamics CRM deployment.

Get-CrmOperationStatus

Retrieves the status on asynchronous operations sitting in the asynchronous operation queue for Microsoft Dynamics CRM.

Get-CrmOrganization

Retrieves one or all of the organizations in the Microsoft Dynamics CRM deployment.

Get-CrmOrganizationUserMap

Retrieves an XML file used to map users from a Microsoft Dynamics CRM organization about to be imported to an existing user domain.

Get-CrmServer

Retrieves a server object for one or all Microsoft Dynamics CRM servers in a deployment.

Get-CrmSetting

Retrieves a Microsoft Dynamics CRM deployment setting object.

Import-CrmOrganization

Initiates the process to import a Microsoft Dynamics CRM organization database into the deployment.

New-CrmDeploymentAdministrator

Creates a new deployment administrator for the Microsoft Dynamics CRM deployment.

New-CrmOrganization

Initiates the process to create a new organization in the Microsoft Dynamics CRM deployment.

Remove-CrmCertificate

Removes the specified certificate from Microsoft Dynamics CRM.

Remove-CrmDeploymentAdministrator

Removes the specified deployment administrator from the Microsoft Dynamics CRM deployment.

Remove-CrmOrganization

Deletes the specified organization from the Microsoft Dynamics CRM deployment.

Remove-CrmServer

Deletes the specified server from the Microsoft Dynamics CRM deployment.

Set-CrmAdvancedSetting

Sets an advanced setting value for Microsoft Dynamics CRM. It is not intended for general use.

Set-CrmCertificate

Creates a certificate record or sets the properties of an existing certificate record in the Microsoft Dynamics CRM configuration database.

Set-CrmProductKey

Sets the product key for the Microsoft Dynamics CRM deployment.

Set-CrmSetting

Sets the specified Microsoft Dynamics CRM deployment-wide settings.

Update-CrmOrganization

Updates the specified Microsoft Dynamics CRM organization with the latest software updates, or upgrades the organization to the latest available Microsoft Dynamics CRM release.

Connector Cmdlets

Name Description

Get-CrmConnection

Returns a connection to a Microsoft Dynamics CRM instance.

Get-CrmOrganizations

Returns a list of Microsoft Dynamics CRM organizations.

Package Deployment Cmdlets

Name Description

Get-CrmPackages

Returns a list of available packages that can be deployed to a Microsoft Dynamics CRM instance.

Import-CrmPackage

Imports a package to a Microsoft Dynamics CRM instance.

See Also

Other Resources

Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online Implementation Guide
Blog: PowerShell module for performing data operations and manipulating user and system settings in CRM
Scripting with Windows PowerShell