CrmServiceClient.ImportSolutionToCrm Method

Definition

Namespace:

Microsoft.Xrm.Tooling.Connector

Assembly:

Microsoft.Xrm.Tooling.Connector.dll

Package:

Microsoft.CrmSdk.XrmTooling.CoreAssembly v9.1.1.65

Overloads

ImportSolutionToCrm(Guid, Guid, Boolean, Boolean, Boolean, Boolean, Boolean, Dictionary<String,Object>)	Imports a solution to the CRM server currently connected.
ImportSolutionToCrm(String, Guid, Boolean, Boolean, Boolean, Boolean, Boolean, Dictionary<String,Object>)	Imports a solution to the CRM Server currently connected.

ImportSolutionToCrm(Guid, Guid, Boolean, Boolean, Boolean, Boolean, Boolean, Dictionary<String,Object>)

Imports a solution to the CRM server currently connected.

public Guid ImportSolutionToCrm (Guid StageSolutionUploadId, out Guid importId, bool activatePlugIns = true, bool overwriteUnManagedCustomizations = false, bool skipDependancyOnProductUpdateCheckOnInstall = false, bool importAsHoldingSolution = false, bool isInternalUpgrade = false, System.Collections.Generic.Dictionary<string,object> extraParameters = default);

member this.ImportSolutionToCrm : Guid * Guid * bool * bool * bool * bool * bool * System.Collections.Generic.Dictionary<string, obj> -> Guid

Public Function ImportSolutionToCrm (StageSolutionUploadId As Guid, ByRef importId As Guid, Optional activatePlugIns As Boolean = true, Optional overwriteUnManagedCustomizations As Boolean = false, Optional skipDependancyOnProductUpdateCheckOnInstall As Boolean = false, Optional importAsHoldingSolution As Boolean = false, Optional isInternalUpgrade As Boolean = false, Optional extraParameters As Dictionary(Of String, Object) = Nothing) As Guid

Parameters

StageSolutionUploadId

Guid

Unique identifier of an uploaded and staged solution.

importId

Guid

Unique identifier of the import job that will be created to perform the import. You can use this ID to request status on the import via a request to the ImportJob entity.

activatePlugIns

Boolean

Activate plug-ins and workflows upon solution import.

overwriteUnManagedCustomizations

Boolean

Indicates whether any unmanaged customizations that have been applied over existing managed solution components should be overwritten.

skipDependancyOnProductUpdateCheckOnInstall

Boolean

Indicates whether enforcement of dependencies related to product updates should be skipped.

importAsHoldingSolution

Boolean

Import solution as holding solution staged for upgrade.

isInternalUpgrade

Boolean

For internal use.

extraParameters

Dictionary<String,Object>

Extra parameters to pass.

Returns

Guid

The job ID of the import.

Remarks

This is a blocking call and will take some time to complete.

ImportSolutionToCrm(String, Guid, Boolean, Boolean, Boolean, Boolean, Boolean, Dictionary<String,Object>)

Imports a solution to the CRM Server currently connected.

public Guid ImportSolutionToCrm (string solutionPath, out Guid importId, bool activatePlugIns = true, bool overwriteUnManagedCustomizations = false, bool skipDependancyOnProductUpdateCheckOnInstall = false, bool importAsHoldingSolution = false, bool isInternalUpgrade = false, System.Collections.Generic.Dictionary<string,object> extraParameters = default);

member this.ImportSolutionToCrm : string * Guid * bool * bool * bool * bool * bool * System.Collections.Generic.Dictionary<string, obj> -> Guid

Public Function ImportSolutionToCrm (solutionPath As String, ByRef importId As Guid, Optional activatePlugIns As Boolean = true, Optional overwriteUnManagedCustomizations As Boolean = false, Optional skipDependancyOnProductUpdateCheckOnInstall As Boolean = false, Optional importAsHoldingSolution As Boolean = false, Optional isInternalUpgrade As Boolean = false, Optional extraParameters As Dictionary(Of String, Object) = Nothing) As Guid

Parameters

solutionPath

String

Path to the solution file.

importId

Guid

This will populate with the import ID even if the request failed. You can use this ID to request status on the import via a request to the ImportJob entity.

activatePlugIns

Boolean

Activate plug-ins and workflows on the solution.

overwriteUnManagedCustomizations

Boolean

Forces an overwrite of unmanaged customizations of the managed solution you are installing. Defaults to false.

skipDependancyOnProductUpdateCheckOnInstall

Boolean

Skips dependency against dependencies flagged as product update. Defaults to false.

importAsHoldingSolution

Boolean

Applies only on CRM organizations version 7.2 or higher. This imports the CRM solution as a holding solution utilizing the “As Holding” capability of ImportSolution

isInternalUpgrade

Boolean

Internal use only.

extraParameters

Dictionary<String,Object>

Extra parameters.

Returns

Guid

The job ID of the import.

Remarks

This is a blocking call and will take some time to complete.