Deployment web service messages

 

Updated: November 29, 2016

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

You can use deployment server messages to retrieve and update deployment settings. Most of these messages use the classes described in Deployment entities and deployment configuration settings. The base class for all messages is DeploymentServiceRequest.

The following table lists the synchronous messages supported by the deployment service, to be used with the IDeploymentService. Execute method. Synchronous requests will be committed within a 60-second timeout.

Request class name

Description

AddDeploymentAdministratorRequest

Adds a deployment service administrator account. The user must already exist in Active Directory.

DeferredOperationRequest

Base class for asynchronous operations. See Asynchronous messages.

DeleteRequest

Deletes a deployment or configuration settings record. You can also call the Delete method.

RetrieveAdvancedSettingsRequest

For internal use only. Retrieves values from the configuration database.

RetrieveAllRequest

Retrieves all records for the specified deployment or configuration settings entity. You can also call the RetrieveAll method.

RetrieveRequest

Retrieves the specified deployment or configuration settings record by name or by ID. You can also call the Retrieve method.

TrackLicenseRequest

Tracks client access license (CAL) usage and server license usage.

UpdateAdvancedSettingsRequest

For internal use only. Updates a writable setting in the configuration database.

UpdateProductKeyRequest

Updates the product key.

UpdateRequest

Updates a deployment or configuration settings record. You can also call the Update method.

Asynchronous requests return an ID that can be used to retrieve current state and show status. For example, in a create organization request a retrieve would show the org status as ”pending.” If you make multiple asynchronous requests they will be queued. Each request in the queue is processed serially.

The following table lists the asynchronous messages supported by the deployment service.

Request class name

Description

BeginCreateOrganizationRequest

Initiates the creation of a new organization. This is an asynchronous request.

BeginImportOrganizationRequest

Initiates the import of an organization. This is an asynchronous request.

BeginUpdateOrganizationRequest

Initiates the update of a Microsoft Dynamics 365 (online) organization. This is an asynchronous request.

BeginUpgradeOrganizationRequest

Initiates the upgrade of an on-premises Microsoft Dynamics 365 organization. This is an asynchronous request.

Before you begin to create or import an organization, check to see if the unique name for the organization is not on the reserved names list defined in the configuration database. For a partial list, see UniqueName.

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show: