Get-CrmPackages
Applies To: CRM 2016 on-prem, Dynamics 365 (online), Dynamics 365 (on-premises)
Get-CrmPackages
Returns a list of available packages (package name and package assembly location) that can be deployed to Microsoft Dynamics 365.
Syntax
Parameter Set: Default
Get-CrmPackages [[-PackageDirectory] <String> ] [[-PackageName] <String> ] [-LogWriteDirectory <String> ] [ <CommonParameters>]
Detailed Description
The Get-CrmPackages cmdlet returns a list of packages (package name and package assembly location). The cmdlet can also return information about a specific package if you specify the package name as a cmdlet parameter. A package can contain the following items Microsoft Dynamics 365 solution files, files or exported data files from the Configuration Migration tool, custom code that can run during or after the package is deployed to the Microsoft Dynamics 365 instance, and HTML content specific to the package that can display at the beginning and end of the package deployment process. This HTML content can be useful to provide a description of the solutions and files that are deployed in the package. This cmdlet applies to Microsoft Dynamics 365 (online and on-premises).
This cmdlet applies to Microsoft Dynamics 365 (online) and Microsoft Dynamics 365 (on-premises).
Parameters
-PackageDirectory<String>
Directory where a package or packages can be found.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PackageName<String>
Name of the assembly (.dll) that contains the package definition.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LogWriteDirectory<String>
Custom directory location to store the Package Deployer log files. The directory must already exist, and the user who is running the cmdlet must have Write permission to the directory. You must also use the -Verbose parameter along with the -LogWriteDirectory parameter to be able to store the log files in a custom location.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
List<PackageInfoClass>
This cmdlet exports a list of PackageInfo objects. The short name of this object can be used as input to the Import-CrmPackage cmdlet.
Examples
-------------------------- Example 1 --------------------------
This example returns a list of packages available for import in the specified directory (in this case, c:\CRM\SDK\Tools\PackageDeployer).
PS C:\>Get-CrmPackages -PackageDirectory c:\CRM\SDK\Tools\PackageDeployer
-------------------------- Example 2 --------------------------
This example displays information about a package available in the specified directory (in this case, c:\CRM\SDK\Tools\PackageDeployer). To display information about a package, you must specify the name of the assembly (in this case ADXSTUDIO.PREVIEW_COMMUNITYPORTAL.dll) in the -PackageName parameter that contains the package definition.
PS C:\>Get-CrmPackages -PackageDirectory c:\CRM\SDK\Tools\PackageDeployer -PackageName ADXSTUDIO.PREVIEW_COMMUNITYPORTAL.dll