Microsoft.Xrm.Data.PowerShell.Help.xml
|
<?xml version="1.0" encoding="utf-8"?><helpItems schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Add-CrmActivityToCrmRecord</command:name> <maml:description> <maml:para>Create a new activity to a record.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>CrmActivityToCrmRecord</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-CrmActivityToCrmRecord cmdlet lets you add an activity to a record. You use ActivityEntityType to specify Activity Type and Subject/Description to set values. You can use Fields optional Parameter to specify additional Field values. Use @{"field logical name"="value"} syntax to create Fields , and make sure you specify correct type of value for the field. You can use Get-CrmEntityAttributeMetadata cmdlet and check AttributeType to see the field type. In addition, for CRM specific types, you can use New-CrmMoney, New-CrmOptionSetValue or New-CrmEntityReference cmdlets.</maml:para> <maml:para>There are two ways to specify a target record. 1. Pass EntityLogicalName and record's Id. 2. Get a record object by using Get-CrmRecord/Get-CrmRecords cmdlets, and pass it.</maml:para> <maml:para>You can specify note subject and body by using -Subject and -NoteText parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-CrmActivityToCrmRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>A record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ActivityEntityType</maml:name> <maml:description> <maml:para>A logicalname for an Activity Entity to add. i.e.)phonecall, email, task, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Subject</maml:name> <maml:description> <maml:para>Subject of the activity record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the activity record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>OnwerUserId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="7"> <maml:name>Fields</maml:name> <maml:description> <maml:para>A List of field name/value pair. Use @{"field logical name"="value"} syntax to create Fields, and make sure you specify correct type of value for the field. You can use Get-CrmEntityAttributeMetadata cmdlet and check AttributeType to see the field type. In addition, for CRM specific types, you can use New-CrmMoney, New-CrmOptionSetValue or New-CrmEntityReference cmdlets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-CrmActivityToCrmRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname of the target record. i.e.)account, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id</maml:name> <maml:description> <maml:para>An Id (guid) of the record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ActivityEntityType</maml:name> <maml:description> <maml:para>A logicalname for an Activity Entity to add. i.e.)phonecall, email, task, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Subject</maml:name> <maml:description> <maml:para>Subject of the activity record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the activity record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>OnwerUserId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="7"> <maml:name>Fields</maml:name> <maml:description> <maml:para>A List of field name/value pair. Use @{"field logical name"="value"} syntax to create Fields, and make sure you specify correct type of value for the field. You can use Get-CrmEntityAttributeMetadata cmdlet and check AttributeType to see the field type. In addition, for CRM specific types, you can use New-CrmMoney, New-CrmOptionSetValue or New-CrmEntityReference cmdlets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>A record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ActivityEntityType</maml:name> <maml:description> <maml:para>A logicalname for an Activity Entity to add. i.e.)phonecall, email, task, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Subject</maml:name> <maml:description> <maml:para>Subject of the activity record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the activity record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>OnwerUserId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="7"> <maml:name>Fields</maml:name> <maml:description> <maml:para>A List of field name/value pair. Use @{"field logical name"="value"} syntax to create Fields, and make sure you specify correct type of value for the field. You can use Get-CrmEntityAttributeMetadata cmdlet and check AttributeType to see the field type. In addition, for CRM specific types, you can use New-CrmMoney, New-CrmOptionSetValue or New-CrmEntityReference cmdlets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname of the target record. i.e.)account, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id</maml:name> <maml:description> <maml:para>An Id (guid) of the record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Add-CrmActivityToCrmRecord -conn $conn -EntityLogicalName account -Id feff5970-6317-e511-80da-c4346bc43d94 -ActivityEntityType task -Subject "sample task" -Description "sample task description" -OnwerUserId f9d40920-7a43-4f51-9749-0549c4caf67d</dev:code> <dev:remarks> <maml:para>This example adds a task an account record.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Add-CrmActivityToCrmRecord account feff5970-6317-e511-80da-c4346bc43d94 task "sample task" "sample task description" f9d40920-7a43-4f51-9749-0549c4caf67d</dev:code> <dev:remarks> <maml:para>This example adds a task to an account record by omitting parameters names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Add-CrmActivityToCrmRecord account feff5970-6317-e511-80da-c4346bc43d94 task "sample task" "sample task description" f9d40920-7a43-4f51-9749-0549c4caf67d @{"scheduledend"=(Get-Date).AddDays(3);"prioritycode"=New-CrmOptionSetValue 2}</dev:code> <dev:remarks> <maml:para>This example adds a task to an account record with Due Date and Priority fields.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>$account = Get-CrmRecord account feff5970-6317-e511-80da-c4346bc43d94 name PS C:\>user = Get-MyCrmUserId PS C:\>Add-CrmActivityToCrmRecord $account task "sample task" "sample task description" $user</dev:code> <dev:remarks> <maml:para>This example retrieves and stores an account, and login user Id (guid) to variables. Then passes them to Add-CrmActivityToCrmRecord.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Add-CrmMultiRecordAssociation</command:name> <maml:description> <maml:para>Associates multiple records to single record for N:N relationship.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>CrmMultiRecordAssociation</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-CrmMultiRecordAssociation cmdlet lets you associate multiple records to single record for N:N relationship by specifying relatioship logical name. Use @('<object>','<object>') syntax to specify multiple ids or records. if the relationship is self-referencing, specify $True for -IsReflexiveRelationship Parameter.</maml:para> <maml:para>There are two ways to specify records. 1. Pass EntityLogicalName and record's Id for both records. 2. Get record object(s) by using Get-CrmRecord/Get-CrmRecords cmdlets, and pass them.</maml:para> <maml:para>You can specify relationship logical name for the association.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-CrmMultiRecordAssociation</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CrmRecord1</maml:name> <maml:description> <maml:para>A first record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="2"> <maml:name>CrmRecord2s</maml:name> <maml:description> <maml:para>An array of records object which are obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSObject[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>RelationshipName</maml:name> <maml:description> <maml:para>A N:N relationship logical name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>IsReflexiveRelationship</maml:name> <maml:description> <maml:para>Specify $True if the N:N relationship is self-referencing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-CrmMultiRecordAssociation</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName1</maml:name> <maml:description> <maml:para>A logicalname for first Entity. i.e.)account, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id1</maml:name> <maml:description> <maml:para>An Id (guid) of first record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>EntityLogicalName2</maml:name> <maml:description> <maml:para>A logicalname for second Entity. i.e.)account, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="4"> <maml:name>Id2s</maml:name> <maml:description> <maml:para>An array of Ids (guid) of second records. Specify by using @('66005a70-6317-e511-80da-c4346bc43d94','62005a70-6317-e511-80da-c4346bc43d94') syntax.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>RelationshipName</maml:name> <maml:description> <maml:para>A N:N relationship logical name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>IsReflexiveRelationship</maml:name> <maml:description> <maml:para>Specify $True if the N:N relationship is self-referencing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CrmRecord1</maml:name> <maml:description> <maml:para>A first record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="2"> <maml:name>CrmRecord2s</maml:name> <maml:description> <maml:para>An array of records object which are obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>RelationshipName</maml:name> <maml:description> <maml:para>A N:N relationship logical name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>IsReflexiveRelationship</maml:name> <maml:description> <maml:para>Specify $True if the N:N relationship is self-referencing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName1</maml:name> <maml:description> <maml:para>A logicalname for first Entity. i.e.)account, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id1</maml:name> <maml:description> <maml:para>An Id (guid) of first record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>EntityLogicalName2</maml:name> <maml:description> <maml:para>A logicalname for second Entity. i.e.)account, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="4"> <maml:name>Id2s</maml:name> <maml:description> <maml:para>An array of Ids (guid) of second records. Specify by using @('66005a70-6317-e511-80da-c4346bc43d94','62005a70-6317-e511-80da-c4346bc43d94') syntax.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Add-CrmMultiRecordAssociation -conn $conn -EntityLogicalName1 account -Id1 00005a70-6317-e511-80da-c4346bc43d94 -EntityLogicalName2 contact -Id2s @('66005a70-6317-e511-80da-c4346bc43d94','62005a70-6317-e511-80da-c4346bc43d94') -RelationshipName new_accounts_contacts </dev:code> <dev:remarks> <maml:para>This example associates an account and two contact records through new_accounts_contacts custom N:N relationship.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Add-CrmMultiRecordAssociation account 00005a70-6317-e511-80da-c4346bc43d94 contact @('66005a70-6317-e511-80da-c4346bc43d94','62005a70-6317-e511-80da-c4346bc43d94') new_accounts_contacts</dev:code> <dev:remarks> <maml:para>This example associates an account and two contact records through new_accounts_contacts custom N:N relationship by omitting parameters names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>$account = Get-CrmRecord account 00005a70-6317-e511-80da-c4346bc43d94 name PS C:\>$fetch = @" <fetch version="1.0" output-format="xml-platform" mapping="logical" distinct="false" no-lock="true"> <entity name="contact"> <attribute name="fullname" /> <filter type="and"> <condition attribute="lastname" operator="like" value="%sample%" /> </filter> </entity> </fetch> "@ PS C:\>$contacts = Get-CrmRecordsByFetch $fetch PS C:\>Add-CrmMultiRecordAssociation $account $contacts.CrmRecords new_accounts_contacts</dev:code> <dev:remarks> <maml:para>This example retrieves contacts by using FetchXML and stores to a variable, then retrieves and store an account record to another variable. Then passes those variables Add-CrmMultiRecordAssociation.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Add-CrmRecordAssociation</command:name> <maml:description> <maml:para>Associates two records for N:N relationship.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>CrmRecordAssociation</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-CrmRecordAssociation cmdlet lets you associate two records for N:N relationship by specifying relatioship logical name. </maml:para> <maml:para>There are two ways to specify records. 1. Pass EntityLogicalName and record's Id for both records. 2. Get a record object by using Get-CrmRecord/Get-CrmRecords cmdlets, and pass it for both records.</maml:para> <maml:para>You can specify relationship logical name for the association.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-CrmRecordAssociation</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CrmRecord1</maml:name> <maml:description> <maml:para>A first record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>CrmRecord2</maml:name> <maml:description> <maml:para>A second record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>RelationshipName</maml:name> <maml:description> <maml:para>A N:N relationship logical name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-CrmRecordAssociation</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName1</maml:name> <maml:description> <maml:para>A logicalname for first Entity. i.e.)accout, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id1</maml:name> <maml:description> <maml:para>An Id (guid) of first record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>EntityLogicalName2</maml:name> <maml:description> <maml:para>A logicalname for second Entity. i.e.)accout, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Id2</maml:name> <maml:description> <maml:para>An Id (guid) of second record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>RelationshipName</maml:name> <maml:description> <maml:para>A N:N relationship logical name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CrmRecord1</maml:name> <maml:description> <maml:para>A first record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>CrmRecord2</maml:name> <maml:description> <maml:para>A second record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>RelationshipName</maml:name> <maml:description> <maml:para>A N:N relationship logical name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName1</maml:name> <maml:description> <maml:para>A logicalname for first Entity. i.e.)accout, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id1</maml:name> <maml:description> <maml:para>An Id (guid) of first record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>EntityLogicalName2</maml:name> <maml:description> <maml:para>A logicalname for second Entity. i.e.)accout, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Id2</maml:name> <maml:description> <maml:para>An Id (guid) of second record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Add-CrmRecordAssociation -conn $conn -EntityLogicalName1 account -Id1 00005a70-6317-e511-80da-c4346bc43d94 -EntityLogicalName2 contact -Id2 66005a70-6317-e511-80da-c4346bc43d94 -RelationshipName new_accounts_contacts</dev:code> <dev:remarks> <maml:para>This example associates an account and a contact records through new_accounts_contacts custom N:N relationship.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Add-CrmRecordAssociation account 00005a70-6317-e511-80da-c4346bc43d94 contact 66005a70-6317-e511-80da-c4346bc43d94 new_accounts_contacts</dev:code> <dev:remarks> <maml:para>This example associates an account and a contact records through new_accounts_contacts custom N:N relationship by ommiting parameters names. When ommiting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>$account = Get-CrmRecord account 00005a70-6317-e511-80da-c4346bc43d94 name PS C:\>$contact = Get-CrmRecord contact 66005a70-6317-e511-80da-c4346bc43d94 fullname PS C:\>Add-CrmRecordAssociation -conn $conn -CrmRecord1 $account -CrmRecord2 $contact -RelationshipName new_accounts_contacts</dev:code> <dev:remarks> <maml:para>This example retrieves and stores an account and a contact records to variables, then pass them to Add-CrmRecordAssociation cmdlets.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>$account = Get-CrmRecord account 00005a70-6317-e511-80da-c4346bc43d94 name PS C:\>$contact = Get-CrmRecord contact 66005a70-6317-e511-80da-c4346bc43d94 fullname PS C:\>Add-CrmRecordAssociation $account $contact new_accounts_contacts</dev:code> <dev:remarks> <maml:para>This example retrieves and stores an account and a contact records to variables, then pass them to Add-CrmRecordAssociation cmdlets.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Add-CrmSampleData</command:name> <maml:description> <maml:para>Add sample data CRM Organization. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>CrmSampleData</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-CrmSampleData cmdlet lets you add sample data to CRM Organization and returns Job Id. You can confirm the status by using Test-CrmSampleDataInstalled cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-CrmSampleData</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Add-CrmSampleData -conn $conn </dev:code> <dev:remarks> <maml:para>This example adds sample data, it returns the import job ID of the sample data import. </maml:para> <maml:para /> <maml:para /> <maml:para>Guid ---- 9f7ff9ec-d2b5-4599-9909-04a072e0a546 </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Add-CrmSampleData</dev:code> <dev:remarks> <maml:para>This example adds sample data by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it. It returns the import job ID of the sample data import. </maml:para> <maml:para /> <maml:para /> <maml:para>Guid ---- 9f7ff9ec-d2b5-4599-9909-04a072e0a546 </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Add-CrmSecurityRoleToTeam</command:name> <maml:description> <maml:para>Assigns a security role to a team.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>CrmSecurityRoleToTeam</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-CrmSecurityRoleToTeam cmdlet lets you assign a security role to a team. </maml:para> <maml:para>There are two ways to specify records. 1. Pass record's Id for both records. 2. Get a record object by using Get-CrmRecord/Get-CrmRecords cmdlets, and pass it for both records.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-CrmSecurityRoleToTeam</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TeamRecord</maml:name> <maml:description> <maml:para>A team record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use UserId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SecurityRoleRecord</maml:name> <maml:description> <maml:para>A security role record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use SecurityRoleId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SecurityRoleName</maml:name> <maml:description> <maml:para>A name of security role record </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-CrmSecurityRoleToTeam</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>An Id (guid) of team record </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SecurityRoleId</maml:name> <maml:description> <maml:para>An Id (guid) of security role record </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SecurityRoleName</maml:name> <maml:description> <maml:para>A name of security role record </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TeamRecord</maml:name> <maml:description> <maml:para>A team record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use UserId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SecurityRoleRecord</maml:name> <maml:description> <maml:para>A security role record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use SecurityRoleId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SecurityRoleName</maml:name> <maml:description> <maml:para>A name of security role record </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>An Id (guid) of team record </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SecurityRoleId</maml:name> <maml:description> <maml:para>An Id (guid) of security role record </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Add-CrmSecurityRoleToTeam -conn $conn -TeamId 00005a70-6317-e511-80da-c4346bc43d94 -SecurityRoleId 66005a70-6317-e511-80da-c4346bc43d94 </dev:code> <dev:remarks> <maml:para>This example assigns the security role to the team by using Id. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Add-CrmSecurityRoleToTeam 00005a70-6317-e511-80da-c4346bc43d94 66005a70-6317-e511-80da-c4346bc43d94 </dev:code> <dev:remarks> <maml:para>This example assigns the security role to the team by using Id by omitting parameters names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>$team = Get-CrmRecord team 00005a70-6317-e511-80da-c4346bc43d94 name PS C:\>$role = Get-CrmRecord role 66005a70-6317-e511-80da-c4346bc43d94 name PS C:\>Add-CrmSecurityRoleToTeam $team $role</dev:code> <dev:remarks> <maml:para>This example assigns the security role to the team by using record objects. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Add-CrmSecurityRoleToUser -conn $conn -TeamId 00005a70-6317-e511-80da-c4346bc43d94 -SecurityRoleName "salesperson" </dev:code> <dev:remarks> <maml:para>This example assigns the salesperson role to the team by using Id and role name. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Add-CrmSecurityRoleToUser</command:name> <maml:description> <maml:para>Assigns a security role to a user. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>CrmSecurityRoleToUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-CrmSecurityRoleToUser cmdlet lets you assign a security role to a user. There are two ways to specify records. 1. Pass record's Id for both records. 2. Get a record object by using Get-CrmRecord/Get-CrmRecords cmdlets, and pass it for both records.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-CrmSecurityRoleToUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserRecord</maml:name> <maml:description> <maml:para>A user record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use UserId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SecurityRoleRecord</maml:name> <maml:description> <maml:para>A security role record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use SecurityRoleId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-CrmSecurityRoleToUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>An Id (guid) of user record </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SecurityRoleId</maml:name> <maml:description> <maml:para>An Id (guid) of security role record </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserRecord</maml:name> <maml:description> <maml:para>A user record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use UserId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SecurityRoleRecord</maml:name> <maml:description> <maml:para>A security role record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use SecurityRoleId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>An Id (guid) of user record </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SecurityRoleId</maml:name> <maml:description> <maml:para>An Id (guid) of security role record </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Add-CrmSecurityRoleToUser -conn $conn -UserId 00005a70-6317-e511-80da-c4346bc43d94 -SecurityRoleId 66005a70-6317-e511-80da-c4346bc43d94 </dev:code> <dev:remarks> <maml:para>This example assigns the security role to the user by using Id. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Add-CrmSecurityRoleToUser 00005a70-6317-e511-80da-c4346bc43d94 66005a70-6317-e511-80da-c4346bc43d94 </dev:code> <dev:remarks> <maml:para>This example assigns the security role to the user by using Id by omitting parameters names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>$user = Get-CrmRecord sysetmuser 00005a70-6317-e511-80da-c4346bc43d94 fullname PS C:\>$role = Get-CrmRecord role 66005a70-6317-e511-80da-c4346bc43d94 name PS C:\>Add-CrmSecurityRoleToUser $user $role</dev:code> <dev:remarks> <maml:para>This example assigns the security role to the user by using record objects. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Add-CrmSecurityRoleToUser -conn $conn -UserId 00005a70-6317-e511-80da-c4346bc43d94 -SecurityRoleName "salesperson" </dev:code> <dev:remarks> <maml:para>This example assigns the salesperson role to the user by using Id and role name. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Approve-CrmEmailAddress</command:name> <maml:description> <maml:para>Approve email address change of a user or a queue. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Approve</command:verb> <command:noun>CrmEmailAddress</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Approve-CrmEmailAddress cmdlet lets you approves email address change of a user or a queue. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Approve-CrmEmailAddress</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>A record Id of User. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Approve-CrmEmailAddress</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>QueueId</maml:name> <maml:description> <maml:para>A record Id of Queue. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>A record Id of User. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>QueueId</maml:name> <maml:description> <maml:para>A record Id of Queue. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Approve-CrmEmailAddress -conn $conn -UserId 00005a70-6317-e511-80da-c4346bc43d94 </dev:code> <dev:remarks> <maml:para>This example approves email address for a user. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Approve-CrmEmailAddress -UserId 00005a70-6317-e511-80da-c4346bc43d94 </dev:code> <dev:remarks> <maml:para>This example approves email address for a user by omitting parameters names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Approve-CrmEmailAddress -conn $conn -QueueId 00005a70-6317-e511-80da-c4346bc43d94 </dev:code> <dev:remarks> <maml:para>This example approves email address for a queue. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Connect-CrmOnline</command:name> <maml:description> <maml:para>Connects to CRM Online organization without using Discovery Service.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Connect</command:verb> <command:noun>CrmOnline</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Connect-CrmOnline cmdlet lets you connect to CRM Online organization without using Discovery Service. You can use Get-Credential to create Credential information.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-CrmOnline</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>Override the connectionstring used to connect to the instance, this can be used to debug scenarios or accomidate new options that may not be supported in the mainstream module. Please proceed with caution using this parameter as it could be removed in the future or may cause unintended consequences when used in combination with connection string parameters that are unexpected. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectionTimeoutInSeconds</maml:name> <maml:description> <maml:para>Integer value for the connection timeout in seconds</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogWriteDirectory</maml:name> <maml:description> <maml:para>Override the directory location to store the Xrm.Tooling.Connector log files. The directory must already exist, and the user who is running the cmdlet must have Write permission to the directory. You must also use the -Verbose parameter along with the -LogWriteDirectory parameter to be able to store the log files in a custom location.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BypassTokenCache</maml:name> <maml:description> <maml:para>Will bypass using a local cache path, this is most commonly used in conjunction with build pipelines in azure dev ops or limited access environments</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-CrmOnline</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ServerUrl</maml:name> <maml:description> <maml:para>A Url of your Dynamics CRM Online organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ForceDiscovery</maml:name> <maml:description> <maml:para>Forces the connector to verify an org connection with discovery (NOT COMPATIBLE with Partner CSP). </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ForceOAuth</maml:name> <maml:description> <maml:para>Forces oAuth authentication via Azure Active Directory. If a credential is not provided, then Single Sign on will be attempted, if you wish to use a credential that is not your currently signed in user you may provide a credential.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>OAuthClientId</maml:name> <maml:description> <maml:para>Azure Active Directory Native Application Id</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>OAuthRedirectUri</maml:name> <maml:description> <maml:para>Azure Active Directory Redirect Uri (Must match the Applications redirect uri) </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Username</maml:name> <maml:description> <maml:para>This should be used when needing to provide a username hint to ADAL, this will ensure the correct identity is used to attempt acquring a token. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectionTimeoutInSeconds</maml:name> <maml:description> <maml:para>Integer value for the connection timeout in seconds</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogWriteDirectory</maml:name> <maml:description> <maml:para>Override the directory location to store the Xrm.Tooling.Connector log files. The directory must already exist, and the user who is running the cmdlet must have Write permission to the directory. You must also use the -Verbose parameter along with the -LogWriteDirectory parameter to be able to store the log files in a custom location.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BypassTokenCache</maml:name> <maml:description> <maml:para>Will bypass using a local cache path, this is most commonly used in conjunction with build pipelines in azure dev ops or limited access environments</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-CrmOnline</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ServerUrl</maml:name> <maml:description> <maml:para>A Url of your Dynamics CRM Online organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Credential</maml:name> <maml:description> <maml:para>A PS-Credential. You can invoke Get-Credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ForceDiscovery</maml:name> <maml:description> <maml:para>Forces the connector to verify an org connection with discovery (NOT COMPATIBLE with Partner CSP). </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ForceOAuth</maml:name> <maml:description> <maml:para>Forces oAuth authentication via Azure Active Directory. If a credential is not provided, then Single Sign on will be attempted, if you wish to use a credential that is not your currently signed in user you may provide a credential.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>OAuthClientId</maml:name> <maml:description> <maml:para>Azure Active Directory Native Application Id</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>OAuthRedirectUri</maml:name> <maml:description> <maml:para>Azure Active Directory Redirect Uri (Must match the Applications redirect uri) </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectionTimeoutInSeconds</maml:name> <maml:description> <maml:para>Integer value for the connection timeout in seconds</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogWriteDirectory</maml:name> <maml:description> <maml:para>Override the directory location to store the Xrm.Tooling.Connector log files. The directory must already exist, and the user who is running the cmdlet must have Write permission to the directory. You must also use the -Verbose parameter along with the -LogWriteDirectory parameter to be able to store the log files in a custom location.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BypassTokenCache</maml:name> <maml:description> <maml:para>Will bypass using a local cache path, this is most commonly used in conjunction with build pipelines in azure dev ops or limited access environments</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-CrmOnline</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ServerUrl</maml:name> <maml:description> <maml:para>A Url of your Dynamics CRM Online organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>OAuthClientId</maml:name> <maml:description> <maml:para>Azure Active Directory Native Application Id</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>OAuthRedirectUri</maml:name> <maml:description> <maml:para>Azure Active Directory Redirect Uri (Must match the Applications redirect uri) </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ClientSecret</maml:name> <maml:description> <maml:para>Client Secret value when using AzureAD ClientSecret auth and an application user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectionTimeoutInSeconds</maml:name> <maml:description> <maml:para>Integer value for the connection timeout in seconds</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogWriteDirectory</maml:name> <maml:description> <maml:para>Override the directory location to store the Xrm.Tooling.Connector log files. The directory must already exist, and the user who is running the cmdlet must have Write permission to the directory. You must also use the -Verbose parameter along with the -LogWriteDirectory parameter to be able to store the log files in a custom location.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BypassTokenCache</maml:name> <maml:description> <maml:para>Will bypass using a local cache path, this is most commonly used in conjunction with build pipelines in azure dev ops or limited access environments</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Credential</maml:name> <maml:description> <maml:para>A PS-Credential. You can invoke Get-Credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>Get-Credential</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ServerUrl</maml:name> <maml:description> <maml:para>A Url of your Dynamics CRM Online organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ForceDiscovery</maml:name> <maml:description> <maml:para>Forces the connector to verify an org connection with discovery (NOT COMPATIBLE with Partner CSP). </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ForceOAuth</maml:name> <maml:description> <maml:para>Forces oAuth authentication via Azure Active Directory. If a credential is not provided, then Single Sign on will be attempted, if you wish to use a credential that is not your currently signed in user you may provide a credential.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>OAuthClientId</maml:name> <maml:description> <maml:para>Azure Active Directory Native Application Id</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>OAuthRedirectUri</maml:name> <maml:description> <maml:para>Azure Active Directory Redirect Uri (Must match the Applications redirect uri) </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ClientSecret</maml:name> <maml:description> <maml:para>Client Secret value when using AzureAD ClientSecret auth and an application user</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ConnectionString</maml:name> <maml:description> <maml:para>Override the connectionstring used to connect to the instance, this can be used to debug scenarios or accomidate new options that may not be supported in the mainstream module. Please proceed with caution using this parameter as it could be removed in the future or may cause unintended consequences when used in combination with connection string parameters that are unexpected. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectionTimeoutInSeconds</maml:name> <maml:description> <maml:para>Integer value for the connection timeout in seconds</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>120</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogWriteDirectory</maml:name> <maml:description> <maml:para>Override the directory location to store the Xrm.Tooling.Connector log files. The directory must already exist, and the user who is running the cmdlet must have Write permission to the directory. You must also use the -Verbose parameter along with the -LogWriteDirectory parameter to be able to store the log files in a custom location.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BypassTokenCache</maml:name> <maml:description> <maml:para>Will bypass using a local cache path, this is most commonly used in conjunction with build pipelines in azure dev ops or limited access environments</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Username</maml:name> <maml:description> <maml:para>This should be used when needing to provide a username hint to ADAL, this will ensure the correct identity is used to attempt acquring a token. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 Office365 legacy authentication --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Connect-CrmOnline -Credential (Get-Credential) -ServerUrl "https://contoso.crm.dynamics.com"</dev:code> <dev:remarks> <maml:para>Connect to online using your organization URL </maml:para> <maml:para /> <maml:para /> <maml:para>IsReady : True IsBatchOperationsAvailable : True Authority : OAuthUserId : ActiveAuthenticationType : Office365 OrganizationServiceProxy : Microsoft.Xrm.Tooling.Connector.CrmWebSvc+ManagedTokenOrganizationServiceProxy OrganizationWebProxyClient : LastCrmError : OrganizationWebProxyClient is null LastCrmException : CrmConnectOrgUriActual : https://contoso.api.crm.dynamics.com/XRMServices/2011/Organization.svc ConnectedOrgFriendlyName : contoso ConnectedOrgUniqueName : contoso ConnectedOrgPublishedEndpoints : {[WebApplication, https://contoso.crm.dynamics.com/], [OrganizationService, https://contoso.api.crm.dynamics.com/XRMServices/2011/Organization.svc], [OrganizationDataService, https://contoso.api.crm.dynamics.com/XRMServices/2011/OrganizationData.svc]} ConnectionLockObject : System.Object ConnectedOrgVersion : 9.1.0000.0000 DisableCrossThreadSafeties : False CallerId : 00000000-0000-0000-0000-000000000000</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 oAuth Single Sign on --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Connect-CrmOnline -ServerUrl "https://contoso.crm.dynamics.com" -ForceOAuth</dev:code> <dev:remarks> <maml:para>Connect to online using your organization URL using oAuth attempting single sign on - sign on using ADAL and the browser is attempted when a credential is not provided. </maml:para> <maml:para /> <maml:para /> <maml:para>IsReady : True IsBatchOperationsAvailable : True Authority : https://login.windows.net/{guid}/oauth2/authorize/ OAuthUserId : user@contoso.com ActiveAuthenticationType : OAuth OrganizationServiceProxy : OrganizationWebProxyClient : Microsoft.Xrm.Sdk.WebServiceClient.OrganizationWebProxyClient LastCrmError : LastCrmException : CrmConnectOrgUriActual : https://contoso.api.crm.dynamics.com/XRMServices/2011/Organization.svc/web?SDKClientVersion=9.0.9002.0 ConnectedOrgFriendlyName : Contoso ConnectedOrgUniqueName : contosocrmol ConnectedOrgPublishedEndpoints : {[WebApplication, https://contoso.crm.dynamics.com/], [OrganizationService, https://contoso.api.crm.dynamics.com/XRMServices/2011/Organization.svc], [OrganizationDataService, https://contoso.api.crm.dynamics.com/XRMServices/2011/OrganizationData.svc]} ConnectionLockObject : System.Object ConnectedOrgVersion : 9.1.0000.0000 DisableCrossThreadSafeties : False CallerId : 00000000-0000-0000-0000-000000000000</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 oAuth with credenital --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Connect-CrmOnline -ServerUrl "https://contoso.crm.dynamics.com" -Credential (Get-Credential) -ForceOAuth</dev:code> <dev:remarks> <maml:para>Connect to online using your organization URL using oAuth using provided credential.</maml:para> <maml:para /> <maml:para /> <maml:para>IsReady : True IsBatchOperationsAvailable : True Authority : https://login.windows.net/{guid}/oauth2/authorize/ OAuthUserId : user@contoso.com ActiveAuthenticationType : OAuth OrganizationServiceProxy : OrganizationWebProxyClient : Microsoft.Xrm.Sdk.WebServiceClient.OrganizationWebProxyClient LastCrmError : LastCrmException : CrmConnectOrgUriActual : https://contoso.api.crm.dynamics.com/XRMServices/2011/Organization.svc/web?SDKClientVersion=9.0.9002.0 ConnectedOrgFriendlyName : Contoso ConnectedOrgUniqueName : contosocrmol ConnectedOrgPublishedEndpoints : {[WebApplication, https://contoso.crm.dynamics.com/], [OrganizationService, https://contoso.api.crm.dynamics.com/XRMServices/2011/Organization.svc], [OrganizationDataService, https://contoso.api.crm.dynamics.com/XRMServices/2011/OrganizationData.svc]} ConnectionLockObject : System.Object ConnectedOrgVersion : 9.1.0000.0000 DisableCrossThreadSafeties : False CallerId : 00000000-0000-0000-0000-000000000000</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 oAuth with ClientSecret --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Connect-CrmOnline -ServerUrl "https://contoso.crm.dynamics.com" -ClientSecret "T_DA0EY+DdfaJFH3/DFLK@QoFbY" -OAuthClientId "812fad6d-4727-44f5-b02e-f35d74efb78e" -OAuthRedirectUri "https://tempuri.org"</dev:code> <dev:remarks> <maml:para>Connect to a CDS instance as an application user, using ClientSecret authentication </maml:para> <maml:para /> <maml:para /> <maml:para>MaxRetryCount : 10 RetryPauseTime : 00:00:05 IsReady : True IsBatchOperationsAvailable : True Authority : https://login.microsoftonline.com/{guid}/oauth2/authorize/ OAuthUserId : ActiveAuthenticationType : ClientSecret OrganizationServiceProxy : OrganizationWebProxyClient : Microsoft.Xrm.Sdk.WebServiceClient.OrganizationWebProxyClient LastCrmError : LastCrmException : CrmConnectOrgUriActual : https://contoso.crm.dynamics.com/XRMServices/2011/Organization.svc/web?SDKClientV ersion=9.1.0000.0000 ConnectedOrgFriendlyName : [9.1] contoso seanmcn ConnectedOrgUniqueName : contoso ConnectedOrgPublishedEndpoints : {[WebApplication, https://contoso.crm.dynamics.com/], [OrganizationService, https://contoso.api.crm.dynamics.com/XRMServices/2011/Organization.svc], [OrganizationDataService, https://contoso.api.crm.dynamics.com/XRMServices/2011/OrganizationData.svc]} ConnectionLockObject : System.Object ConnectedOrgVersion : 9.1.0000.0000 ConnectedOrgId : b283ca00-d54d-4dd0-ba1a-ee8e51d5256a DisableCrossThreadSafeties : False CallerId : 00000000-0000-0000-0000-000000000000 CallerAADObjectId : SessionTrackingId : ForceServerMetadataCacheConsistency : False SdkVersionProperty : 9.1.0000.0000 TenantId : 03cd4258-2030-45a3-aea9-508adbed80b6 EnvironmentId : 11537934-8ab9-4721-aba1-0feff3133e38 _sdkVersionProperty : 9.1.0000.0000</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 5 ConnectionString FOR DEBUGGING --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Connect-CrmOnline -ConnectionString "RequireNewInstance=True;Url=https://naosrtw.crm.dynamics.com;AuthType=ClientSecret;ClientId=812fad6d-4727-44f5-b02e-f35d74efb78e;SkipDiscovery=True;ClientSecret=T_DA0EY+DdfaJFH3/DFLK@QoFbY" -ConnectionTimeoutInSeconds 500 -LogWriteDirectory "C:\temp\"</dev:code> <dev:remarks> <maml:para>Connect to a CDS instance as an application user, using a custom connectionstring </maml:para> <maml:para>Use with caution and *only* for debugging as this may change or parameter may be removed in the future. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Connect-CrmOnlineDiscovery</command:name> <maml:description> <maml:para>Retrieves all CRM Online Organization you belong to, let you select which organization to login, then returns connection information.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Connect</command:verb> <command:noun>CrmOnlineDiscovery</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Connect-CrmOnlineDiscovery cmdlet lets you retrieves all CRM Online Organization you belong to, let you select which organization to login, then returns connection information. You can use Get-Credential to create Credential information, or you can simply invoke Connect-CrmOnlineDiscovery which prompts you to enter username/password.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-CrmOnlineDiscovery</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Credential</maml:name> <maml:description> <maml:para>A PS-Credential. You can invoke Get-Credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InteractiveMode</maml:name> <maml:description> <maml:para>Switch to launch a wpf dialog to discover and connect to CRM Online instances.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Credential</maml:name> <maml:description> <maml:para>A PS-Credential. You can invoke Get-Credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InteractiveMode</maml:name> <maml:description> <maml:para>Switch to launch a wpf dialog to discover and connect to CRM Online instances.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Default --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\> Connect-CrmOnlineDiscovery</dev:code> <dev:remarks> <maml:para>This example prompts you to enter username/password, displays all CRM organization, and returns connection.</maml:para> <maml:para /> <maml:para /> <maml:para> IsReady : True IsBatchOperationsAvailable : True OrganizationServiceProxy : Microsoft.Xrm.Tooling.Connector.CrmWebSvc+ManagedTokenOrganizationServiceProxy LastCrmError : LastCrmException : CrmConnectOrgUriActual : https://contoso.api.crm.dynamics.com/XRMServices/2011/Organization.svc ConnectedOrgFriendlyName : contoso ConnectedOrgUniqueName : contoso ConnectedOrgPublishedEndpoints : {[WebApplication, https://contoso.crm.dynamics.com/], [OrganizationService, https://contoso.api.crm.dynamics.com/XRMServices/2011/Organization.svc], [OrganizationDataService, https://contoso.api.crm.dynamics.com/XRMServices/2011/OrganizationData.svc]} ConnectionLockObject : System.Object ConnectedOrgVersion : 7.1.0.1086 </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Credential Provided --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>$cred = Get-Credential PS C:\>Connect-CrmOnlineDiscovery $cred </dev:code> <dev:remarks> <maml:para>This example displays all CRM organization, and returns connection.</maml:para> <maml:para /> <maml:para /> <maml:para> IsReady : True IsBatchOperationsAvailable : True OrganizationServiceProxy : Microsoft.Xrm.Tooling.Connector.CrmWebSvc+ManagedTokenOrganizationServiceProxy LastCrmError : LastCrmException : CrmConnectOrgUriActual : https://contoso.api.crm.dynamics.com/XRMServices/2011/Organization.svc ConnectedOrgFriendlyName : contoso ConnectedOrgUniqueName : contoso ConnectedOrgPublishedEndpoints : {[WebApplication, https://contoso.crm.dynamics.com/], [OrganizationService, https://contoso.api.crm.dynamics.com/XRMServices/2011/Organization.svc], [OrganizationDataService, https://contoso.api.crm.dynamics.com/XRMServices/2011/OrganizationData.svc]} ConnectionLockObject : System.Object ConnectedOrgVersion : 7.1.0.1086</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Interactive --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>Connect-CrmOnlineDiscovery -InteractiveMode</dev:code> <dev:remarks> <maml:para> IsReady : True IsBatchOperationsAvailable : True OrganizationServiceProxy : Microsoft.Xrm.Tooling.Connector.CrmWebSvc+ManagedTokenOrganizationServiceProxy LastCrmError : LastCrmException : CrmConnectOrgUriActual : https://contoso.api.crm.dynamics.com/XRMServices/2011/Organization.svc ConnectedOrgFriendlyName : contoso ConnectedOrgUniqueName : contoso ConnectedOrgPublishedEndpoints : {[WebApplication, https://contoso.crm.dynamics.com/], [OrganizationService, https://contoso.api.crm.dynamics.com/XRMServices/2011/Organization.svc], [OrganizationDataService, https://contoso.api.crm.dynamics.com/XRMServices/2011/OrganizationData.svc]} ConnectionLockObject : System.Object ConnectedOrgVersion : 7.1.0.1086</maml:para> <maml:para /> <maml:para /> <maml:para>This example shows how to use -InteractiveMode switch. By specifying the switch, you can login via GUI tool.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Connect-CrmOnPremDiscovery</command:name> <maml:description> <maml:para>Retrieves all CRM OnPrem orgs you belong to, let you select which organization to login, then returns connection information.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Connect</command:verb> <command:noun>CrmOnPremDiscovery</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Connect-CrmOnPremDiscovery cmdlet lets you retrieve all CRM OnPrem Organization you belong to, let you select which organization to login, then returns connection information. You can use Get-Credential to create Credential information, or you can simply invoke Connect-CrmOnlineDiscovery which prompts you to enter username/password.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-CrmOnPremDiscovery</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>A PS-Credential. You can invoke Get-Credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServerUrl</maml:name> <maml:description> <maml:para>A Url of OnPrem Dynamics CRM Server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrganizationName</maml:name> <maml:description> <maml:para>An Organization Unique Name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HomeRealmUrl</maml:name> <maml:description> <maml:para>To specify HomeRealm when you use Claim Authentication with Multiple STS.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-CrmOnPremDiscovery</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InteractiveMode</maml:name> <maml:description> <maml:para>Switch to launch a wpf dialog to discover and connect to CRM Online instances.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>A PS-Credential. You can invoke Get-Credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ServerUrl</maml:name> <maml:description> <maml:para>A Url of OnPrem Dynamics CRM Server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrganizationName</maml:name> <maml:description> <maml:para>An Organization Unique Name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HomeRealmUrl</maml:name> <maml:description> <maml:para>To specify HomeRealm when you use Claim Authentication with Multiple STS.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InteractiveMode</maml:name> <maml:description> <maml:para>Switch to launch a wpf dialog to discover and connect to CRM Online instances.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Connect-CrmOnPremDiscovery</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para> Supply values for the following parameters: ServerUrl: http://crm2015:5555 cmdlet Get-Credential at command pipeline position 1 Supply values for the following parameters [0] CRM (http://crm2015:5555/CRM) [1] CRM2 (http://crm2015:5555/CRM2) Select CRM Organization by index number: 0 IsReady : True IsBatchOperationsAvailable : True Authority : OAuthUserId : ActiveAuthenticationType : AD OrganizationServiceProxy : Microsoft.Xrm.Sdk.Client.OrganizationServiceProxy OrganizationWebProxyClient : LastCrmError : OrganizationWebProxyClient is null LastCrmException : CrmConnectOrgUriActual : http://crm2015:5555/CRM/XRMServices/2011/Organization.svc ConnectedOrgFriendlyName : CRM ConnectedOrgUniqueName : CRM ConnectedOrgPublishedEndpoints : {[WebApplication, http://crm2015:5555/CRM], [OrganizationService, http://crm2015:5555/CRM/XRMServices/2011/Organization.svc], [OrganizationDataService, http://crm2015:5555/CRM/XRMServices/2011/OrganizationData.svc]} ConnectionLockObject : System.Object ConnectedOrgVersion : 7.0.0.3543 This example asks you to enter ServerUrl and prompts for username/password, displays all CRM organization, and returns connection.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>$cred = Get-Credential PS C:\>Connect-CrmOnPremDiscovery -Credential $cred -ServerUrl http://crm2015:5555 </dev:code> <dev:remarks> <maml:para>This example passes credential and ServerUrl. Displays all CRM organization, and returns connection.</maml:para> <maml:para /> <maml:para /> <maml:para> [0] CRM (http://crm2015:5555/CRM) [1] CRM2 (http://crm2015:5555/CRM2) Select CRM Organization by index number: 0 IsReady : True IsBatchOperationsAvailable : True Authority : OAuthUserId : ActiveAuthenticationType : AD OrganizationServiceProxy : Microsoft.Xrm.Sdk.Client.OrganizationServiceProxy OrganizationWebProxyClient : LastCrmError : OrganizationWebProxyClient is null LastCrmException : CrmConnectOrgUriActual : http://crm2015:5555/CRM/XRMServices/2011/Organization.svc ConnectedOrgFriendlyName : CRM ConnectedOrgUniqueName : CRM ConnectedOrgPublishedEndpoints : {[WebApplication, http://crm2015:5555/CRM], [OrganizationService, http://crm2015:5555/CRM/XRMServices/2011/Organization.svc], [OrganizationDataService, http://crm2015:5555/CRM/XRMServices/2011/OrganizationData.svc]} ConnectionLockObject : System.Object ConnectedOrgVersion : 7.0.0.3543 </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>$cred = Get-Credential PS C:\>Connect-CrmOnPremDiscovery -Credential $cred -ServerUrl http://crm2015:5555 -OrganizationName CRM</dev:code> <dev:remarks> <maml:para>This example passes credential, ServerUrl and Organization Unique Name. It does not prompt you at all and returns connection.</maml:para> <maml:para /> <maml:para /> <maml:para> IsReady : True IsBatchOperationsAvailable : True Authority : OAuthUserId : ActiveAuthenticationType : AD OrganizationServiceProxy : Microsoft.Xrm.Sdk.Client.OrganizationServiceProxy OrganizationWebProxyClient : LastCrmError : OrganizationWebProxyClient is null LastCrmException : CrmConnectOrgUriActual : http://crm2015:5555/CRM/XRMServices/2011/Organization.svc ConnectedOrgFriendlyName : CRM ConnectedOrgUniqueName : CRM ConnectedOrgPublishedEndpoints : {[WebApplication, http://crm2015:5555/CRM], [OrganizationService, http://crm2015:5555/CRM/XRMServices/2011/Organization.svc], [OrganizationDataService, http://crm2015:5555/CRM/XRMServices/2011/OrganizationData.svc]} ConnectionLockObject : System.Object ConnectedOrgVersion : 7.0.0.3543</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>Connect-CrmOnPremDiscovery -InteractiveMode</dev:code> <dev:remarks> <maml:para>This example shows how to use -InteractiveMode switch. By specifying the switch, you can login via GUI tool.</maml:para> <maml:para /> <maml:para /> <maml:para> IsReady : True IsBatchOperationsAvailable : True Authority : OAuthUserId : ActiveAuthenticationType : AD OrganizationServiceProxy : Microsoft.Xrm.Sdk.Client.OrganizationServiceProxy OrganizationWebProxyClient : LastCrmError : OrganizationWebProxyClient is null LastCrmException : CrmConnectOrgUriActual : http://crm2015:5555/CRM/XRMServices/2011/Organization.svc ConnectedOrgFriendlyName : CRM ConnectedOrgUniqueName : CRM ConnectedOrgPublishedEndpoints : {[WebApplication, http://crm2015:5555/CRM], [OrganizationService, http://crm2015:5555/CRM/XRMServices/2011/Organization.svc], [OrganizationDataService, http://crm2015:5555/CRM/XRMServices/2011/OrganizationData.svc]} ConnectionLockObject : System.Object ConnectedOrgVersion : 7.0.0.3543</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Disable-CrmLanguagePack</command:name> <maml:description> <maml:para>Executes DeprovisionLanguageRequest Organization Request.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>CrmLanguagePack</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Disable-CrmLanguagePack cmdlet lets you deprovision LanguagePack. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-CrmLanguagePack</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>LCID</maml:name> <maml:description> <maml:para>A Language ID. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>LCID</maml:name> <maml:description> <maml:para>A Language ID. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Disable-CrmLanguagePack -conn $conn -LCID 1041 </dev:code> <dev:remarks> <maml:para>This example deprovisions Japanese Language Pack. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Disable-CrmLanguagePack 1041 </dev:code> <dev:remarks> <maml:para>This example deprovisions Japanese Language Pack by omitting parameters names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Enable-CrmLanguagePack</command:name> <maml:description> <maml:para>Executes ProvisionLanguageRequest Organization Request. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>CrmLanguagePack</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Enable-CrmLanguagePack cmdlet lets you provision LanguagePack. For OnPremise, you need to install corresponding Language Pack inadvance. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-CrmLanguagePack</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>LCID</maml:name> <maml:description> <maml:para>A Language ID. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>LCID</maml:name> <maml:description> <maml:para>A Language ID. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Enable-CrmLanguagePack -conn $conn -LCID 1041 </dev:code> <dev:remarks> <maml:para>This example provisions Japanese Language Pack. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Enable-CrmLanguagePack 1041 </dev:code> <dev:remarks> <maml:para>This example provisions Japanese Language Pack by omitting parameters names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Export-CrmApplicationRibbonXml</command:name> <maml:description> <maml:para>Retrieves the ribbon definition XML for application and saves it to a file on the file system. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Export</command:verb> <command:noun>CrmApplicationRibbonXml</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Export-CrmEntityRibbonXml cmdlet lets you retrieve ribbon definition XML for an Entity. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-CrmApplicationRibbonXml</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RibbonFilePath</maml:name> <maml:description> <maml:para>The path to the desired output location. This should be a full file path, e.g.-c:\temp </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RibbonFilePath</maml:name> <maml:description> <maml:para>The path to the desired output location. This should be a full file path, e.g.-c:\temp </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Export-CrmEntityRibbonXml -conn $conn -EntityLogicalName Account -Path d:\temp\accountribbon.xml </dev:code> <dev:remarks> <maml:para>This example gets the Ribbon XML for the account entity and outputs it to the specified file path. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Export-CrmEntityRibbonXml</command:name> <maml:description> <maml:para>Retrieves the ribbon definition XML for an Entity and saves it to a file on the file system. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Export</command:verb> <command:noun>CrmEntityRibbonXml</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Export-CrmEntityRibbonXml cmdlet lets you retrieve ribbon definition XML for an Entity. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-CrmEntityRibbonXml</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for Entity. e.g.- account, contact, lead, etc.. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>RibbonFilePath</maml:name> <maml:description> <maml:para>The path to the desired output location. This should be a full file path, e.g.-c:\temp </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for Entity. e.g.- account, contact, lead, etc.. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>RibbonFilePath</maml:name> <maml:description> <maml:para>The path to the desired output location. This should be a full file path, e.g.-c:\temp </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Export-CrmEntityRibbonXml -conn $conn -EntityLogicalName account -RibbonFilePath c:\temp </dev:code> <dev:remarks> <maml:para>This example export the Ribbon XML for the account entity to c:\temp\accountRibbon.xml. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Export-CrmSolution</command:name> <maml:description> <maml:para>Exports a solution by Name from a CRM Organization. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Export</command:verb> <command:noun>CrmSolution</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Export-CrmSolution cmdlet lets you export a solution file from CRM. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-CrmSolution</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>An unique name of the exporting solution. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SolutionFilePath</maml:name> <maml:description> <maml:para>A path to save exporting solution. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SolutionZipFileName</maml:name> <maml:description> <maml:para>A file name of exporting solution zip file. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Managed</maml:name> <maml:description> <maml:para>Specify the parameter to export the solution as managed. if you don't give this parameter, the solution will be exported as unmanaged. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetVersion</maml:name> <maml:description> <maml:para>Specify TargetVersion of exporting solution. Examples of Valid versions: 7.0.0.0, 7.1.0.0, 8.0.0.0, 8.1.0.0, 8.2.0.0 See https://msdn.microsoft.com/en-us/library/dn689055.aspx for more details.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportAutoNumberingSettings</maml:name> <maml:description> <maml:para>Specify the parameter to export auto numbering settings. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportCalendarSettings</maml:name> <maml:description> <maml:para>Specify the parameter to export calendar settings. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportCustomizationSettings</maml:name> <maml:description> <maml:para>Specify the parameter to export customization settings. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportEmailTrackingSettings</maml:name> <maml:description> <maml:para>Specify the parameter to export email tracking settings. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportGeneralSettings</maml:name> <maml:description> <maml:para>Specify the parameter to export general settings. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportMarketingSettings</maml:name> <maml:description> <maml:para>Specify the parameter to export marketing settings. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportOutlookSynchronizationSettings</maml:name> <maml:description> <maml:para>Specify the parameter to export outlook synchronization settings. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportRelationshipRoles</maml:name> <maml:description> <maml:para>Specify the parameter to export relationship roles. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportIsvConfig</maml:name> <maml:description> <maml:para>Specify the parameter to export ISV config. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportSales</maml:name> <maml:description> <maml:para>Specify the parameter to export sales settings. Only available CRM 2015+ </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>An unique name of the exporting solution. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SolutionFilePath</maml:name> <maml:description> <maml:para>A path to save exporting solution. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SolutionZipFileName</maml:name> <maml:description> <maml:para>A file name of exporting solution zip file. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Managed</maml:name> <maml:description> <maml:para>Specify the parameter to export the solution as managed. if you don't give this parameter, the solution will be exported as unmanaged. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetVersion</maml:name> <maml:description> <maml:para>Specify TargetVersion of exporting solution. Examples of Valid versions: 7.0.0.0, 7.1.0.0, 8.0.0.0, 8.1.0.0, 8.2.0.0 See https://msdn.microsoft.com/en-us/library/dn689055.aspx for more details.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportAutoNumberingSettings</maml:name> <maml:description> <maml:para>Specify the parameter to export auto numbering settings. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportCalendarSettings</maml:name> <maml:description> <maml:para>Specify the parameter to export calendar settings. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportCustomizationSettings</maml:name> <maml:description> <maml:para>Specify the parameter to export customization settings. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportEmailTrackingSettings</maml:name> <maml:description> <maml:para>Specify the parameter to export email tracking settings. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportGeneralSettings</maml:name> <maml:description> <maml:para>Specify the parameter to export general settings. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportMarketingSettings</maml:name> <maml:description> <maml:para>Specify the parameter to export marketing settings. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportOutlookSynchronizationSettings</maml:name> <maml:description> <maml:para>Specify the parameter to export outlook synchronization settings. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportRelationshipRoles</maml:name> <maml:description> <maml:para>Specify the parameter to export relationship roles. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportIsvConfig</maml:name> <maml:description> <maml:para>Specify the parameter to export ISV config. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExportSales</maml:name> <maml:description> <maml:para>Specify the parameter to export sales settings. Only available CRM 2015+ </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Export-CrmSolution -conn $conn -SolutionName "MySolution" </dev:code> <dev:remarks> <maml:para>This example exports "MySolution" solution as unmanaged with current path and default name. </maml:para> <maml:para /> <maml:para /> <maml:para>ExportSolutionResponse SolutionPath ---------------------- ------------ Microsoft.Crm.Sdk.Messages.ExportSolutionResponse C:\Users\xxxx\Desktop\MySolution_unmanaged_1.0.0.0.zip</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Export-CrmSolution "MySolution" </dev:code> <dev:remarks> <maml:para>This example exports "MySolution" solution as unmanaged with current path and default name by omitting $conn parameter. When omitting $conn parameter, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>ExportSolutionResponse SolutionPath ---------------------- ------------ Microsoft.Crm.Sdk.Messages.ExportSolutionResponse C:\Users\xxxx\Desktop\MySolution_unmanaged_1.0.0.0.zip</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Export-CrmSolution -conn $conn -SolutionName "MySolution" -Managed -SolutionFilePath "C:\temp" -SolutionZipFileName "MySolution_Managed.zip" </dev:code> <dev:remarks> <maml:para>This example exports "MySolution" solution as managed with specified path and name. </maml:para> <maml:para /> <maml:para /> <maml:para>ExportSolutionResponse SolutionPath ---------------------- ------------ Microsoft.Crm.Sdk.Messages.ExportSolutionResponse C:\temp\MySolution_Managed.zip</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Export-CrmSolutionTranslation</command:name> <maml:description> <maml:para>Exports a translation from a solution. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Export</command:verb> <command:noun>CrmSolutionTranslation</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Export-CrmSolutionTranslation cmdlet lets you export a translation from a solution. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-CrmSolutionTranslation</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>An unique name of the exporting solution. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TranslationFilePath</maml:name> <maml:description> <maml:para>A path to save exporting solution translation. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TranslationZipFileName</maml:name> <maml:description> <maml:para>A file name of exporting solution translation zip file. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>An unique name of the exporting solution. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TranslationFilePath</maml:name> <maml:description> <maml:para>A path to save exporting solution translation. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TranslationZipFileName</maml:name> <maml:description> <maml:para>A file name of exporting solution translation zip file. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Export-CrmSolutionTranslation -conn $conn -SolutionName "MySolution" </dev:code> <dev:remarks> <maml:para>This example exports translation file of "MySolution" solution with current path and default name. </maml:para> <maml:para /> <maml:para /> <maml:para>ExportTranslationResponse SolutionTranslationPath ------------------------- ----------------------- Microsoft.Crm.Sdk.Messages.ExportTranslationResponse C:\Users\xxx\Desktop\CrmTranslations_MySolution_1_0_0_0.zip</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Export-CrmSolutionTranslation -SolutionName "MySolution" </dev:code> <dev:remarks> <maml:para>This example exports translation file of "MySolution" solution with current path and default name by omitting $conn parameter. When omitting $conn parameter, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>ExportTranslationResponse SolutionTranslationPath ------------------------- ----------------------- Microsoft.Crm.Sdk.Messages.ExportTranslationResponse C:\Users\xxx\Desktop\CrmTranslations_MySolution_1_0_0_0.zip</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Export-CrmSolutionTranslation -conn $conn -SolutionName "MySolution" -TranslationFilePath "C:\temp" -TranslationZipFileName "CrmTranslations_MySolution.zip" </dev:code> <dev:remarks> <maml:para>This example exports translation file of "MySolution" solution with specified path and name. </maml:para> <maml:para /> <maml:para /> <maml:para>ExportTranslationResponse SolutionTranslationPath ------------------------- ----------------------- Microsoft.Crm.Sdk.Messages.ExportTranslationResponse C:\temp\CrmTranslations_MySolution.zip</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmAllLanguagePacks</command:name> <maml:description> <maml:para>Executes RetrieveAvailableLanguagesRequest Organization Request. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmAllLanguagePacks</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmAllLanguagePacks cmdlet lets you retrieve all available LanguagePack. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmAllLanguagePacks</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>Get-CrmAllLanguagePacks -conn $conn </dev:code> <dev:remarks> <maml:para>This example retrieves all available Language Pack. </maml:para> <maml:para /> <maml:para /> <maml:para>1041 1033 2052 ...</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>Get-CrmAllLanguagePacks </dev:code> <dev:remarks> <maml:para>This example etrieves all available Language Pack by omitting parameters names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>1041 1033 2052 ...</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmEntityAllMetadata</command:name> <maml:description> <maml:para>Retrieves all Metadata for CRM organization.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmEntityAllMetadata</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmEntityAllMetadata cmdlet lets you retrieve all Metadata for CRM organization. You can specify which type of Metadata you want to retrive by using EntityFilters parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmEntityAllMetadata</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>OnlyPublished</maml:name> <maml:description> <maml:para>Specify $True if you retrieve only published Metadata. Specifying $False will display unpublished metadata (metadata that will eventually become published)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>EntityFilters</maml:name> <maml:description> <maml:para>Specify which type of Metadata you want to retrieve. Valid options are "all", "attributes", "entity", "privileges", "relationships".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>OnlyPublished</maml:name> <maml:description> <maml:para>Specify $True if you retrieve only published Metadata. Specifying $False will display unpublished metadata (metadata that will eventually become published)</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>EntityFilters</maml:name> <maml:description> <maml:para>Specify which type of Metadata you want to retrieve. Valid options are "all", "attributes", "entity", "privileges", "relationships".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmEntityAllMetadata -conn $conn -OnlyPublished $True -EntityFilters all</dev:code> <dev:remarks> <maml:para>This example retrieves all published Metadata.</maml:para> <maml:para /> <maml:para /> <maml:para>ActivityTypeMask : 0 Attributes : {, , Microsoft.Xrm.Sdk.Metadata.AttributeTypeDisplayName, ...} AutoRouteToOwnerQueue : False CanTriggerWorkflow : False Description : Microsoft.Xrm.Sdk.Label DisplayCollectionName : Microsoft.Xrm.Sdk.Label DisplayName : Microsoft.Xrm.Sdk.Label EntityHelpUrlEnabled : False EntityHelpUrl : ...</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmEntityAllMetadata $True Entity</dev:code> <dev:remarks> <maml:para>This example retrieves all published Entity metadata by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>ActivityTypeMask : 0 Attributes : AutoRouteToOwnerQueue : False CanTriggerWorkflow : False Description : Microsoft.Xrm.Sdk.Label DisplayCollectionName : Microsoft.Xrm.Sdk.Label DisplayName : Microsoft.Xrm.Sdk.Label EntityHelpUrlEnabled : False ...</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmEntityAllMetadata -conn $conn -EntityFilters Entity | select -property @{N='LogicalName';E={$_.logicalname}}, @{N='DisplayName';E={$_.DisplayCollectionName.UserLocalizedLabel.Label}} | sort DisplayName</dev:code> <dev:remarks> <maml:para>This samples get Entity metadata and list its logicalname and display name as table.</maml:para> <maml:para /> <maml:para /> <maml:para>LogicalName DisplayName ----------- ----------- cardtype Action Card Type actioncardusersettings Action Card User Settings actioncard Action Cards actioncarduserstate ActionCardUserStates activitypointer Activities activityparty Activity Parties customeraddress Addresses advancedsimilarityrule Advanced Similarity Rules </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmEntityAttributeMetadata</command:name> <maml:description> <maml:para>Retrieves an attribute metadata for an Entity.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmEntityAttributeMetadata</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmEntityAttributeMetadata cmdlet lets you retrieve an attribute metadata for an Entity. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmEntityAttributeMetadata</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for Entity. i.e.)account, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FieldLogicalName</maml:name> <maml:description> <maml:para>A logicalname for a field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for Entity. i.e.)account, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FieldLogicalName</maml:name> <maml:description> <maml:para>A logicalname for a field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmEntityAttributeMetadata -conn $conn -EntityLogicalName account -FieldLogicalName parentaccountid</dev:code> <dev:remarks> <maml:para>This example retrieves Parent Account attribute metadata for Account Entity.</maml:para> <maml:para /> <maml:para /> <maml:para>Targets : {account} AttributeOf : AttributeType : Lookup AttributeTypeName : Microsoft.Xrm.Sdk.Metadata.AttributeTypeDisplayName ColumnNumber : 57 Description : Microsoft.Xrm.Sdk.Label DisplayName : Microsoft.Xrm.Sdk.Label DeprecatedVersion : IntroducedVersion : 5.0.0.0 EntityLogicalName : account ... </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmEntityAttributeMetadata account parentaccountid </dev:code> <dev:remarks> <maml:para>This example retrieves Parent Account attribute metadata for Account Entity by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>AttributeOf : preferredcontactmethodcode AttributeType : Virtual AttributeTypeName : Microsoft.Xrm.Sdk.Metadata.AttributeTypeDisplayName ColumnNumber : 149 Description : Microsoft.Xrm.Sdk.Label DisplayName : Microsoft.Xrm.Sdk.Label DeprecatedVersion : IntroducedVersion : 5.0.0.0 EntityLogicalName : account IsAuditEnabled : Microsoft.Xrm.Sdk.BooleanManagedProperty IsCustomAttribute : False ...</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmEntityAttributes</command:name> <maml:description> <maml:para>Retrieves all attributes metadata for an Entity.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmEntityAttributes</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmEntityAttributes cmdlet lets you retrieve all attributes metadata for an Entity.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmEntityAttributes</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for Entity. i.e.)account, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for Entity. i.e.)account, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmEntityAttributes -conn $conn -EntityLogicalName account</dev:code> <dev:remarks> <maml:para>This example retrieves all attributes metadata for Account Entity.</maml:para> <maml:para /> <maml:para /> <maml:para>AttributeOf : preferredcontactmethodcode AttributeType : Virtual AttributeTypeName : Microsoft.Xrm.Sdk.Metadata.AttributeTypeDisplayName ColumnNumber : 149 Description : Microsoft.Xrm.Sdk.Label DisplayName : Microsoft.Xrm.Sdk.Label DeprecatedVersion : IntroducedVersion : 5.0.0.0 EntityLogicalName : account IsAuditEnabled : Microsoft.Xrm.Sdk.BooleanManagedProperty IsCustomAttribute : False ...</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmEntityAttributes account</dev:code> <dev:remarks> <maml:para>This example retrieves all attributes metadata for Account Entity by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>AttributeOf : preferredcontactmethodcode AttributeType : Virtual AttributeTypeName : Microsoft.Xrm.Sdk.Metadata.AttributeTypeDisplayName ColumnNumber : 149 Description : Microsoft.Xrm.Sdk.Label DisplayName : Microsoft.Xrm.Sdk.Label DeprecatedVersion : IntroducedVersion : 5.0.0.0 EntityLogicalName : account IsAuditEnabled : Microsoft.Xrm.Sdk.BooleanManagedProperty IsCustomAttribute : False ...</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmEntityAttributes account | Where {$_.IsCustomAttribute -eq $true} | Select logicalname</dev:code> <dev:remarks> <maml:para>This example retrieves all attributes metadata for an account, and filter for only custom fields. Then displays logicalname field only.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmEntityDisplayName</command:name> <maml:description> <maml:para>Retrieves Display Name for an Entity.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmEntityDisplayName</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmEntityDisplayName cmdlet lets you retrieve Display Name for an Entity.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmEntityDisplayName</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for Entity. i.e.)account, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for Entity. i.e.)account, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmEntityDisplayName -conn $conn -EntityLogicalName account</dev:code> <dev:remarks> <maml:para>This example retrieves Display Name for Account Entity.</maml:para> <maml:para /> <maml:para /> <maml:para>Account</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmEntityDisplayName incident</dev:code> <dev:remarks> <maml:para>This example retrieves Display Name for Incident Entity by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>Case</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmEntityDisplayPluralName</command:name> <maml:description> <maml:para>Retrieves Display Plural Name for an Entity.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmEntityDisplayPluralName</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmEntityDisplayPluralName cmdlet lets you retrieve Display Plural Name for an Entity. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmEntityDisplayPluralName</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for Entity. i.e.)account, contact, lead, etc.. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for Entity. i.e.)account, contact, lead, etc.. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmEntityDisplayPluralName -conn $conn -EntityLogicalName account </dev:code> <dev:remarks> <maml:para>This example retrieves Display Name for Account Entity. </maml:para> <maml:para /> <maml:para /> <maml:para>Accounts </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmEntityDisplayPluralName incident </dev:code> <dev:remarks> <maml:para>This example retrieves Display Name for Incident Entity by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it. </maml:para> <maml:para /> <maml:para /> <maml:para>Cases </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmEntityMetadata</command:name> <maml:description> <maml:para>Retrieves Metadata for an Entity.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmEntityMetadata</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmEntityMetadata cmdlet lets you retrieve Metadata for an Entity. You can specify which type of Metadata you want to retrieve by using EntityFilters parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmEntityMetadata</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for Entity. i.e.)account, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>EntityFilters</maml:name> <maml:description> <maml:para>Specify which type of Metadata you want to retrieve. Valid options are "all", "attributes", "entity", "privileges", "relationships".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for Entity. i.e.)account, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>EntityFilters</maml:name> <maml:description> <maml:para>Specify which type of Metadata you want to retrieve. Valid options are "all", "attributes", "entity", "privileges", "relationships".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmEntityMetadata -conn $conn -EntityLogicalName account EntityFilters all</dev:code> <dev:remarks> <maml:para>This example retrieves all Metadata for Account Entity.</maml:para> <maml:para /> <maml:para /> <maml:para>ActivityTypeMask : 0 Attributes : {Microsoft.Xrm.Sdk.Metadata.AttributeTypeDisplayName, Microsoft.Xrm.Sdk.Metadata.StringFormatName, Microsoft.Xrm.Sdk.Metadata.StringFormatName, Microsoft.Xrm.Sdk.Metadata.StringFormatName...} AutoRouteToOwnerQueue : False CanTriggerWorkflow : True Description : Microsoft.Xrm.Sdk.Label DisplayCollectionName : Microsoft.Xrm.Sdk.Label ...</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmEntityMetadata account relationships</dev:code> <dev:remarks> <maml:para>ActivityTypeMask : 0 Attributes : {Microsoft.Xrm.Sdk.Metadata.AttributeTypeDisplayName, Microsoft.Xrm.Sdk.Metadata.StringFormatName, Microsoft.Xrm.Sdk.Metadata.StringFormatName, Microsoft.Xrm.Sdk.Metadata.StringFormatName...} AutoRouteToOwnerQueue : False CanTriggerWorkflow : True Description : Microsoft.Xrm.Sdk.Label DisplayCollectionName : Microsoft.Xrm.Sdk.Label ...</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmEntityName</command:name> <maml:description> <maml:para>Retrieves Entity logicalname for EntityTypeCode. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmEntityName</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmEntityName cmdlet lets you retrieve Entity logicalname. You can specify EntityTypeCode. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmEntityName</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityTypeCode</maml:name> <maml:description> <maml:para>A number for Entity. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityTypeCode</maml:name> <maml:description> <maml:para>A number for Entity. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmEntityName -conn $conn -EntityTypeCode 1 </dev:code> <dev:remarks> <maml:para>This example retrieves Entity logicalname for EntityTypeCode 1 (Account). </maml:para> <maml:para /> <maml:para /> <maml:para>account </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmEntityName 4200 </dev:code> <dev:remarks> <maml:para>This example retrieves Entity logicalname for EntityTypeCode 4200 (Activity) by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>activitypointer </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmEntityOptionSet</command:name> <maml:description> <maml:para>Retrieves a picklist field of an Entity. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmEntityOptionSet</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmEntityOptionSet cmdlet lets you retrieve a picklist field of an Entity. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmEntityOptionSet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for Entity. i.e.)account, contact, lead, etc.. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FieldLogicalName</maml:name> <maml:description> <maml:para>A logicalname for a picklist filed. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for Entity. i.e.)account, contact, lead, etc.. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FieldLogicalName</maml:name> <maml:description> <maml:para>A logicalname for a picklist filed. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmEntityOptionSet -conn $conn -EntityLogicalName account -FieldLogicalName statuscode </dev:code> <dev:remarks> <maml:para>This example retrieves statuscode picklist for Account Entity. </maml:para> <maml:para /> <maml:para /> <maml:para>ActualValue PickListLabel DisplayValue Items ----------- ------------- ------------ ----- Status Reason {1, 2} </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmEntityOptionSet account statuscode </dev:code> <dev:remarks> <maml:para>This example retrieves statuscode picklist for Account Entity by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>ActualValue PickListLabel DisplayValue Items ----------- ------------- ------------ ----- Status Reason {1, 2} </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmEntityOptionSet account statuscode | % {$_.Items} </dev:code> <dev:remarks> <maml:para>This example retrieves statuscode picklist for Account Entity and displays Label and Id. </maml:para> <maml:para /> <maml:para /> <maml:para>DisplayLabel PickListItemId ------------ -------------- Active 1 Inactive 2</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmEntityRecordCount</command:name> <maml:description> <maml:para>Retrieves total record count for an Entity. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmEntityRecordCount</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmEntityRecordCount cmdlet lets you retrieve total record count for an Entity. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmEntityRecordCount</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for an Entity to retrieve. i.e.)account, contact, lead, etc.. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for an Entity to retrieve. i.e.)account, contact, lead, etc.. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmEntityRecordCount -conn $conn -EntityLogicalName account </dev:code> <dev:remarks> <maml:para>10 </maml:para> <maml:para /> <maml:para /> <maml:para>This example retrieves total record count for Account Entity. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmEntityRecordCount contact </dev:code> <dev:remarks> <maml:para>This example retrieves total record count for Contact Entity by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>8413 </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmEntityTypeCode</command:name> <maml:description> <maml:para>Retrieves EntityTypeCode for an Entity. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmEntityTypeCode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmEntityTypeCode cmdlet lets you retrieve EntityTypeCode. You can specify EntityLogicalName. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmEntityTypeCode</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for Entity. i.e.)account, contact, lead, etc.. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for Entity. i.e.)account, contact, lead, etc.. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmEntityTypeCode -conn $conn -EntityLogicalName account</dev:code> <dev:remarks> <maml:para>This example retrieves EntityTypeCode for Account Entity.</maml:para> <maml:para /> <maml:para /> <maml:para>1</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmEntityTypeCode lead </dev:code> <dev:remarks> <maml:para>This example retrieves EntityTypeCode for Lead Entity by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>4 </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmFailedWorkflows</command:name> <maml:description> <maml:para>Retrieves alert notifications from CRM organization. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmFailedWorkflows</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmFailedWorkflows cmdlet lets you retrieve failed workflows from a CRM organization. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmFailedWorkflows</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>TopCount</maml:name> <maml:description> <maml:para>Maximum number of records to retrieve</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>PageNumber</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>PageCookie</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>AllRows</maml:name> <maml:description> <maml:para>Indicates you would like to bring back data from all pages (all available rows in CRM, this function will take longer to execute, but will include all the data rather than the first 5000 rows) </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>TopCount</maml:name> <maml:description> <maml:para>Maximum number of records to retrieve</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>PageNumber</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>PageCookie</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>AllRows</maml:name> <maml:description> <maml:para>Indicates you would like to bring back data from all pages (all available rows in CRM, this function will take longer to execute, but will include all the data rather than the first 5000 rows) </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmFailedWorkflows </dev:code> <dev:remarks> <maml:para>This example retrieves failed workflow records notifications by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>Key Value --- ----- CrmRecords {@{startedon_Property=[startedon, 9/14/2015 8:03:11 AM]; startedon=9/14/2015 3:03 AM;.... Count 2565 PagingCookie <cookie page="1"><modifiedon last="2015-05-10T01:43:22-03:00" first="2015-05-10T01:4... NextPage False FetchXml <fetch version="1.0" output-format="xml-platform" mapping="logical" distinct="false">...</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmFailedWorkflows | % {$_.CrmRecords} | select message,startedon </dev:code> <dev:remarks> <maml:para>This example retrieves workflow errors and displays them with the startedon and message attributes. </maml:para> <maml:para /> <maml:para /> <maml:para>startedon message --------- ------- 9/14/2015 3:03 AM Unhandled Exception: System.ServiceModel.FaultException`1[[Microsoft.Xrm.Sdk.OrganizationServiceFault... 9/13/2015 3:03 AM Unhandled Exception: System.ServiceModel.FaultException`1[[Microsoft.Xrm.Sdk.OrganizationServiceFault... 9/12/2015 3:03 AM Unhandled Exception: System.ServiceModel.FaultException`1[[Microsoft.Xrm.Sdk.OrganizationServiceFault... 9/11/2015 3:03 AM Unhandled Exception: System.ServiceModel.FaultException`1[[Microsoft.Xrm.Sdk.OrganizationServiceFault... 9/10/2015 3:03 AM Unhandled Exception: System.ServiceModel.FaultException`1[[Microsoft.Xrm.Sdk.OrganizationServiceFault... 9/9/2015 2:46 PM Plugin Trace:... 9/9/2015 3:03 AM Unhandled Exception: System.ServiceModel.FaultException`1[[Microsoft.Xrm.Sdk.OrganizationServiceFault... 9/8/2015 3:03 AM Unhandled Exception: System.ServiceModel.FaultException`1[[Microsoft.Xrm.Sdk.OrganizationServiceFault... 9/7/2015 3:02 AM Unhandled Exception: System.ServiceModel.FaultException`1[[Microsoft.Xrm.Sdk.OrganizationServiceFault... 9/6/2015 3:03 AM Unhandled Exception: System.ServiceModel.FaultException`1[[Microsoft.Xrm.Sdk.OrganizationServiceFault... 9/5/2015 3:02 AM Unhandled Exception: System.ServiceModel.FaultException`1[[Microsoft.Xrm.Sdk.OrganizationServiceFault... 9/4/2015 7:30 AM Plugin Trace:... 9/4/2015 3:02 AM Unhandled Exception: System.ServiceModel.FaultException`1[[Microsoft.Xrm.Sdk.OrganizationServiceFault... 9/3/2015 3:02 AM Unhandled Exception: System.ServiceModel.FaultException`1[[Microsoft.Xrm.Sdk.OrganizationServiceFault... 9/2/2015 3:02 AM Unhandled Exception: System.ServiceModel.FaultException`1[[Microsoft.Xrm.Sdk.OrganizationServiceFault... 9/1/2015 3:02 AM Unhandled Exception: System.ServiceModel.FaultException`1[[Microsoft.Xrm.Sdk.OrganizationServiceFault... 8/31/2015 4:49 PM Plugin Trace:... 8/31/2015 4:33 PM Plugin Trace:... 8/31/2015 4:33 PM Plugin Trace:... ... </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmGlobalOptionSet</command:name> <maml:description> <maml:para>Retrieves a global OptionSet. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmGlobalOptionSet</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmGlobalOptionSet cmdlet lets you retrieve a global OptionSet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmGlobalOptionSet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>OptionSetName</maml:name> <maml:description> <maml:para>A logicalname for a global OptionSet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>OptionSetName</maml:name> <maml:description> <maml:para>A logicalname for a global OptionSet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmGlobalOptionSet -conn $conn -OptionSetName incident_caseorigincode </dev:code> <dev:remarks> <maml:para>This example retrieves incident_caseorigincode global OptionSet. </maml:para> <maml:para /> <maml:para /> <maml:para>Options : {, , , ...} Description : Microsoft.Xrm.Sdk.Label DisplayName : Microsoft.Xrm.Sdk.Label IsCustomOptionSet : False IsGlobal : True IsManaged : True IsCustomizable : Microsoft.Xrm.Sdk.BooleanManagedProperty Name : incident_caseorigincode OptionSetType : Picklist IntroducedVersion : MetadataId : 08fa2cb2-e3fe-497a-9b5d-ee887f5cc3cd HasChanged : ExtensionData : System.Runtime.Serialization.ExtensionDataObject</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmGlobalOptionSet incident_caseorigincode </dev:code> <dev:remarks> <maml:para>This example retrieves incident_caseorigincode global OptionSet by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>Options : {, , , ...} Description : Microsoft.Xrm.Sdk.Label DisplayName : Microsoft.Xrm.Sdk.Label IsCustomOptionSet : False IsGlobal : True IsManaged : True IsCustomizable : Microsoft.Xrm.Sdk.BooleanManagedProperty Name : incident_caseorigincode OptionSetType : Picklist IntroducedVersion : MetadataId : 08fa2cb2-e3fe-497a-9b5d-ee887f5cc3cd HasChanged : ExtensionData : System.Runtime.Serialization.ExtensionDataObject</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>$optionset = Get-CrmGlobalOptionSet incident_caseorigincode PS C:\>$optionset.Options | % {[string]$_.Value + ":" + $_.Label.LocalizedLabels.Label}</dev:code> <dev:remarks> <maml:para>This example retrieves incident_caseorigincode global OptionSet and stores to variable, then query its value and display name.</maml:para> <maml:para /> <maml:para /> <maml:para>1:Phone 2:Email 3:Web 2483:Facebook 3986:Twitter</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmRecord</command:name> <maml:description> <maml:para>Retrieves a CRM record by specifying EntityLogicalName, record's Id (guid) and field names. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmRecord</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmRecord cmdlet lets you retrieve a record from your CRM organization. The retrieve results has two properties for each field like name and name_Property. The field with "_Property" contains field's logicalname and its Type information, and another field contains "readable" value, which is either FormattedValue or extracted value from CRM special type like EntityReference. The output also contains logical name of the Entity and original field which contains raw data. You can ignore these two fields.</maml:para> <maml:para>You can specify fields as fieldname1,fieldname2,fieldname3 syntax or * to retrieve all fields (not recommended for performance reason.) You can use Get-CrmEntityAttributes cmdlet to see all fields logicalname. The retrieved data can be passed to several cmdlets like Set-CrmRecord, Removed-CrmRecord to further process it.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organizatoin. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for an Entity to retrieve. i.e.)accout, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id</maml:name> <maml:description> <maml:para>An Id (guid) of the record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="3"> <maml:name>Fields</maml:name> <maml:description> <maml:para>A List of field logicalnames. Use "fieldname1, fieldname2, fieldname3" syntax to specify Fields, or use "*" to retrieve all fields (not recommended for performance reason.)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>IncludeNullValue</maml:name> <maml:description> <maml:para>Sepcify when you want to include fields even if it has null value. By default, all the fields doesn't include value won't be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organizatoin. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for an Entity to retrieve. i.e.)accout, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id</maml:name> <maml:description> <maml:para>An Id (guid) of the record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="3"> <maml:name>Fields</maml:name> <maml:description> <maml:para>A List of field logicalnames. Use "fieldname1, fieldname2, fieldname3" syntax to specify Fields, or use "*" to retrieve all fields (not recommended for performance reason.)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>IncludeNullValue</maml:name> <maml:description> <maml:para>Sepcify when you want to include fields even if it has null value. By default, all the fields doesn't include value won't be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmRecord -conn $conn -EntityLogicalName account -Id be02caab-6c16-e511-80d6-c4346bc43dc0 -Fields name,accountnumber </dev:code> <dev:remarks> <maml:para>This example retrieves an account record with name and accountnumber fields. If the value of the field is null, then it won't be returned.</maml:para> <maml:para /> <maml:para /> <maml:para>name_Property : [name, A. Datum Corporation (sample)] name : A. Datum Corporation (sample) accountid_Property : [accountid, be02caab-6c16-e511-80d6-c4346bc43dc0] accountid : be02caab-6c16-e511-80d6-c4346bc43dc0 original : {[name_Property, [name, A. Datum Corporation (sample)]], [name, A. Datum Corporation (sample)], [accountid_Property, [accountid, be02caab-6c16-e511-80d6-c4346bc43dc0]], [accountid, be02caab-6c16-e511-80d6-c4346bc43dc0]} logicalname : account</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmRecord account be02caab-6c16-e511-80d6-c4346bc43dc0 primarycontactid,statuscode</dev:code> <dev:remarks> <maml:para>This example retrieves an account record with PrimaryContact and StateCode fields by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>accountid_Property : [accountid, be02caab-6c16-e511-80d6-c4346bc43dc0] accountid : be02caab-6c16-e511-80d6-c4346bc43dc0 primarycontactid_Property : [primarycontactid, Microsoft.Xrm.Sdk.EntityReference] primarycontactid : Rene Valdes (sample) statuscode_Property : [statuscode, Microsoft.Xrm.Sdk.OptionSetValue] statuscode : Active original : {[accountid_Property, [accountid, be02caab-6c16-e511-80d6-c4346bc43dc0]], [accountid, be02caab-6c16-e511-80d6-c4346bc43dc0], [primarycontactid_Property, [primarycontactid, Microsoft.Xrm.Sdk.EntityReference]], [primarycontactid, Microsoft.Xrm.Sdk.EntityReference]...} logicalname : account</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmRecord account 5b2fe1f3-b503-e511-80d4-c4346bc43dc0 *</dev:code> <dev:remarks> <maml:para>This example retrieve an account record with all fields (which have values).</maml:para> <maml:para /> <maml:para /> <maml:para>address2_addresstypecode_Property : [address2_addresstypecode, Microsoft.Xrm.Sdk.OptionSetValue] address2_addresstypecode : Default Value merged_Property : [merged, False] merged : No statecode_Property : [statecode, Microsoft.Xrm.Sdk.OptionSetValue] statecode : Active emailaddress1_Property : [emailaddress1, someone9@example.com] emailaddress1 : someone9@example.com ...... </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmRecord -conn $conn -EntityLogicalName account -Id be02caab-6c16-e511-80d6-c4346bc43dc0 -Fields name,accountnumber,websiteurl -IncludeNullValue </dev:code> <dev:remarks> <maml:para>This example retrieves an account record with specified fields even if some of them are null value.</maml:para> <maml:para /> <maml:para /> <maml:para>name_Property : [name, A. Datum Corporation (sample)] name : A. Datum Corporation (sample) accountid_Property : [accountid, be02caab-6c16-e511-80d6-c4346bc43dc0] accountid : be02caab-6c16-e511-80d6-c4346bc43dc0 accountnumber : accountnumber_Property : websiteurl : websiteurl_Property : original : {[name_Property, [name, A. Datum Corporation (sample)]], [name, A. Datum Corporation (sample)], [accountid_Property, [accountid, be02caab-6c16-e511-80d6-c4346bc43dc0]], [accountid, be02caab-6c16-e511-80d6-c4346bc43dc0]} logicalname : account</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmRecords</command:name> <maml:description> <maml:para>Retrieves CRM records by using single filter condition. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmRecords</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmRecords cmdlet lets you retrieve CRM records by using single filter condition. It my return more than a record. You can specify condition operator by using PowerShell operator like "eq", "ne", "lt", "like", etc.</maml:para> <maml:para>You can specify desired fields as fieldname1,fieldname2,fieldname3 syntax or * to retrieve all fields (not recommended for performance reason.) You can use Get-CrmEntityAttributes cmdlet to see all fields logicalname. The retrieved data can be passed to several cmdlets like Set-CrmRecord, Removed-CrmRecord to further process it. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmRecords</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for an Entity to retrieve. i.e.)account, contact, lead, etc.. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FilterAttribute</maml:name> <maml:description> <maml:para>A field logical name for filtering. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>FilterOperator</maml:name> <maml:description> <maml:para>An condition operator like "eq", "ne", "lt", "like", etc. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>FilterValue</maml:name> <maml:description> <maml:para>A field value for filtering </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="5"> <maml:name>Fields</maml:name> <maml:description> <maml:para>A List of field logicalnames. Use "fieldname1, fieldname2, fieldname3" syntax to speficy Fields, or ues "*" to retrieve all fields (not recommended for performance reason.) </maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>AllRows</maml:name> <maml:description> <maml:para>By default the first 5000 rows are returned, this switch will bring back all results regardless of how many </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="7"> <maml:name>TopCount</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for an Entity to retrieve. i.e.)account, contact, lead, etc.. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FilterAttribute</maml:name> <maml:description> <maml:para>A field logical name for filtering. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>FilterOperator</maml:name> <maml:description> <maml:para>An condition operator like "eq", "ne", "lt", "like", etc. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>FilterValue</maml:name> <maml:description> <maml:para>A field value for filtering </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="5"> <maml:name>Fields</maml:name> <maml:description> <maml:para>A List of field logicalnames. Use "fieldname1, fieldname2, fieldname3" syntax to speficy Fields, or ues "*" to retrieve all fields (not recommended for performance reason.) </maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>AllRows</maml:name> <maml:description> <maml:para>By default the first 5000 rows are returned, this switch will bring back all results regardless of how many </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="7"> <maml:name>TopCount</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmRecords -conn $conn -EntityLogicalName account -FilterAttribute name -FilterOperator "eq" -FilterValue "Adventure Works (sample)" -Fields name,accountnumber </dev:code> <dev:remarks> <maml:para>This example retrieves account(s) which name is "Adventure Works (sample)", with specified fields. </maml:para> <maml:para /> <maml:para /> <maml:para>Key Value --- ----- CrmRecords {@{name_Property=[name, Adventure Works (sample)]; name=A... Count 5 PagingCookie <cookie page="1"><accountid last="{1FF8D93D-1F18-E511-80D... NextPage False</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmRecords account name "like" "%(sample)%" name,accountnumber -AllRows </dev:code> <dev:remarks> <maml:para>This example retrieves account(s) which name includes "sample", with specified fields by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>Key Value --- ----- CrmRecords {@{name_Property=[name, Adventure Works (sample)]; name=A... Count 5 PagingCookie <cookie page="1"><accountid last="{1FF8D93D-1F18-E511-80D... NextPage False</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmRecordsByFetch</command:name> <maml:description> <maml:para>Retrieves CRM records by using FetchXML query.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmRecordsByFetch</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmRecordsByFetch cmdlet lets you retrieve up to 5,000 records from your CRM organization by using FetchXML query. The output contains CrmRecords (List or retrieved records), PagingCookie (for next iteration), and NextPage (to indicate if there are more records on the next page).</maml:para> <maml:para>if you need to paging the result, you can also specify TopCount, PageNumber and PagingCookie.</maml:para> <maml:para>You can obtain FetchXML by using Advanced Find tool. As FetchXML query can be multiple lines, use "@ ... @" syntax to speficy the query. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmRecordsByFetch</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Fetch</maml:name> <maml:description> <maml:para>A FetchXML query to retrieve records. You can obtain FetchXML by using Advanced Find tool. Use "@ ... @" syntax to specify the query. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>TopCount</maml:name> <maml:description> <maml:para>Specify how many records you need to retireve at once (up to 5,000 at once). </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>PageNumber</maml:name> <maml:description> <maml:para>Specify starting page number for paging. Starting from 1. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>PageCookie</maml:name> <maml:description> <maml:para>Specify cookie string for paging. Keep previous PagingCookie value for next iteration. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>AllRows</maml:name> <maml:description> <maml:para>By default the first 5000 rows are returned, this switch will bring back all results regardless of how many </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Fetch</maml:name> <maml:description> <maml:para>A FetchXML query to retrieve records. You can obtain FetchXML by using Advanced Find tool. Use "@ ... @" syntax to specify the query. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>TopCount</maml:name> <maml:description> <maml:para>Specify how many records you need to retireve at once (up to 5,000 at once). </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>PageNumber</maml:name> <maml:description> <maml:para>Specify starting page number for paging. Starting from 1. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>PageCookie</maml:name> <maml:description> <maml:para>Specify cookie string for paging. Keep previous PagingCookie value for next iteration. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>AllRows</maml:name> <maml:description> <maml:para>By default the first 5000 rows are returned, this switch will bring back all results regardless of how many </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmRecordsByFetch -conn $conn -Fetch @" <fetch version="1.0" output-format="xml-platform" mapping="logical" distinct="false" no-lock="true"> <entity name="account"> <attribute name="name" /> <attribute name="primarycontactid" /> <attribute name="telephone1" /> <attribute name="accountid" /> <order attribute="name" descending="false" /> </entity> </fetch> "@</dev:code> <dev:remarks> <maml:para>This example retrieves account records by using FetchXML and results contains CrmRecords, PagingCookie and NextPage. Please note that copying and pasting above example may not work due to multiline issue. Please remove all whitespace before last @"</maml:para> <maml:para /> <maml:para /> <maml:para>Key Value --- ----- CrmRecords {@{name_Property=[name, A. Datum Corporation (sample)]; name=A. Datum Corporation (s... Count 5 PagingCookie <cookie page="1"><name last="Litware, Inc. (sample)" first="A. Datum Corporation (sa... NextPage False</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$result = Get-CrmRecordsByFetch @" <fetch version="1.0" output-format="xml-platform" mapping="logical" distinct="false" no-lock="true"> <entity name="account"> <attribute name="name" /> <attribute name="primarycontactid" /> <attribute name="telephone1" /> <attribute name="accountid" /> <order attribute="name" descending="false" /> </entity> </fetch> "@ PS C:\>$result.CrmRecords</dev:code> <dev:remarks> <maml:para>This example stores retrieved result into $result variable, then show records by CrmRecords property. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>name_Property : [name, A. Datum Corporation (sample)] name : A. Datum Corporation (sample) primarycontactid_Property : [primarycontactid, Microsoft.Xrm.Sdk.EntityReference] primarycontactid : Rene Valdes (sample) telephone1_Property : [telephone1, 555-0158] telephone1 : 555-0158 accountid_Property : [accountid, be02caab-6c16-e511-80d6-c4346bc43dc0] accountid : be02caab-6c16-e511-80d6-c4346bc43dc0 returnProperty_EntityName : account returnProperty_Id : be02caab-6c16-e511-80d6-c4346bc43dc0 original : {[name_Property, [name, A. Datum Corporation (sample)]], [name, A. Datum Corporation (sample)], [primarycontactid_Property, [primarycontactid, Microsoft.Xrm.Sdk.EntityReference]], [primarycontactid, Microsoft.Xrm.Sdk.EntityReference]...} logicalname : account name_Property : [name, Adventure Works (sample)] name : Adventure Works (sample) primarycontactid_Property : [primarycontactid, Microsoft.Xrm.Sdk.EntityReference] primarycontactid : Nancy Anderson (sample) telephone1_Property : [telephone1, 555-0152] ....</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$result1 = Get-CrmRecordsByFetch @" <fetch version="1.0" output-format="xml-platform" mapping="logical" distinct="false" no-lock="true"> <entity name="contact"> <attribute name="fullname" /> </entity> </fetch> "@ PS C:\>$result1.CrmRecords.Count 5000 PS C:\>$result1.NextPage True PS C:\>$result1.PagingCookie <cookie page="1"><contactid last="{890FDA88-4217-E511-80DB-C4346BC42D18}" first="{E1D47674-4017-E511-80DB-C4346BC42D18}" /></cookie> PS C:\>$result2 = Get-CrmRecordsByFetch -conn $conn -Fetch @" <fetch version="1.0" output-format="xml-platform" mapping="logical" distinct="false" no-lock="true"> <entity name="contact"> <attribute name="fullname" /> </entity> </fetch> "@ -TopCount 5000 -PageNumber 2 -PageCookie $result1.PagingCookie PS C:\>$result2.CrmRecords.Count 453 PS C:\>$result2.NextPage False</dev:code> <dev:remarks> <maml:para>This example stores retrieved result into $result1 variable, then use $result1.PagingCookie data for next iteration. FetchXML is exactly same but specifying additional Parameters for second command.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmRecordsByViewName</command:name> <maml:description> <maml:para>Retrieves CRM records by using View Name. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmRecordsByViewName</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmRecordsByViewName cmdlet lets you retrieve CRM records by using View Name. You can use IsUserView parameter to select SystemView or UserView. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmRecordsByViewName</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ViewName</maml:name> <maml:description> <maml:para>A name of a view, which contains desired FetchXML. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>IsUserView</maml:name> <maml:description> <maml:para>Speficy $True if the view is User View. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>AllRows</maml:name> <maml:description> <maml:para>Indicates you would like to bring back data from all pages (all available rows in CRM, this function will take longer to execute, but will include all the data rather than the first 5000 rows) </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>TopCount</maml:name> <maml:description> <maml:para>Maximum number of records to retrieve</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ViewName</maml:name> <maml:description> <maml:para>A name of a view, which contains desired FetchXML. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>IsUserView</maml:name> <maml:description> <maml:para>Speficy $True if the view is User View. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>AllRows</maml:name> <maml:description> <maml:para>Indicates you would like to bring back data from all pages (all available rows in CRM, this function will take longer to execute, but will include all the data rather than the first 5000 rows) </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>TopCount</maml:name> <maml:description> <maml:para>Maximum number of records to retrieve</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmRecordsByViewName -conn $conn -ViewName "Active Accounts" </dev:code> <dev:remarks> <maml:para>This example retrieves account records by using "Active Accounts" system view. </maml:para> <maml:para /> <maml:para /> <maml:para>Key Value --- ----- CrmRecords {@{accountid_Property=[accountid, 2bf8d93d-1f18-e511-80da-c4346bc43d94]; accountid=2... Count 5 PagingCookie <cookie page="1"><name last="account907" first="A. Datum Corporation (sample)" /><ac... NextPage True </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmRecordsByViewName "My Custom Account View" $True </dev:code> <dev:remarks> <maml:para>This example retrieves account records by using "My Custom Account View" user view by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>Key Value --- ----- CrmRecords {@{accountid_Property=[accountid, 2bf8d93d-1f18-e511-80da-c4346bc43d94]; accountid=2... Count 5 PagingCookie <cookie page="1"><name last="account907" first="A. Datum Corporation (sample)" /><ac... NextPage True </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmRecordsCount</command:name> <maml:description> <maml:para>Retrieves CRM entity total record counts. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmRecordsCount</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmRecordsCount cmdlet lets you retrieve CRM entity total record counts. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmRecordsCount</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for an Entity to retrieve. i.e.)account, contact, lead, etc.. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for an Entity to retrieve. i.e.)account, contact, lead, etc.. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmRecordsCount -conn $conn -EntityLogicalName account </dev:code> <dev:remarks> <maml:para>This example retrieves total number of Account entity records. </maml:para> <maml:para /> <maml:para /> <maml:para>5677 </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmRecordsCount account </dev:code> <dev:remarks> <maml:para>This example retrieves total number of Account entity records by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>5677 </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmSdkMessageProcessingStepsForPluginAssembly</command:name> <maml:description> <maml:para>Retrieves all registered steps for Plugin. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmSdkMessageProcessingStepsForPluginAssembly</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmSdkMessageProcessingStepsForPluginAssembly cmdlet lets you retrieve all registered steps for Plugin. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmSdkMessageProcessingStepsForPluginAssembly</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PluginAssemblyName</maml:name> <maml:description> <maml:para>A plugin assembly name. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>OnlyCustomizable</maml:name> <maml:description> <maml:para>By specifying this swich returns only customizable steps. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>PluginAssemblyName</maml:name> <maml:description> <maml:para>A plugin assembly name. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>OnlyCustomizable</maml:name> <maml:description> <maml:para>By specifying this swich returns only customizable steps. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmSdkMessageProcessingStepsForPluginAssembly -conn $conn -PluginAssemblyName YourPluginAssemblyName </dev:code> <dev:remarks> <maml:para>This example retrieves all registered steps for the plugin assembly. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmSdkMessageProcessingStepsForPluginAssembly -conn $conn -PluginAssemblyName YourPluginAssemblyName -OnlyCustomizable </dev:code> <dev:remarks> <maml:para>This example retrieves all registered customizable steps for the plugin assembly. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmSdkMessageProcessingStepsForPluginAssembly -PluginAssemblyName YourPluginAssemblyName </dev:code> <dev:remarks> <maml:para>This example retrieves all registered steps for the plugin assembly by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmSystemSettings</command:name> <maml:description> <maml:para>Retrieves CRM Organization's System Settings. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmSystemSettings</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmSystemSettings cmdlet lets you retrieve CRM Organization's System Settings. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmSystemSettings</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ShowDisplayName</maml:name> <maml:description> <maml:para>When you specify the ShowDisplayName switch, you see DisplayName for all fields, otherwise you see SchemaName. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ShowDisplayName</maml:name> <maml:description> <maml:para>When you specify the ShowDisplayName switch, you see DisplayName for all fields, otherwise you see SchemaName. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>This example retrieves CRM Organization's System Settings. </dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para>Get-CrmSystemSettings -conn $conn AllowUsersSeeAppdownloadMessage : Yes IsPresenceEnabled : Yes defaultemailsettings:incomingemaildeliverymethod : Server-Side Synchronization or Email Router defaultemailsettings:outgoingemaildeliverymethod : Server-Side Synchronization or Email Router defaultemailsettings:actdeliverymethod : Microsoft Dynamics CRM for Outlook ...</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmSystemSettings -conn $conn -ShowDisplayName </dev:code> <dev:remarks> <maml:para>This example retrieves CRM Organization's System Settings and show DisplayName for fields. </maml:para> <maml:para /> <maml:para /> <maml:para>Allow the showing tablet application notification bars in a browser. : Yes Presence Enabled : Yes Default Email Settings:Incoming Email : Server-Side Synchronization or Email Router Default Email Settings:Outgoing Email : Server-Side Synchronization or Email Router Default Email Settings:Appointments, Contacts, and Tasks : Microsoft Dynamics CRM for Outlook ...</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmSystemSettings </dev:code> <dev:remarks> <maml:para>This example retrieves CRM Organization's System Settings by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>AllowUsersSeeAppdownloadMessage : Yes IsPresenceEnabled : Yes defaultemailsettings:incomingemaildeliverymethod : Server-Side Synchronization or Email Router defaultemailsettings:outgoingemaildeliverymethod : Server-Side Synchronization or Email Router defaultemailsettings:actdeliverymethod : Microsoft Dynamics CRM for Outlook ...</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmSystemSettings -ShowDisplayName </dev:code> <dev:remarks> <maml:para>Allow the showing tablet application notification bars in a browser. : Yes Presence Enabled : Yes Default Email Settings:Incoming Email : Server-Side Synchronization or Email Router Default Email Settings:Outgoing Email : Server-Side Synchronization or Email Router Default Email Settings:Appointments, Contacts, and Tasks : Microsoft Dynamics CRM for Outlook ...</maml:para> <maml:para /> <maml:para /> <maml:para>This example retrieves CRM Organization's System Settings and show DisplayName for fields by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmTimeZones</command:name> <maml:description> <maml:para>Retrieves CRM Timezone information. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmTimeZones</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmTimeZones cmdlet lets you retrieve CRM Timezone information. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmTimeZones</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmTimeZones -conn $conn </dev:code> <dev:remarks> <maml:para>This example retrieves timezone information. </maml:para> <maml:para /> <maml:para /> <maml:para>Timezone Name TimeZoneCode ------------- ------------ (GMT-12:00) International Date Line West 0 (GMT+13:00) Samoa 1 (GMT-10:00) Hawaii 2 (GMT-09:00) Alaska 3 (GMT-08:00) Pacific Time (US & Canada) 4 ... </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmTimeZones </dev:code> <dev:remarks> <maml:para>This example retrieves timezone information by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>Timezone Name TimeZoneCode ------------- ------------ (GMT-12:00) International Date Line West 0 (GMT+13:00) Samoa 1 (GMT-10:00) Hawaii 2 (GMT-09:00) Alaska 3 (GMT-08:00) Pacific Time (US & Canada) 4 ... </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmTraceAlerts</command:name> <maml:description> <maml:para>Retrieves alert notifications from CRM organization. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmTraceAlerts</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmTraceAlerts cmdlet lets you retrieve alert notifications from CRM organization. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmTraceAlerts</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmTraceAlerts -conn $conn </dev:code> <dev:remarks> <maml:para>This example retrieves alert notifications. </maml:para> <maml:para /> <maml:para /> <maml:para>Key Value --- ----- CrmRecords {@{tracecode_Property=[tracecode, 66]; tracecode=66; text_Property=[text, One or mor... Count 5 PagingCookie <cookie page="1"><modifiedon last="2015-05-10T01:43:22-03:00" first="2015-05-10T01:4... NextPage False</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmTraceAlerts </dev:code> <dev:remarks> <maml:para>This example retrieves alert notifications by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>Key Value --- ----- CrmRecords {@{tracecode_Property=[tracecode, 66]; tracecode=66; text_Property=[text, One or mor... Count 5 PagingCookie <cookie page="1"><modifiedon last="2015-05-10T01:43:22-03:00" first="2015-05-10T01:4... NextPage False</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmTraceAlerts | % {$_.CrmRecords} | select text,level </dev:code> <dev:remarks> <maml:para>This example retrieves alert notifications and display its text and level. </maml:para> <maml:para /> <maml:para /> <maml:para>text level ---- ----- One or more mailboxes associated with the email server profile @[9605,7eedeb22-6a30-... Error Appointments, contacts and tasks can't be synchronized for mailbox @[9606,d0deee3f-6... Information Appointments, contacts, and tasks can't be synchronized for your mailbox @[9606,d0de... Information Email cannnot be be received because the email address of the mailbox @[9606,28c1e1a... Error The mailbox @[9606,e453c89b-6417-e511-80dc-c4346bc4fc6c,"Support Queue"] can't recei... Information Your mailbox @[9606,e453c89b-6417-e511-80dc-c4346bc4fc6c,"Support Queue"] can't rece... Information The mailbox @[9606,d0deee3f-6a17-e511-80dc-c4346bc4fc6c,"<sample team>"] can't recei... Information Your mailbox @[9606,d0deee3f-6a17-e511-80dc-c4346bc4fc6c,"<sample team>"] can't rece... Information Appointments, contacts and tasks can't be synchronized for mailbox @[9606,28c1e1af-6... Information ...</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmUserPrivileges</command:name> <maml:description> <maml:para>Retrieves privileges a CRM User has. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmUserPrivileges</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmUserPrivileges cmdlet lets you retrieve privileges a CRM User has. Result set contains following properties.</maml:para> <maml:para>Depth: Accumulated privilege Depth PrivilegeId: Privilege ID PrivilegeName: Privilege Name Origin: Indicate where the privilege comes from. RoleName:Depth format PrincipalType: User or Team PrincipalName: User's fullname or Team's name BusinessUnitName: User's or Team's BusinessUnitName</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmUserPrivileges</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>An Id (guid) of CRM User. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>An Id (guid) of CRM User. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmUserPrivileges -conn $conn -UserId f9d40920-7a43-4f51-9749-0549c4caf67d </dev:code> <dev:remarks> <maml:para>This example retrieves privileges assigned to the CRM User. </maml:para> <maml:para /> <maml:para /> <maml:para> Depth : Global PrivilegeId : 59f49e9a-a621-4836-8a35-b44f1f7122fb PrivilegeName : prvAppendToConvertRule Origin : Marketing Manager:Global,System Administrator:Global PrincipalType : User PrincipalName : kenichiro nakamura BusinessUnitName : Contoso Depth : Global PrivilegeId : 368aff3b-95b1-45c1-bf73-01a7becdedc5 PrivilegeName : prvAppendToCustomerOpportunityRole Origin : Salesperson:Global PrincipalType : Team PrincipalName : TeamA BusinessUnitName : Contoso ...</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmUserPrivileges f9d40920-7a43-4f51-9749-0549c4caf67d </dev:code> <dev:remarks> <maml:para>This example retrieves privileges assigned to the CRM User by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>Depth : Global PrivilegeId : 59f49e9a-a621-4836-8a35-b44f1f7122fb PrivilegeName : prvAppendToConvertRule Origin : Marketing Manager:Global,System Administrator:Global PrincipalType : User PrincipalName : kenichiro nakamura BusinessUnitName : Contoso Depth : Global PrivilegeId : 368aff3b-95b1-45c1-bf73-01a7becdedc5 PrivilegeName : prvAppendToCustomerOpportunityRole Origin : Salesperson:Global PrincipalType : Team PrincipalName : TeamA BusinessUnitName : Contoso ...</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmUserSecurityRoles</command:name> <maml:description> <maml:para>Retrieves Security Roles assigned to a CRM User. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmUserSecurityRoles</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmUserSecurityRoles cmdlet lets you retrieve Security Roles assigned to a CRM User. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmUserSecurityRoles</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>An Id (guid) of CRM User. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeTeamRoles</maml:name> <maml:description> <maml:para>When you specify the IncludeTeamRoles switch, Security Roles from teams are also returned. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>An Id (guid) of CRM User. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeTeamRoles</maml:name> <maml:description> <maml:para>When you specify the IncludeTeamRoles switch, Security Roles from teams are also returned. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmUserSecurityRoles -conn $conn -UserId f9d40920-7a43-4f51-9749-0549c4caf67d </dev:code> <dev:remarks> <maml:para>This example retrieves Security Roles assigned to the CRM User. </maml:para> <maml:para /> <maml:para /> <maml:para>RoleId RoleName TeamName BusinessUnitName ------ -------- -------- ---------------- cac2d2c7-c6f7-e411-80de-c4346bc520c0 Marketing Manager TeamA Contoso 57d5d2c7-c6f7-e411-80de-c4346bc520c0 Salesperson Contoso ...</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmUserSecurityRoles -conn $conn -UserId f9d40920-7a43-4f51-9749-0549c4caf67d -IncludeTeamRoles </dev:code> <dev:remarks> <maml:para>This example retrieves Security Roles assigned to the CRM User and Teams which the CRM User belongs to.</maml:para> <maml:para /> <maml:para /> <maml:para>RoleId RoleName TeamName BusinessUnitName ------ -------- -------- ---------------- cac2d2c7-c6f7-e411-80de-c4346bc520c0 Marketing Manager TeamA Contoso 57d5d2c7-c6f7-e411-80de-c4346bc520c0 Salesperson Contoso ...</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmUserSecurityRoles f9d40920-7a43-4f51-9749-0549c4caf67d -IncludeTeamRoles </dev:code> <dev:remarks> <maml:para>This example retrieves Security Roles assigned to the CRM User and Teams which the CRM User belongs to by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>RoleId RoleName TeamName BusinessUnitName ------ -------- -------- ---------------- cac2d2c7-c6f7-e411-80de-c4346bc520c0 Marketing Manager TeamA Contoso 57d5d2c7-c6f7-e411-80de-c4346bc520c0 Salesperson Contoso ...</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmUserSettings</command:name> <maml:description> <maml:para>Retrieves CRM user's settings. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmUserSettings</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmUserSettings cmdlet lets you retrieve CRM user's settings. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmUserSettings</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>An Id (guid) of CRM User. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Fields</maml:name> <maml:description> <maml:para>A List of field logicalnames. Use "fieldname1, fieldname2, fieldname3" syntax to specify Fields, or use "*" to retrieve all fields (not recommended for performance reason.) </maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>An Id (guid) of CRM User. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="2"> <maml:name>Fields</maml:name> <maml:description> <maml:para>A List of field logicalnames. Use "fieldname1, fieldname2, fieldname3" syntax to specify Fields, or use "*" to retrieve all fields (not recommended for performance reason.) </maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmUserSettings -conn $conn -UserId f9d40920-7a43-4f51-9749-0549c4caf67d -Fields * </dev:code> <dev:remarks> <maml:para>This example retrieves all fields from specified User's UserSettings. </maml:para> <maml:para /> <maml:para /> <maml:para>timeformatcode_Property : [timeformatcode, 0] timeformatcode : 0 timezonestandardminute_Property : [timezonestandardminute, 0] timezonestandardminute : 0 synccontactcompany_Property : [synccontactcompany, True] synccontactcompany : Yes ...</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmUserSettings (Get-MyCrmUserId) * </dev:code> <dev:remarks> <maml:para>This example retrieves all fields from login User's UserSettings by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>timeformatcode_Property : [timeformatcode, 0] timeformatcode : 0 timezonestandardminute_Property : [timezonestandardminute, 0] timezonestandardminute : 0 synccontactcompany_Property : [synccontactcompany, True] synccontactcompany : Yes ...</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-MyCrmUserId</command:name> <maml:description> <maml:para>Retrieves login user's CRM UserId (guid).</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>MyCrmUserId</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-MyCrmUserId cmdlet retrieves login user's CRM UserId. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-MyCrmUserId</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-MyCrmUserId -conn $conn</dev:code> <dev:remarks> <maml:para>This example returns login user's CRM UserId.</maml:para> <maml:para /> <maml:para /> <maml:para>Guid ---- 2fde1c38-c483-4464-a521-1e963ea1d166</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-MyCrmUserId</dev:code> <dev:remarks> <maml:para>This example returns login user's CRM UserId by ommiting -conn parameter. To omit conn parameter, you need creating $conn in advance, then cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Import-CrmSolution</command:name> <maml:description> <maml:para>Imports solution file to CRM Organization. NOTE: Under most circumstances you should use Import-CrmSolutionAsync instead of this cmdlet</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>CrmSolution</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Import-CrmSolution cmdlet lets you import solution file to CRM Organization and returns Job Id. You can use the Job Id to check import progress. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-CrmSolution</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SolutionFilePath</maml:name> <maml:description> <maml:para>A file path to solution zip file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ActivatePlugIns</maml:name> <maml:description> <maml:para>Specify the parameter to active plug-ins when importing solution.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>OverwriteUnManagedCustomizations</maml:name> <maml:description> <maml:para>Specify the parameter to overwrite conflicting unmanaged customizations when importing solution. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>SkipDependancyOnProductUpdateCheckOnInstall</maml:name> <maml:description> <maml:para>Specify the parameter to skip dependency check when importing solution. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>PublishChanges</maml:name> <maml:description> <maml:para>Specify the parameter to publish all customizations (applicable only for unmanaged solution) </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>MaxWaitTimeInSeconds</maml:name> <maml:description> <maml:para>Specify the parameter to override the default maximum 900 seconds (15 minutes) to wait for an imported solution to complete. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="7"> <maml:name>ImportAsHoldingSolution</maml:name> <maml:description> <maml:para>Import as a holding solution</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="8"> <maml:name>AsyncOperationImportMethod</maml:name> <maml:description> <maml:para>Attempt to import using an async & poll method</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SolutionFilePath</maml:name> <maml:description> <maml:para>A file path to solution zip file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ActivatePlugIns</maml:name> <maml:description> <maml:para>Specify the parameter to active plug-ins when importing solution.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>OverwriteUnManagedCustomizations</maml:name> <maml:description> <maml:para>Specify the parameter to overwrite conflicting unmanaged customizations when importing solution. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>SkipDependancyOnProductUpdateCheckOnInstall</maml:name> <maml:description> <maml:para>Specify the parameter to skip dependency check when importing solution. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>PublishChanges</maml:name> <maml:description> <maml:para>Specify the parameter to publish all customizations (applicable only for unmanaged solution) </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>MaxWaitTimeInSeconds</maml:name> <maml:description> <maml:para>Specify the parameter to override the default maximum 900 seconds (15 minutes) to wait for an imported solution to complete. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="7"> <maml:name>ImportAsHoldingSolution</maml:name> <maml:description> <maml:para>Import as a holding solution</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="8"> <maml:name>AsyncOperationImportMethod</maml:name> <maml:description> <maml:para>Attempt to import using an async & poll method</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Import-CrmSolution -conn $conn -SolutionFilePath "C:\SampleSolution_1_0_0_0.zip"</dev:code> <dev:remarks> <maml:para>This example imports solution and returns JobId. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Import-CrmSolution "C:\SampleSolution_1_0_0_0.zip" $True -AsyncOperationImportMethod</dev:code> <dev:remarks> <maml:para>This example imports solution by activating plug-ins and returns JobId by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it. Also, the Async Operation Import will be used instead of waiting for a response, which is preferred. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Import-CrmSolutionTranslation</command:name> <maml:description> <maml:para>Imports a translation to a solution. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>CrmSolutionTranslation</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Import-CrmSolutionTranslation cmdlet lets you export a translation to a solution. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-CrmSolutionTranslation</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TranslationFileName</maml:name> <maml:description> <maml:para>A file name and path of importing solution translation zip file. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>PublishChanges</maml:name> <maml:description> <maml:para>Specify the parameter to publish all customizations. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TranslationFileName</maml:name> <maml:description> <maml:para>A file name and path of importing solution translation zip file. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>PublishChanges</maml:name> <maml:description> <maml:para>Specify the parameter to publish all customizations. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Import-CrmSolutionTranslation -conn $conn -TranslationZipFileName "C:\temp\CrmTranslations_MySolution_1_0_0_0.zip" </dev:code> <dev:remarks> <maml:para>This example imports translation file "CrmTranslations_MySolution_1_0_0_0". </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Import-CrmSolutionTranslation -conn $conn -TranslationZipFileName "C:\temp\CrmTranslations_MySolution_1_0_0_0.zip" </dev:code> <dev:remarks> <maml:para>This example imports translation file "CrmTranslations_MySolution_1_0_0_0" by omitting $conn parameter. When omitting $conn parameter, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Import-CrmSolutionTranslation -conn $conn -TranslationZipFileName "C:\temp\CrmTranslations_MySolution_1_0_0_0.zip" -PublishChanges </dev:code> <dev:remarks> <maml:para>This example imports translation file "CrmTranslations_MySolution_1_0_0_0" and publish all customizations. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Invoke-CrmRecordWorkflow</command:name> <maml:description> <maml:para>Runs an on-demand workflow for a record.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>CrmRecordWorkflow</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Invoke-CrmRecordWorkflow cmdlet lets you run an on-demand workflow for a record. </maml:para> <maml:para>There are two ways to specify records. 1. Pass record's Id. 2. Get a record object by using Get-CrmRecord/Get-CrmRecords cmdlets, and pass it.</maml:para> <maml:para>You can specify on-demand workflow by using its name.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-CrmRecordWorkflow</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>A record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WorkflowName</maml:name> <maml:description> <maml:para>An on-demand workflow name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-CrmRecordWorkflow</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>A record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WorkflowId</maml:name> <maml:description> <maml:para>The GUID for any given workflow you want to execute</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-CrmRecordWorkflow</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EntityId</maml:name> <maml:description> <maml:para>An Id (guid) of the record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WorkflowName</maml:name> <maml:description> <maml:para>An on-demand workflow name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-CrmRecordWorkflow</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EntityId</maml:name> <maml:description> <maml:para>An Id (guid) of the record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WorkflowId</maml:name> <maml:description> <maml:para>The GUID for any given workflow you want to execute</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>A record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WorkflowName</maml:name> <maml:description> <maml:para>An on-demand workflow name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WorkflowId</maml:name> <maml:description> <maml:para>The GUID for any given workflow you want to execute</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EntityId</maml:name> <maml:description> <maml:para>An Id (guid) of the record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Invoke-CrmRecordWorkflow -conn $conn -EntityId faff5970-6317-e511-80da-c4346bc43d94 -WorkflowName "Sample Workflow for Account"</dev:code> <dev:remarks> <maml:para>This example runs an on-demand workflow named "Sample Workflow for Account" for an account.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Invoke-CrmRecordWorkflow faff5970-6317-e511-80da-c4346bc43d94 "Sample Workflow for Account"</dev:code> <dev:remarks> <maml:para>This example runs an on-demand workflow named "Sample Workflow for Account" for an account by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>$account = Get-CrmRecord account 00005a70-6317-e511-80da-c4346bc43d94 name PS C:\>Invoke-CrmRecordWorkflow -CrmRecords $account -WorkflowName "Sample Workflow for Account"</dev:code> <dev:remarks> <maml:para>This example runs an on-demand workflow named "Sample Workflow for Account" for an account by omitting parameter names.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Invoke-CrmWhoAmI</command:name> <maml:description> <maml:para>Executes WhoAmI Organization Request and returns current user's Id (guid), belonging BusinessUnit Id (guid) and CRM Organization Id (guid). </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>CrmWhoAmI</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Invoke-CrmWhoAmI cmdlet lets you execute WhoAmI request and obtain UserId, BusinessUnitId and OrganizationId. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-CrmWhoAmI</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Invoke-CrmWhoAmI -conn $conn </dev:code> <dev:remarks> <maml:para>This example executes WhoAmI organization request and returns current user's Id (guid), belonging BusinessUnit Id (guid) and CRM Organization Id (guid). </maml:para> <maml:para /> <maml:para /> <maml:para>UserId : 420a942a-7786-4843-9a8b-f8265d9f80ac BusinessUnitId : 69e48894-f7d6-e511-80d3-c4346bb5987c OrganizationId : 73354da0-d5a9-4221-bd11-64f988f234a6 ResponseName : WhoAmI Results : {[UserId, 420a942a-7786-4843-9a8b-f8265d9f80ac], [BusinessUnitId, 69e48894-f7d6-e511-80d3-c4346bb5987c], [OrganizationId, 73354da0-d5a9-4221-bd11-64f988f234a6]} ExtensionData : System.Runtime.Serialization.ExtensionDataObject</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Invoke-CrmWhoAmI </dev:code> <dev:remarks> <maml:para>This example executes WhoAmI by omitting parameters names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>UserId : 420a942a-7786-4843-9a8b-f8265d9f80ac BusinessUnitId : 69e48894-f7d6-e511-80d3-c4346bb5987c OrganizationId : 73354da0-d5a9-4221-bd11-64f988f234a6 ResponseName : WhoAmI Results : {[UserId, 420a942a-7786-4843-9a8b-f8265d9f80ac], [BusinessUnitId, 69e48894-f7d6-e511-80d3-c4346bb5987c], [OrganizationId, 73354da0-d5a9-4221-bd11-64f988f234a6]} ExtensionData : System.Runtime.Serialization.ExtensionDataObject </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Move-CrmRecordToQueue</command:name> <maml:description> <maml:para>Move a CRM record to a Queue</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Move</command:verb> <command:noun>CrmRecordToQueue</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Move-CrmRecordToQueue cmdlet lets you move a record to a queue. </maml:para> <maml:para>There are two ways to specify a record. 1. Pass EntityLogicalName and record's Id. 2. Get a record object by using Get-CrmRecord/Get-CrmRecords cmdlets, then pass it.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Move-CrmRecordToQueue</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>A record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>QueueName</maml:name> <maml:description> <maml:para>Queue's Name to move the record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>WorkingUserId</maml:name> <maml:description> <maml:para>An Id (guid) of SystemUser who works on the queue item.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>SetWorkingByUser</maml:name> <maml:description> <maml:para>Specify if the record needs to be marked as WorkingByUser.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Move-CrmRecordToQueue</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for an Entity to move. i.e.)accout, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id</maml:name> <maml:description> <maml:para>An Id (guid) of the record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>QueueName</maml:name> <maml:description> <maml:para>Queue's Name to move the record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>WorkingUserId</maml:name> <maml:description> <maml:para>An Id (guid) of SystemUser who works on the queue item.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>SetWorkingByUser</maml:name> <maml:description> <maml:para>Specify if the record needs to be marked as WorkingByUser.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>A record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>QueueName</maml:name> <maml:description> <maml:para>Queue's Name to move the record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>WorkingUserId</maml:name> <maml:description> <maml:para>An Id (guid) of SystemUser who works on the queue item.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>SetWorkingByUser</maml:name> <maml:description> <maml:para>Specify if the record needs to be marked as WorkingByUser.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for an Entity to move. i.e.)accout, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id</maml:name> <maml:description> <maml:para>An Id (guid) of the record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Move-CrmRecordToQueue -conn $conn -EntityLogicalName incident -Id 1e005a70-6317-e511-80da-c4346bc43d94 -QueueName "Support Queue" -WorkingUserId f9d40920-7a43-4f51-9749-0549c4caf67d</dev:code> <dev:remarks> <maml:para>This example moves an incident (Case) record to "Support Queue" queue and assigned it to a User as WorkingUser.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Move-CrmRecordToQueue incident 1e005a70-6317-e511-80da-c4346bc43d94 "Support Queue" f9d40920-7a43-4f51-9749-0549c4caf67d $True</dev:code> <dev:remarks> <maml:para>This example moves an incident (Case) record to "Support Queue" queue and assigned it to a User as WorkingUser and mark it as User Working When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>$incident = Get-CrmRecord incident 20005a70-6317-e511-80da-c4346bc43d94 title PS C:\>Move-CrmRecordToQueue $incident "Support Queue" f9d40920-7a43-4f51-9749-0549c4caf67d $True</dev:code> <dev:remarks> <maml:para>This example retrieves and store an incident record, then pass it to Move-CrmRecordToQueue.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-CrmEntityReference</command:name> <maml:description> <maml:para>Instantiates EntityReference type object.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>CrmEntityReference</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-CrmEntityReference cmdlet lets you instantiates EntityReference type object. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-CrmEntityReference</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for an Entity to update. i.e.)account, contact, lead, etc.. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Id</maml:name> <maml:description> <maml:para>An Id (guid) of the record </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for an Entity to update. i.e.)account, contact, lead, etc.. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Id</maml:name> <maml:description> <maml:para>An Id (guid) of the record </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>New-CrmEntityReference -EntityLogicalName account -Id 1df8d93d-1f18-e511-80da-c4346bc43d94</dev:code> <dev:remarks> <maml:para>This example instantiates CrmEntityReference object for an account record.</maml:para> <maml:para /> <maml:para /> <maml:para>Id : 1df8d93d-1f18-e511-80da-c4346bc43d94 LogicalName : account Name : KeyAttributes : {} RowVersion : ExtensionData :</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>New-CrmEntityReference account 1df8d93d-1f18-e511-80da-c4346bc43d94</dev:code> <dev:remarks> <maml:para>This example instantiates CrmEntityReference object for an account record by omitting parameter names.</maml:para> <maml:para /> <maml:para /> <maml:para>Id : 1df8d93d-1f18-e511-80da-c4346bc43d94 LogicalName : account Name : KeyAttributes : {} RowVersion : ExtensionData :</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-CrmMoney</command:name> <maml:description> <maml:para>Instantiates Money type object. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>CrmMoney</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-CrmMoney cmdlet lets you instantiates Money type object. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-CrmMoney</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Value</maml:name> <maml:description> <maml:para>Money Value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Value</maml:name> <maml:description> <maml:para>Money Value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>New-CrmMoney -Value 1000.01</dev:code> <dev:remarks> <maml:para>This example instantiates Money object with Value of 1,000.01 in whatever currency is applicable given the record configuration &/or CRM Settings. </maml:para> <maml:para /> <maml:para /> <maml:para>Value ExtensionData ----- ------------- 1000</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-CrmOptionSetValue</command:name> <maml:description> <maml:para> Instantiates OptionSetValue type object. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>CrmOptionSetValue</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> The New-CrmOptionSetValue cmdlet lets you instantiates OptionSetValue type object. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-CrmOptionSetValue</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Value</maml:name> <maml:description> <maml:para> OptionSetValue Value. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Value</maml:name> <maml:description> <maml:para> OptionSetValue Value. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>New-CrmOptionSetValue -Value 20</dev:code> <dev:remarks> <maml:para>This example instantiates OptionSetValue object with Value of 20.</maml:para> <maml:para /> <maml:para /> <maml:para>Value ExtensionData ----- ------------- 20 </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-CrmRecord</command:name> <maml:description> <maml:para>Creates a new CRM record by specifying field name/value set, and returns record guid.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>CrmRecord</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-CrmRecord cmdlet lets you create a record to your CRM organization. </maml:para> <maml:para>Use @{"field logical name"="value"} syntax to create Fields, and make sure you specify correct type of value for the field. </maml:para> <maml:para>You can use Get-CrmEntityAttributeMetadata cmdlet and check AttributeType to see the field type. In addition, for CRM specific types, you can use New-CrmMoney, New-CrmOptionSetValue or New-CrmEntityReference cmdlets.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-CrmRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for an Entity to create. i.e.) account, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Fields</maml:name> <maml:description> <maml:para>A List of field name/value pair. Use @{"field logical name"="value"} syntax to create Fields, and make sure you specify correct type of value for the field. You can use Get-CrmEntityAttributeMetadata cmdlet and check AttributeType to see the field type. In addition, for CRM specific types, you can use New-CrmMoney, New-CrmOptionSetValue or New-CrmEntityReference cmdlets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-CrmRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>A record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Fields</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>PreserveCrmRecordId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for an Entity to create. i.e.) account, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Fields</maml:name> <maml:description> <maml:para>A List of field name/value pair. Use @{"field logical name"="value"} syntax to create Fields, and make sure you specify correct type of value for the field. You can use Get-CrmEntityAttributeMetadata cmdlet and check AttributeType to see the field type. In addition, for CRM specific types, you can use New-CrmMoney, New-CrmOptionSetValue or New-CrmEntityReference cmdlets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>A record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Fields</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>PreserveCrmRecordId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>New-CrmRecord -conn $conn -EntityLogicalName account -Fields @{"name"="account name";"telephone1"="555-5555"}</dev:code> <dev:remarks> <maml:para>This example creates an account record and set value for account and telephone1 fields.</maml:para> <maml:para /> <maml:para /> <maml:para>Guid ---- 57bd1c45-2b17-e511-80dc-c4346bc4fc6c </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>New-CrmRecord account @{"name"="account name";"industrycode"=New-CrmOptionSetValue -Value 1}</dev:code> <dev:remarks> <maml:para>This example creates an account record by specifying OptionSetValue to IndustryCode field by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>Guid ---- 57bd1c45-2b17-e511-80dc-c4346bc4fc6c </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>New-CrmRecord account @{"name"="account name";"overriddencreatedon"=[datetime]"2000-01-01"}</dev:code> <dev:remarks> <maml:para>This example creates an account record by specifying past date for CreatedOn. You can create DateTime object by casting like this Example or use Get-Date cmdlets. </maml:para> <maml:para /> <maml:para /> <maml:para>Guid ---- 57bd1c45-2b17-e511-80dc-c4346bc4fc6c</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>$parentId = New-CrmRecord account @{"name"="parent account name"} PS C:\>$parentReference = New-CrmEntityReference -EntityLogicalName account -Id $parentId PS C:\>$childId = New-CrmRecord account @{"name"="child account name";"parentaccountid"=$parentReference}</dev:code> <dev:remarks> <maml:para>This example creates an account record, then assign the created account as Parent Account field to second account record.</maml:para> <maml:para /> <maml:para /> <maml:para>Guid ---- 59bd1c45-2b17-e511-80dc-c4346bc4fc6c</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>$account = Get-CrmRecord -conn $conn -EntityLogicalName account -Id $accountid -Fields * PS C:\>New-CrmRecord -conn $conn -CrmRecord $account</dev:code> <dev:remarks> <maml:para>This example get record by Get-CrmRecord, then pass it to New-CrmRecord to create another record.</maml:para> <maml:para /> <maml:para /> <maml:para>Guid ---- d6960250-d178-e711-80ff-c4346bdc42d1</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Publish-CrmAllCustomization</command:name> <maml:description> <maml:para>Publishes all customizations for a CRM Organization. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Publish</command:verb> <command:noun>CrmAllCustomization</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Publish-CrmAllCustomization cmdlet lets you publish all customizations. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Publish-CrmAllCustomization</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Publish-CrmAllCustomization -conn $conn </dev:code> <dev:remarks> <maml:para>This example publishes all customizations. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Publish-CrmAllCustomization </dev:code> <dev:remarks> <maml:para>This example publishes all customizations by omitting parameters names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Publish-CrmEntity</command:name> <maml:description> <maml:para>Publishes customization for an Entity. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Publish</command:verb> <command:noun>CrmEntity</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Publish-CrmEntity cmdlet lets you publish customization for an Entity. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Publish-CrmEntity</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for Entity. i.e.)account, contact, lead, etc.. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for Entity. i.e.)account, contact, lead, etc.. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Publish-CrmEntity -conn $conn -EntityLogicalName account</dev:code> <dev:remarks> <maml:para>This example publishes customization for Account Entity.</maml:para> <maml:para /> <maml:para /> <maml:para>True</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Publish-CrmEntity lead</dev:code> <dev:remarks> <maml:para>This example publishes customization for Lead Entity by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>True</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-CrmEntityMetadataCache</command:name> <maml:description> <maml:para>Removes metadata cache for an Entity. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>CrmEntityMetadataCache</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-CrmEntityMetadataCache cmdlet lets you remove metadata cache for an Entity. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-CrmEntityMetadataCache</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for Entity. i.e.)account, contact, lead, etc.. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for Entity. i.e.)account, contact, lead, etc.. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-CrmEntityMetadataCache -conn $conn -EntityLogicalName account </dev:code> <dev:remarks> <maml:para>This example removes metadata cache for Account Entity. </maml:para> <maml:para /> <maml:para /> <maml:para>True </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-CrmEntityMetadataCache lead </dev:code> <dev:remarks> <maml:para>This example removes metadata cache for Lead Entity by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>True </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-CrmRecord</command:name> <maml:description> <maml:para>Delete a CRM record by specifying EntityLogicalName and record's Id (guid)</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>CrmRecord</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-CrmRecord cmdlet lets you delete a record of your CRM organization. </maml:para> <maml:para>There are two ways to delete a record. 1. Pass EntityLogicalName and record's Id. 2. Get a record object by using Get-CrmRecord/Get-CrmRecords cmdlets, then pass it.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-CrmRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>A record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-CrmRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for an Entity to delete. i.e.)accout, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id</maml:name> <maml:description> <maml:para>An Id (guid) of the record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>A record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for an Entity to delete. i.e.)accout, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id</maml:name> <maml:description> <maml:para>An Id (guid) of the record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-CrmRecord -conn $conn -EntityLogicalName account -Id 52a17637-5617-e511-80dc-c4346bc4fc6c</dev:code> <dev:remarks> <maml:para>This example deletes an account record by using Id</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>$account = Get-CrmRecord account b202caab-6c16-e511-80d6-c4346bc43dc0 name PS C:\>$account accountid_Property : [accountid, b202caab-6c16-e511-80d6-c4346bc43dc0] accountid : b202caab-6c16-e511-80d6-c4346bc43dc0 original : {[name_Property, [name, Adventure Works (sample)]], [name, Adventure Works (sample)], [accountid_Property, [accountid, b202caab-6c16-e511-80d6-c4346bc43dc0]], [accountid, b202caab-6c16-e511-80d6-c4346bc43dc0]} logicalname : account PS C:\>Remove-CrmRecord $account PS C:\>Get-CrmRecord account b202caab-6c16-e511-80d6-c4346bc43dc0 name WARNING: Record Id: b202caab-6c16-e511-80d6-c4346bc43dc0Does Not Exist</dev:code> <dev:remarks> <maml:para>This example retrieves and store an account record to $account object, then pass it to Remove-CrmRecord cmdlet. Finally retrieves it again to confirm it is deleted. When ommiting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code></dev:code> <dev:remarks> <maml:para>This example retrieves and stores account records by using FetchXML and pipe results (CrmRecords). In the next pipe, it updates each record using Remove-CrmRecord. Finally retrieves them again to confirm all records are deleted.</maml:para> <maml:para /> <maml:para /> <maml:para>PS C:\>$fetch = @" <fetch version="1.0" output-format="xml-platform" mapping="logical" distinct="false" no-lock="true"> <entity name="account"> <attribute name="name" /> </entity> </fetch> "@ PS C:\>(Get-CrmRecordsByFetch $fetch).CrmRecords | % { Remove-CrmRecord $conn -CrmRecord $_} PS C:\>Get-CrmRecordsByFetch $fetch WARNING: No Result</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-CrmRecordAssociation</command:name> <maml:description> <maml:para>Associates two records for N:N relationship.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>CrmRecordAssociation</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-CrmRecordAssociation cmdlet lets you disassociate two records for N:N relationship by specifying relationship logical name. </maml:para> <maml:para>There are two ways to specify records. 1. Pass EntityLogicalName and record's Id for both records. 2. Get a record object by using Get-CrmRecord/Get-CrmRecords cmdlets, and pass it for both records.</maml:para> <maml:para>You can specify relationship logical name for the disassociation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-CrmRecordAssociation</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CrmRecord1</maml:name> <maml:description> <maml:para>A first record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>CrmRecord2</maml:name> <maml:description> <maml:para>A second record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>RelationshipName</maml:name> <maml:description> <maml:para>A N:N relationship logical name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-CrmRecordAssociation</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName1</maml:name> <maml:description> <maml:para>A logicalname for first Entity. i.e.)account, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id1</maml:name> <maml:description> <maml:para>An Id (guid) of first record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>EntityLogicalName2</maml:name> <maml:description> <maml:para>A logicalname for second Entity. i.e.)account, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Id2</maml:name> <maml:description> <maml:para>An Id (guid) of second record </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>RelationshipName</maml:name> <maml:description> <maml:para>A N:N relationship logical name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CrmRecord1</maml:name> <maml:description> <maml:para>A first record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>CrmRecord2</maml:name> <maml:description> <maml:para>A second record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>RelationshipName</maml:name> <maml:description> <maml:para>A N:N relationship logical name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName1</maml:name> <maml:description> <maml:para>A logicalname for first Entity. i.e.)account, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id1</maml:name> <maml:description> <maml:para>An Id (guid) of first record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>EntityLogicalName2</maml:name> <maml:description> <maml:para>A logicalname for second Entity. i.e.)account, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Id2</maml:name> <maml:description> <maml:para>An Id (guid) of second record </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-CrmRecordAssociation -conn $conn -EntityLogicalName1 account -Id1 00005a70-6317-e511-80da-c4346bc43d94 -EntityLogicalName2 contact -Id2 66005a70-6317-e511-80da-c4346bc43d94 -RelationshipName new_accounts_contacts</dev:code> <dev:remarks> <maml:para>This example associates an account and a contact records through new_accounts_contacts custom N:N relationship.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-CrmRecordAssociation account 00005a70-6317-e511-80da-c4346bc43d94 contact 66005a70-6317-e511-80da-c4346bc43d94 new_accounts_contacts</dev:code> <dev:remarks> <maml:para>This example associates an account and a contact records through new_accounts_contacts custom N:N relationship by omitting parameters names.</maml:para> <maml:para>When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>$account = Get-CrmRecord account 00005a70-6317-e511-80da-c4346bc43d94 name PS C:\>$contact = Get-CrmRecord contact 66005a70-6317-e511-80da-c4346bc43d94 fullname PS C:\>Remove-CrmRecordAssociation -conn $conn -CrmRecord1 $account -CrmRecord2 $contact -RelationshipName new_accounts_contacts</dev:code> <dev:remarks> <maml:para>This example retrieves and stores an account and a contact records to variables, then pass them to Remove-CrmRecordAssociation cmdlets.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>$account = Get-CrmRecord account 00005a70-6317-e511-80da-c4346bc43d94 name PS C:\>$contact = Get-CrmRecord contact 66005a70-6317-e511-80da-c4346bc43d94 fullname PS C:\>Remove-CrmRecordAssociation $account $contact new_accounts_contacts</dev:code> <dev:remarks> <maml:para>This example retrieves and stores an account and a contact records to variables, then pass them to Remove-CrmRecordAssociation cmdlets.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-CrmSampleData</command:name> <maml:description> <maml:para>Removes sample data CRM Organization. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>CrmSampleData</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-CrmSampleData cmdlet lets you remove sample data to CRM Organization and returns Job Id. You can confirm the status by using Test-CrmSampleDataInstalled cmdlet. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-CrmSampleData</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-CrmSampleData -conn $conn</dev:code> <dev:remarks> <maml:para>This example removes sample data. </maml:para> <maml:para /> <maml:para /> <maml:para>Guid ---- 9f7ff9ec-d2b5-4599-9909-04a072e0a546 </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Add-CrmSampleData </dev:code> <dev:remarks> <maml:para>This example removes sample data by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>Guid ---- 9f7ff9ec-d2b5-4599-9909-04a072e0a546 </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-CrmSecurityRoleFromTeam</command:name> <maml:description> <maml:para>Removes a security role from a team. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>CrmSecurityRoleFromTeam</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-CrmSecurityRoleToUser cmdlet lets you remove a security role from a team. </maml:para> <maml:para>There are two ways to specify records. 1. Pass record's Id for both records. 2. Get a record object by using Get-CrmRecord/Get-CrmRecords cmdlets, and pass it for both records. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-CrmSecurityRoleFromTeam</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TeamRecord</maml:name> <maml:description> <maml:para>A team record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use UserId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SecurityRoleRecord</maml:name> <maml:description> <maml:para>A security role record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use SecurityRoleId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-CrmSecurityRoleFromTeam</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>An Id (guid) of team record </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SecurityRoleId</maml:name> <maml:description> <maml:para>An Id (guid) of security role record </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TeamRecord</maml:name> <maml:description> <maml:para>A team record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use UserId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SecurityRoleRecord</maml:name> <maml:description> <maml:para>A security role record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use SecurityRoleId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>An Id (guid) of team record </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SecurityRoleId</maml:name> <maml:description> <maml:para>An Id (guid) of security role record </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-CrmSecurityRoleFromTeam -conn $conn -TeamId 00005a70-6317-e511-80da-c4346bc43d94 -SecurityRoleId 66005a70-6317-e511-80da-c4346bc43d94 </dev:code> <dev:remarks> <maml:para>This example removes a security role to a team by using Id. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-CrmSecurityRoleFromTeam 00005a70-6317-e511-80da-c4346bc43d94 66005a70-6317-e511-80da-c4346bc43d94 </dev:code> <dev:remarks> <maml:para>This example removes a security role to a team by using Id by omitting parameters names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>$team = Get-CrmRecord team 00005a70-6317-e511-80da-c4346bc43d94 name PS C:\>$role = Get-CrmRecord role 66005a70-6317-e511-80da-c4346bc43d94 name PS C:\>Remove-CrmSecurityRoleFromTeam $team $role</dev:code> <dev:remarks> <maml:para>This example removes a security role to a team by using record objects. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-CrmSecurityRoleFromUser</command:name> <maml:description> <maml:para>Removes a security role to a user. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>CrmSecurityRoleFromUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-CrmSecurityRoleFromUser cmdlet lets you remove a security role to a user. </maml:para> <maml:para>There are two ways to specify records. 1. Pass record's Id for both records. 2. Get a record object by using Get-CrmRecord/Get-CrmRecords cmdlets, and pass it for both records. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-CrmSecurityRoleFromUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserRecord</maml:name> <maml:description> <maml:para>A user record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use UserId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SecurityRoleName</maml:name> <maml:description> <maml:para>Security Role Name, case insensitive but must include spaces. Parameter value should be wrapped in quotes to include spaces.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-CrmSecurityRoleFromUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserRecord</maml:name> <maml:description> <maml:para>A user record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use UserId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SecurityRoleRecord</maml:name> <maml:description> <maml:para>A security role record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use SecurityRoleId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-CrmSecurityRoleFromUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>An Id (guid) of user record </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SecurityRoleName</maml:name> <maml:description> <maml:para>Security Role Name, case insensitive but must include spaces. Parameter value should be wrapped in quotes to include spaces.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-CrmSecurityRoleFromUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>An Id (guid) of user record </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SecurityRoleId</maml:name> <maml:description> <maml:para>An Id (guid) of security role record </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserRecord</maml:name> <maml:description> <maml:para>A user record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use UserId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SecurityRoleRecord</maml:name> <maml:description> <maml:para>A security role record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use SecurityRoleId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>An Id (guid) of user record </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SecurityRoleId</maml:name> <maml:description> <maml:para>An Id (guid) of security role record </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>SecurityRoleName</maml:name> <maml:description> <maml:para>Security Role Name, case insensitive but must include spaces. Parameter value should be wrapped in quotes to include spaces.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-CrmSecurityRoleFromUser -conn $conn -UserId 00005a70-6317-e511-80da-c4346bc43d94 -SecurityRoleId 66005a70-6317-e511-80da-c4346bc43d94 </dev:code> <dev:remarks> <maml:para>This example removes a security role to a user by using Id. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-CrmSecurityRoleFromUser 00005a70-6317-e511-80da-c4346bc43d94 66005a70-6317-e511-80da-c4346bc43d94 </dev:code> <dev:remarks> <maml:para>This example removes a security role to a user by using Id by omitting parameters names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>$user = Get-CrmRecord sysetmuser 00005a70-6317-e511-80da-c4346bc43d94 fullname PS C:\>$role = Get-CrmRecord role 66005a70-6317-e511-80da-c4346bc43d94 name PS C:\>Remove-CrmSecurityRoleFromUser $user $role </dev:code> <dev:remarks> <maml:para>This example removes a security role to a user by using record objects. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-CrmUserManager</command:name> <maml:description> <maml:para>Removes CRM user's manager. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>CrmUserManager</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-CrmUserManager lets you remove CRM user's manager. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-CrmUserManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>An Id (guid) of CRM User. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>An Id (guid) of CRM User. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-CrmUserManager -conn $conn -UserId 3772fe6e-8a18-e511-80dc-c4346bc42d48 </dev:code> <dev:remarks> <maml:para>This example removes a manager from a CRM user. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-CrmUserManager 3772fe6e-8a18-e511-80dc-c4346bc42d48 </dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-CrmActivityRecordToCloseState</command:name> <maml:description> <maml:para>Close an activity record.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>CrmActivityRecordToCloseState</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-CrmActivityRecordToCloseState cmdlet lets you close an activity record. </maml:para> <maml:para>There are two ways to specify a record. 1. Pass ActivityEntityType and record's Id. 2. Get a record object by using Get-CrmRecord/Get-CrmRecords cmdlets, then pass it.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-CrmActivityRecordToCloseState</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>A record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use ActivityEntityType/ActivityId</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>StateCode</maml:name> <maml:description> <maml:para>A State code name. You can use (Get-CrmEntityOptionSet <EntityLogicalName> statecode).Items to get StateCode strings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>StatusCode</maml:name> <maml:description> <maml:para>A Status code name. You can use (Get-CrmEntityOptionSet <EntityLogicalName> statuscode).Items to get StateCode strings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-CrmActivityRecordToCloseState</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ActivityEntityType</maml:name> <maml:description> <maml:para>A logicalname for an Activity Entity to close. i.e.)phonecall, email, task, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ActivityId</maml:name> <maml:description> <maml:para>An Id (guid) of the activity record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>StateCode</maml:name> <maml:description> <maml:para>A State code name. You can use (Get-CrmEntityOptionSet <EntityLogicalName> statecode).Items to get StateCode strings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>StatusCode</maml:name> <maml:description> <maml:para>A Status code name. You can use (Get-CrmEntityOptionSet <EntityLogicalName> statuscode).Items to get StateCode strings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>A record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use ActivityEntityType/ActivityId</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>StateCode</maml:name> <maml:description> <maml:para>A State code name. You can use (Get-CrmEntityOptionSet <EntityLogicalName> statecode).Items to get StateCode strings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>StatusCode</maml:name> <maml:description> <maml:para>A Status code name. You can use (Get-CrmEntityOptionSet <EntityLogicalName> statuscode).Items to get StateCode strings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ActivityEntityType</maml:name> <maml:description> <maml:para>A logicalname for an Activity Entity to close. i.e.)phonecall, email, task, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ActivityId</maml:name> <maml:description> <maml:para>An Id (guid) of the activity record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmActivityRecordToCloseState -conn $conn -ActivityEntityType task -ActivityId a0025a70-6317-e511-80da-c4346bc43d94 -StateCode Completed -StatusCode Completed</dev:code> <dev:remarks> <maml:para>This example closes a task record as Completed/Completed.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmActivityRecordToCloseState task a0025a70-6317-e511-80da-c4346bc43d94 Open "In Progress"</dev:code> <dev:remarks> <maml:para>This example closes a task record as InProgress/Open. When ommiting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>$task = Get-CrmRecord task a0025a70-6317-e511-80da-c4346bc43d94 subject PS C:\>Set-CrmActivityRecordToCloseState $task Open "Not Started"</dev:code> <dev:remarks> <maml:para>This example retrieves and store a task record, then pass it to Set-CrmActivityRecordToCloseState</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-CrmConnectionCallerId</command:name> <maml:description> <maml:para>Sets CRM Connection CallerId to impersonate. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>CrmConnectionCallerId</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-CrmConnectionCallerId lets you set CRM Connection CallerId to impersonate. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-CrmConnectionCallerId</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CallerId</maml:name> <maml:description> <maml:para>A guid of the User to impersonate. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CallerId</maml:name> <maml:description> <maml:para>A guid of the User to impersonate. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmConnectionCallerId -conn $conn -CallerId 2eded89d-be89-e511-80f0-c4346bc4ef0c </dev:code> <dev:remarks> <maml:para>This example sets CRM Connection CallerId to 2eded89d-be89-e511-80f0-c4346bc4ef0c. NOTE THIS WILL CONTINUE TO IMPERSONATE THE USER UNTIL YOU SET IT BACK TO YOUR OWN USERID. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-CrmConnectionTimeout</command:name> <maml:description> <maml:para>Sets CRM Connection timeout value in seconds. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>CrmConnectionTimeout</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-CrmConnectionTimeout lets you set CRM Connection timeout value in seconds. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-CrmConnectionTimeout</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TimeoutInSeconds</maml:name> <maml:description> <maml:para>Timeout value for CRM connection. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SetDefault</maml:name> <maml:description> <maml:para>Specyfing SetDefault will set default value to the connection. (120 seconds) </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>TimeoutInSeconds</maml:name> <maml:description> <maml:para>Timeout value for CRM connection. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SetDefault</maml:name> <maml:description> <maml:para>Specyfing SetDefault will set default value to the connection. (120 seconds) </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmConnectionTimeout -conn $conn -TimeoutInSeconds 1000 </dev:code> <dev:remarks> <maml:para>This example sets CRM Connection timeout to 1000 seconds. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmConnectionTimeout -conn $conn -SetDefault </dev:code> <dev:remarks> <maml:para>This example sets CRM Connection timeout to default. (120 seconds) </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-CrmRecord</command:name> <maml:description> <maml:para>Updates a new CRM record by specifying EntityLogicalName, record's Id (guid) and field name/value sets.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>CrmRecord</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-CrmRecord cmdlet lets you update a record of your CRM organization. </maml:para> <maml:para>There are two ways to update a record. 1. Pass EntityLogicalName and record's Id and field name/value set. Use @{"field logical name"="value"} syntax to update Fields, and make sure you specify correct type of value for the field. You can use Get-CrmEntityAttributeMetadata cmdlet and check AttributeType to see the field type. In addition, for CRM specific types, you can use New-CrmMoney, New-CrmOptionSetValue or New-CrmEntityReference cmdlets.</maml:para> <maml:para>2. Get a record object by using Get-CrmRecord/Get-CrmRecords cmdlets, then assign new value for fields. if a field you want to assign value is not available, you need to use first method to update the field.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-CrmRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organizatoin. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>A record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Upsert</maml:name> <maml:description> <maml:para>Spcify Upsert when you want to create a record if it does not exist in the system yet. It tries to retrieve a record by using Id first, and if exists, update otherwise create.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PrimaryKeyField</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-CrmRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organizatoin. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for an Entity to update. i.e.)accout, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id</maml:name> <maml:description> <maml:para>An Id (guid) of the record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Fields</maml:name> <maml:description> <maml:para>A List of field name/value pair. Use @{"field logical name"="value"} syntax to create Fields, and make sure you specify correct type of value for the field. You can use Get-CrmEntityAttributeMetadata cmdlet and check AttributeType to see the field type. In addition, for CRM specific types, you can use New-CrmMoney, New-CrmOptionSetValue or New-CrmEntityReference cmdlets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Upsert</maml:name> <maml:description> <maml:para>Spcify Upsert when you want to create a record if it does not exist in the system yet. It tries to retrieve a record by using Id first, and if exists, update otherwise create.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PrimaryKeyField</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organizatoin. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>A record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for an Entity to update. i.e.)accout, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id</maml:name> <maml:description> <maml:para>An Id (guid) of the record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Fields</maml:name> <maml:description> <maml:para>A List of field name/value pair. Use @{"field logical name"="value"} syntax to create Fields, and make sure you specify correct type of value for the field. You can use Get-CrmEntityAttributeMetadata cmdlet and check AttributeType to see the field type. In addition, for CRM specific types, you can use New-CrmMoney, New-CrmOptionSetValue or New-CrmEntityReference cmdlets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Upsert</maml:name> <maml:description> <maml:para>Spcify Upsert when you want to create a record if it does not exist in the system yet. It tries to retrieve a record by using Id first, and if exists, update otherwise create.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PrimaryKeyField</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmRecord -conn $conn -EntityLogicalName account -Id 52a17637-5617-e511-80dc-c4346bc4fc6c -Fields @{"name"="updated name";"telephone1"="555-5555"}</dev:code> <dev:remarks> <maml:para>This example updates an account record by using Id and new value for name/telephone1 fields. Though any of field value is same as current record, it still tries to update the field.</maml:para> <maml:para /> <maml:para /> <maml:para>name_Property : [name, updated name] name : updatedname accountid_Property : [accountid, 52a17637-5617-e511-80dc-c4346bc4fc6c] accountid : 52a17637-5617-e511-80dc-c4346bc4fc6c original : {[name_Property, [name, updated name]], [name, updatedname], [accountid_Property, [accountid, 52a17637-5617-e511-80dc-c4346bc4fc6c]], [accountid, 52a17637-5617-e511-80dc-c4346bc4fc6c]} logicalname : account</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>$fetch = @" <fetch version="1.0" output-format="xml-platform" mapping="logical" distinct="false" no-lock="true"> <entity name="account"> <attribute name="name" /> </entity> </fetch> "@ PS C:\>(Get-CrmRecordsByFetch $fetch).CrmRecords | % { $_.name = $_.name + " updated!"; Set-CrmRecord -CrmRecord $_} </dev:code> <dev:remarks> <maml:para>This example retrieves and stores account records by using FetchXML and pipe results (CrmRecords). In the next pipe, it does foreach operation (%) and assign new value for name. Then it updates each record using Set-CrmRecord.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmRecord account 52a17637-5617-e511-80dc-c4346bc4fc6c @{"industrycode"=New-CrmOptionSetValue -Value 1}</dev:code> <dev:remarks> <maml:para>This example updates an account record by using Id and IndustryCode filed by specifying OptionSetValue. When ommiting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>$account = Get-CrmRecord account b202caab-6c16-e511-80d6-c4346bc43dc0 name PS C:\>$account PS C:\>$account.name = $account.name + " updated!" PS C:\>Set-CrmRecord $account PS C:\>Get-CrmRecord account b202caab-6c16-e511-80d6-c4346bc43dc0 name </dev:code> <dev:remarks> <maml:para>This example retrieves and store an account record to $account object, then assign new value for name field. Then update it by using Set-CrmRecord cmdlet. Finally retrieves it again to display the result. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>PS C:\>$account = Get-CrmRecord account b202caab-6c16-e511-80d6-c4346bc43dc0 name PS C:\>$account name_Property : [name, Adventure Works (sample)] name : Adventure Works (sample) accountid_Property : [accountid, b202caab-6c16-e511-80d6-c4346bc43dc0] accountid : b202caab-6c16-e511-80d6-c4346bc43dc0 original : {[name_Property, [name, Adventure Works (sample)]], [name, Adventure Works (sample)], [accountid_Property, [accountid, b202caab-6c16-e511-80d6-c4346bc43dc0]], [accountid, b202caab-6c16-e511-80d6-c4346bc43dc0]} logicalname : account PS C:\>$account.name = $account.name + " updated!" PS C:\>Set-CrmRecord $account PS C:\>Get-CrmRecord account b202caab-6c16-e511-80d6-c4346bc43dc0 name name_Property : [name, Adventure Works (sample) updated!] name : Adventure Works (sample)updated! accountid_Property : [accountid, b202caab-6c16-e511-80d6-c4346bc43dc0] accountid : b202caab-6c16-e511-80d6-c4346bc43dc0 original : {[name_Property, [name, Adventure Works (sample) updated!]], [name, Adventure Works (sample) updated!], [accountid_Property, [accountid, b202caab-6c16-e511-80d6-c4346bc43dc0]], [accountid, b202caab-6c16-e511-80d6-c4346bc43dc0]} logicalname : account</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-CrmRecordOwner</command:name> <maml:description> <maml:para>Assign an user as a CRM record's owner</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>CrmRecordOwner</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-CrmRecordOwner cmdlet lets you assign a user to a record's owner. There are two ways to specify a record. 1. Pass EntityLogicalName and record's Id. 2. Get a record object by using Get-CrmRecord/Get-CrmRecords cmdlets, then pass it.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-CrmRecordOwner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>A record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>PrincipalId</maml:name> <maml:description> <maml:para>An Id (guid) of SystemUser or team to be assigned as owner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>AssignToTeam</maml:name> <maml:description> <maml:para>Switch indicating the PrincipalId Supplied is for a CRM Ownership Team and NOT a CRM User</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-CrmRecordOwner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for an Entity to set an owner. i.e.)accout, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id</maml:name> <maml:description> <maml:para>An Id (guid) of the record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>PrincipalId</maml:name> <maml:description> <maml:para>An Id (guid) of SystemUser or team to be assigned as owner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>AssignToTeam</maml:name> <maml:description> <maml:para>Switch indicating the PrincipalId Supplied is for a CRM Ownership Team and NOT a CRM User</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>A record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>PrincipalId</maml:name> <maml:description> <maml:para>An Id (guid) of SystemUser or team to be assigned as owner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>AssignToTeam</maml:name> <maml:description> <maml:para>Switch indicating the PrincipalId Supplied is for a CRM Ownership Team and NOT a CRM User</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for an Entity to set an owner. i.e.)accout, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id</maml:name> <maml:description> <maml:para>An Id (guid) of the record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmRecordOwner -conn $conn -EntityLogicalName contact -Id e1d47674-4017-e511-80db-c4346bc42d18 -PrincipalId f9d40920-7a43-4f51-9749-0549c4caf67d</dev:code> <dev:remarks> <maml:para>This example assigns a contact record to an User.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmRecordOwner -conn $conn -EntityLogicalName contact -Id e1d47674-4017-e511-80db-c4346bc42d18 -PrincipalId f0d40920-7a43-4f51-9749-0549c4caf673 -AssignToTeam</dev:code> <dev:remarks> <maml:para>This example assigns a contact record to a Team.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmRecordOwner contact e1d47674-4017-e511-80db-c4346bc42d18 f9d40920-7a43-4f51-9749-0549c4caf67d</dev:code> <dev:remarks> <maml:para>This example assigns a contact record to an User by ommiting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>$contact = Get-CrmRecord contact e1d47674-4017-e511-80db-c4346bc42d18 fullname PS C:\>Set-CrmRecordOwner $contact f9d40920-7a43-4f51-9749-0549c4caf67d</dev:code> <dev:remarks> <maml:para>This example retrieves and store a contact record, then pass it to Set-CrmRecordOwner.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-CrmRecordState</command:name> <maml:description> <maml:para>Sets Status/State for a CRM record. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>CrmRecordState</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-CrmRecordState cmdlet lets you set Status/State for a CRM record. There are two ways to specify a record. 1. Pass EntityLogicalName and record's Id. 2. Get a record object by using Get-CrmRecord/Get-CrmRecords cmdlets, then pass it.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-CrmRecordState</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>A record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>StateCode</maml:name> <maml:description> <maml:para>StateCode value for a record. You can retrieve values by using Get-CrmEntityOptionSet <EntityLogicalName> statecode | % {$_.Items} </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>StatusCode</maml:name> <maml:description> <maml:para>StatusCode value for a record. You can retrieve values by using Get-CrmEntityOptionSet <EntityLogicalName> statuscode | % {$_.Items} </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-CrmRecordState</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for an Entity to set an owner. i.e.)account, contact, lead, etc.. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id</maml:name> <maml:description> <maml:para>An Id (guid) of the record </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>StateCode</maml:name> <maml:description> <maml:para>StateCode value for a record. You can retrieve values by using Get-CrmEntityOptionSet <EntityLogicalName> statecode | % {$_.Items} </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>StatusCode</maml:name> <maml:description> <maml:para>StatusCode value for a record. You can retrieve values by using Get-CrmEntityOptionSet <EntityLogicalName> statuscode | % {$_.Items} </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>A record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>StateCode</maml:name> <maml:description> <maml:para>StateCode value for a record. You can retrieve values by using Get-CrmEntityOptionSet <EntityLogicalName> statecode | % {$_.Items} </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>StatusCode</maml:name> <maml:description> <maml:para>StatusCode value for a record. You can retrieve values by using Get-CrmEntityOptionSet <EntityLogicalName> statuscode | % {$_.Items} </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname for an Entity to set an owner. i.e.)account, contact, lead, etc.. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id</maml:name> <maml:description> <maml:para>An Id (guid) of the record </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmRecordState -conn $conn -EntityLogicalName account -Id 1bf8d93d-1f18-e511-80da-c4346bc43d94 -StateCode Inactive -StatusCode Inactive </dev:code> <dev:remarks> <maml:para>This example sets disabled state for an account record. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmRecordState account 1bf8d93d-1f18-e511-80da-c4346bc43d94 Inactive Inactive </dev:code> <dev:remarks> <maml:para>This example sets disabled state for an account record by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>$contact = Get-CrmRecord contact 81f8d93d-1f18-e511-80da-c4346bc43d94 fullname PS C:\>Set-CrmRecordState $contact Inactive Inactive</dev:code> <dev:remarks> <maml:para>This example retrieves and store a contact record, then pass it to Set-CrmRecordState to disable it. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-CrmSystemSettings</command:name> <maml:description> <maml:para> Update CRM Organization's System Settings. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>CrmSystemSettings</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> The Set-CrmSystemSettings cmdlet lets you update CRM Organization's System Settings. Use Get-CrmSystemSettings to confirm current settings. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-CrmSystemSettings</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para> A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>AcknowledgementTemplateId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ACTDeliveryMethod</maml:name> <maml:description> <maml:para>Change "Appointments, Contact, and Tasks" setting for Configure default synchronization method. This parameter accepts int. To get all options, use Get-CrmEntityOptionSet mailbox actdeliverymethod | % Items command and use PickListItemId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>AllowAddressBookSyncs</maml:name> <maml:description> <maml:para>Change "Users can schedule background address book synchronization" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>AllowAutoResponseCreation</maml:name> <maml:description> <maml:para>Indicates whether automatic response creation is allowed. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>AllowAutoUnsubscribe</maml:name> <maml:description> <maml:para>Indicates whether automatic unsubscribe is allowed. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>AllowAutoUnsubscribeAcknowledgement</maml:name> <maml:description> <maml:para>Change "Send acknowledgement to customers when they unsubscribe" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="7"> <maml:name>AllowClientMessageBarAd</maml:name> <maml:description> <maml:para>Change "Users see "Get CRM for Outlook" option displayed in the message bar" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="8"> <maml:name>AllowEntityOnlyAudit</maml:name> <maml:description> <maml:para>Indicates whether auditing of changes to an entity is allowed when no attributes have changed. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="9"> <maml:name>AllowMarketingEmailExecution</maml:name> <maml:description> <maml:para>Indicates whether marketing emails execution is allowed </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="10"> <maml:name>AllowOfflineScheduledSyncs</maml:name> <maml:description> <maml:para>Change "Users can schedule background local data synchronization" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="11"> <maml:name>AllowOutlookScheduledSyncs</maml:name> <maml:description> <maml:para>Change "Users can schedule synchronization" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="12"> <maml:name>AllowUnresolvedPartiesOnEmailSend</maml:name> <maml:description> <maml:para>Change "Allw messages with unresolved email recipients to be sent" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="13"> <maml:name>AllowUserFormModePreference</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="14"> <maml:name>AllowUsersSeeAppdownloadMessage</maml:name> <maml:description> <maml:para>Change "Users see app download message" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="15"> <maml:name>AllowWebExcelExport</maml:name> <maml:description> <maml:para>Indicates whether web-based export of grids to Microsoft Office Excel is allowed. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="16"> <maml:name>AMDesignator</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="17"> <maml:name>AutoApplyDefaultonCaseCreate</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="18"> <maml:name>AutoApplyDefaultonCaseUpdate</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="19"> <maml:name>AutoApplySLA</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="20"> <maml:name>BingMapsApiKey</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="21"> <maml:name>BlockedAttachments</maml:name> <maml:description> <maml:para>Update "Set blocked file extensions for attachements" list. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="22"> <maml:name>BusinessClosureCalendarId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="23"> <maml:name>CampaignPrefix</maml:name> <maml:description> <maml:para>Prefix used for campaign numbering. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="24"> <maml:name>CascadeStatusUpdate</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="25"> <maml:name>CasePrefix</maml:name> <maml:description> <maml:para>Prefix to use for all cases throughout Microsoft Dynamics CRM. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="26"> <maml:name>ContractPrefix</maml:name> <maml:description> <maml:para>Prefix to use for all contracts throughout Microsoft Dynamics CRM. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="27"> <maml:name>CortanaProactiveExperienceEnabled</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="28"> <maml:name>CreateProductsWithoutParentInActiveState</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="29"> <maml:name>CurrencyDecimalPrecision</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="30"> <maml:name>CurrencyDisplayOption</maml:name> <maml:description> <maml:para>Change "Display currencies by using" setting. This parameter accepts int. To get all options, use Get-CrmEntityOptionSet organization currencydisplayoption | % Items command and use PickListItemId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="31"> <maml:name>CurrentCampaignNumber</maml:name> <maml:description> <maml:para>Current campaign number. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="32"> <maml:name>CurrentCaseNumber</maml:name> <maml:description> <maml:para>First case number to use. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="33"> <maml:name>CurrentContractNumber</maml:name> <maml:description> <maml:para>First contract number to use. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="34"> <maml:name>CurrentInvoiceNumber</maml:name> <maml:description> <maml:para>First invoice number to use. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="35"> <maml:name>CurrentKbNumber</maml:name> <maml:description> <maml:para>First article number to use. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="36"> <maml:name>CurrentOrderNumber</maml:name> <maml:description> <maml:para>First order number to use. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="37"> <maml:name>CurrentQuoteNumber</maml:name> <maml:description> <maml:para>First quote number to use. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="38"> <maml:name>DefaultCountryCode</maml:name> <maml:description> <maml:para>Change "Country/Region Code Prefix" value. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="39"> <maml:name>DefaultEmailServerProfileId</maml:name> <maml:description> <maml:para>Change "Server Profile" setting for Configure default synchronization method. This parameter accepts Email Server Profile record's guid. To get all profiles, use Get-CrmEmailServerProfiles command and use ProfileId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="40"> <maml:name>DisableSocialCare</maml:name> <maml:description> <maml:para>Change "Prevent feature from receiving social data in CRM" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="41"> <maml:name>DisplayNavigationTour</maml:name> <maml:description> <maml:para>Change "Display welcome screen to users when they sign in" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="42"> <maml:name>EmailConnectionChannel</maml:name> <maml:description> <maml:para>Change "Process Email Using" setting. This parameter accepts int. To get all options, use Get-CrmEntityOptionSet organization emailcommunicationchannel | % Items command and use PickListItemId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="43"> <maml:name>EmailCorrelationEnabled</maml:name> <maml:description> <maml:para>Change "User correlation to track email conversations" setting. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="44"> <maml:name>EnableBingMapsIntegration</maml:name> <maml:description> <maml:para>Change "Show Bing Maps on forms" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="45"> <maml:name>EnableSmartMatching</maml:name> <maml:description> <maml:para>Change "Use Smart Matching" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="46"> <maml:name>FullNameConventionCode</maml:name> <maml:description> <maml:para>Change "Name Format" setting for full-name fields. This parameters accept int. To get all options, use Get-CrmEntityOptionSet organization fullnameconventioncode | % Items command and use PickListItemId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="47"> <maml:name>GenerateAlertsForErrors</maml:name> <maml:description> <maml:para>Change "Error level of Configure Alerts" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="48"> <maml:name>GenerateAlertsForWarnings</maml:name> <maml:description> <maml:para>Change "Warning level of Configure Alerts" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="49"> <maml:name>GenerateAlertsForInformation</maml:name> <maml:description> <maml:para>Change "Information level of Configure Alerts" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="50"> <maml:name>GlobalAppendUrlParametersEnabled</maml:name> <maml:description> <maml:para>Change "Append parameters to URL" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="51"> <maml:name>GlobalHelpUrl</maml:name> <maml:description> <maml:para>Change "Global custom Help URL" value. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="52"> <maml:name>GlobalHelpUrlEnabled</maml:name> <maml:description> <maml:para>Change "Use custom Help for customizable entities" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="53"> <maml:name>HashDeltaSubjectCount</maml:name> <maml:description> <maml:para>Change "Maximum difference allowed between subject keywords" setting. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="54"> <maml:name>HashFilterKeywords</maml:name> <maml:description> <maml:para>Change "Filter subject keywords" setting. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="55"> <maml:name>HashMaxCount</maml:name> <maml:description> <maml:para>Change "Maximum number of subject keywords or recipients" setting. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="56"> <maml:name>HashMinAddressCount</maml:name> <maml:description> <maml:para>Change "Minimum number of recipients required to match" setting. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="57"> <maml:name>IgnoreInternalEmail</maml:name> <maml:description> <maml:para>Change "Track emails sent between CRM users as two activities" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="58"> <maml:name>IncomingEmailDeliveryMethod</maml:name> <maml:description> <maml:para>Change "Incoming Email" setting for Configure default synchronization method. This parameter accepts int. To get all options, use Get-CrmEntityOptionSet mailbox incomingemaildeliverymethod | % Items command and use PickListItemId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="59"> <maml:name>InvoicePrefix</maml:name> <maml:description> <maml:para>Prefix to use for all invoice numbers throughout Microsoft Dynamics CRM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="60"> <maml:name>IsAutoSaveEnabled</maml:name> <maml:description> <maml:para>Change "Enable auto save on all forms" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="61"> <maml:name>IsDefaultCountryCodeCheckEnabled</maml:name> <maml:description> <maml:para>Change "Enable country/region code prefixing" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="62"> <maml:name>IsDuplicateDetectionEnabled</maml:name> <maml:description> <maml:para>Indicates whether duplicate detection of records is enabled. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="63"> <maml:name>IsDuplicateDetectionEnabledForImport</maml:name> <maml:description> <maml:para>Indicates whether duplicate detection of records during import is enabled. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="64"> <maml:name>IsDuplicateDetectionEnabledForOfflineSync</maml:name> <maml:description> <maml:para>Indicates whether duplicate detection of records during offline synchronization is enabled. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="65"> <maml:name>IsDuplicateDetectionEnabledForOnlineCreateUpdate</maml:name> <maml:description> <maml:para>Indicates whether duplicate detection during online create or update is enabled. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="66"> <maml:name>isenabledforallroles</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="67"> <maml:name>IsFolderBasedTrackingEnabled</maml:name> <maml:description> <maml:para>Change "Use folder-level tracking for Exchange folders" setting. Supported at v7.1 or above. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="68"> <maml:name>IsFullTextSearchEnabled</maml:name> <maml:description> <maml:para>Change "Enable full-text search for Quick Find" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="69"> <maml:name>IsHierarchicalSecurityModelEnabled</maml:name> <maml:description> <maml:para>Indicates whether the hierarchical security model is enabled. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="70"> <maml:name>IsPresenceEnabled</maml:name> <maml:description> <maml:para>Change "Enable presence for the system" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="71"> <maml:name>IsUserAccessAuditEnabled</maml:name> <maml:description> <maml:para>Change "Audit user access" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="72"> <maml:name>KbPrefix</maml:name> <maml:description> <maml:para>Prefix to use for all articles in Microsoft Dynamics CRM. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="73"> <maml:name>MaxAppointmentDurationDays</maml:name> <maml:description> <maml:para>Set "Maximum durations of an appointment in days" setting. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="74"> <maml:name>MaxDepthForHierarchicalSecurityModel</maml:name> <maml:description> <maml:para>Maximum depth for hierarchy security propagation. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="75"> <maml:name>MaximumActiveBusinessProcessFlowsAllowedPerEntity</maml:name> <maml:description> <maml:para>Maximum number of active business process flows allowed per entity. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="76"> <maml:name>MaximumDynamicPropertiesAllowed</maml:name> <maml:description> <maml:para>Maximum number of product properties for a product family or bundle.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="77"> <maml:name>MaximumTrackingNumber</maml:name> <maml:description> <maml:para>Change "Number of digits for incremental message counter" setting. Specify 999 will set 3 as setting, 9999 will set 4 as setting and you can set up to 999999999. You can disable "Use Tracking Token" by setting 0. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="78"> <maml:name>MaxProductsInBundle</maml:name> <maml:description> <maml:para>Maximum number of items in a bundle.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="79"> <maml:name>MaxRecordsForExportToExcel</maml:name> <maml:description> <maml:para>Maximum number of records that will be exported to a static Microsoft Office Excel worksheet when exporting from the grid. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="80"> <maml:name>MaxRecordsForLookupFilters</maml:name> <maml:description> <maml:para>Maximum number of lookup and picklist records that can be selected by user for filtering. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="81"> <maml:name>MaxUploadFileSize</maml:name> <maml:description> <maml:para>Maximum allowed size of an attachment. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="82"> <maml:name>MinAddressBookSyncInterval</maml:name> <maml:description> <maml:para>Change "Minimum time between address book synchronizations" setting. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="83"> <maml:name>MinOfflineSyncInterval</maml:name> <maml:description> <maml:para>Change "Minimum time between background local data synchronizations" setting. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="84"> <maml:name>MinOutlookSyncInterval</maml:name> <maml:description> <maml:para>Change "Minimum time between synchronizations" setting. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="85"> <maml:name>NotifyMailboxOwnerOfEmailServerLevelAlerts</maml:name> <maml:description> <maml:para>Change "Notify mailbox owner" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="86"> <maml:name>OrderPrefix</maml:name> <maml:description> <maml:para>Prefix to use for all orders throughout Microsoft Dynamics CRM. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="87"> <maml:name>OutgoingEmailDeliveryMethod</maml:name> <maml:description> <maml:para>Change "Outgoing Email" setting for Configure default synchronization method. This parameter accepts int. To get all options, use Get-CrmEntityOptionSet mailbox outgoingemaildeliverymethod | % Items command and use PickListItemId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="88"> <maml:name>PluginTraceLogSetting</maml:name> <maml:description> <maml:para>Change "Enable logging to plug-in trace log" setting. 0:Off 1:Exception 2:All </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="89"> <maml:name>PricingDecimalPrecision</maml:name> <maml:description> <maml:para>Change "Pricing Decimal Precision" setting. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="90"> <maml:name>QuickFindRecordLimitEnabled</maml:name> <maml:description> <maml:para>Change "Enable Quick Find record limits" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="91"> <maml:name>QuotePrefix</maml:name> <maml:description> <maml:para>Prefix to use for all quotes throughout Microsoft Dynamics CRM. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="92"> <maml:name>RequireApprovalForUserEmail</maml:name> <maml:description> <maml:para>Change "Process emails only for approved users" setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="93"> <maml:name>RequireApprovalForQueueEmail</maml:name> <maml:description> <maml:para>Change "Process emails only for approved queues" setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="94"> <maml:name>ShareToPreviousOwnerOnAssign</maml:name> <maml:description> <maml:para>Change "Share reassigned records with original owner" setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="95"> <maml:name>TrackingPrefix</maml:name> <maml:description> <maml:para>Change Tracking Token "Prefix" setting.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="96"> <maml:name>TrackingTokenIdBase</maml:name> <maml:description> <maml:para>Change "Deployment base tracking number" setting.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="97"> <maml:name>TrackingTokenIdDigits</maml:name> <maml:description> <maml:para>Change "Number of digits for user numbers" setting </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="98"> <maml:name>UniqueSpecifierLength</maml:name> <maml:description> <maml:para>Number of characters appended to invoice, quote, and order numbers. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="99"> <maml:name>UseLegacyRendering</maml:name> <maml:description> <maml:para>Change "Use legacy form rendering" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="100"> <maml:name>UsePositionHierarchy</maml:name> <maml:description> <maml:para>Indicates whether to use position hierarchy. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="101"> <maml:name>UseSkypeProtocol</maml:name> <maml:description> <maml:para>Change "Select provider for Click to call" setting. $true: Skype $false: Lync </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="102"> <maml:name>UseAllowUsersSeeAppdownloadMessage</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="103"> <maml:name>DefaultCrmCustomName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="104"> <maml:name>SuppressSLA</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="105"> <maml:name>IsAuditEnabled</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="106"> <maml:name>AllowLegacyClientExperience</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para> A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ACTDeliveryMethod</maml:name> <maml:description> <maml:para>Change "Appointments, Contact, and Tasks" setting for Configure default synchronization method. This parameter accepts int. To get all options, use Get-CrmEntityOptionSet mailbox actdeliverymethod | % Items command and use PickListItemId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>AllowAddressBookSyncs</maml:name> <maml:description> <maml:para>Change "Users can schedule background address book synchronization" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>AllowAutoResponseCreation</maml:name> <maml:description> <maml:para>Indicates whether automatic response creation is allowed. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>AllowAutoUnsubscribe</maml:name> <maml:description> <maml:para>Indicates whether automatic unsubscribe is allowed. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>AllowAutoUnsubscribeAcknowledgement</maml:name> <maml:description> <maml:para>Change "Send acknowledgement to customers when they unsubscribe" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="7"> <maml:name>AllowClientMessageBarAd</maml:name> <maml:description> <maml:para>Change "Users see "Get CRM for Outlook" option displayed in the message bar" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="8"> <maml:name>AllowEntityOnlyAudit</maml:name> <maml:description> <maml:para>Indicates whether auditing of changes to an entity is allowed when no attributes have changed. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="9"> <maml:name>AllowMarketingEmailExecution</maml:name> <maml:description> <maml:para>Indicates whether marketing emails execution is allowed </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="10"> <maml:name>AllowOfflineScheduledSyncs</maml:name> <maml:description> <maml:para>Change "Users can schedule background local data synchronization" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="11"> <maml:name>AllowOutlookScheduledSyncs</maml:name> <maml:description> <maml:para>Change "Users can schedule synchronization" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="12"> <maml:name>AllowUnresolvedPartiesOnEmailSend</maml:name> <maml:description> <maml:para>Change "Allw messages with unresolved email recipients to be sent" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="14"> <maml:name>AllowUsersSeeAppdownloadMessage</maml:name> <maml:description> <maml:para>Change "Users see app download message" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="15"> <maml:name>AllowWebExcelExport</maml:name> <maml:description> <maml:para>Indicates whether web-based export of grids to Microsoft Office Excel is allowed. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="21"> <maml:name>BlockedAttachments</maml:name> <maml:description> <maml:para>Update "Set blocked file extensions for attachements" list. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="23"> <maml:name>CampaignPrefix</maml:name> <maml:description> <maml:para>Prefix used for campaign numbering. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="25"> <maml:name>CasePrefix</maml:name> <maml:description> <maml:para>Prefix to use for all cases throughout Microsoft Dynamics CRM. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="26"> <maml:name>ContractPrefix</maml:name> <maml:description> <maml:para>Prefix to use for all contracts throughout Microsoft Dynamics CRM. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="30"> <maml:name>CurrencyDisplayOption</maml:name> <maml:description> <maml:para>Change "Display currencies by using" setting. This parameter accepts int. To get all options, use Get-CrmEntityOptionSet organization currencydisplayoption | % Items command and use PickListItemId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="31"> <maml:name>CurrentCampaignNumber</maml:name> <maml:description> <maml:para>Current campaign number. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="32"> <maml:name>CurrentCaseNumber</maml:name> <maml:description> <maml:para>First case number to use. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="33"> <maml:name>CurrentContractNumber</maml:name> <maml:description> <maml:para>First contract number to use. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="34"> <maml:name>CurrentInvoiceNumber</maml:name> <maml:description> <maml:para>First invoice number to use. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="35"> <maml:name>CurrentKbNumber</maml:name> <maml:description> <maml:para>First article number to use. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="36"> <maml:name>CurrentOrderNumber</maml:name> <maml:description> <maml:para>First order number to use. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="37"> <maml:name>CurrentQuoteNumber</maml:name> <maml:description> <maml:para>First quote number to use. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="38"> <maml:name>DefaultCountryCode</maml:name> <maml:description> <maml:para>Change "Country/Region Code Prefix" value. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="39"> <maml:name>DefaultEmailServerProfileId</maml:name> <maml:description> <maml:para>Change "Server Profile" setting for Configure default synchronization method. This parameter accepts Email Server Profile record's guid. To get all profiles, use Get-CrmEmailServerProfiles command and use ProfileId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="40"> <maml:name>DisableSocialCare</maml:name> <maml:description> <maml:para>Change "Prevent feature from receiving social data in CRM" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="41"> <maml:name>DisplayNavigationTour</maml:name> <maml:description> <maml:para>Change "Display welcome screen to users when they sign in" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="42"> <maml:name>EmailConnectionChannel</maml:name> <maml:description> <maml:para>Change "Process Email Using" setting. This parameter accepts int. To get all options, use Get-CrmEntityOptionSet organization emailcommunicationchannel | % Items command and use PickListItemId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="43"> <maml:name>EmailCorrelationEnabled</maml:name> <maml:description> <maml:para>Change "User correlation to track email conversations" setting. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="44"> <maml:name>EnableBingMapsIntegration</maml:name> <maml:description> <maml:para>Change "Show Bing Maps on forms" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="45"> <maml:name>EnableSmartMatching</maml:name> <maml:description> <maml:para>Change "Use Smart Matching" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="46"> <maml:name>FullNameConventionCode</maml:name> <maml:description> <maml:para>Change "Name Format" setting for full-name fields. This parameters accept int. To get all options, use Get-CrmEntityOptionSet organization fullnameconventioncode | % Items command and use PickListItemId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="47"> <maml:name>GenerateAlertsForErrors</maml:name> <maml:description> <maml:para>Change "Error level of Configure Alerts" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="48"> <maml:name>GenerateAlertsForWarnings</maml:name> <maml:description> <maml:para>Change "Warning level of Configure Alerts" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="49"> <maml:name>GenerateAlertsForInformation</maml:name> <maml:description> <maml:para>Change "Information level of Configure Alerts" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="50"> <maml:name>GlobalAppendUrlParametersEnabled</maml:name> <maml:description> <maml:para>Change "Append parameters to URL" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="51"> <maml:name>GlobalHelpUrl</maml:name> <maml:description> <maml:para>Change "Global custom Help URL" value. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="52"> <maml:name>GlobalHelpUrlEnabled</maml:name> <maml:description> <maml:para>Change "Use custom Help for customizable entities" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="53"> <maml:name>HashDeltaSubjectCount</maml:name> <maml:description> <maml:para>Change "Maximum difference allowed between subject keywords" setting. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="54"> <maml:name>HashFilterKeywords</maml:name> <maml:description> <maml:para>Change "Filter subject keywords" setting. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="55"> <maml:name>HashMaxCount</maml:name> <maml:description> <maml:para>Change "Maximum number of subject keywords or recipients" setting. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="56"> <maml:name>HashMinAddressCount</maml:name> <maml:description> <maml:para>Change "Minimum number of recipients required to match" setting. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="57"> <maml:name>IgnoreInternalEmail</maml:name> <maml:description> <maml:para>Change "Track emails sent between CRM users as two activities" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="58"> <maml:name>IncomingEmailDeliveryMethod</maml:name> <maml:description> <maml:para>Change "Incoming Email" setting for Configure default synchronization method. This parameter accepts int. To get all options, use Get-CrmEntityOptionSet mailbox incomingemaildeliverymethod | % Items command and use PickListItemId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="59"> <maml:name>InvoicePrefix</maml:name> <maml:description> <maml:para>Prefix to use for all invoice numbers throughout Microsoft Dynamics CRM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="60"> <maml:name>IsAutoSaveEnabled</maml:name> <maml:description> <maml:para>Change "Enable auto save on all forms" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="61"> <maml:name>IsDefaultCountryCodeCheckEnabled</maml:name> <maml:description> <maml:para>Change "Enable country/region code prefixing" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="62"> <maml:name>IsDuplicateDetectionEnabled</maml:name> <maml:description> <maml:para>Indicates whether duplicate detection of records is enabled. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="63"> <maml:name>IsDuplicateDetectionEnabledForImport</maml:name> <maml:description> <maml:para>Indicates whether duplicate detection of records during import is enabled. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="64"> <maml:name>IsDuplicateDetectionEnabledForOfflineSync</maml:name> <maml:description> <maml:para>Indicates whether duplicate detection of records during offline synchronization is enabled. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="65"> <maml:name>IsDuplicateDetectionEnabledForOnlineCreateUpdate</maml:name> <maml:description> <maml:para>Indicates whether duplicate detection during online create or update is enabled. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="67"> <maml:name>IsFolderBasedTrackingEnabled</maml:name> <maml:description> <maml:para>Change "Use folder-level tracking for Exchange folders" setting. Supported at v7.1 or above. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="68"> <maml:name>IsFullTextSearchEnabled</maml:name> <maml:description> <maml:para>Change "Enable full-text search for Quick Find" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="69"> <maml:name>IsHierarchicalSecurityModelEnabled</maml:name> <maml:description> <maml:para>Indicates whether the hierarchical security model is enabled. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="70"> <maml:name>IsPresenceEnabled</maml:name> <maml:description> <maml:para>Change "Enable presence for the system" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="71"> <maml:name>IsUserAccessAuditEnabled</maml:name> <maml:description> <maml:para>Change "Audit user access" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="72"> <maml:name>KbPrefix</maml:name> <maml:description> <maml:para>Prefix to use for all articles in Microsoft Dynamics CRM. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="73"> <maml:name>MaxAppointmentDurationDays</maml:name> <maml:description> <maml:para>Set "Maximum durations of an appointment in days" setting. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="74"> <maml:name>MaxDepthForHierarchicalSecurityModel</maml:name> <maml:description> <maml:para>Maximum depth for hierarchy security propagation. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="75"> <maml:name>MaximumActiveBusinessProcessFlowsAllowedPerEntity</maml:name> <maml:description> <maml:para>Maximum number of active business process flows allowed per entity. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="76"> <maml:name>MaximumDynamicPropertiesAllowed</maml:name> <maml:description> <maml:para>Maximum number of product properties for a product family or bundle.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="77"> <maml:name>MaximumTrackingNumber</maml:name> <maml:description> <maml:para>Change "Number of digits for incremental message counter" setting. Specify 999 will set 3 as setting, 9999 will set 4 as setting and you can set up to 999999999. You can disable "Use Tracking Token" by setting 0. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="78"> <maml:name>MaxProductsInBundle</maml:name> <maml:description> <maml:para>Maximum number of items in a bundle.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="79"> <maml:name>MaxRecordsForExportToExcel</maml:name> <maml:description> <maml:para>Maximum number of records that will be exported to a static Microsoft Office Excel worksheet when exporting from the grid. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="80"> <maml:name>MaxRecordsForLookupFilters</maml:name> <maml:description> <maml:para>Maximum number of lookup and picklist records that can be selected by user for filtering. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="81"> <maml:name>MaxUploadFileSize</maml:name> <maml:description> <maml:para>Maximum allowed size of an attachment. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="82"> <maml:name>MinAddressBookSyncInterval</maml:name> <maml:description> <maml:para>Change "Minimum time between address book synchronizations" setting. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="83"> <maml:name>MinOfflineSyncInterval</maml:name> <maml:description> <maml:para>Change "Minimum time between background local data synchronizations" setting. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="84"> <maml:name>MinOutlookSyncInterval</maml:name> <maml:description> <maml:para>Change "Minimum time between synchronizations" setting. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="85"> <maml:name>NotifyMailboxOwnerOfEmailServerLevelAlerts</maml:name> <maml:description> <maml:para>Change "Notify mailbox owner" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="86"> <maml:name>OrderPrefix</maml:name> <maml:description> <maml:para>Prefix to use for all orders throughout Microsoft Dynamics CRM. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="87"> <maml:name>OutgoingEmailDeliveryMethod</maml:name> <maml:description> <maml:para>Change "Outgoing Email" setting for Configure default synchronization method. This parameter accepts int. To get all options, use Get-CrmEntityOptionSet mailbox outgoingemaildeliverymethod | % Items command and use PickListItemId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="88"> <maml:name>PluginTraceLogSetting</maml:name> <maml:description> <maml:para>Change "Enable logging to plug-in trace log" setting. 0:Off 1:Exception 2:All </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="89"> <maml:name>PricingDecimalPrecision</maml:name> <maml:description> <maml:para>Change "Pricing Decimal Precision" setting. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="90"> <maml:name>QuickFindRecordLimitEnabled</maml:name> <maml:description> <maml:para>Change "Enable Quick Find record limits" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="91"> <maml:name>QuotePrefix</maml:name> <maml:description> <maml:para>Prefix to use for all quotes throughout Microsoft Dynamics CRM. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="92"> <maml:name>RequireApprovalForUserEmail</maml:name> <maml:description> <maml:para>Change "Process emails only for approved users" setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="93"> <maml:name>RequireApprovalForQueueEmail</maml:name> <maml:description> <maml:para>Change "Process emails only for approved queues" setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="94"> <maml:name>ShareToPreviousOwnerOnAssign</maml:name> <maml:description> <maml:para>Change "Share reassigned records with original owner" setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="95"> <maml:name>TrackingPrefix</maml:name> <maml:description> <maml:para>Change Tracking Token "Prefix" setting.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="96"> <maml:name>TrackingTokenIdBase</maml:name> <maml:description> <maml:para>Change "Deployment base tracking number" setting.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="97"> <maml:name>TrackingTokenIdDigits</maml:name> <maml:description> <maml:para>Change "Number of digits for user numbers" setting </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="98"> <maml:name>UniqueSpecifierLength</maml:name> <maml:description> <maml:para>Number of characters appended to invoice, quote, and order numbers. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="99"> <maml:name>UseLegacyRendering</maml:name> <maml:description> <maml:para>Change "Use legacy form rendering" setting. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="100"> <maml:name>UsePositionHierarchy</maml:name> <maml:description> <maml:para>Indicates whether to use position hierarchy. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="101"> <maml:name>UseSkypeProtocol</maml:name> <maml:description> <maml:para>Change "Select provider for Click to call" setting. $true: Skype $false: Lync </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>AcknowledgementTemplateId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="13"> <maml:name>AllowUserFormModePreference</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="16"> <maml:name>AMDesignator</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="17"> <maml:name>AutoApplyDefaultonCaseCreate</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="18"> <maml:name>AutoApplyDefaultonCaseUpdate</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="19"> <maml:name>AutoApplySLA</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="20"> <maml:name>BingMapsApiKey</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="22"> <maml:name>BusinessClosureCalendarId</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="24"> <maml:name>CascadeStatusUpdate</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="27"> <maml:name>CortanaProactiveExperienceEnabled</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="28"> <maml:name>CreateProductsWithoutParentInActiveState</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="29"> <maml:name>CurrencyDecimalPrecision</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="66"> <maml:name>isenabledforallroles</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="102"> <maml:name>UseAllowUsersSeeAppdownloadMessage</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="103"> <maml:name>DefaultCrmCustomName</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="104"> <maml:name>SuppressSLA</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="105"> <maml:name>IsAuditEnabled</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="106"> <maml:name>AllowLegacyClientExperience</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmSystemSettings -conn $conn -IsAutoSaveEnabled $false</dev:code> <dev:remarks> <maml:para>This example disables "Enable auto save on all forms" System setting.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmSystemSettings -conn $conn -FullNameConventionCode 7 </dev:code> <dev:remarks> <maml:para>This example updates "Name Format" of Set the full-name format to "Last NameFirst Name" System setting. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmSystemSettings -IsAutoSaveEnabled $false </dev:code> <dev:remarks> <maml:para>This example disables "Enable auto save on all forms" System setting by omitting -conn parameter. When omitting conn parameter, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-CrmUserBusinessUnit</command:name> <maml:description> <maml:para>Moves Crm User to another Business Unit. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>CrmUserBusinessUnit</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-CrmUserBusinessUnit lets you move Crm User to another Business Unit. You can specify different CRM UserId to ReassignUserId to update ownership of records as well. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-CrmUserBusinessUnit</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>An Id (guid) of CRM User which moves to another Business Unit. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>BusinessUnitId</maml:name> <maml:description> <maml:para>An Id (guid) of Business Unit. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ReassignUserId</maml:name> <maml:description> <maml:para>An Id (guid) of CRM User to own records of Moving CRM User. You can specify same Id as UserId or omit it if you want to keep records ownership. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>An Id (guid) of CRM User which moves to another Business Unit. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>BusinessUnitId</maml:name> <maml:description> <maml:para>An Id (guid) of Business Unit. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ReassignUserId</maml:name> <maml:description> <maml:para>An Id (guid) of CRM User to own records of Moving CRM User. You can specify same Id as UserId or omit it if you want to keep records ownership. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmUserBusinessUnit -conn $conn -UserId 3772fe6e-8a18-e511-80dc-c4346bc42d48 -BusinessUnitId 5a18974c-ae18-e511-80dd-c4346bc44d24 -ReassignUserId 3772fe6e-8a18-e511-80dc-c4346bc42d48 </dev:code> <dev:remarks> <maml:para>This example moves a CRM User to specified BusinessUnit, then keeps the records ownership. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmUserBusinessUnit 3772fe6e-8a18-e511-80dc-c4346bc42d48 5a18974c-ae18-e511-80dd-c4346bc44d24 f9d40920-7a43-4f51-9749-0549c4caf67d </dev:code> <dev:remarks> <maml:para>This example moves a CRM User to specified BusinessUnit, then reassign the records ownership by omitting parameters names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-CrmUserMailbox</command:name> <maml:description> <maml:para>Updates CRM user's mailibox. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>CrmUserMailbox</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-CrmUserMailbox cmdlet lets you update CRM user's mailibox. Use Get-CrmUserMailbox to confirm current values. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-CrmUserMailbox</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>An Id of CRM user. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>An EmailAddress of CRM user. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EmailServerProfile</maml:name> <maml:description> <maml:para>Change "Server Profile" setting of Synchronization Method. This parameter accepts Email Server Profile record's guid. To get all profiles, use Get-CrmEmailServerProfiles command and use ProfileId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncomingEmailDeliveryMethod</maml:name> <maml:description> <maml:para>Change "Incoming Email" setting for Configure default synchronization method. This parameter accepts int. To get all options, use Get-CrmEntityOptionSet mailbox incomingemaildeliverymethod | % Items command and use PickListItemId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutgoingEmailDeliveryMethod</maml:name> <maml:description> <maml:para>Change "Outgoing Email" setting for Configure default synchronization method. This parameter accepts int. To get all options, use Get-CrmEntityOptionSet mailbox outgoingemaildeliverymethod | % Items command and use PickListItemId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ACTDeliveryMethod</maml:name> <maml:description> <maml:para>Change "Appointments, Contact, and Tasks" setting for Configure default synchronization method. This parameter accepts int. To get all options, use Get-CrmEntityOptionSet mailbox actdeliverymethod | % Items command and use PickListItemId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-CrmUserMailbox</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>An Id of CRM user. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>An EmailAddress of CRM user. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplyDefaultEmailSettings</maml:name> <maml:description> <maml:para>Specify this to apply the organization default settings</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-CrmUserMailbox</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>An Id of CRM user. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>An EmailAddress of CRM user. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StateCode</maml:name> <maml:description> <maml:para>StateCode value for a record. You can retrieve values by using Get-CrmEntityOptionSet <EntityLogicalName> statecode | % {$_.Items} </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StatusCode</maml:name> <maml:description> <maml:para>StatusCode value for a record. You can retrieve values by using Get-CrmEntityOptionSet <EntityLogicalName> statuscode | % {$_.Items}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ScheduleTest</maml:name> <maml:description> <maml:para>Specify this to schedule test for the mailbox</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MarkedAsPrimaryForExchangeSync</maml:name> <maml:description> <maml:para>Specify this to mark the mailbox as primary mailbox to sync with Exchange Online</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApproveEmail</maml:name> <maml:description> <maml:para>Specify this to approve the emailaddress.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>An Id of CRM user. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>An EmailAddress of CRM user. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EmailServerProfile</maml:name> <maml:description> <maml:para>Change "Server Profile" setting of Synchronization Method. This parameter accepts Email Server Profile record's guid. To get all profiles, use Get-CrmEmailServerProfiles command and use ProfileId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncomingEmailDeliveryMethod</maml:name> <maml:description> <maml:para>Change "Incoming Email" setting for Configure default synchronization method. This parameter accepts int. To get all options, use Get-CrmEntityOptionSet mailbox incomingemaildeliverymethod | % Items command and use PickListItemId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutgoingEmailDeliveryMethod</maml:name> <maml:description> <maml:para>Change "Outgoing Email" setting for Configure default synchronization method. This parameter accepts int. To get all options, use Get-CrmEntityOptionSet mailbox outgoingemaildeliverymethod | % Items command and use PickListItemId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ACTDeliveryMethod</maml:name> <maml:description> <maml:para>Change "Appointments, Contact, and Tasks" setting for Configure default synchronization method. This parameter accepts int. To get all options, use Get-CrmEntityOptionSet mailbox actdeliverymethod | % Items command and use PickListItemId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplyDefaultEmailSettings</maml:name> <maml:description> <maml:para>Specify this to apply the organization default settings</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StateCode</maml:name> <maml:description> <maml:para>StateCode value for a record. You can retrieve values by using Get-CrmEntityOptionSet <EntityLogicalName> statecode | % {$_.Items} </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StatusCode</maml:name> <maml:description> <maml:para>StatusCode value for a record. You can retrieve values by using Get-CrmEntityOptionSet <EntityLogicalName> statuscode | % {$_.Items}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ScheduleTest</maml:name> <maml:description> <maml:para>Specify this to schedule test for the mailbox</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MarkedAsPrimaryForExchangeSync</maml:name> <maml:description> <maml:para>Specify this to mark the mailbox as primary mailbox to sync with Exchange Online</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApproveEmail</maml:name> <maml:description> <maml:para>Specify this to approve the emailaddress.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmUserMailbox -conn $conn -UserId f9d40920-7a43-4f51-9749-0549c4caf67d -IncomingEmailDeliveryMethod 0 </dev:code> <dev:remarks> <maml:para>This example updates "Incoming Email" setting to "None". </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmUserMailbox -conn $conn -UserId f9d40920-7a43-4f51-9749-0549c4caf67d -EmailServerProfile 1b2d4b03-831e-e511-80e1-c4346bc44d24 </dev:code> <dev:remarks> <maml:para>This example updates "Server Profile" setting to specified Profile. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmUserMailbox -conn $conn -UserId f9d40920-7a43-4f51-9749-0549c4caf67d -ApplyDefaultEmailSettings </dev:code> <dev:remarks> <maml:para>This example updates mailbox email settings to default settings, which is in System Settings. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmUserMailbox -UserId f9d40920-7a43-4f51-9749-0549c4caf67d -IncomingEmailDeliveryMethod 0 </dev:code> <dev:remarks> <maml:para>This example disables "Incoming Email" setting to "None" by omitting -conn parameter. When omitting conn parameter, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmUserMailbox -UserId f9d40920-7a43-4f51-9749-0549c4caf67d -ApplyDefaultEmailSettings </dev:code> <dev:remarks> <maml:para>This example updates mailbox email settings to default settings, which is in System Settings by omitting -conn parameter. When omitting conn parameter, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmUserMailbox -conn $conn -UserId f9d40920-7a43-4f51-9749-0549c4caf67d -StateCode Active -StatusCode Active -ScheduleTest -MarkedAsPrimaryForExchangeSync -ApproveEmail</dev:code> <dev:remarks> <maml:para>This example activates mailbox, approve emailaddress, schedule test and set the mailbox as primary for sync with Exchange Online.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Test-CrmSampleDataInstalled</command:name> <maml:description> <maml:para>Checks if sample data has been installed to CRM Organization. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test</command:verb> <command:noun>CrmSampleDataInstalled</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Test-CrmSampleDataInstalled cmdlet lets you Check if sample data has been installed to CRM Organization. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-CrmSampleDataInstalled</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Test-CrmSampleDataInstalled -conn $conn </dev:code> <dev:remarks> <maml:para>This example checks if sample data has been installed. </maml:para> <maml:para /> <maml:para /> <maml:para>Completed </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Test-CrmSampleDataInstalled </dev:code> <dev:remarks> <maml:para>This example checks if sample data has been installed by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>Completed </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Test-CrmViewPerformance</command:name> <maml:description> <maml:para>Test CRM View performance. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test</command:verb> <command:noun>CrmViewPerformance</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Test-CrmViewPerformance cmdlet lets you test CRM View performance. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-CrmViewPerformance</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>View</maml:name> <maml:description> <maml:para>A view record object to test performance. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsViewOwner</maml:name> <maml:description> <maml:para>Indicate if using view owner's id to run the view to test performance. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAs</maml:name> <maml:description> <maml:para>Specify User Id to run the view to test performance. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsUserView</maml:name> <maml:description> <maml:para>Indicate if the view is user owned view. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-CrmViewPerformance</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ViewId</maml:name> <maml:description> <maml:para>A view id to test performance. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsViewOwner</maml:name> <maml:description> <maml:para>Indicate if using view owner's id to run the view to test performance. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAs</maml:name> <maml:description> <maml:para>Specify User Id to run the view to test performance. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsUserView</maml:name> <maml:description> <maml:para>Indicate if the view is user owned view. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-CrmViewPerformance</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ViewName</maml:name> <maml:description> <maml:para>A view name to test performance. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsViewOwner</maml:name> <maml:description> <maml:para>Indicate if using view owner's id to run the view to test performance. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAs</maml:name> <maml:description> <maml:para>Specify User Id to run the view to test performance. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsUserView</maml:name> <maml:description> <maml:para>Indicate if the view is user owned view. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>View</maml:name> <maml:description> <maml:para>A view record object to test performance. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsViewOwner</maml:name> <maml:description> <maml:para>Indicate if using view owner's id to run the view to test performance. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAs</maml:name> <maml:description> <maml:para>Specify User Id to run the view to test performance. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsUserView</maml:name> <maml:description> <maml:para>Indicate if the view is user owned view. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ViewId</maml:name> <maml:description> <maml:para>A view id to test performance. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ViewName</maml:name> <maml:description> <maml:para>A view name to test performance. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Test-CrmViewPerformance -conn $conn -ViewName "Active Accounts" </dev:code> <dev:remarks> <maml:para>This example test "Active Accounts" system view performance by using user of the connection. </maml:para> <maml:para /> <maml:para /> <maml:para>ViewName : Active Accounts FetchXml : <fetch version="1.0" output-format="xml-platform" mapping="logical"><entity name="account"><attribute name="name" /><attribute name="address1_city" /><order attribute="name" descending="false" /><attribute name="primarycontactid" /><attribute name="telephone1" /><filter type="and"><condition attribute="statecode" operator="eq" value="0" /></filter><link-entity alias="accountprimarycontactidcontactcontactid" name="contact" from="contactid" to="primarycontactid" link-type="outer" visible="false"><attribute name="emailaddress1" /></link-entity><attribute name="accountid" /></entity></fetch> Entity : Account Columns : 5 LayoutXml : <grid name="resultset" object="1" jump="name" select="1" icon="1" preview="1"><row name="result" id="accountid"><cell name="name" width="300" /><cell name="telephone1" width="100" /><cell name="address1_city" width="100" /><cell name="primarycontactid" width="150" /><cell name="accountprimarycontactidcontactcontactid.emailaddress1" width="150" disableSorting="1" /></row></grid> TotalRecords : 11 Owner : System Performance : The operation took 00:00:00.3948901</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Test-CrmViewPerformance -conn $conn -ViewId 00000000-0000-0000-00aa-000010001002 </dev:code> <dev:remarks> <maml:para>This example test view which has id of 00000000-0000-0000-00aa-000010001002 performance by using user of the connection. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Test-CrmViewPerformance -conn $conn -ViewName "Active Accounts" </dev:code> <dev:remarks> <maml:para>This example test "Active Accounts" system view performance by using user of the connection. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Test-CrmViewPerformance -conn $conn -ViewName "Active Accounts" -RunAs f9d40920-7a43-4f51-9749-0549c4caf67d </dev:code> <dev:remarks> <maml:para>This example test "Active Accounts" system view performance by using specified user. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Test-CrmViewPerformance -conn $conn -ViewName "My Custom View" -RunAsViewOwner -IsUserView </dev:code> <dev:remarks> <maml:para>This example test "My Custom View" user view performance by using view owner. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Add-CrmNoteToCrmRecord</command:name> <maml:description> <maml:para>Create a new note (annotation) to a record.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>CrmNoteToCrmRecord</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-CrmNoteToCrmRecord cmdlet lets you add a note (annotation) to a record. </maml:para> <maml:para>There are two ways to specify a target record. 1. Pass EntityLogicalName and record's Id. 2. Get a record object by using Get-CrmRecord/Get-CrmRecords cmdlets, and pass it.</maml:para> <maml:para>You can specify note subject and body by using -Subject and -NoteText parameters</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-CrmNoteToCrmRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>A record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Subject</maml:name> <maml:description> <maml:para>Subject of a note (annotation).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>NoteText</maml:name> <maml:description> <maml:para>Body Text of a note (annotation).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-CrmNoteToCrmRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname of the target record. i.e.)accout, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id</maml:name> <maml:description> <maml:para>An Id (guid) of the record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Subject</maml:name> <maml:description> <maml:para>Subject of a note (annotation).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>NoteText</maml:name> <maml:description> <maml:para>Body Text of a note (annotation).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>A record object which is obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Subject</maml:name> <maml:description> <maml:para>Subject of a note (annotation).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>NoteText</maml:name> <maml:description> <maml:para>Body Text of a note (annotation).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>A logicalname of the target record. i.e.)accout, contact, lead, etc..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id</maml:name> <maml:description> <maml:para>An Id (guid) of the record</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Add-CrmNote -conn $conn -EntityLogicalName account -Id 00005a70-6317-e511-80da-c4346bc43d94 -Subject "sample subject" -NoteText "sample body"</dev:code> <dev:remarks> <maml:para>This example add a note (annotation) to an account record.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Add-CrmNote account 00005a70-6317-e511-80da-c4346bc43d94 "sample subject" "sample body"</dev:code> <dev:remarks> <maml:para>This example add a note (annotation) to an account record by ommiting parameters names. When ommiting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmLicenseSummary</command:name> <maml:description> <maml:para>Displays License assignment and AccessMode/CalType summary. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmLicenseSummary</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmLicenseSummery cmdlet lets you display License assignment and AccessMode/CalType summery. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmLicenseSummary</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmLicenseSummary -conn $conn </dev:code> <dev:remarks> <maml:para>This example displays License assignment and AccessMode/CalType summery. </maml:para> <maml:para /> <maml:para /> <maml:para>IsLicensed: Count Name ----- ---- 4 Yes 2 No AccessMode: 3 Read-Write 1 Non-interactive 2 Administrative CalType: 3 Read-Write 1 Non-interactive 2 Administrative</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmLicenseSummary </dev:code> <dev:remarks> <maml:para>This example displays License assignment and AccessMode/CalType summery by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>IsLicensed: Count Name ----- ---- 4 Yes 2 No AccessMode: 3 Read-Write 1 Non-interactive 2 Administrative CalType: 3 Read-Write 1 Non-interactive 2 Administrative</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmOrgDbOrgSettings</command:name> <maml:description> <maml:para>Retrieves CrmOrgDbOrgSettings. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmOrgDbOrgSettings</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmOrgDbOrgSettings cmdlet lets you retrieve CrmOrgDbOrgSettings. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmOrgDbOrgSettings</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmOrgDbOrgSettings -conn $conn</dev:code> <dev:remarks> <maml:para>This example retrieves CrmOrgDbOrgSettings.</maml:para> <maml:para /> <maml:para /> <maml:para> ActivateAdditionalRefreshOfWorkflowConditions : false ActivityConvertDlgCampaignUnchecked : true ClientUEIPDisabled : false CreateSPFoldersUsingNameandGuid : true DisableSmartMatching : false</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmOrgDbOrgSettings contact</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para>ActivateAdditionalRefreshOfWorkflowConditions : false ActivityConvertDlgCampaignUnchecked : true ClientUEIPDisabled : false CreateSPFoldersUsingNameandGuid : true DisableSmartMatching : false This example retrieves CrmOrgDbOrgSettings by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmSiteMap</command:name> <maml:description> <maml:para>Retrieves CRM Organization's SiteMap information. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmSiteMap</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmSiteMap cmdlet lets you retrieve CRM Organization's SiteMap information. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmSiteMap</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SiteXml</maml:name> <maml:description> <maml:para>Specify SiteXml switch to retrieve SiteMapXml xml data. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-CrmSiteMap</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Areas</maml:name> <maml:description> <maml:para>Specify Areas switch to retrieve AreaIds list. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-CrmSiteMap</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupsOfArea</maml:name> <maml:description> <maml:para>Passing AreaId to GroupsOfArea parameter retrievs GroupIds of the specified Area. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-CrmSiteMap</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SubAreasOfArea</maml:name> <maml:description> <maml:para>Passing AreaId to SubAreasOfArea parameter retrievs SubAreaIds of the specified Area. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SiteXml</maml:name> <maml:description> <maml:para>Specify SiteXml switch to retrieve SiteMapXml xml data. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Areas</maml:name> <maml:description> <maml:para>Specify Areas switch to retrieve AreaIds list. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupsOfArea</maml:name> <maml:description> <maml:para>Passing AreaId to GroupsOfArea parameter retrievs GroupIds of the specified Area. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SubAreasOfArea</maml:name> <maml:description> <maml:para>Passing AreaId to SubAreasOfArea parameter retrievs SubAreaIds of the specified Area. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmSiteMap -conn $conn -SiteXml </dev:code> <dev:remarks> <maml:para>This example retrieves CRM Organization's SiteMap data. </maml:para> <maml:para /> <maml:para /> <maml:para><SiteMap IntroducedVersion="7.0.0.0"><Area Id="SFA" ResourceId="Area_Sales".. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmSiteMap -conn $conn -Areas </dev:code> <dev:remarks> <maml:para>This example retrieves AreaIds of CRM Organization's SiteMap. </maml:para> <maml:para /> <maml:para /> <maml:para>SFA CS MA Settings HLP</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmSiteMap -conn $conn -GroupsOfArea SFA </dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para>MyWork Customers SFA Collateral MA Goals Tools</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>This example retrieves GroupIds of CRM Organization's SiteMap. </dev:code> <dev:remarks> <maml:para>This example retrieves SubAreaIds of CRM Organization's SiteMap by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para>Get-CrmSiteMap -SubAreasOfArea SFA nav_dashboards nav_personalwall nav_activities nav_accts nav_conts nav_leads nav_oppts ...</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-CrmUserMailbox</command:name> <maml:description> <maml:para>Retrieves CRM user's mailbox. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>CrmUserMailbox</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-CrmUserMailbox cmdlet lets you retrieve CRM user's mailbox. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmUserMailbox</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>An Id (guid) of CRM User. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>An Id (guid) of CRM User. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmUserMailbox -conn $conn -UserId f9d40920-7a43-4f51-9749-0549c4caf67d </dev:code> <dev:remarks> <maml:para>This example retrieves User's mailbox. </maml:para> <maml:para /> <maml:para /> <maml:para>EnabledForOutgoingEmail : No ProcessAndDeleteEmails : No EmailServerProfile : Microsoft Exchange Online IncomingEmailDeliveryMethod : Server-Side Synchronization or Email Router OwnerId : nakamura kenichiro IsForwardMailbox : No ...</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmUserMailbox -conn $conn -UserId f9d40920-7a43-4f51-9749-0549c4caf67d -ShowDisplayName </dev:code> <dev:remarks> <maml:para>This example retrieves User's mailbox and shows DisplayName for each field. </maml:para> <maml:para /> <maml:para /> <maml:para>Enabled For Outgoing Email : No Delete Emails after Processing : No Server Profile : Microsoft Exchange Online Incoming Email : Server-Side Synchronization or Email Router Owner : nakamura kenichiro Is Forward Mailbox : No ...</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-CrmUserMailbox f9d40920-7a43-4f51-9749-0549c4caf67d -ShowDisplayName </dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para>Enabled For Outgoing Email : No Delete Emails after Processing : No Server Profile : Microsoft Exchange Online Incoming Email : Server-Side Synchronization or Email Router Owner : nakamura kenichiro Is Forward Mailbox : No ...</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-CrmUserManager</command:name> <maml:description> <maml:para>Sets CRM user's manager. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>CrmUserManager</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-CrmUserManager lets you set CRM user's manager. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-CrmUserManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>An Id (guid) of CRM User. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>An Id (guid) of Manager. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>KeepChildUsers</maml:name> <maml:description> <maml:para>Specify if you keep child users for the user. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>An Id (guid) of CRM User. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ManagerId</maml:name> <maml:description> <maml:para>An Id (guid) of Manager. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>KeepChildUsers</maml:name> <maml:description> <maml:para>Specify if you keep child users for the user. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmUserManager -conn $conn -UserId 3772fe6e-8a18-e511-80dc-c4346bc42d48 -ManagerId 5a18974c-ae18-e511-80dd-c4346bc44d24 -KeepChildUsers $True </dev:code> <dev:remarks> <maml:para>This example sets a manager to a CRM User and keeps its child users. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmUserManager 3772fe6e-8a18-e511-80dc-c4346bc42d48 5a18974c-ae18-e511-80dd-c4346bc44d24 $True </dev:code> <dev:remarks> <maml:para>This example sets a manager to a CRM User and keeps its child users by omitting parameters names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-CrmUserSettings</command:name> <maml:description> <maml:para>Update CRM user's settings.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>CrmUserSettings</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-CrmUserSettings cmdlet lets you update CRM user's settings.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-CrmUserSettings</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>A CRMUserSettings object. Use Get-CrmUserSettings to retrieve the setting.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>A CRMUserSettings object. Use Get-CrmUserSettings to retrieve the setting.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>$userSettings = Get-CrmUserSettings -conn $conn -UserId (Get-MyCrmUserId) -Fields * PS C:\>$userSettings.timezonecode = 4 PS C:\>Set-CrmUserSettings -conn $conn -CrmRecord $userSettings</dev:code> <dev:remarks> <maml:para>This example retrieves retrieves all fields from login User's UserSettings update TimeZone to Pacific Time. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>PS C:\>$userSettings = Get-CrmUserSettings (Get-MyCrmUserId) * PS C:\>$userSettings.paginglimit = 100 PS C:\>Set-CrmUserSettings $userSettings</dev:code> <dev:remarks> <maml:para>This example retrieves all fields from login User's UserSettings and update PagingLimit to 100 by omitting parameter names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Publish-CrmCustomization</command:name> <maml:description> <maml:para>Publishes specified customizations for a CRM Organization.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Publish</command:verb> <command:noun>CrmCustomization</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Publish-CrmCustomization cmdlet lets you publish specified customizations. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Publish-CrmCustomization</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Entity</maml:name> <maml:description> <maml:para>Specify this when you publish Entity. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalNames</maml:name> <maml:description> <maml:para>Array of Entity Logical Name to publish. Use with -Entity switch. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Ribbon</maml:name> <maml:description> <maml:para>Specify this to publish Ribbon. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SiteMap</maml:name> <maml:description> <maml:para>Specify this to publish SiteMap. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Dashbord</maml:name> <maml:description> <maml:para>Specify this when you publish Dashboard. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="2"> <maml:name>DashbordIds</maml:name> <maml:description> <maml:para>Array of Dashboard Id to publish. Use with -Dashboard switch. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OptionSet</maml:name> <maml:description> <maml:para>Specify this when you publish OptionSet. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="3"> <maml:name>OptionSetNames</maml:name> <maml:description> <maml:para>Array of OptionSet Logical Name to publish. Use with -OptionSet switch. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WebResource</maml:name> <maml:description> <maml:para>Specify this when you publish WebResource. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="4"> <maml:name>WebResourceIds</maml:name> <maml:description> <maml:para>Array of WebResource Ids to publish. Use with -WebResource switch. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Entity</maml:name> <maml:description> <maml:para>Specify this when you publish Entity. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalNames</maml:name> <maml:description> <maml:para>Array of Entity Logical Name to publish. Use with -Entity switch. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Ribbon</maml:name> <maml:description> <maml:para>Specify this to publish Ribbon. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SiteMap</maml:name> <maml:description> <maml:para>Specify this to publish SiteMap. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Dashbord</maml:name> <maml:description> <maml:para>Specify this when you publish Dashboard. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="2"> <maml:name>DashbordIds</maml:name> <maml:description> <maml:para>Array of Dashboard Id to publish. Use with -Dashboard switch. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OptionSet</maml:name> <maml:description> <maml:para>Specify this when you publish OptionSet. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="3"> <maml:name>OptionSetNames</maml:name> <maml:description> <maml:para>Array of OptionSet Logical Name to publish. Use with -OptionSet switch. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WebResource</maml:name> <maml:description> <maml:para>Specify this when you publish WebResource. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="4"> <maml:name>WebResourceIds</maml:name> <maml:description> <maml:para>Array of WebResource Ids to publish. Use with -WebResource switch. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Publish-CrmCustomization -conn $conn -Entity -EntityLogicalNames account,contact,systemuser </dev:code> <dev:remarks> <maml:para>This example publishes Account, Contact and System Entity Metadata. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Publish-CrmCustomization -conn $conn -Ribbon -SiteMap </dev:code> <dev:remarks> <maml:para>This example publishes Ribbon and SiteMap </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Publish-CrmCustomization -conn $conn -Dashbord -DashbordIds 79dcdea7-490a-46ed-a887-9ed87fe39d66,90a32046-973e-4370-ad3f-06b9e73ed036 </dev:code> <dev:remarks> <maml:para>This example publishes specified Dashboards.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Grant-CrmRecordAccess</command:name> <maml:description> <maml:para>Grant access privilege to a crm record.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Grant</command:verb> <command:noun>CrmRecordAccess</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Grant-CrmRecordAccess cmdlet lets you grant a security principal (user or team) access to the specified record. The operation will create access rights if none already exist, or be additive to any existing access rights already granted. That is, if a principal has pre-existing access rights to a record, any new access rights specified in executing this cmdlet are granted and no existing rights are removed. Note that the append right requires both AppendAccess and AppendToAccess to be specified.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Grant-CrmRecordAccess</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>The record object to grant access to, obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSObject[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Principal</maml:name> <maml:description> <maml:para>The principal (user or team) being granted access rights to the record. Use New-CrmEntityReference <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">EntityReference</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>AccessMask</maml:name> <maml:description> <maml:para>The access rights to grant the principal over the record. Assign multiple values to generate the full value, e.g. AppendAccess,ReadAccess,WriteAccess.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AccessRights</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Grant-CrmRecordAccess</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>The logical name of an entity to grant access to, i.e. account, contact, lead, etc.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of a record to grant access to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Principal</maml:name> <maml:description> <maml:para>The principal (user or team) being granted access rights to the record. Use New-CrmEntityReference <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">EntityReference</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>AccessMask</maml:name> <maml:description> <maml:para>The access rights to grant the principal over the record. Assign multiple values to generate the full value, e.g. AppendAccess,ReadAccess,WriteAccess.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AccessRights</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>The record object to grant access to, obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Principal</maml:name> <maml:description> <maml:para>The principal (user or team) being granted access rights to the record. Use New-CrmEntityReference <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">EntityReference</command:parameterValue> <dev:type> <maml:name>EntityReference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>AccessMask</maml:name> <maml:description> <maml:para>The access rights to grant the principal over the record. Assign multiple values to generate the full value, e.g. AppendAccess,ReadAccess,WriteAccess.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AccessRights</command:parameterValue> <dev:type> <maml:name>AccessRights</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>The logical name of an entity to grant access to, i.e. account, contact, lead, etc.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of a record to grant access to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Grant-CrmRecordAccess -conn $conn -CrmRecord $contact -Principal $team -AccessMask AppendAccess,AppendToAccess,ReadAccess,WriteAccess</dev:code> <dev:remarks> <maml:para>This example grants a team append, read, and write access to a contact record.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$contact | Grant-CrmRecordAccess -conn $conn -Principal $team -AccessMask ReadAccess,WriteAccess,DeleteAccess</dev:code> <dev:remarks> <maml:para>This example pipes a contact to Grant-CrmRecordAccess and grants a team read, write, and delete access to it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Import-CrmSolutionAsync</command:name> <maml:description> <maml:para>Import a solution using an import job.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>CrmSolutionAsync</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Import a solution using an import job and poll for the result (success or failure). This is the preferred method of importing. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-CrmSolutionAsync</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SolutionFilePath</maml:name> <maml:description> <maml:para>A file path to solution zip file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ActivateWorkflows</maml:name> <maml:description> <maml:para>Specify the parameter to active plug-ins when importing solution.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>OverwriteUnManagedCustomizations</maml:name> <maml:description> <maml:para>Specify the parameter to overwrite conflicting unmanaged customizations when importing solution. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>SkipDependancyOnProductUpdateCheckOnInstall</maml:name> <maml:description> <maml:para>Specify the parameter to skip dependency check when importing solution. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>PublishChanges</maml:name> <maml:description> <maml:para>Automatically publish the changes if the import completes before the max wait time</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>MaxWaitTimeInSeconds</maml:name> <maml:description> <maml:para>Specify the parameter to override the default maximum 900 seconds (15 minutes) to wait for an imported solution to complete. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="7"> <maml:name>ImportAsHoldingSolution</maml:name> <maml:description> <maml:para>Import as a holding solution</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="8"> <maml:name>BlockUntilImportComplete</maml:name> <maml:description> <maml:para>Rather than return the import ID - block and poll until the command is complete</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="9"> <maml:name>PollingDelayInSeconds</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SolutionFilePath</maml:name> <maml:description> <maml:para>A file path to solution zip file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ActivateWorkflows</maml:name> <maml:description> <maml:para>Specify the parameter to active plug-ins when importing solution.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>OverwriteUnManagedCustomizations</maml:name> <maml:description> <maml:para>Specify the parameter to overwrite conflicting unmanaged customizations when importing solution. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>SkipDependancyOnProductUpdateCheckOnInstall</maml:name> <maml:description> <maml:para>Specify the parameter to skip dependency check when importing solution. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>PublishChanges</maml:name> <maml:description> <maml:para>Automatically publish the changes if the import completes before the max wait time</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>MaxWaitTimeInSeconds</maml:name> <maml:description> <maml:para>Specify the parameter to override the default maximum 900 seconds (15 minutes) to wait for an imported solution to complete. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="7"> <maml:name>ImportAsHoldingSolution</maml:name> <maml:description> <maml:para>Import as a holding solution</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="8"> <maml:name>BlockUntilImportComplete</maml:name> <maml:description> <maml:para>Rather than return the import ID - block and poll until the command is complete</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="9"> <maml:name>PollingDelayInSeconds</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Import-CrmSolutionAsync -SolutionFilePath c:\temp\mysolution.zip -ActivateWorkflows -OverwriteUnManagedCustomizations -MaxWaitTimeInSeconds 600</dev:code> <dev:remarks> <maml:para>Import a solution using an import job, poll for the result for up to 600 seconds</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Publish-CrmTheme</command:name> <maml:description> <maml:para>Publishes a Theme for a CRM Organization.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Publish</command:verb> <command:noun>CrmTheme</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Publish-CrmTheme cmdlet lets you publish a Theme.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Publish-CrmTheme</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ThemeName</maml:name> <maml:description> <maml:para>Name of the Theme you want to publish.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Publish-CrmTheme</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ThemeId</maml:name> <maml:description> <maml:para>Id for the Theme you want to publish.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ThemeName</maml:name> <maml:description> <maml:para>Name of the Theme you want to publish.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ThemeId</maml:name> <maml:description> <maml:para>Id for the Theme you want to publish.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Publish-CrmTheme -conn $conn -ThemeName "CRM Default Theme"</dev:code> <dev:remarks> <maml:para>This example publishes "CRM Default Theme" theme.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Publish-CrmTheme -conn $conn -ThemeId f499443d-2082-4938-8842-e7ee62de9a23</dev:code> <dev:remarks> <maml:para>This example publishes theme with id "This example publishes "CRM Default Theme" theme."</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Revoke-CrmRecordAccess</command:name> <maml:description> <maml:para>Revokes (removes) access rights on the target record for the specified security principal (user or team).</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Revoke</command:verb> <command:noun>CrmRecordAccess</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Revoke-CrmRecordAccess cmdlet lets you remove a security principal's (user or team) previously granted access to a specified record.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Revoke-CrmRecordAccess</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>The record object to revoke access to, obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSObject[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Revokee</maml:name> <maml:description> <maml:para>The principal (user or team) whose access rights are to be revoked from the record. Use New-CrmEntityReference <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">EntityReference</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Revoke-CrmRecordAccess</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para> # The logical name of an entity to revoke access to, i.e. account, contact, lead, etc.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id</maml:name> <maml:description> <maml:para># The Id of a record to revoke access to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Revokee</maml:name> <maml:description> <maml:para>The principal (user or team) whose access rights are to be revoked from the record. Use New-CrmEntityReference <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">EntityReference</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>The record object to revoke access to, obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Revokee</maml:name> <maml:description> <maml:para>The principal (user or team) whose access rights are to be revoked from the record. Use New-CrmEntityReference <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">EntityReference</command:parameterValue> <dev:type> <maml:name>EntityReference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para> # The logical name of an entity to revoke access to, i.e. account, contact, lead, etc.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id</maml:name> <maml:description> <maml:para># The Id of a record to revoke access to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Revoke-CrmRecordAccess -conn $conn -CrmRecord $contact -Principal $team </dev:code> <dev:remarks> <maml:para>This example revokes a team's access rights to a contact record.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$contact | Revoke-CrmRecordAccess -conn $conn -Principal $team</dev:code> <dev:remarks> <maml:para>This example pipes a contact to Revoke-CrmRecordAccess and removes a team's access rights to the contact.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-CrmRecordAccess</command:name> <maml:description> <maml:para>Sets a security principal's (user or team) access to the specified record.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>CrmRecordAccess</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-CrmRecordAccess cmdlet sets a security principal's (user or team) access to the specified record. The operation creates access rights if none exist, or replaces existing access rights. That is, if a principal has been granted pre-existing access rights to a record, any access rights specified in executing this cmdlet are granted and any existing access rights not specified are removed. Note that the append right requires both AppendAccess and AppendToAccess to be specified.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-CrmRecordAccess</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>The record object to grant access to, obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSObject[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Principal</maml:name> <maml:description> <maml:para>The principal (user or team) being granted access rights to the record. Use New-CrmEntityReference <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">EntityReference</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>AccessMask</maml:name> <maml:description> <maml:para>The access rights to grant the principal over the record. Assign multiple values to generate the full value, e.g. AppendAccess,ReadAccess,WriteAccess.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AccessRights</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-CrmRecordAccess</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>The logical name of an entity to grant access to, i.e. account, contact, lead, etc.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of a record to grant access to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Principal</maml:name> <maml:description> <maml:para>The principal (user or team) being granted access rights to the record. Use New-CrmEntityReference <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">EntityReference</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>AccessMask</maml:name> <maml:description> <maml:para>The access rights to grant the principal over the record. Assign multiple values to generate the full value, e.g. AppendAccess,ReadAccess,WriteAccess.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AccessRights</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>CrmRecord</maml:name> <maml:description> <maml:para>The record object to grant access to, obtained via Get-CrmRecord/Get-CrmRecords. When you pass CrmRecord, then you don't use EntityLogicalName/Id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Principal</maml:name> <maml:description> <maml:para>The principal (user or team) being granted access rights to the record. Use New-CrmEntityReference <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">EntityReference</command:parameterValue> <dev:type> <maml:name>EntityReference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>AccessMask</maml:name> <maml:description> <maml:para>The access rights to grant the principal over the record. Assign multiple values to generate the full value, e.g. AppendAccess,ReadAccess,WriteAccess.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AccessRights</command:parameterValue> <dev:type> <maml:name>AccessRights</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>EntityLogicalName</maml:name> <maml:description> <maml:para>The logical name of an entity to grant access to, i.e. account, contact, lead, etc.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of a record to grant access to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmRecordAccess -conn $conn -CrmRecord $contact -Principal $team -AccessMask AppendAccess,AppendToAccess,ReadAccess,WriteAccess </dev:code> <dev:remarks> <maml:para>This example grants a team append, read, and write access to a contact record. Any other access rights previously assigned would be revoked.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$contact | Set-CrmRecordAccess -conn $conn -Principal $team -AccessMask ReadAccess,WriteAccess,DeleteAccess</dev:code> <dev:remarks> <maml:para>This example pipes a contact to Set-CrmRecordAccess and grants a team read, write, and delete access to it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-CrmSolutionVersionNumber</command:name> <maml:description> <maml:para>Sets a CDS Solutions version number.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>CrmSolutionVersionNumber</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Sets a CDS Solutions version number in the CDS Database via an api call </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-CrmSolutionVersionNumber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>Name of solution </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>VersionNumber</maml:name> <maml:description> <maml:para>Version Number</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>SolutionName</maml:name> <maml:description> <maml:para>Name of solution </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>VersionNumber</maml:name> <maml:description> <maml:para>Version Number</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Revoke-CrmEmailAddress</command:name> <maml:description> <maml:para>Revoke email address change of a user or a queue.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Revoke</command:verb> <command:noun>CrmEmailAddress</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Revoke-CrmEmailAddress cmdlet lets you revoke email address change of a user or a queue. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Revoke-CrmEmailAddress</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>A record Id of User. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Revoke-CrmEmailAddress</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>QueueId</maml:name> <maml:description> <maml:para>A record Id of Queue. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>UserId</maml:name> <maml:description> <maml:para>A record Id of User. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>QueueId</maml:name> <maml:description> <maml:para>A record Id of Queue. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Revoke-CrmEmailAddress -conn $conn -UserId 00005a70-6317-e511-80da-c4346bc43d94 </dev:code> <dev:remarks> <maml:para>This example revokes email address for a user. </maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Revoke-CrmEmailAddress -UserId 00005a70-6317-e511-80da-c4346bc43d94 </dev:code> <dev:remarks> <maml:para>This example revokes email address for a user by omitting parameters names. When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Revoke-CrmEmailAddress -conn $conn -QueueId 00005a70-6317-e511-80da-c4346bc43d94 </dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Invoke-CrmAction</command:name> <maml:description> <maml:para>Invoke a CDS or CRM Action</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>CrmAction</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Invoke a CDS or CRM Action</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-CrmAction</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Parameters</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>Target</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">EntityReference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Parameters</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="3"> <maml:name>Target</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">EntityReference</command:parameterValue> <dev:type> <maml:name>EntityReference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Raw</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Microsoft.Xrm.Sdk.OrganizationResponse</maml:name> <maml:uri /> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- -------------------------- Example 1 -------------------------- --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Invoke-CrmAction -conn $conn -Name "new_NoOutputs"</dev:code> <dev:remarks> <maml:para>This example shows the execution of a custom unbound action named "new_NoOutputs" that doesn't accept any input arguments and doesn't return any output arguments. There is no output because the action doesn't have any output arguments.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- -------------------------- Example 2 -------------------------- --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Invoke-CrmAction -conn $conn -Name 'new_NoInputs'</dev:code> <dev:remarks> <maml:para>This example shows the execution of a custom unbound action named 'new_NoInputs' that doesn't accept any input arguments and returns the output arguments in a [hashtable]. The output consists of a single Boolean argument named 'Output'.</maml:para> <maml:para /> <maml:para /> <maml:para>Name Value ---- ----- Output True</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- -------------------------- Example 3 -------------------------- --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Invoke-CrmAction -conn $conn -Name 'new_Echo' -Parameters @{BooleanInput=$true;DateTimeInput=[DateTime]::Now}</dev:code> <dev:remarks> <maml:para>This example shows the execution of a custom unbound action named 'new_Echo' that accepts two input arguments and returns them as output argments in a hastable, along with returning one output argument for each type of each possible output argument type supported by actions.</maml:para> <maml:para /> <maml:para /> <maml:para> Name Value ---- ----- BooleanOutput True DateTimeOutput 3/2/2017 6:51:20 AM IntegerOutput 1234 PicklistOutput Microsoft.Xrm.Sdk.OptionSetValue FloatOutput 1.234 EntityReferenceOutput Microsoft.Xrm.Sdk.EntityReference StringOutput This is a string DecimalOutput 1.234 MoneyOutput Microsoft.Xrm.Sdk.Money</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- -------------------------- Example 4 -------------------------- --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Invoke-CrmAction -conn $conn -Name 'new_ContactBound' -Target $contactRef -Parameters @{Activate = $true }</dev:code> <dev:remarks> <maml:para>This example shows the execution of an unbound action named 'new_ContactBound' that is bound to the contact entity, with the contact record to process being the $contactRef [Microsoft.Xrm.Sdk.EntityReference] object (see New-CrmEntityReference). There are no output arguments and as no return value.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- -------------------------- Example 5 -------------------------- --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$contactRef1,$contactRef2 | Invoke-CrmAction -conn $conn -Name 'new_ContactBound' -Parameters @{Activate = $true } -Raw</dev:code> <dev:remarks> <maml:para>This example shows the execution of an unbound action named 'new_ContactBound' that is bound to the contact entity, with the contact records to process being piped to Invoke-CrmAction, and the use of the -Raw switch. The action doesn't have any output arguments and as such would normally not have any output, but because the -Raw switch is used the output includes the two original unparsed [Microsoft.Xrm.Sdk.OrganizationResponse] objects, one for each invocation of the action.</maml:para> <maml:para /> <maml:para /> <maml:para> ResponseName Results ExtensionData ------------ ------- ------------- new_ContactBound {} System.Runtime.Serialization.ExtensionDataObject new_ContactBound {} System.Runtime.Serialization.ExtensionDataObject</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-CrmQueueMailbox</command:name> <maml:description> <maml:para>Sets the CRM mailbox for a given queue</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>CrmQueueMailbox</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Sets the CRM mailbox for a given queue.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-CrmQueueMailbox</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>QueueId</maml:name> <maml:description> <maml:para>An Id of queue. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>An EmailAddress of the queue. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EmailServerProfile</maml:name> <maml:description> <maml:para>Change "Server Profile" setting of Synchronization Method. This parameter accepts Email Server Profile record's guid. To get all profiles, use Get-CrmEmailServerProfiles command and use ProfileId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncomingEmailDeliveryMethod</maml:name> <maml:description> <maml:para>Change "Incoming Email" setting for Configure default synchronization method. This parameter accepts int. To get all options, use Get-CrmEntityOptionSet mailbox incomingemaildeliverymethod | % Items command and use PickListItemId.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutgoingEmailDeliveryMethod</maml:name> <maml:description> <maml:para>Change "Outgoing Email" setting for Configure default synchronization method. This parameter accepts int. To get all options, use Get-CrmEntityOptionSet mailbox outgoingemaildeliverymethod | % Items command and use PickListItemId.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-CrmQueueMailbox</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>QueueId</maml:name> <maml:description> <maml:para>An Id of queue. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>An EmailAddress of the queue. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplyDefaultEmailSettings</maml:name> <maml:description> <maml:para>Specify this to apply the organization default settings</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-CrmQueueMailbox</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>QueueId</maml:name> <maml:description> <maml:para>An Id of queue. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>An EmailAddress of the queue. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StateCode</maml:name> <maml:description> <maml:para>StateCode value for a record. You can retrieve values by using Get-CrmEntityOptionSet <EntityLogicalName> statecode | % {$_.Items} </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StatusCode</maml:name> <maml:description> <maml:para>StatusCode value for a record. You can retrieve values by using Get-CrmEntityOptionSet <EntityLogicalName> statuscode | % {$_.Items}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ScheduleTest</maml:name> <maml:description> <maml:para>Specify this to schedule test for the mailbox</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MarkedAsPrimaryForExchangeSync</maml:name> <maml:description> <maml:para>Specify this to mark the mailbox as primary mailbox to sync with Exchange Online</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApproveEmail</maml:name> <maml:description> <maml:para>Specify this to approve the emailaddress.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>QueueId</maml:name> <maml:description> <maml:para>An Id of queue. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EmailAddress</maml:name> <maml:description> <maml:para>An EmailAddress of the queue. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EmailServerProfile</maml:name> <maml:description> <maml:para>Change "Server Profile" setting of Synchronization Method. This parameter accepts Email Server Profile record's guid. To get all profiles, use Get-CrmEmailServerProfiles command and use ProfileId. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncomingEmailDeliveryMethod</maml:name> <maml:description> <maml:para>Change "Incoming Email" setting for Configure default synchronization method. This parameter accepts int. To get all options, use Get-CrmEntityOptionSet mailbox incomingemaildeliverymethod | % Items command and use PickListItemId.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutgoingEmailDeliveryMethod</maml:name> <maml:description> <maml:para>Change "Outgoing Email" setting for Configure default synchronization method. This parameter accepts int. To get all options, use Get-CrmEntityOptionSet mailbox outgoingemaildeliverymethod | % Items command and use PickListItemId.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApplyDefaultEmailSettings</maml:name> <maml:description> <maml:para>Specify this to apply the organization default settings</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StateCode</maml:name> <maml:description> <maml:para>StateCode value for a record. You can retrieve values by using Get-CrmEntityOptionSet <EntityLogicalName> statecode | % {$_.Items} </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StatusCode</maml:name> <maml:description> <maml:para>StatusCode value for a record. You can retrieve values by using Get-CrmEntityOptionSet <EntityLogicalName> statuscode | % {$_.Items}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ScheduleTest</maml:name> <maml:description> <maml:para>Specify this to schedule test for the mailbox</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MarkedAsPrimaryForExchangeSync</maml:name> <maml:description> <maml:para>Specify this to mark the mailbox as primary mailbox to sync with Exchange Online</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApproveEmail</maml:name> <maml:description> <maml:para>Specify this to approve the emailaddress.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmQueueMailbox -conn $conn -QueueId f9d40920-7a43-4f51-9749-0549c4caf67d -IncomingEmailDeliveryMethod 0</dev:code> <dev:remarks> <maml:para>This example updates "Incoming Email" setting to "None".</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmQueueMailbox -conn $conn -QueueId f9d40920-7a43-4f51-9749-0549c4caf67d -EmailServerProfile 1b2d4b03-831e-e511-80e1-c4346bc44d24</dev:code> <dev:remarks> <maml:para>This example updates "Server Profile" setting to specified Profile.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmQueueMailbox -conn $conn -QueueId f9d40920-7a43-4f51-9749-0549c4caf67d -ApplyDefaultEmailSettings</dev:code> <dev:remarks> <maml:para>This example updates mailbox email settings to default settings, which is in System Settings.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmQueueMailbox -QueueId f9d40920-7a43-4f51-9749-0549c4caf67d -IncomingEmailDeliveryMethod 0</dev:code> <dev:remarks> <maml:para>This example disables "Incoming Email" setting to "None" by omitting -conn parameter. When omitting conn parameter, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmQueueMailbox -QueueId f9d40920-7a43-4f51-9749-0549c4caf67d -ApplyDefaultEmailSettings</dev:code> <dev:remarks> <maml:para>This example updates mailbox email settings to default settings, which is in System Settings by omitting -conn parameter. When omitting conn parameter, cmdlets automatically finds it.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-CrmQueueMailbox -conn $conn -QueueId f9d40920-7a43-4f51-9749-0549c4caf67d -StateCode Active -StatusCode Active -ScheduleTest -MarkedAsPrimaryForExchangeSync -ApproveEmail</dev:code> <dev:remarks> <maml:para>This example activates mailbox, approve emailaddress, schedule test and set the mailbox as primary for sync with Exchange Online.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Merge-CrmHoldingSolutionAsync</command:name> <maml:description> <maml:para>Merges a holding solution.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Merge</command:verb> <command:noun>CrmHoldingSolutionAsync</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Merges a holding solution using the DeleteAndPromoteRequest</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Merge-CrmHoldingSolutionAsync</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>The connection to the CRM organization. Use Get-CrmConnection or one of the other connection functions to get it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CrmSolutionName</maml:name> <maml:description> <maml:para>The unique name of the base solution to apply the upgrade.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>MaxWaitTimeInSeconds</maml:name> <maml:description> <maml:para>The polling delay in seconds, to check wether the delete and promote async operation has finished. If specified, it will override the default value of 5 seconds. After the max time expires, the command will still execute in the background but the powershell code will continue</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>BlockUntilImportComplete</maml:name> <maml:description> <maml:para>If specified, the execution will poll and wait for the delete and promote async operation to complete. If not specified, it will return the asyncoperationid immediatelly and the operation will continue to execute asynchronously on Dynamics organization.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>PollingDelayInSeconds</maml:name> <maml:description> <maml:para>The polling delay in seconds, to check wether the delete and promote async operation has finished. If specified, it will override the default value of 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>conn</maml:name> <maml:description> <maml:para>The connection to the CRM organization. Use Get-CrmConnection or one of the other connection functions to get it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CrmServiceClient</command:parameterValue> <dev:type> <maml:name>CrmServiceClient</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>CrmSolutionName</maml:name> <maml:description> <maml:para>The unique name of the base solution to apply the upgrade.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>PollingDelayInSeconds</maml:name> <maml:description> <maml:para>The polling delay in seconds, to check wether the delete and promote async operation has finished. If specified, it will override the default value of 5 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>MaxWaitTimeInSeconds</maml:name> <maml:description> <maml:para>The polling delay in seconds, to check wether the delete and promote async operation has finished. If specified, it will override the default value of 5 seconds. After the max time expires, the command will still execute in the background but the powershell code will continue</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>BlockUntilImportComplete</maml:name> <maml:description> <maml:para>If specified, the execution will poll and wait for the delete and promote async operation to complete. If not specified, it will return the asyncoperationid immediatelly and the operation will continue to execute asynchronously on Dynamics organization.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Merge-CrmHoldingSolutionAsync -conn $conn -CrmSolutionName "SampleSolution"</dev:code> <dev:remarks> <maml:para>This example requests a delete and promote message regarding a Dynamics solution named "SampleSolution" and returns the system job id.</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Merge-CrmHoldingSolutionAsync -conn $conn -CrmSolutionName "SampleSolution" -MaxWaitTimeInSeconds 900 -PollingDelayInSeconds 60 -BlockUntilImportComplete</dev:code> <dev:remarks> <maml:para>This example requests a delete and promote message regarding a Dynamics solution named "SampleSolution", while specifying that the execution should wait for the system job to finish and should poll the job every 60 seconds. It also sets a maximum blocking/polling time of 15 minutes (900 seconds). After the max time expires, the command will still execute in the background but the powershell code will continue</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Disable-CrmConnectorVerboseLogging</command:name> <maml:description> <maml:para>Disable verbsoe logging for the CDS connector.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>CrmConnectorVerboseLogging</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Disable verbsoe logging for the CDS connector.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-CrmConnectorVerboseLogging</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Enable-CrmConnectorVerboseLogging</command:name> <maml:description> <maml:para>Enable verbsoe logging for the CDS connector.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>CrmConnectorVerboseLogging</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Enable verbsoe logging for the CDS connector.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-CrmConnectorVerboseLogging</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>filePath</maml:name> <maml:description> <maml:para>Valid path to the file you wish to have log entries pushed into</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>filePath</maml:name> <maml:description> <maml:para>Valid path to the file you wish to have log entries pushed into</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> </helpItems> |