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 -InteractiveMode</maml:para> <maml:para>Update-XrmAseembly -Connection $conn -AssemblyFile .\Plugin.dll</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Export-XrmEntities --> <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-XrmEntities</command:name> <command:verb>Export</command:verb> <command:noun>XrmEntities</command:noun> <maml:description> <maml:para>Lists all entities of the given entity type.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function lists all entities of a given entity type. The result can be saved into json. The results of the Get-XrmSolutions function can be piped into this one. The EntityData can be piped into the Import-XrmEntities function.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Export-XrmEntities</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: EntityName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The entity type to list.</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: ColumnSet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ColumnSet</maml:name> <maml:description> <maml:para>The columns to retrieve. Default is all columns.</maml:para> </maml:description> <command:parameterValue required="true">ColumnSet</command:parameterValue> <dev:type> <maml:name>Microsoft.Xrm.Sdk.Query.ColumnSet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Microsoft.Xrm.Sdk.Query.ColumnSet</dev:defaultValue> </command:parameter> <!-- Parameter: FilterConditions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterConditions</maml:name> <maml:description> <maml:para>Filter conditions to filter the retrieved entities.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Microsoft.Xrm.Sdk.Query.ConditionExpression, Microsoft.Xrm.Sdk, Version=9.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: GetAll --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GetAll</maml:name> <maml:description> <maml:para>Set to true, if the retrieve of all entites in the system is desired. This will do multiple calls to the xrm system according to the page size.</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: IgnoreColumns --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreColumns</maml:name> <maml:description> <maml:para>List of columns which should get filtered out in the result set.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PageNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PageNumber</maml:name> <maml:description> <maml:para>The page to retrieve. Default is the first page.</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>1</dev:defaultValue> </command:parameter> <!-- Parameter: PageSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PageSize</maml:name> <maml:description> <maml:para>The page size to show. Default is 500.</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>500</dev:defaultValue> </command:parameter> <!-- Parameter: Relations --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Relations</maml:name> <maml:description> <maml:para>List of relation schemas to export.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Sharings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Sharings</maml:name> <maml:description> <maml:para>Set to true, to export the sharings for the exported entities.</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: ValidForCreate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValidForCreate</maml:name> <maml:description> <maml:para>Only get attributes which are valid for create. Default is false.</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: ValidForUpdate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValidForUpdate</maml:name> <maml:description> <maml:para>Only get attributes which are valid for update. Default is false.</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: EntityName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The entity type to list.</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: ColumnSet --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ColumnSet</maml:name> <maml:description> <maml:para>The columns to retrieve. Default is all columns.</maml:para> </maml:description> <command:parameterValue required="true">ColumnSet</command:parameterValue> <dev:type> <maml:name>Microsoft.Xrm.Sdk.Query.ColumnSet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Microsoft.Xrm.Sdk.Query.ColumnSet</dev:defaultValue> </command:parameter> <!-- Parameter: FilterConditions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterConditions</maml:name> <maml:description> <maml:para>Filter conditions to filter the retrieved entities.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Microsoft.Xrm.Sdk.Query.ConditionExpression, Microsoft.Xrm.Sdk, Version=9.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IgnoreColumns --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnoreColumns</maml:name> <maml:description> <maml:para>List of columns which should get filtered out in the result set.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Relations --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Relations</maml:name> <maml:description> <maml:para>List of relation schemas to export.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PageSize --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PageSize</maml:name> <maml:description> <maml:para>The page size to show. Default is 500.</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>500</dev:defaultValue> </command:parameter> <!-- Parameter: PageNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PageNumber</maml:name> <maml:description> <maml:para>The page to retrieve. Default is the first page.</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>1</dev:defaultValue> </command:parameter> <!-- Parameter: GetAll --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GetAll</maml:name> <maml:description> <maml:para>Set to true, if the retrieve of all entites in the system is desired. This will do multiple calls to the xrm system according to the page size.</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: Sharings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Sharings</maml:name> <maml:description> <maml:para>Set to true, to export the sharings for the exported entities.</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: ValidForCreate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValidForCreate</maml:name> <maml:description> <maml:para>Only get attributes which are valid for create. Default is false.</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: ValidForUpdate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ValidForUpdate</maml:name> <maml:description> <maml:para>Only get attributes which are valid for update. Default is false.</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 entity type to list.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: EntityData --> <command:returnValue> <dev:type> <maml:name>PentaWork.Xrm.PowerShell.Verbs.EntityData</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Holds some meta data for the retrieved entity type and the export process.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-CrmConnection -InteractiveMode | Export-XrmEntities -EntityName userquery | ConvertTo-Json -depth 6 | Out-File "userquery.json"</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Import-XrmEntities --> <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-XrmEntities</command:name> <command:verb>Import</command:verb> <command:noun>XrmEntities</command:noun> <maml:description> <maml:para>Imports given entities to the given xrm system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function imports a given set of entities to the connected xrm system. The result of the Export-XrmEntities can be piped into this function.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Import-XrmEntities</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: EntityData --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>EntityData</maml:name> <maml:description> <maml:para>The entities to import.</maml:para> </maml:description> <command:parameterValue required="true">EntityData</command:parameterValue> <dev:type> <maml:name>PentaWork.Xrm.PowerShell.Verbs.EntityData</maml:name> <maml:uri /> <maml:description> <maml:para>Holds some meta data for the retrieved entity type and the export process.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FallbackOwner --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FallbackOwner</maml:name> <maml:description> <maml:para>The fallback user id to use for new entities, if the given one is not found (mapped by name).</maml:para> </maml:description> <command:parameterValue required="true">EntityReference</command:parameterValue> <dev:type> <maml:name>Microsoft.Xrm.Sdk.EntityReference</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CreateOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateOnly</maml:name> <maml:description> <maml:para>The entity names listed will only be created, but not updated, if found.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ImpersonateOwner --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ImpersonateOwner</maml:name> <maml:description> <maml:para>Set to true, if the call for creates and updates should impersonate the target owner (either the fallback owner, the owner of the existing entity or the owner given in the entity data to import).</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: MapByName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MapByName</maml:name> <maml:description> <maml:para>Set, if the mapping for updates should be done by entity name instead of the id.</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: MapByNameLookups --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MapByNameLookups</maml:name> <maml:description> <maml:para>The values for the listed lookup fields will be matches by its primary name value.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TakeFirst --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TakeFirst</maml:name> <maml:description> <maml:para>Set, if the first found matching entity should be used for updates (only relevant with the MapByName option). Otherwise it will be skipped.</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: EntityData --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>EntityData</maml:name> <maml:description> <maml:para>The entities to import.</maml:para> </maml:description> <command:parameterValue required="true">EntityData</command:parameterValue> <dev:type> <maml:name>PentaWork.Xrm.PowerShell.Verbs.EntityData</maml:name> <maml:uri /> <maml:description> <maml:para>Holds some meta data for the retrieved entity type and the export process.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: FallbackOwner --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FallbackOwner</maml:name> <maml:description> <maml:para>The fallback user id to use for new entities, if the given one is not found (mapped by name).</maml:para> </maml:description> <command:parameterValue required="true">EntityReference</command:parameterValue> <dev:type> <maml:name>Microsoft.Xrm.Sdk.EntityReference</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MapByName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MapByName</maml:name> <maml:description> <maml:para>Set, if the mapping for updates should be done by entity name instead of the id.</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: TakeFirst --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TakeFirst</maml:name> <maml:description> <maml:para>Set, if the first found matching entity should be used for updates (only relevant with the MapByName option). Otherwise it will be skipped.</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: ImpersonateOwner --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ImpersonateOwner</maml:name> <maml:description> <maml:para>Set to true, if the call for creates and updates should impersonate the target owner (either the fallback owner, the owner of the existing entity or the owner given in the entity data to import).</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: MapByNameLookups --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MapByNameLookups</maml:name> <maml:description> <maml:para>The values for the listed lookup fields will be matches by its primary name value.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CreateOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CreateOnly</maml:name> <maml:description> <maml:para>The entity names listed will only be created, but not updated, if found.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</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>PentaWork.Xrm.PowerShell.Verbs.EntityData</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The entities to import.</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 -InteractiveMode</maml:para> <maml:para>$fallbackOwner = [Microsoft.Xrm.Sdk.EntityReference]::new("systemuser", [System.Guid]::new("D78327BB-A5F2-EA11-A86A-005056B5F580"))</maml:para> <maml:para>Get-Content "userquery.json" | ConvertFrom-Json | Import-XrmEntities -Connection $conn -FallbackOwner $fallbackOwner</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-XrmEntities --> <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>Remove-XrmEntities</command:name> <command:verb>Remove</command:verb> <command:noun>XrmEntities</command:noun> <maml:description> <maml:para>Removes ALL entities matching the given parameters.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function remoces all entities matching the given entity name and conditions.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-XrmEntities</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: EntityName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The entity name of the enitities to delete.</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: FilterConditions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterConditions</maml:name> <maml:description> <maml:para>Filter conditions to filter the entities which should get deleted.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Microsoft.Xrm.Sdk.Query.ConditionExpression, Microsoft.Xrm.Sdk, Version=9.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]</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: EntityName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The entity name of the enitities to delete.</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: FilterConditions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterConditions</maml:name> <maml:description> <maml:para>Filter conditions to filter the entities which should get deleted.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Microsoft.Xrm.Sdk.Query.ConditionExpression, Microsoft.Xrm.Sdk, Version=9.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]</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.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The entity name of the enitities to delete.</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 -InteractiveMode</maml:para> <maml:para>$cond = [Microsoft.Xrm.Sdk.Query.ConditionExpression]::new("accountname", [Microsoft.Xrm.Sdk.Query.ConditionOperator]::Equal, "test")</maml:para> <maml:para>Remove-XrmEntities -EntityName account -Conditions @($cond)</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> <!-- Parameter: ExcludeEntities --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeEntities</maml:name> <maml:description> <maml:para>All entities in this list will be excluded in the proxy generation.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeEntities --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeEntities</maml:name> <maml:description> <maml:para>If used with the solution parameter, this list will add entities which are not part of the given solution.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Solution --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Solution</maml:name> <maml:description> <maml:para>Only create proxies for entities which are part of the given solution (uniquename).</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: UseBaseProxy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseBaseProxy</maml:name> <maml:description> <maml:para>Use a custom base proxy class for the generated 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: Solution --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Solution</maml:name> <maml:description> <maml:para>Only create proxies for entities which are part of the given solution (uniquename).</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: IncludeEntities --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeEntities</maml:name> <maml:description> <maml:para>If used with the solution parameter, this list will add entities which are not part of the given solution.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeEntities --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeEntities</maml:name> <maml:description> <maml:para>All entities in this list will be excluded in the proxy generation.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</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> <!-- Parameter: UseBaseProxy --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseBaseProxy</maml:name> <maml:description> <maml:para>Use a custom base proxy class for the generated 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 -InteractiveMode | Get-XrmProxies -FakeNamespace FakeNamespace -ProxyNamespace ProxyNamespace -OutputPath .\output -Clear</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Import-XrmRelations --> <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-XrmRelations</command:name> <command:verb>Import</command:verb> <command:noun>XrmRelations</command:noun> <maml:description> <maml:para>Imports given N:M relations to the given xrm system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function imports a given set of given N:M relations to the connected xrm system. The result of the Export-XrmEntities can be piped into this function.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Import-XrmRelations</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: EntityData --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>EntityData</maml:name> <maml:description> <maml:para>The entities with sharings to import.</maml:para> </maml:description> <command:parameterValue required="true">EntityData</command:parameterValue> <dev:type> <maml:name>PentaWork.Xrm.PowerShell.Verbs.EntityData</maml:name> <maml:uri /> <maml:description> <maml:para>Holds some meta data for the retrieved entity type and the export process.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: MapEntitiesByName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MapEntitiesByName</maml:name> <maml:description> <maml:para>Set, if the entities should get mapped by name instead of the id.</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: MapRelatedEntitiesByName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MapRelatedEntitiesByName</maml:name> <maml:description> <maml:para>Set, if the entities to relate should get mapped by name instead of the id.</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: RelationConditions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RelationConditions</maml:name> <maml:description> <maml:para>Additional mapping conditions to retrieve matching entities, if using MapRelatedEntitiesByName. This can be especially helpful for syncing security roles where the business unit has to be the same as the business unit of the regarding team or user.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[PentaWork.Xrm.PowerShell.Verbs.RelationCondition, PentaWork.Xrm.PowerShell, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]</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: EntityData --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>EntityData</maml:name> <maml:description> <maml:para>The entities with sharings to import.</maml:para> </maml:description> <command:parameterValue required="true">EntityData</command:parameterValue> <dev:type> <maml:name>PentaWork.Xrm.PowerShell.Verbs.EntityData</maml:name> <maml:uri /> <maml:description> <maml:para>Holds some meta data for the retrieved entity type and the export process.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: MapEntitiesByName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MapEntitiesByName</maml:name> <maml:description> <maml:para>Set, if the entities should get mapped by name instead of the id.</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: MapRelatedEntitiesByName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MapRelatedEntitiesByName</maml:name> <maml:description> <maml:para>Set, if the entities to relate should get mapped by name instead of the id.</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: RelationConditions --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RelationConditions</maml:name> <maml:description> <maml:para>Additional mapping conditions to retrieve matching entities, if using MapRelatedEntitiesByName. This can be especially helpful for syncing security roles where the business unit has to be the same as the business unit of the regarding team or user.</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[PentaWork.Xrm.PowerShell.Verbs.RelationCondition, PentaWork.Xrm.PowerShell, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]</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>PentaWork.Xrm.PowerShell.Verbs.EntityData</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The entities with sharings to import.</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 -InteractiveMode</maml:para> <maml:para>Export-XrmEntities -EntityName team -Connection $conn -Relations @("teamroles_association") | Import-XrmRelations -Connection $conn</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Import-XrmSharings --> <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-XrmSharings</command:name> <command:verb>Import</command:verb> <command:noun>XrmSharings</command:noun> <maml:description> <maml:para>Imports given sharings to the given xrm system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function imports a given set of sharings to the connected xrm system. The result of the Export-XrmEntities can be piped into this function.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Import-XrmSharings</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: EntityData --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>EntityData</maml:name> <maml:description> <maml:para>The entities with sharings to import.</maml:para> </maml:description> <command:parameterValue required="true">EntityData</command:parameterValue> <dev:type> <maml:name>PentaWork.Xrm.PowerShell.Verbs.EntityData</maml:name> <maml:uri /> <maml:description> <maml:para>Holds some meta data for the retrieved entity type and the export process.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: MapEntitiesByName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MapEntitiesByName</maml:name> <maml:description> <maml:para>Set, if the entities should get mapped by name instead of the id.</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: MapPrincipalsByName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MapPrincipalsByName</maml:name> <maml:description> <maml:para>Set, if the principals should get mapped by name instead of the id.</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: EntityData --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>EntityData</maml:name> <maml:description> <maml:para>The entities with sharings to import.</maml:para> </maml:description> <command:parameterValue required="true">EntityData</command:parameterValue> <dev:type> <maml:name>PentaWork.Xrm.PowerShell.Verbs.EntityData</maml:name> <maml:uri /> <maml:description> <maml:para>Holds some meta data for the retrieved entity type and the export process.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: MapEntitiesByName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MapEntitiesByName</maml:name> <maml:description> <maml:para>Set, if the entities should get mapped by name instead of the id.</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: MapPrincipalsByName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MapPrincipalsByName</maml:name> <maml:description> <maml:para>Set, if the principals should get mapped by name instead of the id.</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>PentaWork.Xrm.PowerShell.Verbs.EntityData</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The entities with sharings to import.</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 -InteractiveMode</maml:para> <maml:para>Export-XrmEntities -EntityName userquery -Connection $conn | Import-XrmSharings -Connection $conn</maml:para> </maml:introduction> </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 -InteractiveMode</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 -InteractiveMode | 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 -InteractiveMode | Set-XrmTimeout -Timeout 30</maml:para> </maml:introduction> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-XrmUserViews --> <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-XrmUserViews</command:name> <command:verb>Get</command:verb> <command:noun>XrmUserViews</command:noun> <maml:description> <maml:para>Gets a list of all user views, dashboards and charts.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The function returns a list of user views, dashboards and charts.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-XrmUserViews</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: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[PentaWork.Xrm.PowerShell.UserObjectInfo, PentaWork.Xrm.PowerShell, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-CrmConnection -InteractiveMode | Get-XrmUserViews</dev:code> </command:example> </command:examples> </command:command> </helpItems> |