en-us/AMSoftware.Dataverse.PowerShell.Development.psm1-help.xml
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Export-DataversePluginAssembly</command:name> <command:verb>Export</command:verb> <command:noun>DataversePluginAssembly</command:noun> <maml:description> <maml:para>Export a Plugin Assembly to a file</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Export a Plugin Assembly to a file</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-DataversePluginAssembly</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the specific Plugin Assembly to export</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>Folder path for the exported assembly. Filename is determined from the Plugin Assembly name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the specific Plugin Assembly to export</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>Folder path for the exported assembly. Filename is determined from the Plugin Assembly name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online</maml:linkText> <maml:uri>https://github.com/AMSoftwareNL/DataversePowershell/blob/main/docs/Export-DataversePluginAssembly.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Export-DataverseSolution</command:name> <command:verb>Export</command:verb> <command:noun>DataverseSolution</command:noun> <maml:description> <maml:para>Export a solution</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Export a solution</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-DataverseSolution</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="Name"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>The uniquename of the solution to export</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>The folder path where to place the exported solution. The filename is determined from the solution.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AsManaged</maml:name> <maml:description> <maml:para>Export the solution as managed</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AsManaged</maml:name> <maml:description> <maml:para>Export the solution as managed</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>The folder path where to place the exported solution. The filename is determined from the solution.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="Name"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>The uniquename of the solution to export</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online</maml:linkText> <maml:uri>https://github.com/AMSoftwareNL/DataversePowershell/blob/main/docs/Export-DataverseSolution.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Export-DataverseTranslation</command:name> <command:verb>Export</command:verb> <command:noun>DataverseTranslation</command:noun> <maml:description> <maml:para>Export the translations for customizations</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Export the translations for customizations</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-DataverseTranslation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="Name"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>Uniquename of the solution to export the translations for</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>The folder path for the exported translations. The filename is determined from the solution.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>The folder path for the exported translations. The filename is determined from the solution.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="Name"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>Uniquename of the solution to export the translations for</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online</maml:linkText> <maml:uri>https://github.com/AMSoftwareNL/DataversePowershell/blob/main/docs/Export-DataverseTranslation.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Export-DataverseWebResource</command:name> <command:verb>Export</command:verb> <command:noun>DataverseWebResource</command:noun> <maml:description> <maml:para>Export the content of a WebResource</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Export the content of a WebResource to a file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-DataverseWebResource</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the WebResource to export</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>Path of the folder to export the WebResource to. The Filename for the exported WebResource is set from the name of the WebResource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the WebResource to export</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>Path of the folder to export the WebResource to. The Filename for the exported WebResource is set from the name of the WebResource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>The name of the WebResource determines the name of the export file. In case the webresource name contains invalid path characters these are replaced by '-'. The URL folder structure of the webresource is not maintained on export, but included in the filename.</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online</maml:linkText> <maml:uri>https://github.com/AMSoftwareNL/DataversePowershell/blob/main/docs/Export-DataverseWebResource.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Import-DataverseSolution</command:name> <command:verb>Import</command:verb> <command:noun>DataverseSolution</command:noun> <maml:description> <maml:para>Import a Dataverse Solution</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Import a Dataverse Solution. Supports the following:</maml:para> <maml:para>- Import a new solution</maml:para> <maml:para>- Import a solution as holding (deprecated) for later upgrade using Update-DataverseSolution</maml:para> <maml:para>- Import a solution as staged for later upgrade using Update-DataverseSolution</maml:para> <maml:para>- Import and Upgrade a solution using the improved Stage and Upgrade process</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-DataverseSolution</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ComponentParameters</maml:name> <maml:description> <maml:para>The list of entities to overwrite values from the solution. Used for Environment Variables and Connection References.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Microsoft.Xrm.Sdk.EntityCollection</command:parameterValue> <dev:type> <maml:name>Microsoft.Xrm.Sdk.EntityCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Hold</maml:name> <maml:description> <maml:para>Import the solution as a holding solution for later upgrade</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="PSPath"> <maml:name>LiteralPath</maml:name> <maml:description> <maml:para>Full path to the solution file to import</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Overwrite existing unmnaged customizations</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PublishWorkflows</maml:name> <maml:description> <maml:para>Processes (workflows) included in the solution should be activated after they are imported.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Import-DataverseSolution</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ComponentParameters</maml:name> <maml:description> <maml:para>The list of entities to overwrite values from the solution. Used for Environment Variables and Connection References.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Microsoft.Xrm.Sdk.EntityCollection</command:parameterValue> <dev:type> <maml:name>Microsoft.Xrm.Sdk.EntityCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="PSPath"> <maml:name>LiteralPath</maml:name> <maml:description> <maml:para>Full path to the solution file to import</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Overwrite existing unmnaged customizations</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PublishWorkflows</maml:name> <maml:description> <maml:para>Processes (workflows) included in the solution should be activated after they are imported.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Upgrade</maml:name> <maml:description> <maml:para>Import the solution with stage and upgrade using the improved process</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Import-DataverseSolution</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="PSPath"> <maml:name>LiteralPath</maml:name> <maml:description> <maml:para>Full path to the solution file to import</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Overwrite existing unmnaged customizations</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stage</maml:name> <maml:description> <maml:para>Import the solution as Staged for later Upgrade</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ComponentParameters</maml:name> <maml:description> <maml:para>The list of entities to overwrite values from the solution. Used for Environment Variables and Connection References.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Microsoft.Xrm.Sdk.EntityCollection</command:parameterValue> <dev:type> <maml:name>Microsoft.Xrm.Sdk.EntityCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Hold</maml:name> <maml:description> <maml:para>Import the solution as a holding solution for later upgrade</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="PSPath"> <maml:name>LiteralPath</maml:name> <maml:description> <maml:para>Full path to the solution file to import</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Overwrite existing unmnaged customizations</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PublishWorkflows</maml:name> <maml:description> <maml:para>Processes (workflows) included in the solution should be activated after they are imported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stage</maml:name> <maml:description> <maml:para>Import the solution as Staged for later Upgrade</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Upgrade</maml:name> <maml:description> <maml:para>Import the solution with stage and upgrade using the improved process</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Microsoft.Xrm.Sdk.StageSolutionResults</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>When Stage is used the Function returns StageSolutionResults. This Ouput contains the StageId which is needed to Upgrade using Update-DataverseSolution.</maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online</maml:linkText> <maml:uri>https://github.com/AMSoftwareNL/DataversePowershell/blob/main/docs/Import-DataverseSolution.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DataverseSolution</maml:linkText> <maml:uri>https://github.com/AMSoftwareNL/DataversePowershell/blob/main/docs/Update-DataverseSolution.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Solution staging, with asynchronous import and export</maml:linkText> <maml:uri>https://learn.microsoft.com/power-platform/alm/solution-async</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Import-DataverseTranslation</command:name> <command:verb>Import</command:verb> <command:noun>DataverseTranslation</command:noun> <maml:description> <maml:para>Import customization translations</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Import translations for customizations. The path must point to the compressed translations file (ZIP) to import.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-DataverseTranslation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="PSPath"> <maml:name>LiteralPath</maml:name> <maml:description> <maml:para>Path to the translations file to import</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="PSPath"> <maml:name>LiteralPath</maml:name> <maml:description> <maml:para>Path to the translations file to import</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online</maml:linkText> <maml:uri>https://github.com/AMSoftwareNL/DataversePowershell/blob/main/docs/Import-DataverseTranslation.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Publish-DataverseComponent</command:name> <command:verb>Publish</command:verb> <command:noun>DataverseComponent</command:noun> <maml:description> <maml:para>Publish Customizations</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Publish customizations. Publishish all customization, or a specific component.</maml:para> <maml:para>If the Component is provided through the pipeline, all components are collected and published as a single action.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Publish-DataverseComponent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>ComponentId</maml:name> <maml:description> <maml:para>The ID of the component to publish. For a Table this is the LogicalName, for a Choice this is the Name, and for a WebResource this is the ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of Component to publish. This can be a Table, Global Choice, or WebResource.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Table</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Choice</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WebResource</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>ComponentId</maml:name> <maml:description> <maml:para>The ID of the component to publish. For a Table this is the LogicalName, for a Choice this is the Name, and for a WebResource this is the ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of Component to publish. This can be a Table, Global Choice, or WebResource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online</maml:linkText> <maml:uri>https://github.com/AMSoftwareNL/DataversePowershell/blob/main/docs/Publish-DataverseComponent.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-DataverseSolution</command:name> <command:verb>Update</command:verb> <command:noun>DataverseSolution</command:noun> <maml:description> <maml:para>Upgrade a staged or holding solution</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Upgrade a solution from staged or holding, as a result from an Import-DataverseSolution.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-DataverseSolution</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ComponentParameters</maml:name> <maml:description> <maml:para>The list of entities to overwrite values from the solution. Used for Environment Variables and Connection References.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Microsoft.Xrm.Sdk.EntityCollection</command:parameterValue> <dev:type> <maml:name>Microsoft.Xrm.Sdk.EntityCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PublishWorkflows</maml:name> <maml:description> <maml:para>Processes (workflows) included in the solution should be activated after they are imported.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stage</maml:name> <maml:description> <maml:para>The StageId of the solution to Upgrade as the result from a staged solution through Import-DataverseSolution.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-DataverseSolution</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="UniqueName"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>The uniquename of the solution to upgrade from holding</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ComponentParameters</maml:name> <maml:description> <maml:para>The list of entities to overwrite values from the solution. Used for Environment Variables and Connection References.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Microsoft.Xrm.Sdk.EntityCollection</command:parameterValue> <dev:type> <maml:name>Microsoft.Xrm.Sdk.EntityCollection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PublishWorkflows</maml:name> <maml:description> <maml:para>Processes (workflows) included in the solution should be activated after they are imported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="UniqueName"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>The uniquename of the solution to upgrade from holding</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Stage</maml:name> <maml:description> <maml:para>The StageId of the solution to Upgrade as the result from a staged solution through Import-DataverseSolution.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online</maml:linkText> <maml:uri>https://github.com/AMSoftwareNL/DataversePowershell/blob/main/docs/Update-DataverseSolution.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-DataverseSolution</maml:linkText> <maml:uri>https://github.com/AMSoftwareNL/DataversePowershell/blob/main/docs/Import-DataverseSolution.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Solution staging, with asynchronous import and export</maml:linkText> <maml:uri>https://learn.microsoft.com/power-platform/alm/solution-async</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |