Deployment web service messages
Applies To: Dynamics 365 (on-premises), Dynamics CRM 2016
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.
In This Topic
Synchronous messages
Asynchronous messages
Synchronous messages
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 |
|---|---|
Adds a deployment service administrator account. The user must already exist in Active Directory. |
|
Base class for asynchronous operations. See Asynchronous messages. |
|
Deletes a deployment or configuration settings record. You can also call the Delete method. |
|
For internal use only. Retrieves values from the configuration database. |
|
Retrieves all records for the specified deployment or configuration settings entity. You can also call the RetrieveAll method. |
|
Retrieves the specified deployment or configuration settings record by name or by ID. You can also call the Retrieve method. |
|
Tracks client access license (CAL) usage and server license usage. |
|
For internal use only. Updates a writable setting in the configuration database. |
|
Updates the product key. |
|
Updates a deployment or configuration settings record. You can also call the Update method. |
Asynchronous messages
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 |
|---|---|
Initiates the creation of a new organization. This is an asynchronous request. |
|
Initiates the import of an organization. This is an asynchronous request. |
|
Initiates the update of a Microsoft Dynamics 365 (online) organization. This is an asynchronous request. |
|
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.
See Also
IDeploymentService
DeploymentServiceRequest
DeploymentServiceResponse
Administer the deployment using the deployment web service
Introduction to the deployment web service
Deployment entities and deployment configuration settings
Microsoft Dynamics 365
© 2017 Microsoft. All rights reserved. Copyright