This repository has been archived by the owner on Jan 29, 2022. It is now read-only.
CRM Powershell Library v1.3.0.0
NOTE: This release contains breaking changes from previous versions. Be sure to test your scripts before updating.
Cmdlets
All Cmdlets are impacted by the changes made in this release. See 'Issues & Changes'.
Issues & Changes
- Combined 'Name' and 'Include' parameters.
The separate parametersName
(without wildcard support) andInclude
(with wildcard support) are combined as the parameterName
with wildcard support.Include
can still be used as the alias. - Improved pipeline support.
Cmdlets which require parent information to function now support this parent information from the pipeline.
The following are now supported for example:
Get-CrmEntity account | Get-CrmAttribute
Get-CrmSolution mysolution | Get-CrmSolutionComponent
- Default sorting on Metadata cmdlet output.
Sorting is applied to the output of Cmdlets which return CRM Metadata; likeGet-CrmEntity
andGet-CrmAttribute
. - Default sorting on administration & customization cmdlet output.
Sorting is applied to the output of Cmdlets which return CRM administration or customization information; likeGet-CrmUser
andGet-CrmPublisher
. - Consistent use of 'InputObject' parameter, conform to best practices for PowerShell.
All Cmdlets which could receive a complex object as input now consistently useInputObject
as the parameter. The previous names of the parameters are still available as alias. - 'PassThru' parameter on all Cmdlets with optional output.
All Cmdlets (except Get-Crm...) have thePassThru
parameter. This needs to be provided to get an output from the cmdlets. By default none return a result. This meansNew-CrmEntity
will not return the EntityMetadata unless explicitly specified with PassThru. - Exporting Cmdlet output contains object values, instead of object Types.
This required a major rewrite and addition of PSPropertyAdapters. The result is all object properties are exposed as their true type, but complex types are wrapped in a custom PSObject which overrides ToString().
As a result all properties can be used as their true Types, but will return a readable value to output. This output includedExport-Csv
for example. - Clear distinction between default properties and extended properties.
The postfixes for extended properties are clearly recognizable. '_FormattedValue' for values from the FormattedValue collection and '_Entity' for the LogicalName of an EntityReference. - Removed 'RelatedEntities' from Get-CrmContent.
The option to include related entities inGet-CrmContent
is removed.