Microsoft.Xrm.OnlineManagementAPI.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Backup-CrmInstance</command:name> <command:verb>Backup</command:verb> <command:noun>CrmInstance</command:noun> <maml:description> <maml:para>Initiates a back up a Dynamics 365 Customer Engagement (online) instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Backup-CrmInstance cmdlet initiates a back up of a Dynamics 365 Customer Engagement (online) instance.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Backup-CrmInstance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Dynamics 365 Customer Enagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Label</maml:name> <maml:Description> <maml:para>Add a label to use to reference the backup.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Notes</maml:name> <maml:Description> <maml:para>Add comments about the backup.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Label</maml:name> <maml:Description> <maml:para>Add a label to use to reference the backup.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Notes</maml:name> <maml:Description> <maml:para>Add comments about the backup.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Backup-CrmInstance -ApiUrl $connectionhost -Credential $cred -Label "BackupLabel" -Notes "Notes on backup"</dev:code> <dev:remarks> <maml:para>Backs up the instance from information specified in the BackupInfo parameter.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disable-CrmAdminMode</command:name> <command:verb>Disable</command:verb> <command:noun>CrmAdminMode</command:noun> <maml:description> <maml:para>Disables administration mode on a sandbox instance that has administration mode enabled.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-CrmAdminMode cmdlet disables administration mode on a sandbox instance that has administration mode enabled. When you place a Sandbox instance in administration mode only users with Dynamics 365 System Administrator or System Customizer security roles will be able to sign in to that instance. Administration mode is useful when you want to make operational changes and not have regular users affect your work, and not have your work affect regular users.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-CrmAdminMode</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>AdminModeSettings</maml:name> <maml:Description> <maml:para>You create the object for this parameter by running the New-CrmAdminModeSetting cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">InstanceAdminModeSettings</command:parameterValue> <dev:type> <maml:name>InstanceAdminModeSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>InstanceId</maml:name> <maml:Description> <maml:para>Instance Id for the specific instance of Dynamics 365 Customer Engagement (online). Use the Get-CrmInstances cmdlet to find all instance Ids within the same tenant.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ValidateOnly</maml:name> <maml:Description> <maml:para>Validates whether the operation will succeed without committing any changes.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>AdminModeSettings</maml:name> <maml:Description> <maml:para>You create the object for this parameter by running the New-CrmAdminModeSetting cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">InstanceAdminModeSettings</command:parameterValue> <dev:type> <maml:name>InstanceAdminModeSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>InstanceId</maml:name> <maml:Description> <maml:para>Instance Id for the specific instance of Dynamics 365 Customer Engagement (online). Use the Get-CrmInstances cmdlet to find all instance Ids within the same tenant.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ValidateOnly</maml:name> <maml:Description> <maml:para>Validates whether the operation will succeed without committing any changes.</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>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Xrm.Services.Admin.Client.Models.InstanceAdminModeSettings</maml:name> </dev:type> <maml:description> <maml:para>System.Guid System.Management.Automation.SwitchParameter System.Uri System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Disable-CrmAdminMode -InstanceId <Instance Id> -ValidateOnly -ApiUrl $connectionhost -Credential $cred</dev:code> <dev:remarks> <maml:para>Validates whether the specified instance can be enabled for administration mode.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2</maml:title> <dev:code>PS C:\> Disable-CrmAdminMode -InstanceId <Instance Id> -AdminModeSettings $MyAdminModeSetting -ApiUrl $connectionhost -Credential $cred</dev:code> <dev:remarks> <maml:para>Disables the specified instance for administration mode and uses additional parameters set by the $MyAdminModeSetting object that is created running the New-CrmAdminModeSetting cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-CrmAdminModeSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-CrmAdminMode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disable-CrmManagementApp</command:name> <command:verb>Disable</command:verb> <command:noun>CrmManagementApp</command:noun> <maml:description> <maml:para>Disables the specified registered Azure Active Directory Web app/API application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-CrmManagementApp cmdlet disables the specified registered Azure Active Directory Web app/API application.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-CrmManagementApp</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The registration id for the app. You can find the registration ids for all registered Azure Active Directory Web app/API applications by running the Get-CrmManagementApps cmdlet.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The registration id for the app. You can find the registration ids for all registered Azure Active Directory Web app/API applications by running the Get-CrmManagementApps cmdlet.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para>System.Uri System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Disable-CrmManagementApp -Id <RegistrationGuid> -ApiUrl $connectionhost -Credential $cred</dev:code> <dev:remarks> <maml:para>Disables the specified registered Azure Active Directory Web app/API application.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-CrmManagementApp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CrmManagementApps</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Enable-CrmAdminMode</command:name> <command:verb>Enable</command:verb> <command:noun>CrmAdminMode</command:noun> <maml:description> <maml:para>Enables administration mode on a sandbox instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-CrmAdminMode cmdlet enables administration mode on a sandbox instance. When you place a Sandbox instance in administration mode only users with Dynamics 365 System Administrator or System Customizer security roles will be able to sign in to that instance. Administration mode is useful when you want to make operational changes and not have regular users affect your work, and not have your work affect regular users.</maml:para> <maml:para>You can find whether a sandbox instance is enabled for administration mode by running the Get-CrmInstances cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-CrmAdminMode</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>AdminModeSettings</maml:name> <maml:Description> <maml:para>You create the object for this parameter by running the New-CrmAdminModeSetting cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">InstanceAdminModeSettings</command:parameterValue> <dev:type> <maml:name>InstanceAdminModeSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>InstanceId</maml:name> <maml:Description> <maml:para>Instance Id for the specific instance of Dynamics 365 Customer Engagement (online). Use the Get-CrmInstances cmdlet to find all instance Ids within the same tenant.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ValidateOnly</maml:name> <maml:Description> <maml:para>Validates whether the operation will succeed without committing any changes.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>AdminModeSettings</maml:name> <maml:Description> <maml:para>You create the object for this parameter by running the New-CrmAdminModeSetting cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">InstanceAdminModeSettings</command:parameterValue> <dev:type> <maml:name>InstanceAdminModeSettings</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>InstanceId</maml:name> <maml:Description> <maml:para>Instance Id for the specific instance of Dynamics 365 Customer Engagement (online). Use the Get-CrmInstances cmdlet to find all instance Ids within the same tenant.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ValidateOnly</maml:name> <maml:Description> <maml:para>Validates whether the operation will succeed without committing any changes.</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>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Xrm.Services.Admin.Client.Models.InstanceAdminModeSettings</maml:name> </dev:type> <maml:description> <maml:para>System.Guid System.Management.Automation.SwitchParameter System.Uri System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Enable-CrmAdminMode -InstanceId <Instance Id> -ValidateOnly -ApiUrl $connectionhost -Credential $cred</dev:code> <dev:remarks> <maml:para>Validates whether the specified instance can be enabled for administration mode.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2</maml:title> <dev:code>PS C:\> Enable-CrmAdminMode -InstanceId <Instance Id> -AdminModeSettings $MyAdminModeSetting -ApiUrl $connectionhost -Credential $cred</dev:code> <dev:remarks> <maml:para>Enables the specified instance for administration mode using the $MyAdminModeSetting object created by running the New-CrmAdminModeSetting cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-CrmAdminModeSetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CrmInstances</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-CrmAdminMode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Enable-CrmManagementApp</command:name> <command:verb>Enable</command:verb> <command:noun>CrmManagementApp</command:noun> <maml:description> <maml:para>Enables the specified registered Azure Active Directory Web app/API application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-CrmManagementApp cmdlet enables the specified registered Azure Active Directory Web app/API application for use with the Microsoft.Xrm.OnlineManagementAPI PowerShell module.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-CrmManagementApp</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The registration id for the app. You can find the registration ids for all registered Azure Active Directory Web app/API applications by running the Get-CrmManagementApps cmdlet.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The registration id for the app. You can find the registration ids for all registered Azure Active Directory Web app/API applications by running the Get-CrmManagementApps cmdlet.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para>System.Uri System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Enable-CrmManagementApp -Id <RegistrationGuid> -ApiUrl $connectionhost -Credential $cred</dev:code> <dev:remarks> <maml:para>Enables the specified registered Azure Active Directory Web app/API application.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-CrmManagementApps</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CrmCurrencies</command:name> <command:verb>Get</command:verb> <command:noun>CrmCurrencies</command:noun> <maml:description> <maml:para>Returns a list of currencies that are available for all instances within the same tenant.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-CrmCurrencies cmdlet returns a list of currencies that are available for all instances within the same tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmCurrencies</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Uri</maml:name> </dev:type> <maml:description> <maml:para>System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Get-CrmCurrencies -ApiUrl $connectionhost -Credential $cred</dev:code> <dev:remarks> <maml:para>Returns a list of available currencies for the specified tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-CrmInstances</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CrmGenerateProtectionKey</command:name> <command:verb>Get</command:verb> <command:noun>CrmGenerateProtectionKey</command:noun> <maml:description> <maml:para>Returns a new protection key</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-CrmGenerateProtectionKey cmdlet returns a new protection key</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmGenerateProtectionKey</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SubjectName</maml:name> <maml:Description> <maml:para>Subject name for the protection key</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>KeyPassword</maml:name> <maml:Description> <maml:para>Key password for the protection key</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SubjectName</maml:name> <maml:Description> <maml:para>Subject name for the protection key</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>KeyPassword</maml:name> <maml:Description> <maml:para>Key password for the protection key</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Uri</maml:name> </dev:type> <maml:description> <maml:para>System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Get-CrmGenerateProtectionKey -ApiUrl $connectionhost -Credential $cred</dev:code> <dev:remarks> <maml:para>Returns a protection key.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-CrmGenerateProtectionKey</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-CrmTenantProtectionKey</command:name> <command:verb>Post</command:verb> <command:noun>CrmSetTenantProtectionKey</command:noun> <maml:description> <maml:para>Sets an existing tenant protection key</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-CrmTenantProtectionKey cmdlet sets an existing tenant protection key and returns the operation status.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-CrmTenantProtectionKey</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>KeyName</maml:name> <maml:Description> <maml:para>The tenant protection key's 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>KeytName</maml:name> <maml:Description> <maml:para>The tenant protection key's 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Uri</maml:name> </dev:type> <maml:description> <maml:para>System.Management.Automation.PSCredential System.Uri</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Set-CrmTenantProtectionKey -ApiUrl $connectionhost -Credential $cred</dev:code> <dev:remarks> <maml:para>Returns an operation status.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Set-CrmTenantProtectionKey</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-CrmImportProtectionKey</command:name> <command:verb>New</command:verb> <command:noun>CrmImportProtectionKey</command:noun> <maml:description> <maml:para>Import a new protection key</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-CrmImportProtectionKey cmdlet add a new protection key</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-CrmImportProtectionKey</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>KeyName</maml:name> <maml:Description> <maml:para>Name for the protection key</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>KeyType</maml:name> <maml:Description> <maml:para>Type of the protection key</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Key</maml:name> <maml:Description> <maml:para>Content of the protection key</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Byte[]</command:parameterValue> <dev:type> <maml:name>Byte[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>KeyPassword</maml:name> <maml:Description> <maml:para>Key password for the protection key</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>KeyName</maml:name> <maml:Description> <maml:para>Name for the protection key</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>KeyType</maml:name> <maml:Description> <maml:para>Type of the protection key</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Key</maml:name> <maml:Description> <maml:para>Content of the protection key</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Byte[]</command:parameterValue> <dev:type> <maml:name>Byte[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>KeyPassword</maml:name> <maml:Description> <maml:para>Key password for the protection key</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Uri</maml:name> </dev:type> <maml:description> <maml:para>System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> New-CrmImportProtectionKey -ApiUrl $connectionhost -Credential $cred -KeyName $keyName -Key $keyContent -KeyType 0 -KeyPassword $keyPassword</dev:code> <dev:remarks> <maml:para>Import a new protection key.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-CrmImportProtectionKey</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-CrmProtectWithMicrosoftKey</command:name> <command:verb>Set</command:verb> <command:noun>ProtectWithMicrosoftKey</command:noun> <maml:description> <maml:para>Protects an instance with default Microsoft key</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-CrmProtectWithMicrosoftKey cmdlet Protects an instance with default microsoft key</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-CrmProtectWithMicrosoftKey</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the ADmin API root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>InstanceId</maml:name> <maml:Description> <maml:para>The Id of the instance to protect</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Admin API root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>InstanceId</maml:name> <maml:Description> <maml:para>Id of the instance to protect</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Uri</maml:name> </dev:type> <maml:description> <maml:para>System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Set-CrmProtectWithMicrosoftKey -ApiUrl $connectionhost -Credential $cred -InstanceId $InstanceId</dev:code> <dev:remarks> <maml:para>Protects an instance with default Microsoft key.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Set-CrmProtectWithTenantKey</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CrmRetrieveTenantProtectionKey</command:name> <command:verb>Get</command:verb> <command:noun>CrmRetrieveTenantProtectionKey</command:noun> <maml:description> <maml:para>Returns the current tenant protection key</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-CrmRetrieveTenantProtectionKey cmdlet returns the current tenant protection key</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmRetrieveTenantProtectionKey</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Uri</maml:name> </dev:type> <maml:description> <maml:para>System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Get-CrmRetrieveTenantProtectionKey -ApiUrl $connectionhost -Credential $cred</dev:code> <dev:remarks> <maml:para>Returns a protection key.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-CrmRetrieveTenantProtectionKey</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CrmRetrieveAvailableTenantProtectionKeys</command:name> <command:verb>Get</command:verb> <command:noun>CrmRetrieveAvailableTenantProtectionKeys</command:noun> <maml:description> <maml:para>Returns the available protection keys for current tenant</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-CrmRetrieveAvailableTenantProtectionKeys cmdlet returns the available tenant protection keys</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmRetrieveAvailableTenantProtectionKeys</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Uri</maml:name> </dev:type> <maml:description> <maml:para>System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Get-CrmRetrieveAvailableTenantProtectionKeys -ApiUrl $connectionhost -Credential $cred</dev:code> <dev:remarks> <maml:para>Returns a protection key.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-CrmRetrieveAvailableTenantProtectionKeys</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-CrmLockTenantProtectedInstances</command:name> <command:verb>Set</command:verb> <command:noun>CrmLockTenantProtectedInstances</command:noun> <maml:description> <maml:para>Lock all the instances associated with the tenant</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set-CrmLockTenantProtectedInstances locks all the instances associated with the tenant</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-CrmLockTenantProtectedInstances</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>KeyName</maml:name> <maml:Description> <maml:para>Name for the protection key</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>KeyName</maml:name> <maml:Description> <maml:para>Name for the protection key</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Uri</maml:name> </dev:type> <maml:description> <maml:para>System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Set-CrmLockTenantProtectedInstances -ApiUrl $connectionhost -Credential $cred -KeyName $keyName</dev:code> <dev:remarks> <maml:para>Lock all the instances associated with the tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Lock all the instances associated with the tenant</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-CrmUnLockTenantProtectedInstance</command:name> <command:verb>Set</command:verb> <command:noun>CrmUnLockTenantProtectedInstance</command:noun> <maml:description> <maml:para>Unlock the target instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set-CrmUnLockTenantProtectedInstance unlocks the target instance</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-CrmUnLockTenantProtectedInstance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>InstanceId</maml:name> <maml:Description> <maml:para>The Id of the instance</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>InstanceId</maml:name> <maml:Description> <maml:para>The id of the instance</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Uri</maml:name> </dev:type> <maml:description> <maml:para>System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Set-CrmUnLockTenantProtectedInstance -ApiUrl $connectionhost -Credential $cred -InstanceId $InstanceId</dev:code> <dev:remarks> <maml:para>Unlock the tenant instance</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Unlock the tenant instance</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-CrmProtectWithTenantKey</command:name> <command:verb>Post</command:verb> <command:noun>CrmProtectWithTenantKey</command:noun> <maml:description> <maml:para>Protects and Instance with the Tenant Key</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-CrmProtectWithTenantKey cmdlet protects a given instance with the Tenant Key and returns operation status.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-CrmProtectWithTenantKey</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>InstanceId</maml:name> <maml:Description> <maml:para>Tenant instance Id</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>InstanceId</maml:name> <maml:Description> <maml:para>Tenant Instance Id</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Uri</maml:name> </dev:type> <maml:description> <maml:para>System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Set-CrmProtectWithTenantKey -ApiUrl $connecthost -Credential $cred -Verbose -InstanceId $InstanceId</dev:code> <dev:remarks> <maml:para>Triggers the protection of the instance and return an operation status.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Set-CrmProtectWithMicrosoftKey</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CrmInstance</command:name> <command:verb>Get</command:verb> <command:noun>CrmInstance</command:noun> <maml:description> <maml:para>Retrieves a Dynamics 365 Customer Engagement (online) instance in your Office 365 tenant.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-CrmInstance cmdlet retrieves a Dynamics 365 Customer Engagement (online) instance in your Office 365 tenant. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmInstance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Instance Id for the specific instance of Dynamics 365 Customer Engagement (online). Use the Get-CrmInstances cmdlet to find all instance Ids within the same tenant.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Instance Id for the specific instance of Dynamics 365 Customer Engagement (online). Use the Get-CrmInstances cmdlet to find all instance Ids within the same tenant.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para>System.Uri System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Get-CrmInstance -Id <Guid> -ApiUrl $connectionhost -Credential $cred</dev:code> <dev:remarks> <maml:para>Retrieves details about a specific instance as specified by using the -Id parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-CrmInstances</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CrmProtectedInstances</command:name> <command:verb>Get</command:verb> <command:noun>CrmProtectedInstances</command:noun> <maml:description> <maml:para>Retrieves a list of tenant protected instances in your Office 365 tenant.</maml:para> </maml:description> </command:details> <maml:description> <maml:para> The Get-CrmProtectedInstances cmdlet retrieves a list of tenant protected instances in your Office 365 tenant. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmProtectedInstances</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para>System.Uri System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Get-CrmProtectedInstances -ApiUrl $connectionhost -Credential $cred</dev:code> <dev:remarks> <maml:para>Retrieves a list of protected instances in the tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-CrmInstances</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CrmInstanceBackup</command:name> <command:verb>Get</command:verb> <command:noun>CrmInstanceBackup</command:noun> <maml:description> <maml:para>Retrieves a specific Dynamics 365 Customer Engagement (online) instance backup based on the backup id.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-CrmInstanceBackup cmdlet retrieves a Dynamics 365 Customer Engagement (online) instance backup based on the InstanceId and BackupId parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmInstanceBackup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>InstanceId</maml:name> <maml:Description> <maml:para>Instance Id for the specific instance of Dynamics 365 Customer Engagement (online) that has the backup that you want to restore. Use the Get-CrmInstances cmdlet to find all instance Ids within the same tenant.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>BackupId</maml:name> <maml:Description> <maml:para>Id of an existing instance backup. You can view the backup Ids of all backups for a specific instance by running the Get-CrmInstanceBackups cmdlet.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>InstanceId</maml:name> <maml:Description> <maml:para>Instance Id for the specific instance of Dynamics 365 Customer Engagement (online) that has the backup that you want to restore. Use the Get-CrmInstances cmdlet to find all instance Ids within the same tenant.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>BackupId</maml:name> <maml:Description> <maml:para>Id of an existing instance backup. You can view the backup Ids of all backups for a specific instance by running the Get-CrmInstanceBackups cmdlet.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para>System.Uri System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Get-CrmInstanceBackup -ApiUrl $connectionhost -InstanceId <instance id> -RestorePointId <restore point id> -Credential $cred</dev:code> <dev:remarks> <maml:para>Retrieves information about a specific backup for an instance of Dynamics 365 Customer Engagement (online) as indicated by the -RestorePointId and -InstanceId parameters.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-CrmInstanceBackups</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CrmInstances</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CrmInstanceBackups</command:name> <command:verb>Get</command:verb> <command:noun>CrmInstanceBackups</command:noun> <maml:description> <maml:para>Retrieves all backups for a Dynamics 365 Customer Engagement (online) instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-CrmInstanceBackups cmdlet retrieves all backups for a Dynamics 365 Customer Engagement (online) instance.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmInstanceBackups</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>InstanceId</maml:name> <maml:Description> <maml:para>Instance Id for the specific instance of Dynamics 365 Customer Engagement (online). Use the Get-CrmInstances cmdlet to find all instance Ids within the same tenant.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>InstanceId</maml:name> <maml:Description> <maml:para>Instance Id for the specific instance of Dynamics 365 Customer Engagement (online). Use the Get-CrmInstances cmdlet to find all instance Ids within the same tenant.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para>System.Uri System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Get-CrmInstanceBackups -ApiUrl $connectionhost -InstanceId <instanceid> -Credential $cred</dev:code> <dev:remarks> <maml:para>Returns a list of all backups for the instance as indicated by the InstanceId parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-CrmInstances</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CrmInstanceBackup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CrmInstances</command:name> <command:verb>Get</command:verb> <command:noun>CrmInstances</command:noun> <maml:description> <maml:para>Retrieves details for Dynamics 365 Customer Engagement (online) instances that are in your tenant.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-CrmInstances cmdlet retrieves details for all Dynamics 365 Customer Engagement (online) instances that are in your tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmInstances</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Uri</maml:name> </dev:type> <maml:description> <maml:para>System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Get-CrmInstances -ApiUrl $connectionhost -Credential $cred</dev:code> <dev:remarks> <maml:para>Retrieves all Dynamics 365 Customer Engagement (online) instances.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-CrmInstance</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CrmInstanceType</command:name> <command:verb>Get</command:verb> <command:noun>CrmInstanceType</command:noun> <maml:description> <maml:para>Retrieves information about a Dynamics 365 Customer Engagement (online) instance type.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-CrmInstanceType cmdlet retrieves information about a Dynamics 365 Customer Engagement (online) instance type.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmInstanceType</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>InstanceType</maml:name> <maml:Description> <maml:para>The instance type.The following are valid instance types: - Production</maml:para> <maml:para>- Sandbox</maml:para> <maml:para>- Support</maml:para> <maml:para>- Preview</maml:para> <maml:para>- Trial</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Production</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Sandbox</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Support</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Preview</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Trial</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">InstanceType</command:parameterValue> <dev:type> <maml:name>InstanceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>InstanceType</maml:name> <maml:Description> <maml:para>The instance type.The following are valid instance types: - Production</maml:para> <maml:para>- Sandbox</maml:para> <maml:para>- Support</maml:para> <maml:para>- Preview</maml:para> <maml:para>- Trial</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">InstanceType</command:parameterValue> <dev:type> <maml:name>InstanceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Xrm.Services.Admin.Client.Models.InstanceType</maml:name> </dev:type> <maml:description> <maml:para>System.Uri System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Get-CrmInstanceType -ApiUrl $connectionhost -InstanceType Production -Credential $cred</dev:code> <dev:remarks> <maml:para>Retrieves the total number of production instances that are provisioned and the total number available for provisioning.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-CrmInstanceTypes</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CrmInstanceTypes</command:name> <command:verb>Get</command:verb> <command:noun>CrmInstanceTypes</command:noun> <maml:description> <maml:para>Retrieves information about all the instance types available, such as production, sandbox, support, preview, and trial, in the Dynamics 365 Customer Engagement (online) tenant.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-CrmInstanceTypes cmdlet retrieves information about all the instance types available, such as production, sandbox, support, preview, and trial, in the Dynamics 365 Customer Engagement (online) tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmInstanceTypes</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Uri</maml:name> </dev:type> <maml:description> <maml:para>System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Get-CrmInstanceTypes -ApiUrl $connectionhost -Credential $cred</dev:code> <dev:remarks> <maml:para>Retrieves information about all the instance types availalbe in the Dynamics 365 Customer Engagement (online) tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-CrmInstanceType</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CrmLanguages</command:name> <command:verb>Get</command:verb> <command:noun>CrmLanguages</command:noun> <maml:description> <maml:para>Retrieves all languages supported by Dynamics 365 Customer Enagagement (online) for the specified service release.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-CrmLanguages cmdlet retrieves all languages supported by Dynamics 365 Customer Enagagement (online) for the specified service release.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmLanguages</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ServiceReleaseId</maml:name> <maml:Description> <maml:para>Release Id for a release of Microsoft Dynamics 365 (online). You can find the ServiceReleaseId by running the Get-CrmServiceVersions cmdlet.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ServiceReleaseId</maml:name> <maml:Description> <maml:para>Release Id for a release of Microsoft Dynamics 365 (online). You can find the ServiceReleaseId by running the Get-CrmServiceVersions cmdlet.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para>System.Uri System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Get-CrmLanguages -ApiUrl $connectionhost -Credential $cred -ServiceReleaseId 015e6a5c-2fa5-e411-80ce-00155db07c21</dev:code> <dev:remarks> <maml:para>Retrieves all languages supported by Dynamics 365 Customer Enagagement (online) for the Microsoft Dynamics CRM Online 2016 (8.0) service release.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-CrmServiceVersions</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CrmManagementApp</command:name> <command:verb>Get</command:verb> <command:noun>CrmManagementApp</command:noun> <maml:description> <maml:para>Returns the specified registered Azure Active Directory Web app/API application.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-CrmManagementApp cmdlet returns the specified registered Azure Active Directory Web app/API application.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmManagementApp</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The registration id for the app. You can find the registration ids for all registered Azure Active Directory Web app/API applications by running the Get-CrmManagementApps cmdlet.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The registration id for the app. You can find the registration ids for all registered Azure Active Directory Web app/API applications by running the Get-CrmManagementApps cmdlet.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para>System.Uri System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Get-CrmManagementApp -Id <RegistrationGuid> -ApiUrl $connectionhost -Credential $cred</dev:code> <dev:remarks> <maml:para>Returns information for a registered Azure Active Directory Web app/API application specified by using the registration id.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-CrmManagementApps</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CrmManagementApps</command:name> <command:verb>Get</command:verb> <command:noun>CrmManagementApps</command:noun> <maml:description> <maml:para>Returns a list of all registered Azure Active Directory Web app/API applications under the tenant.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-CrmManagementApps cmdlet returns a list of all registered Azure Active Directory Web app/API applications under the tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmManagementApps</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Uri</maml:name> </dev:type> <maml:description> <maml:para>System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Get-CrmManagementApps -ApiUrl $connectionhost -Credential $cred</dev:code> <dev:remarks> <maml:para>Returns a list of all registered Azure Active Directory Web app/API applications under the tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-CrmManagementApp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CrmOperationStatus</command:name> <command:verb>Get</command:verb> <command:noun>CrmOperationStatus</command:noun> <maml:description> <maml:para>Retrieves the status for an operation from your Dynamics 365 Customer Engagement (online) instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-CrmOperationStatus retrieves the status of an operation from your Dynamics 365 Customer Engagement (online) instance.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmOperationStatus</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Operation Id of a long-running process, such as a backup, restore, new instance, or delete operation. For example, when you run the Get-CrmInstanceBackup cmdlet, the operation Id is returned from the cmdlet.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Operation Id of a long-running process, such as a backup, restore, new instance, or delete operation. For example, when you run the Get-CrmInstanceBackup cmdlet, the operation Id is returned from the cmdlet.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para>System.Uri System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Get-CrmOperationStatus -Id <OperationIdGuid> -ApiUrl $connectionhost -Credential $cred</dev:code> <dev:remarks> <maml:para>Retrieves the status of an operation as specified by the operation Id.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-CrmInstance</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CrmInstanceBackup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restore-CrmInstance</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-CrmInstance</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CrmServiceVersions</command:name> <command:verb>Get</command:verb> <command:noun>CrmServiceVersions</command:noun> <maml:description> <maml:para>Retrieves information about all currently supported releases for Dynamics 365 Customer Engagement (online).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-CrmServiceVersions cmdlet retrieves information about all currently supported releases for Dynamics 365 Customer Engagement (online).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmServiceVersions</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Uri</maml:name> </dev:type> <maml:description> <maml:para>System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Get-CrmServiceVersions -ApiUrl $connectionhost -Credential $cred</dev:code> <dev:remarks> <maml:para>Retrieves information about all currently supported releases for Dynamics 365 Customer Engagement (online).</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-CrmLanguages</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CrmTemplates</command:name> <command:verb>Get</command:verb> <command:noun>CrmTemplates</command:noun> <maml:description> <maml:para>Retrieves a list of application templates supported for provisioning a Dynamics 365 Customer Engagement (online) instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-CrmTemplates cmdlet retrieves a list of application templates supported for provisioning a Dynamics 365 Customer Engagement (online) instance.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CrmTemplates</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Uri</maml:name> </dev:type> <maml:description> <maml:para>System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Get-CrmTemplates -ApiUrl $connectionhost -Credential $cred</dev:code> <dev:remarks> <maml:para>Retrieves the list of application templates supported for provisioning a Dynamics 365 Customer Engagement (online) instance.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft.Xrm.OnlineManagementAPI Module</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-CrmAdminModeSetting</command:name> <command:verb>New</command:verb> <command:noun>CrmAdminModeSetting</command:noun> <maml:description> <maml:para>Defines the object that can be passed to the Enable-CrmAdminMode and Disable-CrmAdminMode cmdlets to enable or disable administration mode for an instance of Dynamics 365 Customer Engagement (online). When you place a Sandbox instance in administration mode only users with Dynamics 365 System Administrator or System Customizer security roles will be able to sign in to that instance. Administration mode is useful when you want to make operational changes and not have regular users affect your work, and not have your work affect regular users.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-CrmAdminModeSetting cmdlet defines the object that can be passed to the Enable-CrmAdminMode and Enable-CrmAdminMode cmdlets to enable or disable administration mode for an instance of Dynamics 365 Customer Engagement (online).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-CrmAdminModeSetting</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>AllowBackgroundOperations</maml:name> <maml:Description> <maml:para>Optional parameter that determines whether the instance can run background operations. 1 or $true to allow background operations. 0 or $false to not allow background operations. Background operations are asynchronous operations, such as workflows and synchronization with Microsoft Exchange. When set to false, emails will not be sent and server-side synchronization for appointments, contacts, and tasks are disabled.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>NotificationText</maml:name> <maml:Description> <maml:para>Optional parameter that diplays as a message when any user attempts to sign in to the instance. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>OverrideUserAADObjectId</maml:name> <maml:Description> <maml:para>Azure Active Directory object Id that can be used as the authentication identity instead of the user's credentials.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>AllowBackgroundOperations</maml:name> <maml:Description> <maml:para>Optional parameter that determines whether the instance can run background operations. 1 or $true to allow background operations. 0 or $false to not allow background operations. Background operations are asynchronous operations, such as workflows and synchronization with Microsoft Exchange. When set to false, emails will not be sent and server-side synchronization for appointments, contacts, and tasks are disabled.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>NotificationText</maml:name> <maml:Description> <maml:para>Optional parameter that diplays as a message when any user attempts to sign in to the instance. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>OverrideUserAADObjectId</maml:name> <maml:Description> <maml:para>Azure Active Directory object Id that can be used as the authentication identity instead of the user's credentials.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> </dev:type> <maml:description> <maml:para>System.String System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\>$MyAdminModeSetting = New-CrmAdminModeSetting -AllowBackgroundOperations 1 -NotificationText Only administrators and customizers may access this instance while we complete operational changes -OverrideUserAADObjectId <Guid></dev:code> <dev:remarks> <maml:para>Creates the object that can be used with Enable-CrmAdminMode to enable administration mode on an instance.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-CrmAdminMode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-CrmAdminMode</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-CrmInstance</command:name> <command:verb>New</command:verb> <command:noun>CrmInstance</command:noun> <maml:description> <maml:para>Provisions (creates) a Dynamics 365 Customer Engagement (online) instance in your Office 365 tenant.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-CrmInstance cmdlet provisions (creates) a Dynamics 365 Customer Engagement (online) instance in your Office 365 tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-CrmInstance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>NewInstanceInfo</maml:name> <maml:Description> <maml:para>Object created by using the New-CrmInstanceInfo cmdlet that contains the information used to provision the instance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NewInstance</command:parameterValue> <dev:type> <maml:name>NewInstance</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ValidateOnly</maml:name> <maml:Description> <maml:para>Indicates whether to validate that an instance can be provisioned with the provided parameters or create an instance. Set 1 to validate; set 0 to create.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>NewInstanceInfo</maml:name> <maml:Description> <maml:para>Object created by using the New-CrmInstanceInfo cmdlet that contains the information used to provision the instance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NewInstance</command:parameterValue> <dev:type> <maml:name>NewInstance</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ValidateOnly</maml:name> <maml:Description> <maml:para>Indicates whether to validate that an instance can be provisioned with the provided parameters or create an instance. Set 1 to validate; set 0 to 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>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Xrm.Services.Admin.Client.Models.NewInstance</maml:name> </dev:type> <maml:description> <maml:para>System.Management.Automation.SwitchParameter System.Uri System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>New-CrmInstance -ApiUrl $connectionhost -NewInstanceInfo $NewCrmInstance -Credential $cred</dev:code> <dev:remarks> <maml:para>Provisions a Dynamics 365 Customer Engagement (online) instance in your Office 365 tenant from information specified in the object created by the New-CrmInstanceInfo cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-CrmInstanceInfo</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Reset-CrmInstance</command:name> <command:verb>Reset</command:verb> <command:noun>CrmInstance</command:noun> <maml:description> <maml:para>Reset a (v9 or higher) Dynamics 365 Customer Engagement (online) sandbox instance in your Office 365 tenant.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Reset-CrmInstance cmdlet performs a reset operation on a Dynamics 365 Customer Engagement (online) Sandbox instance in your Office 365 tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Reset-CrmInstance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ResetInstanceRequestDetails</maml:name> <maml:Description> <maml:para>Object created by using the New-CrmInstanceResetRequestInfo cmdlet that contains the information used to reset the instance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ResetRequest</command:parameterValue> <dev:type> <maml:name>ResetRequest</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>TargetInstanceIdToReset</maml:name> <maml:Description> <maml:para>Id of the instance to reset</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ResetInstanceRequestDetails</maml:name> <maml:Description> <maml:para>Object created by using the New-CrmInstanceResetRequestInfo cmdlet that contains the information used to reset the instance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ResetRequest</command:parameterValue> <dev:type> <maml:name>ResetRequest</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>TargetInstanceIdToReset</maml:name> <maml:Description> <maml:para>Id of the instance to reset</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Xrm.Services.Admin.Client.Models.ResetRequest</maml:name> </dev:type> <maml:description> <maml:para>System.Management.Automation.SwitchParameter System.Uri System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>Reset-CrmInstance -ApiUrl $connectionhost -ResetInstanceRequestDetails ResetInstanceRequestDetails -Credential $cred -TargetInstanceIdToReset $InstanceId</dev:code> <dev:remarks> <maml:para>Resets a Dynamics 365 Customer Engagement (online) instance in your Office 365 tenant from information specified in the object created by the New-CrmInstanceResetRequestInfo cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-CrmInstanceResetRequestInfo</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Copy-CrmInstance</command:name> <command:verb>Copy</command:verb> <command:noun>CrmInstance</command:noun> <maml:description> <maml:para>Copy a (v9 or higher) Dynamics 365 Customer Engagement (online) production or sandbox instance to another sandbox instance in your Office 365 tenant.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Copy-CrmInstance cmdlet performs a copy operation on a Dynamics 365 Customer Engagement (online) instance to another Sandbox instance in your Office 365 tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Copy-CrmInstance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>CopyInstanceRequestDetails</maml:name> <maml:Description> <maml:para>Object created by using the New-CrmInstanceCopyRequestInfo cmdlet that contains the information used to copy the instance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CopyRequest</command:parameterValue> <dev:type> <maml:name>CopyRequest</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SourceInstanceIdToCopy</maml:name> <maml:Description> <maml:para>Id of the source instance to copy</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>CopyInstanceRequestDetails</maml:name> <maml:Description> <maml:para>Object created by using the New-CrmInstanceCopyRequestInfo cmdlet that contains the information used to copy the instance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CopyRequest</command:parameterValue> <dev:type> <maml:name>CopyRequest</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SourceInstanceIdToCopy</maml:name> <maml:Description> <maml:para>Id of the instance to copy</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Xrm.Services.Admin.Client.Models.CopyRequest</maml:name> </dev:type> <maml:description> <maml:para>System.Management.Automation.SwitchParameter System.Uri System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>Copy-CrmInstance -ApiUrl $connectionhost -CopyInstanceRequestDetails CopyInstanceRequestDetails -Credential $cred -SourceInstanceIdToCopy $InstanceId</dev:code> <dev:remarks> <maml:para>Copies a Dynamics 365 Customer Engagement (online) instance in your Office 365 tenant from information specified in the object created by the New-CrmInstanceCopyRequestInfo cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-CrmInstanceCopyRequestInfo</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-CrmInstanceInfo</command:name> <command:verb>New</command:verb> <command:noun>CrmInstanceInfo</command:noun> <maml:description> <maml:para>Creates the object that defines the parameters used to create a new instance of Dynamics 365 Customer Enagagement (online) by using the New-CrmInstance cmdlet.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-CrmInstanceInfo cmdlet creates the object that defines the parameters used to create a new instance of Dynamics 365 Customer Enagagement (online) by using the New-CrmInstance cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-CrmInstanceInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>BaseLanguage</maml:name> <maml:Description> <maml:para>Required parameter. The base language for the instance. For a list of available languages, run the Get-CrmLanguages cmdlet.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CurrencyCode</maml:name> <maml:Description> <maml:para>Optional parameter. The currency region code to use for the instance. You can find a list of currency region codes by running the Get-CrmCurrencies cmdlet.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CurrencyName</maml:name> <maml:Description> <maml:para>Optional parameter. The currency name to use for the instance. You can find a list of currency names by running the Get-CrmCurrencies cmdlet.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CurrencyPrecision</maml:name> <maml:Description> <maml:para>Optional parameter. Set the pricing decimal precision. Valid values are 0-4.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CurrencySymbol</maml:name> <maml:Description> <maml:para>Optional parameter. Set the symbol that will represent the currency.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>Required parameter. Used for part of the domain namespace and appears in the application url. For example, if you use contoso as the DomainName, the url will appear similar to https://contoso.crm.dynamics.com.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>FriendlyName</maml:name> <maml:Description> <maml:para>Required parameter. This is typically the name of your organization and is displayed in the Microsoft Dynamics 365 application.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>InitialUserEmail</maml:name> <maml:Description> <maml:para>Required parameter. Email address to receive notifications about the instance.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>InstanceType</maml:name> <maml:Description> <maml:para>Required parameter. Sets the instance type, such as Sandbox or Production. For a full list, run the Get-CrmInstanceTypes cmdlet.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Production</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Sandbox</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Support</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Preview</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Trial</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">InstanceType</command:parameterValue> <dev:type> <maml:name>InstanceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Purpose</maml:name> <maml:Description> <maml:para>Optional parameter. A description used to associate the instance with a specific intent. Only tenant administrators will see this 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SecurityGroupId</maml:name> <maml:Description> <maml:para>Optional parameter. This value is used to determine the security group that includes the users who will have access to this instance of Microsoft Dynamics 365 (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ServiceVersionId</maml:name> <maml:Description> <maml:para>Required parameter. Specifies the service release of the instance. For a list of available service releases, run the Get-CrmServiceVersions cmdlet.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>TemplateList</maml:name> <maml:Description> <maml:para>Optional parameter. Specifies the apps you want provisioned in the instance. For a list of available template names, run the Get-CrmTemplates cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-CrmInstanceInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CurrencyCode</maml:name> <maml:Description> <maml:para>Optional parameter. The currency region code to use for the instance. You can find a list of currency region codes by running the Get-CrmCurrencies cmdlet.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CurrencyName</maml:name> <maml:Description> <maml:para>Optional parameter. The currency name to use for the instance. You can find a list of currency names by running the Get-CrmCurrencies cmdlet.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CurrencyPrecision</maml:name> <maml:Description> <maml:para>Optional parameter. Set the pricing decimal precision. Valid values are 0-4.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CurrencySymbol</maml:name> <maml:Description> <maml:para>Optional parameter. Set the symbol that will represent the currency.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>BaseLanguage</maml:name> <maml:Description> <maml:para>Required parameter. The base language for the instance. For a list of available languages, run the Get-CrmLanguages cmdlet.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CurrencyCode</maml:name> <maml:Description> <maml:para>Optional parameter. The currency region code to use for the instance. You can find a list of currency region codes by running the Get-CrmCurrencies cmdlet.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CurrencyName</maml:name> <maml:Description> <maml:para>Optional parameter. The currency name to use for the instance. You can find a list of currency names by running the Get-CrmCurrencies cmdlet.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CurrencyPrecision</maml:name> <maml:Description> <maml:para>Optional parameter. Set the pricing decimal precision. Valid values are 0-4.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CurrencySymbol</maml:name> <maml:Description> <maml:para>Optional parameter. Set the symbol that will represent the currency.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>Required parameter. Used for part of the domain namespace and appears in the application url. For example, if you use contoso as the DomainName, the url will appear similar to https://contoso.crm.dynamics.com.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>FriendlyName</maml:name> <maml:Description> <maml:para>Required parameter. This is typically the name of your organization and is displayed in the Microsoft Dynamics 365 application.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>InitialUserEmail</maml:name> <maml:Description> <maml:para>Required parameter. Email address to receive notifications about the instance.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>InstanceType</maml:name> <maml:Description> <maml:para>Required parameter. Sets the instance type, such as Sandbox or Production. For a full list, run the Get-CrmInstanceTypes cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">InstanceType</command:parameterValue> <dev:type> <maml:name>InstanceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Purpose</maml:name> <maml:Description> <maml:para>Optional parameter. A description used to associate the instance with a specific intent. Only tenant administrators will see this 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SecurityGroupId</maml:name> <maml:Description> <maml:para>Optional parameter. This value is used to determine the security group that includes the users who will have access to this instance of Microsoft Dynamics 365 (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ServiceVersionId</maml:name> <maml:Description> <maml:para>Required parameter. Specifies the service release of the instance. For a list of available service releases, run the Get-CrmServiceVersions cmdlet.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>TemplateList</maml:name> <maml:Description> <maml:para>Optional parameter. Specifies the apps you want provisioned in the instance. For a list of available template names, run the Get-CrmTemplates cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> </dev:type> <maml:description> <maml:para>System.String System.Guid Microsoft.Xrm.Services.Admin.Client.Models.InstanceType System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> $NewCrmInstance = New-CrmInstanceInfo -BaseLanguage 1033 -DomainName matptest -FriendlyName "Contoso production instance" -InitialUserEmail admin@contoso.onmicrosoft.com -InstanceType Sandbox -ServiceVersionId 31cafafe-c6b1-4c0a-bb53-73927841bc5c -CurrencyCode 840 -CurrencyName USD -CurrencyPrecision 2 -CurrencySymbol $ -Purpose "This is a new production instance for Contoso."</dev:code> <dev:remarks> <maml:para>Defines the object that can be used to create a Sandbox instance with Dynamics 365 (8.2), 1033 (US English) as the base language, and USD as the currency.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-CrmInstance</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CrmCurrencies</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CrmLanguages</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CrmServiceVersions</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CrmTemplates</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-CrmInstanceResetRequestInfo</command:name> <command:verb>New</command:verb> <command:noun>CrmInstanceResetRequestInfo</command:noun> <maml:description> <maml:para>Creates the object that defines the parameters used to reset a instance of Dynamics 365 Customer Enagagement (online) by using the Reset-CrmInstance cmdlet.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-CrmInstanceResetRequestInfo cmdlet creates the object that defines the parameters used to reset a instance of Dynamics 365 Customer Enagagement (online) by using the Reset-CrmInstance cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-CrmInstanceResetRequestInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>BaseLanguage</maml:name> <maml:Description> <maml:para>Required parameter. The base language for the instance. For a list of available languages, run the Get-CrmLanguages cmdlet.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CurrencyCode</maml:name> <maml:Description> <maml:para>Optional parameter. The currency region code to use for the instance. You can find a list of currency region codes by running the Get-CrmCurrencies cmdlet.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CurrencyName</maml:name> <maml:Description> <maml:para>Optional parameter. The currency name to use for the instance. You can find a list of currency names by running the Get-CrmCurrencies cmdlet.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CurrencyPrecision</maml:name> <maml:Description> <maml:para>Optional parameter. Set the pricing decimal precision. Valid values are 0-4.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CurrencySymbol</maml:name> <maml:Description> <maml:para>Optional parameter. Set the symbol that will represent the currency.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>Required parameter. Used for part of the domain namespace and appears in the application url. For example, if you use contoso as the DomainName, the url will appear similar to https://contoso.crm.dynamics.com.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>FriendlyName</maml:name> <maml:Description> <maml:para>Required parameter. This is typically the name of your organization and is displayed in the Microsoft Dynamics 365 application.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Purpose</maml:name> <maml:Description> <maml:para>Optional parameter. A description used to associate the instance with a specific intent. Only tenant administrators will see this 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SecurityGroupId</maml:name> <maml:Description> <maml:para>Optional parameter. This value is used to determine the security group that includes the users who will have access to this instance of Microsoft Dynamics 365 (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>TemplateList</maml:name> <maml:Description> <maml:para>Optional parameter. Specifies the apps you want provisioned in the instance. For a list of available template names, run the Get-CrmTemplates cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>TargetReleaseName</maml:name> <maml:Description> <maml:para> Required parameter. The name of the target release.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PreferredCulture</maml:name> <maml:Description> <maml:para> Optional parameter. Indicates if the customer prefers a certain culture for formatting for the new instance. </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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>BaseLanguage</maml:name> <maml:Description> <maml:para>Required parameter. The base language for the instance. For a list of available languages, run the Get-CrmLanguages cmdlet.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CurrencyCode</maml:name> <maml:Description> <maml:para>Optional parameter. The currency region code to use for the instance. You can find a list of currency region codes by running the Get-CrmCurrencies cmdlet.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CurrencyName</maml:name> <maml:Description> <maml:para>Optional parameter. The currency name to use for the instance. You can find a list of currency names by running the Get-CrmCurrencies cmdlet.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CurrencyPrecision</maml:name> <maml:Description> <maml:para>Optional parameter. Set the pricing decimal precision. Valid values are 0-4.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CurrencySymbol</maml:name> <maml:Description> <maml:para>Optional parameter. Set the symbol that will represent the currency.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>DomainName</maml:name> <maml:Description> <maml:para>Required parameter. Used for part of the domain namespace and appears in the application url. For example, if you use contoso as the DomainName, the url will appear similar to https://contoso.crm.dynamics.com.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>FriendlyName</maml:name> <maml:Description> <maml:para>Required parameter. This is typically the name of your organization and is displayed in the Microsoft Dynamics 365 application.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Purpose</maml:name> <maml:Description> <maml:para>Optional parameter. A description used to associate the instance with a specific intent. Only tenant administrators will see this 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SecurityGroupId</maml:name> <maml:Description> <maml:para>Optional parameter. This value is used to determine the security group that includes the users who will have access to this instance of Microsoft Dynamics 365 (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>TemplateList</maml:name> <maml:Description> <maml:para>Optional parameter. Specifies the apps you want provisioned in the instance. For a list of available template names, run the Get-CrmTemplates cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>TargetReleaseName</maml:name> <maml:Description> <maml:para> Required parameter. The name of the target release. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PreferredCulture</maml:name> <maml:Description> <maml:para> Optional parameter. Indicates if the customer prefers a certain culture for formatting for the new instance. </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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> </dev:type> <maml:description> <maml:para>System.String System.Guid Microsoft.Xrm.Services.Admin.Client.Models.InstanceType System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> $ResetRequestInfo = New-CrmInstanceResetRequestInfo -BaseLanguage 1033 -DomainName matptest -FriendlyName "Contoso production instance" -CurrencyCode 840 -CurrencyName USD -CurrencyPrecision 2 -CurrencySymbol $ -Purpose "This is a new production instance for Contoso." -TargetReleaseName "Dynamics 365, version 9.0"</dev:code> <dev:remarks> <maml:para>Defines the object that can be used to reset a instance with Dynamics 365, 1033 (US English) as the base language, and USD as the currency.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-CrmInstance</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CrmCurrencies</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CrmLanguages</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CrmTemplates</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-CrmInstanceCopyRequestInfo</command:name> <command:verb>New</command:verb> <command:noun>CrmInstanceCopyRequestInfo</command:noun> <maml:description> <maml:para>Creates the object that defines the parameters used to copy a instance of Dynamics 365 Customer Enagagement (online) by using the Copy-CrmInstance cmdlet.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-CrmInstanceCopyRequestInfo cmdlet creates the object that defines the parameters used to copy a instance of Dynamics 365 Customer Enagagement (online) by using the Copy-CrmInstance cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-CrmInstanceCopyRequestInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>FriendlyName</maml:name> <maml:Description> <maml:para>Required parameter. This is typically the name of your organization and is displayed in the Microsoft Dynamics 365 application.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SecurityGroupId</maml:name> <maml:Description> <maml:para>Optional parameter. This value is used to determine the security group that includes the users who will have access to this instance of Microsoft Dynamics 365 (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>TargetInstanceId</maml:name> <maml:Description> <maml:para>Required parameter. This value is used to determine the target instance for the copy operation.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>CopyType</maml:name> <maml:Description> <maml:para>Required parameter. This value is used to determine the copy is full copy or minimal copy. The Value can be either FullCopy or MinimalCopy</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>FriendlyName</maml:name> <maml:Description> <maml:para>Required parameter. This is typically the name of your organization and is displayed in the Microsoft Dynamics 365 application.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SecurityGroupId</maml:name> <maml:Description> <maml:para>Optional parameter. This value is used to determine the security group that includes the users who will have access to this instance of Microsoft Dynamics 365 (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>TargetInstanceId</maml:name> <maml:Description> <maml:para>Required parameter. This value is used to determine the target instance for the copy operation</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>CopyType</maml:name> <maml:Description> <maml:para>Required parameter. This value is used to determine the copy is full copy or minimal copy. The Value can be either FullCopy or MinimalCopy</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> </dev:type> <maml:description> <maml:para>System.String System.Guid Microsoft.Xrm.Services.Admin.Client.Models.InstanceType System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> $CopyRequestInfo = New-CrmInstanceCopyRequestInfo -FriendlyName "Contoso production instance" -TargetInstanceId "3c7fa7b4-b93a-4794-8913-6807e0c3aea3" -CopyType "FullCopy"</dev:code> <dev:remarks> <maml:para>Defines the object that can be used to copy an instance to target instance whose id is "3c7fa7b4-b93a-4794-8913-6807e0c3aea3", the new firendly name of the target instance will be "Contoso production instance".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-CrmInstanceCopyRequestInfo</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-CrmManagementApp</command:name> <command:verb>New</command:verb> <command:noun>CrmManagementApp</command:noun> <maml:description> <maml:para>Registers an Azure Active Directory Web app/API to be used with the Microsoft.Xrm.OnlineManagementAPI PowerShell module.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-CrmManagementApp cmdlet registers an Azure Active Directory Web app/API based on the app Id so it can be used with the Microsoft.Xrm.OnlineManagementAPI PowerShell module.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-CrmManagementApp</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-CrmManagementApp</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>AppId</maml:name> <maml:Description> <maml:para>The application Id of the the Azure Active Directory Web app / API app. You can find the application Ids for Azure Active Directory Web app / API applications by running the Get-AzureADApplication Azure Active Directory PowerShell cmdlet or from the Azure Active Directory admin center.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Enable</maml:name> <maml:Description> <maml:para>Enables the app for use with the Microsoft.Xrm.OnlineManagmentAPI PowerShell module.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>AppId</maml:name> <maml:Description> <maml:para>The application Id of the the Azure Active Directory Web app / API app. You can find the application Ids for Azure Active Directory Web app / API applications by running the Get-AzureADApplication Azure Active Directory PowerShell cmdlet or from the Azure Active Directory admin center.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Enable</maml:name> <maml:Description> <maml:para>Enables the app for use with the Microsoft.Xrm.OnlineManagmentAPI PowerShell module.</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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Xrm.Services.Admin.Client.Models.TenantApplicationIdentity</maml:name> </dev:type> <maml:description> <maml:para>System.Guid System.Management.Automation.SwitchParameter System.Uri System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>New-CrmManagementApp -AppId <App Id Guid> -Enable -ApiUrl $connectionhost -Credential $cred</dev:code> <dev:remarks> <maml:para>Registers and enables an Azure Active Directory Web app/API for use with the Microsoft.Xrm.OnlineManagementAPI PowerShell module.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Enable-CrmManagementApp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CrmManagementApps</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Integrating applications with Azure Active Directory</maml:linkText> <maml:uri>https://docs.microsoft.com/azure/active-directory/develop/active-directory-integrating-applications</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureADApplication</maml:linkText> <maml:uri>https://docs.microsoft.com/powershell/module/azuread/get-azureadapplication?view=azureadps-2.0</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-CrmInstance</command:name> <command:verb>Remove</command:verb> <command:noun>CrmInstance</command:noun> <maml:description> <maml:para>Removes (deletes) the specified Dynamics 365 Customer Engagement (online) instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-CrmInstance cmdlet removes (deletes) the specified Dynamics 365 Customer Engagement (online) instance.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-CrmInstance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Instance Id for the specific instance of Dynamics 365 Customer Engagement (online). Use the Get-CrmInstances cmdlet to find all instance Ids within the same tenant.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Instance Id for the specific instance of Dynamics 365 Customer Engagement (online). Use the Get-CrmInstances cmdlet to find all instance Ids within the same tenant.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para>System.Uri System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Remove-CrmInstance -Id <Guid> -ApiUrl $connectionhost -Credential $cred</dev:code> <dev:remarks> <maml:para>Removes the instance specified by using the -Id parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-CrmInstances</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-CrmManagementApp</command:name> <command:verb>Remove</command:verb> <command:noun>CrmManagementApp</command:noun> <maml:description> <maml:para>Removes the specified registered Azure Active Directory Web app/API application so it cannot be used with Microsoft.Xrm.OnlineManagementAPI PowerShell module.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-CrmManagementApp cmdlet removes the specified registered Azure Active Directory Web app/API application so it cannot be used with Microsoft.Xrm.OnlineManagementAPI PowerShell module.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-CrmManagementApp</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The registration id for the app. You can find the registration ids for all registered Azure Active Directory Web app/API applications by running the Get-CrmManagementApps cmdlet.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The registration id for the app. You can find the registration ids for all registered Azure Active Directory Web app/API applications by running the Get-CrmManagementApps cmdlet.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para>System.Uri System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Remove-CrmManagementApp -Id <Guid> -ApiUrl $connectionhost -Credential $cred</dev:code> <dev:remarks> <maml:para>Removes the specified registered Azure Active Directory Web app/API application.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-CrmManagementApps</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-CrmManagementApp</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-CrmCopyInstance</command:name> <command:verb>New</command:verb> <command:noun>CrmCopyInstance</command:noun> <maml:description> <maml:para>Copy a sandbox instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-CrmCopyInstance cmdlet copy sandbox instance.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-CrmCopyInstance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SourceInstanceId</maml:name> <maml:Description> <maml:para>Id of the instance to copy</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>FriendlyName</maml:name> <maml:Description> <maml:para>Friendly name of the instance.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SecurityGroupId</maml:name> <maml:Description> <maml:para>Guid of the security group for which members will sync to this instance</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>TargetInstanceId</maml:name> <maml:Description> <maml:para>Instance Id for the specific target instance</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>CopyType</maml:name> <maml:Description> <maml:para>The copy type. The following are valid copy types: FullCopy, MinimalCopy</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">FullCopy</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MinimalCopy</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">InstanceCopyType</command:parameterValue> <dev:type> <maml:name>InstanceCopyType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SourceInstanceId</maml:name> <maml:Description> <maml:para>Id of the instance to copy</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>FriendlyName</maml:name> <maml:Description> <maml:para>Friendly name of the instance.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SecurityGroupId</maml:name> <maml:Description> <maml:para>Guid of the security group for which members will sync to this instance</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>TargetInstanceId</maml:name> <maml:Description> <maml:para>Instance Id for the specific target instance</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>CopyType</maml:name> <maml:Description> <maml:para>The copy type. The following are valid copy types: FullCopy, MinimalCopy</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">FullCopy</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MinimalCopy</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">InstanceCopyType</command:parameterValue> <dev:type> <maml:name>InstanceCopyType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para>System.Uri System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> New-CrmCopyInstance -SourceInstanceId <Guid> -FriendlyName "aFriendlyName" -CopyType "FullCopy" -TargetInstanceId <Guid> -ApiUrl $connectionhost -Credential $cred</dev:code> <dev:remarks> <maml:para>Copy an instance</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-CrmInstances</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CrmInstanceBackup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Restore-CrmInstance</command:name> <command:verb>Restore</command:verb> <command:noun>CrmInstance</command:noun> <maml:description> <maml:para>Restores a Dynamics 365 Customer Engagement (online) instance from the specified backup and instance restore point ids.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Restore-CrmInstance cmdlet restores a Dynamics 365 Customer Engagement (online) instance from the specified backup and instance restore point ids.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Restore-CrmInstance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SourceInstanceId</maml:name> <maml:Description> <maml:para>Instance where Backup is picked up from.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>TargetInstanceId</maml:name> <maml:Description> <maml:para>Instance Id to restored too. Use the Get-CrmInstances cmdlet to find all instance Ids within the same tenant.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>RestoreTimeUtc</maml:name> <maml:Description> <maml:para>Backup TimeStamp to restore to.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTimeOffset</command:parameterValue> <dev:type> <maml:name>DateTimeOffset</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>FriendlyName</maml:name> <maml:Description> <maml:para>Allows you to change the friendly name on restore</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SecurityGroupId</maml:name> <maml:Description> <maml:para>Allows you to change the security group on restore</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ValidateOnly</maml:name> <maml:Description> <maml:para>Validates whether the operation will succeed without committing any changes.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SourceInstanceId</maml:name> <maml:Description> <maml:para>Instance where Backup is picked up from.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>TargetInstanceId</maml:name> <maml:Description> <maml:para>Instance Id to restored too. Use the Get-CrmInstances cmdlet to find all instance Ids within the same tenant.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>RestoreTimeUtc</maml:name> <maml:Description> <maml:para>Backup TimeStamp to restore to.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTimeOffset</command:parameterValue> <dev:type> <maml:name>DateTimeOffset</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>FriendlyName</maml:name> <maml:Description> <maml:para>Allows you to change the friendly name on restore</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SecurityGroupId</maml:name> <maml:Description> <maml:para>Allows you to change the security group on restore</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ValidateOnly</maml:name> <maml:Description> <maml:para>Validates whether the operation will succeed without committing any changes.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para>Microsoft.Xrm.Services.Admin.Client.Models.InstanceRestorePoint System.Uri System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Restore-CrmInstance -SourceInstanceId <Guid> -TargetInstanceId <Guid> -RestoreTimeUtc <DateTimeUTC> -ApiUrl $connectionhost -Credential $cred</dev:code> <dev:remarks> <maml:para>Restores an instance from the specified instance restore point.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-CrmInstances</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-CrmInstanceBackup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-BackupsCrmInstance</command:name> <command:verb>Get</command:verb> <command:noun>BackupsCrmInstance</command:noun> <maml:description> <maml:para>Retrieves all backups for a Dynamics 365 Customer Engagement (online) instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-BackupsCrmInstance cmdlet retrieves all backups for a Dynamics 365 Customer Engagement (online) instance.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-BackupsCrmInstance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>InstanceId</maml:name> <maml:Description> <maml:para>Instance Id for the specific instance of Dynamics 365 Customer Engagement (online). Use the Get-BackupsCrmInstance cmdlet to find all instance Ids within the same tenant.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ApiUrl</maml:name> <maml:Description> <maml:para>URL of the Dynamics 365 Customer Engagement (online) root service endpoint.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>User credential for signing in to Microsoft Dynamics 365 Customer Engagement (online).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>InstanceId</maml:name> <maml:Description> <maml:para>Instance Id for the specific instance of Dynamics 365 Customer Engagement (online). Use the Get-BackupsCrmInstance cmdlet to find all instance Ids within the same tenant.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>MaxCrmConnectionTimeOutMinutes</maml:name> <maml:Description> <maml:para>Maximum number in minutes to wait before quitting the operation.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para>System.Uri System.Management.Automation.PSCredential System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Get-BackupsCrmInstance -ApiUrl $connectionhost -InstanceId <instanceid> -Credential $cred</dev:code> <dev:remarks> <maml:para>Returns a list of all backups for the instance as indicated by the InstanceId parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-BackupsCrmInstance</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-BackupsCrmInstance</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |