Skip to content

Commit 5f1c17a

Browse files
seanmcneseanmcne
authored
Updated help xml (#411)
Slight rename to new cmdlet and parameters to match existing params/cmdlets. Co-authored-by: Sean <[email protected]>
1 parent 29ae645 commit 5f1c17a

3 files changed

+330
-16
lines changed

‎Microsoft.Xrm.Data.PowerShell/Microsoft.Xrm.Data.PowerShell.Help.pshproj

+103-4
Original file line numberDiff line numberDiff line change
@@ -9678,7 +9678,7 @@ When omitting parameter names, you do not provide $conn, cmdlets automatically f
96789678
<CmdletObject verb="Import" noun="CrmSolutionAsync">
96799679
<Name>Import-CrmSolutionAsync</Name>
96809680
<Syntax>
9681-
<string>Import-CrmSolutionAsync [-conn &lt;CrmServiceClient&gt;] [-SolutionFilePath] &lt;String&gt; [[-ActivateWorkflows] &lt;SwitchParameter&gt;] [[-OverwriteUnManagedCustomizations] &lt;SwitchParameter&gt;] [[-SkipDependancyOnProductUpdateCheckOnInstall] &lt;SwitchParameter&gt;] [[-PublishChanges] &lt;SwitchParameter&gt;] [[-MaxWaitTimeInSeconds] &lt;Int64&gt;] [[-ImportAsHoldingSolution] &lt;SwitchParameter&gt;] [[-BlockUntilImportComplete] &lt;SwitchParameter&gt;]</string>
9681+
<string>Import-CrmSolutionAsync [-conn &lt;CrmServiceClient&gt;] [-SolutionFilePath] &lt;String&gt; [[-ActivateWorkflows] &lt;SwitchParameter&gt;] [[-OverwriteUnManagedCustomizations] &lt;SwitchParameter&gt;] [[-SkipDependancyOnProductUpdateCheckOnInstall] &lt;SwitchParameter&gt;] [[-PublishChanges] &lt;SwitchParameter&gt;] [[-MaxWaitTimeInSeconds] &lt;Int64&gt;] [[-ImportAsHoldingSolution] &lt;SwitchParameter&gt;] [[-BlockUntilImportComplete] &lt;SwitchParameter&gt;] [[-PollingDelayInSeconds] &lt;Int64&gt;]</string>
96829682
</Syntax>
96839683
<GeneralHelp>
96849684
<Synopsis>Import a solution using an import job.</Synopsis>
@@ -9692,7 +9692,7 @@ When omitting parameter names, you do not provide $conn, cmdlets automatically f
96929692
<ReturnTypeDescription />
96939693
</GeneralHelp>
96949694
<ParamSets>
9695-
<CommandParameterSetInfo2 Name="__AllParameterSets" Params="conn SolutionFilePath ActivateWorkflows OverwriteUnManagedCustomizations SkipDependancyOnProductUpdateCheckOnInstall PublishChanges MaxWaitTimeInSeconds ImportAsHoldingSolution BlockUntilImportComplete Verbose Debug ErrorAction WarningAction InformationAction ErrorVariable WarningVariable InformationVariable OutVariable OutBuffer PipelineVariable" />
9695+
<CommandParameterSetInfo2 Name="__AllParameterSets" Params="conn SolutionFilePath ActivateWorkflows OverwriteUnManagedCustomizations SkipDependancyOnProductUpdateCheckOnInstall PublishChanges MaxWaitTimeInSeconds ImportAsHoldingSolution BlockUntilImportComplete PollingDelayInSeconds Verbose Debug ErrorAction WarningAction InformationAction ErrorVariable WarningVariable InformationVariable OutVariable OutBuffer PipelineVariable" />
96969696
</ParamSets>
96979697
<Parameters>
96989698
<ParameterDescription type="CrmServiceClient" varLen="false" required="false" dynamic="false" pipeRemaining="false" pipe="false" pipeProp="false" isPos="false" pos="named" globbing="false">
@@ -9789,6 +9789,16 @@ When omitting parameter names, you do not provide $conn, cmdlets automatically f
97899789
<Description>Rather than return the import ID - block and poll until the command is complete</Description>
97909790
<DefaultValue />
97919791
</ParameterDescription>
9792+
<ParameterDescription type="Int64" varLen="false" required="false" dynamic="false" pipeRemaining="false" pipe="false" pipeProp="false" isPos="true" pos="9" globbing="false">
9793+
<Name>PollingDelayInSeconds</Name>
9794+
<Attributes>
9795+
<string>System.Management.Automation.ParameterAttribute</string>
9796+
<string>System.Management.Automation.ArgumentTypeConverterAttribute</string>
9797+
</Attributes>
9798+
<Aliases />
9799+
<Description />
9800+
<DefaultValue />
9801+
</ParameterDescription>
97929802
</Parameters>
97939803
<Examples>
97949804
<Example>
@@ -10075,8 +10085,8 @@ When omitting parameter names, you do not provide $conn, cmdlets automatically f
1007510085
<string>Set-CrmSolutionVersionNumber [-conn &lt;CrmServiceClient&gt;] [-SolutionName] &lt;String&gt; [-VersionNumber] &lt;String&gt;</string>
1007610086
</Syntax>
1007710087
<GeneralHelp>
10078-
<Synopsis />
10079-
<Description />
10088+
<Synopsis>Sets a CDS Solutions version number.</Synopsis>
10089+
<Description>Sets a CDS Solutions version number in the CDS Database via an api call </Description>
1008010090
<Notes />
1008110091
<InputType />
1008210092
<InputUrl />
@@ -10580,5 +10590,94 @@ When omitting conn parameter, cmdlets automatically finds it.</Description>
1058010590
<SupportInformation ad="false" rsat="false" ps2="false" ps3="false" ps4="false" ps5="false" wxp="false" wv="false" w7="false" w8="false" w81="false" w10="false" w2k3s="false" w2k3e="false" w2k3d="false" w2k8s="false" w2k8e="false" w2k8d="false" w2k8r2s="false" w2k8r2e="false" w2k8r2d="false" w2k12s="false" w2k12d="false" w2k12r2s="false" w2k12r2d="false" />
1058110591
<Publish>false</Publish>
1058210592
</CmdletObject>
10593+
<CmdletObject verb="Merge" noun="CrmHoldingSolutionAsync">
10594+
<Name>Merge-CrmHoldingSolutionAsync</Name>
10595+
<Syntax>
10596+
<string>Merge-CrmHoldingSolutionAsync -conn &lt;CrmServiceClient&gt; [-CrmSolutionName] &lt;String&gt; [[-MaxWaitTimeInSeconds] &lt;Int64&gt;] [[-BlockUntilImportComplete] &lt;SwitchParameter&gt;] [[-PollingDelayInSeconds] &lt;Int64&gt;]</string>
10597+
</Syntax>
10598+
<GeneralHelp>
10599+
<Synopsis>Merges a holding solution.</Synopsis>
10600+
<Description>Merges a holding solution using the DeleteAndPromoteRequest</Description>
10601+
<Notes />
10602+
<InputType />
10603+
<InputUrl />
10604+
<InputTypeDescription />
10605+
<ReturnType />
10606+
<ReturnUrl />
10607+
<ReturnTypeDescription />
10608+
</GeneralHelp>
10609+
<ParamSets>
10610+
<CommandParameterSetInfo2 Name="__AllParameterSets" Params="conn CrmSolutionName MaxWaitTimeInSeconds BlockUntilImportComplete PollingDelayInSeconds Verbose Debug ErrorAction WarningAction InformationAction ErrorVariable WarningVariable InformationVariable OutVariable OutBuffer PipelineVariable" />
10611+
</ParamSets>
10612+
<Parameters>
10613+
<ParameterDescription type="CrmServiceClient" varLen="false" required="true" dynamic="false" pipeRemaining="false" pipe="false" pipeProp="false" isPos="false" pos="named" globbing="false">
10614+
<Name>conn</Name>
10615+
<Attributes>
10616+
<string>System.Management.Automation.ParameterAttribute</string>
10617+
<string>System.Management.Automation.ArgumentTypeConverterAttribute</string>
10618+
</Attributes>
10619+
<Aliases />
10620+
<Description>The connection to the CRM organization. Use Get-CrmConnection or one of the other connection functions to get it.</Description>
10621+
<DefaultValue />
10622+
</ParameterDescription>
10623+
<ParameterDescription type="String" varLen="false" required="true" dynamic="false" pipeRemaining="false" pipe="false" pipeProp="false" isPos="true" pos="1" globbing="false">
10624+
<Name>CrmSolutionName</Name>
10625+
<Attributes>
10626+
<string>System.Management.Automation.ParameterAttribute</string>
10627+
<string>System.Management.Automation.ArgumentTypeConverterAttribute</string>
10628+
</Attributes>
10629+
<Aliases />
10630+
<Description>The unique name of the base solution to apply the upgrade.</Description>
10631+
<DefaultValue />
10632+
</ParameterDescription>
10633+
<ParameterDescription type="Int64" varLen="false" required="false" dynamic="false" pipeRemaining="false" pipe="false" pipeProp="false" isPos="true" pos="4" globbing="false">
10634+
<Name>PollingDelayInSeconds</Name>
10635+
<Attributes>
10636+
<string>System.Management.Automation.ParameterAttribute</string>
10637+
<string>System.Management.Automation.ArgumentTypeConverterAttribute</string>
10638+
</Attributes>
10639+
<Aliases />
10640+
<Description>The polling delay in seconds, to check wether the delete and promote async operation has finished. If specified, it will override the default value of 5 seconds.</Description>
10641+
<DefaultValue />
10642+
</ParameterDescription>
10643+
<ParameterDescription type="Int64" varLen="false" required="false" dynamic="false" pipeRemaining="false" pipe="false" pipeProp="false" isPos="true" pos="2" globbing="false">
10644+
<Name>MaxWaitTimeInSeconds</Name>
10645+
<Attributes>
10646+
<string>System.Management.Automation.ParameterAttribute</string>
10647+
<string>System.Management.Automation.ArgumentTypeConverterAttribute</string>
10648+
</Attributes>
10649+
<Aliases />
10650+
<Description>The polling delay in seconds, to check wether the delete and promote async operation has finished. If specified, it will override the default value of 5 seconds. After the max time expires, the command will still execute in the background but the powershell code will continue</Description>
10651+
<DefaultValue />
10652+
</ParameterDescription>
10653+
<ParameterDescription type="SwitchParameter" varLen="false" required="false" dynamic="false" pipeRemaining="false" pipe="false" pipeProp="false" isPos="true" pos="3" globbing="false">
10654+
<Name>BlockUntilImportComplete</Name>
10655+
<Attributes>
10656+
<string>System.Management.Automation.ParameterAttribute</string>
10657+
<string>System.Management.Automation.ArgumentTypeConverterAttribute</string>
10658+
</Attributes>
10659+
<Aliases />
10660+
<Description>If specified, the execution will poll and wait for the delete and promote async operation to complete. If not specified, it will return the asyncoperationid immediatelly and the operation will continue to execute asynchronously on Dynamics organization.</Description>
10661+
<DefaultValue />
10662+
</ParameterDescription>
10663+
</Parameters>
10664+
<Examples>
10665+
<Example>
10666+
<Name>Example1</Name>
10667+
<Cmd>Merge-CrmHoldingSolutionAsync -conn $conn -CrmSolutionName "SampleSolution"</Cmd>
10668+
<Description>This example requests a delete and promote message regarding a Dynamics solution named "SampleSolution" and returns the system job id.</Description>
10669+
<Output />
10670+
</Example>
10671+
<Example>
10672+
<Name>Example2</Name>
10673+
<Cmd>Merge-CrmHoldingSolutionAsync -conn $conn -CrmSolutionName "SampleSolution" -MaxWaitTimeInSeconds 900 -PollingDelayInSeconds 60 -BlockUntilImportComplete</Cmd>
10674+
<Description>This example requests a delete and promote message regarding a Dynamics solution named "SampleSolution", while specifying that the execution should wait for the system job to finish and should poll the job every 60 seconds. It also sets a maximum blocking/polling time of 15 minutes (900 seconds). After the max time expires, the command will still execute in the background but the powershell code will continue</Description>
10675+
<Output />
10676+
</Example>
10677+
</Examples>
10678+
<RelatedLinks />
10679+
<SupportInformation ad="false" rsat="false" ps2="false" ps3="false" ps4="false" ps5="false" wxp="false" wv="false" w7="false" w8="false" w81="false" w10="false" w2k3s="false" w2k3e="false" w2k3d="false" w2k8s="false" w2k8e="false" w2k8d="false" w2k8r2s="false" w2k8r2e="false" w2k8r2d="false" w2k12s="false" w2k12d="false" w2k12r2s="false" w2k12r2d="false" />
10680+
<Publish>false</Publish>
10681+
</CmdletObject>
1058310682
</Cmdlets>
1058410683
</ModuleObject>

0 commit comments

Comments
 (0)