RetrieveUserMappingRequest Class

Article
11/28/2016

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

Contains the data needed to retrieve mapping information of existing users in a Microsoft Dynamics 365 organization.

Namespace: Microsoft.Xrm.Sdk.Deployment
Assembly: Microsoft.Xrm.Sdk.Deployment (in Microsoft.Xrm.Sdk.Deployment.dll)

Inheritance Hierarchy

System.Object
Microsoft.Xrm.Sdk.Deployment.DeploymentServiceRequest
Microsoft.Xrm.Sdk.Deployment.RetrieveUserMappingRequest

Syntax

[DataContractAttribute(Name = "RetrieveUserMappingRequest", Namespace = "https://schemas.microsoft.com/xrm/2011/Contracts/Deployment")]
public class RetrieveUserMappingRequest : DeploymentServiceRequest

<DataContractAttribute(Name := "RetrieveUserMappingRequest", Namespace := "https://schemas.microsoft.com/xrm/2011/Contracts/Deployment")>
Public Class RetrieveUserMappingRequest
    Inherits DeploymentServiceRequest

Constructors

	Name	Description
	RetrieveUserMappingRequest()	Initializes a new instance of the RetrieveUserMappingRequest class.

Properties

	Name	Description
	DatabaseName	Gets or sets the name of the Dynamics 365 database to import from.
	ExtensionData	Gets or sets the structure that contains extra data.(Inherited from DeploymentServiceRequest.)
	SqlServerName	Gets or sets the name of the Microsoft SQL Server instance that hosts the Dynamics 365 database from where you want to import.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Remarks

Usage

Pass an instance of this class to the Execute method, which returns an instance of the RetrieveUserMappingResponse class.

Notes for Callers

You can also use the Get-CrmOrganizationUserMapWindows PowerShell command. For more information, see Administer the deployment using Windows PowerShell.

The retrieved information is in an XML format, which can be used to map the existing users from the current organization in the target deployment.

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.