BeginImportOrganizationRequest Class

Article
11/28/2016

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

Contains the data that is needed to begin the asynchronous operation to import an 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.DeferredOperationRequest
Microsoft.Xrm.Sdk.Deployment.BeginImportOrganizationRequest

Syntax

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

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

Constructors

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

Properties

	Name	Description
	DatabaseName	Gets or sets the database name for the organization. Required.
	ExtensionData	Gets or sets the structure that contains extra data.(Inherited from DeploymentServiceRequest.)
	FriendlyName	Gets or sets the sets display name, or long name, of the organization database. Optional.
	SqlServerName	Gets or sets the name of the Microsoft SQL Server where the Microsoft Dynamics 365 organization database is located. Required.
	SrsUrl	Gets or sets the URL of the Microsoft SQL Server on which the Microsoft Dynamics 365 Connector for SQL Server Reporting Services is installed. Required.
	UniqueName	Gets or sets the unique name for the organization. Optional.
	UserMappingMethod	Gets or sets the mapping method to use to map user accounts from the original server to the new server. Optional.
	UserMappingXml	Gets or sets the XML user account mapping rules. Optional.

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 BeginImportOrganizationResponse.

Notes for Callers

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

You can use the Get-CrmOperationStatusWindows PowerShell command to check the status of this asynchronous request. Or, you can use the RetrieveRequest message using the OperationId property to set the InstanceTag property.

Examples

BeginImportOrganizationRequest request = new BeginImportOrganizationRequest();
request.DatabaseName = "MyOrgName" + "_MSCRM";
request.SqlServerName = Config.SetupSqlServer;
request.SrsUrl = "http://" + Config.SetupSqlServer + "/reportserver";

Guid operationId = ((BeginImportOrganizationResponse)_deploymentService.Execute(request)).OperationId;

DeferredOperationStatus importOrgOperationStatus = WaitForAsyncOperationAndReturnStatus(operationId);

If (importOrgOperationStatus.State == DeferredOperationState.Completed)
   //Do something

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.

Share via