PentaWork.Xrm.PowerShell.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Update-XrmAssembly --> <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"> <command:details> <command:name>Update-XrmAssembly</command:name> <command:verb>Update</command:verb> <command:noun>XrmAssembly</command:noun> <maml:description> <maml:para>Updates a plugin assembly in the target system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function updates a given plugin assembly in the target system.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-XrmAssembly</maml:name> <!-- Parameter: AssemblyFile --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>AssemblyFile</maml:name> <maml:description> <maml:para>The path to the assembly to update in the XRM system.</maml:para> </maml:description> <command:parameterValue required="true">FileInfo</command:parameterValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Connection --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection to the XRM Organization (Get-CrmConnection)</maml:para> </maml:description> <command:parameterValue required="true">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>Microsoft.Xrm.Tooling.Connector.CrmServiceClient</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Connection --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection to the XRM Organization (Get-CrmConnection)</maml:para> </maml:description> <command:parameterValue required="true">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>Microsoft.Xrm.Tooling.Connector.CrmServiceClient</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AssemblyFile --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>AssemblyFile</maml:name> <maml:description> <maml:para>The path to the assembly to update in the XRM system.</maml:para> </maml:description> <command:parameterValue required="true">FileInfo</command:parameterValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Xrm.Tooling.Connector.CrmServiceClient</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The connection to the XRM Organization (Get-CrmConnection)</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The path to the assembly to update in the XRM system.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>$conn = Get-CrmConnection -Interactive</maml:para> <maml:para>Update-XrmAseembly -Connection $conn -AssemblyFile .\Plugin.dll</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-XrmProxies --> <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"> <command:details> <command:name>Get-XrmProxies</command:name> <command:verb>Get</command:verb> <command:noun>XrmProxies</command:noun> <maml:description> <maml:para>Creates C# and TypeScript proxy classes and fake classes for C# unit testing.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The C# proxy classes contain all entity attributes, optionsets, relation properties and attribute/schema names. The relations are loadable with the "LoadProperty" method of the OrganizationServiceContext. The fake classes are created to be used with FakeXrmEasy. They contain pre defined fake relationships and a static create method to create an instance of an entity with some random data (generated with Bogus)</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-XrmProxies</maml:name> <!-- Parameter: Connection --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection to the XRM Organization (Get-CrmConnection).</maml:para> </maml:description> <command:parameterValue required="true">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>Microsoft.Xrm.Tooling.Connector.CrmServiceClient</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FakeNamespace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FakeNamespace</maml:name> <maml:description> <maml:para>The namespace for all fake classes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>The output path for the proxy classes.</maml:para> </maml:description> <command:parameterValue required="true">DirectoryInfo</command:parameterValue> <dev:type> <maml:name>System.IO.DirectoryInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProxyNamespace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProxyNamespace</maml:name> <maml:description> <maml:para>The namespace for all proxy classes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Clear --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Clear</maml:name> <maml:description> <maml:para>Clear the output folder before generating proxies.</maml:para> </maml:description> <command:parameterValue required="true">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:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Connection --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection to the XRM Organization (Get-CrmConnection).</maml:para> </maml:description> <command:parameterValue required="true">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>Microsoft.Xrm.Tooling.Connector.CrmServiceClient</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProxyNamespace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProxyNamespace</maml:name> <maml:description> <maml:para>The namespace for all proxy classes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FakeNamespace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FakeNamespace</maml:name> <maml:description> <maml:para>The namespace for all fake classes.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OutputPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>The output path for the proxy classes.</maml:para> </maml:description> <command:parameterValue required="true">DirectoryInfo</command:parameterValue> <dev:type> <maml:name>System.IO.DirectoryInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Clear --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Clear</maml:name> <maml:description> <maml:para>Clear the output folder before generating proxies.</maml:para> </maml:description> <command:parameterValue required="true">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>Microsoft.Xrm.Tooling.Connector.CrmServiceClient</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The connection to the XRM Organization (Get-CrmConnection).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-CrmConnection -Interactive | Get-XrmProxies -FakeNamespace FakeNamespace -ProxyNamespace ProxyNamespace -OutputPath .\output -Clear</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Export-XrmSolution --> <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"> <command:details> <command:name>Export-XrmSolution</command:name> <command:verb>Export</command:verb> <command:noun>XrmSolution</command:noun> <maml:description> <maml:para>Export a solution from the target system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function is able to export a solution from a target system. The results of the Get-XrmSolutions function can be piped into this one.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Export-XrmSolution</maml:name> <!-- Parameter: Connection --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection to the XRM Organization (Get-CrmConnection).</maml:para> </maml:description> <command:parameterValue required="true">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>Microsoft.Xrm.Tooling.Connector.CrmServiceClient</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExportPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportPath</maml:name> <maml:description> <maml:para>The path to export the solution to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UniqueName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UniqueName</maml:name> <maml:description> <maml:para>The unique name of the solution to export.).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force export, if version is already existing in target path.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Managed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Managed</maml:name> <maml:description> <maml:para>Export as managed solution.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PublishAll --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PublishAll</maml:name> <maml:description> <maml:para>Publish all before exporting.</maml:para> </maml:description> <command:parameterValue required="true">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:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Connection --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection to the XRM Organization (Get-CrmConnection).</maml:para> </maml:description> <command:parameterValue required="true">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>Microsoft.Xrm.Tooling.Connector.CrmServiceClient</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UniqueName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>UniqueName</maml:name> <maml:description> <maml:para>The unique name of the solution to export.).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExportPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportPath</maml:name> <maml:description> <maml:para>The path to export the solution to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Managed --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Managed</maml:name> <maml:description> <maml:para>Export as managed solution.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PublishAll --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PublishAll</maml:name> <maml:description> <maml:para>Publish all before exporting.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force export, if version is already existing in target path.</maml:para> </maml:description> <command:parameterValue required="true">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>Microsoft.Xrm.Tooling.Connector.CrmServiceClient</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The connection to the XRM Organization (Get-CrmConnection).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The unique name of the solution to export.).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: FileInfo --> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>$conn = Get-CrmConnection -Interactive</maml:para> <maml:para>Get-XrmSolutions -Connection $conn | Where-Object {$_.Name -like "TestSolution*"} | Export-XrmSolution -Connection $conn -Managed -ExportPath .\</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Import-XrmSolution --> <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"> <command:details> <command:name>Import-XrmSolution</command:name> <command:verb>Import</command:verb> <command:noun>XrmSolution</command:noun> <maml:description> <maml:para>Imports a solution into the target system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function is able to import a solution into a target system. It is possible to pipe the result of Export-XrmSolution into this function.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Import-XrmSolution</maml:name> <!-- Parameter: Connection --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection to the XRM Organization (Get-CrmConnection)</maml:para> </maml:description> <command:parameterValue required="true">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>Microsoft.Xrm.Tooling.Connector.CrmServiceClient</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SolutionFile --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>SolutionFile</maml:name> <maml:description> <maml:para>The path to the solution zip file.</maml:para> </maml:description> <command:parameterValue required="true">FileInfo</command:parameterValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Delete --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Delete</maml:name> <maml:description> <maml:para>Delete before installing.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force install even, if version is already deployed.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Overwrite --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Overwrite unmanaged customizations.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PublishWorkflows --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PublishWorkflows</maml:name> <maml:description> <maml:para>Publish all workflows.</maml:para> </maml:description> <command:parameterValue required="true">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:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Connection --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection to the XRM Organization (Get-CrmConnection)</maml:para> </maml:description> <command:parameterValue required="true">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>Microsoft.Xrm.Tooling.Connector.CrmServiceClient</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SolutionFile --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>SolutionFile</maml:name> <maml:description> <maml:para>The path to the solution zip file.</maml:para> </maml:description> <command:parameterValue required="true">FileInfo</command:parameterValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Delete --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Delete</maml:name> <maml:description> <maml:para>Delete before installing.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Overwrite --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Overwrite unmanaged customizations.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PublishWorkflows --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PublishWorkflows</maml:name> <maml:description> <maml:para>Publish all workflows.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force install even, if version is already deployed.</maml:para> </maml:description> <command:parameterValue required="true">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>Microsoft.Xrm.Tooling.Connector.CrmServiceClient</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The connection to the XRM Organization (Get-CrmConnection)</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The path to the solution zip file.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>$conn = Get-CrmConnection -Interactive</maml:para> <maml:para>$conn2 = Get-CrmConnection -Interactive</maml:para> <maml:para>Export-XrmSolution -Connection $conn -UniqueName TestSolution -Managed -ExportPath | Import-XrmSolution -Connection $conn2 -Overwrite</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-XrmSolutions --> <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"> <command:details> <command:name>Get-XrmSolutions</command:name> <command:verb>Get</command:verb> <command:noun>XrmSolutions</command:noun> <maml:description> <maml:para>Gets a list of all installed and visible solutions in the target system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The function returns a custom object with the following properties: Name, UniqueName, Version, Publisher</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-XrmSolutions</maml:name> <!-- Parameter: Connection --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection to the XRM Organization (Get-CrmConnection)</maml:para> </maml:description> <command:parameterValue required="true">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>Microsoft.Xrm.Tooling.Connector.CrmServiceClient</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Connection --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection to the XRM Organization (Get-CrmConnection)</maml:para> </maml:description> <command:parameterValue required="true">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>Microsoft.Xrm.Tooling.Connector.CrmServiceClient</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Xrm.Tooling.Connector.CrmServiceClient</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The connection to the XRM Organization (Get-CrmConnection)</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: SolutionInfo --> <command:returnValue> <dev:type> <maml:name>PentaWork.Xrm.PowerShell.Verbs.SolutionInfo</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Holds the following properties: Name, UniqueName, Version, Publisher</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-CrmConnection -Interactive | Get-XrmSolutions</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-XrmTimeout --> <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"> <command:details> <command:name>Set-XrmTimeout</command:name> <command:verb>Set</command:verb> <command:noun>XrmTimeout</command:noun> <maml:description> <maml:para>Sets the timeout of the given XRM connection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function is able to set the connection timeout of an existing XRM connection.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-XrmTimeout</maml:name> <!-- Parameter: Connection --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection to the XRM Organization (Get-CrmConnection)</maml:para> </maml:description> <command:parameterValue required="true">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>Microsoft.Xrm.Tooling.Connector.CrmServiceClient</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The new timeout in minutes.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Connection --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>The connection to the XRM Organization (Get-CrmConnection)</maml:para> </maml:description> <command:parameterValue required="true">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>Microsoft.Xrm.Tooling.Connector.CrmServiceClient</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The new timeout in minutes.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Xrm.Tooling.Connector.CrmServiceClient</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The connection to the XRM Organization (Get-CrmConnection)</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The new timeout in minutes.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: CrmServiceClient --> <command:returnValue> <dev:type> <maml:name>Microsoft.Xrm.Tooling.Connector.CrmServiceClient</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-CrmConnection -Interactive | Set-XrmTimeout -Timeout 30</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> </helpItems> |