Get-CrmOrganizationUserMap

Applies To: CRM 2016 on-prem, Dynamics 365 (on-premises)

Get-CrmOrganizationUserMap

Retrieves an XML file used to map users from a Microsoft Dynamics CRM organization about to be imported to an existing user domain.

Syntax

Parameter Set: Default
Get-CrmOrganizationUserMap [-SqlServerName] <String> [-DatabaseName] <String> [[-FileName] <String> ] [-Credential <PSCredential> ] [-Diag] [-DwsServerUrl <String> ] [-Timeout <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Get-CrmOrganizationUserMap cmdlet retrieves the organization users and formats them into an XML file that can be used to map users to the target deployment. This cmdlet can produce the user map as an XML document or write the XML document to a file. This behavior is controlled by the -FileName parameter. If the parameter is present, it writes to the file specified; if it is not, it returns the XML.

Parameters

-Credential<PSCredential>

Specifies the credentials used to log in to the Deployment web service.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-DatabaseName<String>

Specifies the name of the organization database to import. The organization database should already be imported to the computer that’s running Microsoft SQL Server.

Aliases	none
Required?	true
Position?	2
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-Diag

Turns on stack traces for error reports returned from Microsoft Dynamics 365 service calls. Enabling this will emit a detailed error message, including a stack trace, when an error is encountered by the Dynamics 365 PowerShell command.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-DwsServerUrl<String>

Identifies the location of the Deployment web service.This should be in the format: http://<serverurl> or https://<serverurl>, for example, http://contoso.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-FileName<String>

Specifies the file name that will be generated when the user map completes. If the parameter is present, it will write to the file specified; if it is not, it will return the XML.

Aliases	none
Required?	false
Position?	3
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-SqlServerName<String>

The name of the computer that’s running SQL Server that hosts the organization database to import.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-Timeout<Int32>

For internal use only.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

PS C:\> 

PS C:\>