Microsoft.Xrm.Sdk.Deployment

Gets the timeout for sending requsts to the web service.

Initializes a new instance of the class.

Type: Binding. The binding. Type: EndpointAddress. The address of the remote endpoint.

Initializes a new instance of the class.

Type: String. The name of the endpoint configuration.

Initializes a new instance of the class.

Type: String. The name of the endpoint configuration. Type: EndpointAddress. The address of the remote endpoint.

Initializes a new instance of the class.

Type: String. The name of the endpoint configuration. Type: String. The address of the remote endpoint.

Deletes a deployment record.

Type: . The type of deployment entity specified by the parameter. Type: . The ID of the deployment record to delete. The ID of a deployment record is also referred to as an instance tag. Deployment entities and deployment configuration settings

Executes a deployment service message in the form of a request, and returns a response.

Type: . A request instance that defines the action to be performed. Type: The response from the request. Deployment entities and deployment configuration settings

Retrieves a deployment record.

Type: . The type of deployment entity specified by the parameter. Type: . The ID of the deployment record to retrieve. Type: The deployment record. The ID of a deployment record is also referred to as an instance tag. Deployment entities and deployment configuration settings

Retrieves all deployment records for the specified deployment entity type.

Type: . The type of deployment entity for which to retrieve all records. Type: <>The collection of all deployment records. Deployment entities and deployment configuration settings

Updates a deployment record.

Type: . An instance of a deployment record with all values populated. See Remarks. Before calling this method you should call to get the deployment entity instance. Unlike the , this update method will use all attribute values in the instance to update the record. Deployment entities and deployment configuration settings

Initializes a new instance of the the class.

Initializes a new instance of the class.

Deletes a deployment record.

Type: . The type of deployment entity specified by the parameter. Type: . The ID of the deployment record to delete. See Remarks. The ID of a deployment record is also referred to as an instance tag. Deployment entities and deployment configuration settings

Executes a message in the form of a request, and returns a response.

Type: . A request instance that defines the action to be performed. Type: The response from the request. You must cast the return value of this method to the specific instance of the response that corresponds to the parameter Deployment entities and deployment configuration settings

Retrieves a deployment record.

Type: . The type of deployment entity specified by the parameter. Type: . The ID of the deployment record to retrieve. See Remarks. Type: The deployment record. The ID of a deployment record is also referred to as an instance tag. Deployment entities and deployment configuration settings

Retrieves all deployment records for the specified deployment entity type.

Type: . The type of deployment entity for which to retrieve all records. Type: <>The collection of all deployment records. Deployment entities and deployment configuration settings

Updates a deployment record.

Initializes a new instance of the class.

Creates a deployment web service client, setting the URL.

Type: URI. The URL for the deployment Web service. Returns . Use the following URL, replacing myservername with the name of your Microsoft Dynamics 365 server. http:// myservername/xrmdeployment/2011/deployment.svc

Creates a deployment web service client, setting the URL and the timeout.

Type: URI. The URL for the deployment Web service. Type: TimeSpan. The timeout value. Returns . Use the following URL, replacing myservername with the name of your Microsoft Dynamics 365 server. http:// myservername/xrmdeployment/2011/deployment.svc

Initializes a new instance of the class.

Gets or sets the name of the SQL Server database backup file.

Type: StringThe name of the SQL Server database backup file. This should be a full backup file of the source Microsoft Dynamics 365 database. This file must be accessible from SQL Server.

Gets or sets the name of the SQL Server database log file (.ldf).

Type: StringThe name of the SQL Server database log file (.ldf). This file must be accessible from SQL Server.

Gets or sets the name of the SQL Server database metadata file (.mdf).

Type: StringThe name of the SQL Server database metadata file (.mdf). This file must be accessible from SQL Server.

Gets or sets the name of the Dynamics 365 organization database to import.

Type: StringThe name of the Dynamics 365 organization database to import.

Gets or sets the name of the SQL Server instance where you want to add the Dynamics 365 organization database.

Type: StringThe name of the SQL Server instance where you want to add the Dynamics 365 organization database.

Gets or sets the name of the deployment administrator to be added. Required.

Type: StringThe name of the deployment administrator to be added, which string must be in the format domain\userid.

Gets or sets the interval used to query to see if there are any organization maintenance jobs that have timed out.

Type: Int32 The interval at which the service will determine if any job has been running longer than .

Gets or sets a value used for organization maintenance jobs to determine if a job has timed out.

Type: Int32 The timeout value for organization maintenance jobs. At each , the service will query to determine if a job has been running longer than the value.

Gets or sets the number of times an asynchronous job will retry before it fails or suspends.

Type: Int32 The number of retries for an asynchronous job.

Gets or sets the maximum number of times a database operation will be attempted before failure.

Type: Int32 The number of retries for a database operation.

Gets or sets the interval used to query to see if there is a pending organization maintenance job.

Type: Int32 The query interval for organization maintenance jobs.

Gets or sets the default rate of retries for failed asynchronous operations.

Type: Int32 The retry rate for failed asynchronous operations. This setting should be used in conjunction with the property.

Gets or sets the root domain used for calls into the Microsoft Dynamics 365 service from the asynchronous service.

Type: String The root domain.

Gets or sets the interval used to determine if new asynchronous operations should be loaded into memory.

Type: Int32 The interval for loading asynchronous operations into memory.

Gets or sets the throttling configuration.

Type: String The throttling configuration. Example: "BulkDelete=15;Workflow=1;Event=1".

Gets or sets the interval used to query to see if there are any asynchronous operations that have timed out.

Type: Int32 The query interval.

For internal use only.

Returns .

Gets or sets the organization instance to be created. Required.

Type: The organization instance to be created.

Gets or sets the name of the system administrator for the new organization. Required.

Type: StringThe name of the system administrator for the new organization. The format of this string is domain\userid. The user must exist in Active Directory.

Gets or sets the database name for the organization. Required.

Type: StringThe database name for the organization. This property cannot be updated after the organization is created.

Gets or sets the sets display name, or long name, of the organization database. Optional.

Type: StringThe sets display name, or long name, of the organization database. This will default to the existing friendly name in the organization database.

Gets or sets the name of the Microsoft SQL Server where the Microsoft Dynamics 365 organization database is located. Required.

Type: StringThe name of the Microsoft SQL Server where the Microsoft Dynamics 365 organization database is located. This property is required.

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.

Type: StringThe URL of the Microsoft SQL Server on which the Microsoft Dynamics 365 Connector for SQL Server Reporting Services is installed.

Gets or sets the unique name for the organization. Optional.

Type: StringThe unique name for the organization. This will default to a unique version of the friendly name. For information about invalid unique names, see .

Gets or sets the mapping method to use to map user accounts from the original server to the new server. Optional.

Type: The mapping method to use to map user accounts from the original server to the new server.

Gets or sets the XML user account mapping rules. Optional.

Type: StringThe XML user account mapping rules. If you have specified for the property, you must provide this value.

Gets or sets the ID or instance tag of the organization to update. Required.

Type: The ID or instance tag of the organization to update.

Gets or sets the ID or the instance tag of the organization to upgrade. Required.

Type: The ID or the instance tag of the organization to upgrade. You can get this value by retrieving the organization.

Gets or sets the certificate type.

Type: StringThe certificate type.

Gets or sets the certificate data.

Type: StringThe certificate data.

Gets or sets the certificate ID.

Type: GuidThe certificate ID.

Gets or sets the certificate name.

Type: StringThe certificate name.

Gets or sets the store find type.

Type: StringThe store find type.

Gets or sets the store location.

Type: StringThe store location.

Gets or sets the store name.

Type: StringThe store name.

Gets or sets whether the setting is enabled.

Type: Booleantrue if the setting is enabled; otherwise, false.

Gets or sets the encryption certificate.

Type: StringThe encryption certificate.

Gets or sets the federation metadata URL.

Type: StringThe federation metadata URL.

Gets or sets the federation provider type.

Type: Int32The federation provider type: 0 = regular claims, 1 = OAuth.

Gets or sets the session security token lifetime.

Type: Int32The session security token lifetime. Specified as the number of hours since the security token was created.

Gets or sets the collection of attribute values.

Type: The collection of attribute values.

Gets or sets the ID of the configuration entity.

Type: GuidThe ID of the configuration entity.

Gets or sets the logical name of the configuration entity.

Type: StringThe logical name of the configuration entity.

Gets or sets whether XAML workflows are allowed on the server.

Type: Booleantrue if XAML workflows are allowed on the server; otherwise, false. You can also use Windows PowerShell to set this. For more information, see Enable or disable XAML workflows. Custom XAML workflows

Gets or sets whether plug-ins and custom workflow activities can be registered on the server.

Type: Booleantrue if the plug-ins and custom workflow activities can be registered on the server; otherwise, false. You can also use Windows PowerShell to set this. For more information, see Enable or disable custom code. Custom workflow activities (workflow assemblies)

Gets or sets the maximum number of controls allowed on dashboards for the server.

Type: Int32 The maximum number of controls allowed on dashboards for the server. The maximum value is 20. You can also use Windows PowerShell to get or set this value. For more information, see Set the number of dashboard controls.

Gets or sets the error code.

Type: Int32The error code.

Gets or sets the detailed error information.

Type: The collection of error information.

Gets or sets the structure that contains extra data.

Type: ExtensionDataObjectThe extension data.

Gets or sets the error message.

Type: StringThe error message.

Gets the ID of the asynchronous request.

Type: GuidThe ID of the asynchronous request. You can use the Windows PowerShell command to check the status of this asynchronous request.

Gets or sets the ID of the deployment entity instance associated with this deferred operation.

Type: The ID of the deployment entity instance associated with this deferred operation.

Gets or sets the time that the deferred operation processing completed.

Type: DateTimeThe time that the deferred operation processing completed.

Gets or sets the error information for the deferred operation.

Type: The error information for the deferred operation.

Gets or sets the time that the deferred operation processing started.

Type: DateTimeThe time that the deferred operation processing started.

Gets or sets the current state of the deferred operation.

Type: The current state of the deferred operation. Check this value to see the current state of the process.

Gets or sets the time that the deferred operation processing was submitted.

Type: DateTimeThe time that the deferred operation processing was submitted.

Gets or sets a value that indicates whether to detach the Dynamics 365 database from the SQL Server instance.

Type: BooleanIndicates whether to detach the Dynamics 365 database from the SQL Server instance. to detach the database, otherwise, . This only removes the database from your deployment; it doesn’t delete the physical database on the server.

Gets or sets the type of deployment entity to be deleted.

Type: the type of deployment entity to be deleted. The deployment type must match the record specified by the property.

Gets or sets the ID or the instance tag for the deployment record to be deleted.

Type: The ID or the instance tag for the deployment record to be deleted. The deployment type specified by the property must match the entity type for this record.

Gets the ID of the deployment administrator.

Type: GuidThe ID of the deployment administrator. This property is assigned a value when the record is created.

Gets or sets the domain name and user ID of the deployment administrator.

Type: String The domain name and user ID of the deployment administrator. The format of this string is domain\userid. The user must exist in Active Directory.

Gets or sets the structure that contains extra data.

Gets or sets the error code.

Type: Int32The error code.

Gets or sets the collection of detailed information about the error.

Type: The collection of error information.

Gets or sets the structure that contains extra data.

Type: ExtensionDataObjectThe extension data.

Gets or sets the fault instance that caused the current fault.

Type: The fault instance.

Gets or sets the error message.

Type: StringThe error message.

Gets or sets the date/time value when the error occurred.

Type: DateTimeThe date/time of the error.

Gets or sets the structure that contains extra data.

Type: ExtensionDataObjectThe extension data.

Gets or sets the structure that contains extra data.

Type: ExtensionDataObjectThe extension data.

Gets or sets the bulk duplicate detection batch size.

Type: Int32 The batch size.

Gets or sets the length of the match code.

Type: Int32 The length of the match code.

Gets or sets the persistence interval for the match code.

Type: Int32 The persistence interval.

Gets or sets the maximum number of published rules.

Type: Int32 The maximum number of published rules.

Gets or sets the polling interval for the asynchronous job.

Type: Int32 The polling interval.

Gets or sets the page size for results.

Type: Int32 The page size.

Gets or sets the structure that contains extra data.

Type: ExtensionDataObjectThe extension data.

Gets or sets the ID of the record.

Type: Guid The ID of the record.

Gets or sets the name of the deployment entity.

Type: String The name of the deployment entity.

Gets or sets whether Enterprise Transaction Monitor (ETM) is enabled.

Type: BooleanFlag indicating whether Enterprise Transaction Monitor (ETM) is enabled.

Gets or sets whether Enterprise Transaction Monitor (ETM) throttling is enabled.

Type: BooleanFlag indicating whether Enterprise Transaction Monitor (ETM) throttling is enabled.

Gets or sets the discovery web service domain.

Type: String The discovery web service domain.

Gets or sets a value that indicates whether Internet-facing deployment (IFD) is enabled.

Type: Booleantrue if Internet-facing deployment (IFD) is enabled; otherwise, false.

Gets or sets the external domain value for Internet-facing deployment (IFD).

Type: String The external domain value for IFD. Use of SSL is assumed so it is not necessary to specify https://.

Gets or sets a value that indicates whether intranet access is enabled.

Type: Booleantrue if intranet access is enabled; otherwise, false. If true, allows intranet URLs to be returned over Internet discovery requests.

Gets or sets the organization web service domain.

Type: String The organization web service domain.

Gets or sets the web application server domain.

Type: String The web application server domain.

Gets or sets the number of items to process in a batch.

Type: Int32The number of items to process in a batch.

Gets or sets the size of the content buffer.

Type: Int32The size of the content buffer.

Gets or sets the batch size for import count updates.

Type: Int32The batch size for import count updates.

Gets or sets the maximum number of columns in an import file.

Type: Int32The maximum number of columns in an import file.

Gets or sets the maximum number or retries.

Type: Int32The maximum number or retries.

Gets or sets the default size of the parsed column.

Type: Int32The default size of the parsed column.

Gets or sets the batch size for picklist import.

Type: Int32The batch size for picklist import.

Gets or sets the edition of Microsoft Dynamics CRM 2011 for this license.

Type: The edition of Microsoft Dynamics CRM 2011 for this license.

Gets or sets the ID of the product.

Type: Int32The ID of the product.

Gets or sets the proxy server and port used for outgoing internet requests.

Type: StringThe proxy server and port.

Gets or sets whether the solutions marketplace is enabled.

Type: Boolean

Gets or sets the time when monitoring test ended.

Type DateTimeTime to filter test results that were reported earlier than the specified time.

Gets or sets the ID of the monitoring test.

Type Guid ID of the monitoring test.

Gets or sets the Dynamics 365 role for which the monitoring test was run.

Type role for which the monitoring test was run. Monitoring test results are run for the following roles: AppServer, AsyncService, SrsDataConnector, DiscoveryService, EmailService, WebService, SqlServer, ApiServer, HelpServer, DeploymentService, SrsSqlServer, SandboxServer, and DeploymentManagementTools.

Gets or sets the Dynamics 365 server name where the test was run.

Type StringThe Dynamics 365 server name where the test was run.

Gets or sets the time when monitoring test started.

Type DateTimeThe time when the test started.

Gets or sets the status of the test.

Type Status of the test.

Gets or sets the information about the test status.

Type StringInformation about the test status.

Gets or sets the name of the test.

Type StringName of the test. A test result name can have one of the following values: VerifyAsyncServiceMaintenanceRunning, VerifyAsyncServiceRunning, VerifySandboxServiceIsRunning, VerifyUnZipServiceIsRunning, VerifyVSSWriterServiceIsRunning, VerifyWebsiteIsRunning, VerifyApplicationAppPoolIsRunning, VerifyDeploymentWebServiceAppPoolIsRunning, CheckApiServer, CheckWebApp, VerifyActiveCrmKeys, VerifyAsyncBacklogTest, VerifyHelpContent, CheckReportServer, CheckCrmReporting, CheckReportServerFromSrsDataConnector, and CheckFetchBasedReport.

Gets or sets the threshold of the certificate lifetime remaining at which to begin reporting expiration notifications.

Type: Int32The threshold of the certificate lifetime remaining at which to begin reporting expiration notifications. Specified as an integral percentage. If at the time the monitoring test runs the remaining time to expiration of the certificate is less than the threshold value, a warning is written into the event log along with details about the certificate.

Gets or sets the unique name of the organization that is being monitored.

Type: StringThe unique name of the organization.

Gets or sets the user account to be used when monitoring the organization.

Type: StringThe name of a user account.

Gets or sets the user account password to be used when monitoring the organization.

Type: StringThe password for the user account.

Gets or sets the number of monitoring results to keep.

Type: Int32The number of results to keep.

Gets or sets the number of monitoring results to keep in the database.

Type: Int32Number of monitoring results to keep in the database.

Gets or sets whether monitoring results should be kept in the database.

Type: Booleantrue if results should be kept in the database; otherwise, false.

Gets or sets the maximum degree of parallelism for multi-entity search queries. Required.

Type: Int32The maximum degree of parallelism for multi-entity search queries. The default value for this setting is 5.

Gets or sets the upper limit for the number of entities that can participate in a multi-entity search query. Required.

Type: Int32The upper limit for the number of entities that can participate in a multi-entity search query. The default value for this setting is 10.

Gets or sets the maximum number of concurrent requests per organization per server. Required.

Type: Int32The maximum number of concurrent requests per organization per server. The default value is -1, which means that the requests are not throttled.

Gets or sets the maximum number of concurrent requests per server. Required.

Type: Int32The maximum number of concurrent requests per server. The default value is -1, which means that the requests are not throttled.

Gets or sets the base currency code for the organization.

Type: String The base currency code for the organization. This property is required when using the class. This property cannot be updated after the organization is created.

Gets or sets the base currency name for the organization.

Type: String The base currency name for the organization. This property is optional when using the class. If not specified the default will be generated based on the base currency code. This property cannot be updated after the organization is created.

Gets or sets the number of decimal places that can be used for the base currency.

Type: Int32 The number of decimal places for the currency for the organization. This property is optional when using the class. If not specified the default will be generated based on the base currency code. This property cannot be updated after the organization is created.

Gets or sets the base currency symbol for the organization.

Type: String The base currency symbol for the organization. This property is optional when using the class. If not specified the default will be generated based on the base currency code. This property cannot be updated after the organization is created.

Gets or sets the base language code for the organization.

Type: Int32 The base language code for the organization. This property is required when using the class. This property cannot be updated after the organization is created. For more information about language packs, see the Installation Guide: Language Pack Installation Instructions.

Gets or sets the database name for the organization.

Type: String The database name for the organization. This property is required when using the class. This property cannot be updated after the organization is created.

Gets or sets the display name, or long name, of the organization database.

Type: String The display name, or long name, of the organization database. This property is required when using the class. It is optional when using the class.

Gets the organization ID.

Type: GuidThe organization ID. This property is assigned a value when the organization is created. This property is required when using the class.

Gets or sets the SQL collation property that the organization will use to sort and compare data characters.

Type: String The SQL collation property that the organization will use to sort and compare data characters. This property is required when using the class. This property cannot be updated after the organization is created. Collation and Unicode Supporthttp://msdn.microsoft.com/en-us/library/ms143726.aspx

Gets or sets the name of the SQL server on which the organization database is installed.

Type: String The name of the SQL server on which the organization database is installed. This property is required when using the class. This property is optional when using the class.

Gets or sets whether information is being collected for the customer experience improvement program.

Type: Booleantrue if information is being collected for the customer experience improvement program; otherwise, false. This property is optional when using the class. If not specified the value is . This property cannot be updated after the organization is created. Microsoft Customer Experience Improvement Programhttp://www.microsoft.com/products/ceip/EN-US/default.mspx

Gets or sets the URL of the Microsoft SQL Server on which the Microsoft Dynamics 365 Connector for SQL Server Reporting Services is installed.

Type: String The URL of the Microsoft SQL Server on which the Microsoft Dynamics 365 Connector for SQL Server Reporting Services is installed. This property is required when using the class. This property is optional when using the class.

Gets or sets the organization state.

Type: The organization state.

Gets or sets the unique name for the organization.

Type: String The unique name for the organization. This property is optional when using the class. If not specified a unique name is generated using the friendly name. This property cannot be updated after the organization is created. The maximum length is 30 characters. Spaces and extended characters are not allowed The following words are a partial list of invalid unique names. Also included in this lists are offensive words, not listed here. Invalid name

Gets the current updated version of organization.

Type: String The current updated version of organization.

Gets or sets the type of client access license for the user.

Type: Int32The license type.

Gets or sets the domain name for the user.

Type: StringThe domain name.

Gets or sets the structure that contains extra data.

Type: ExtensionDataObject

Gets or sets the full name of the user.

Type: Int32The user’s full name.

Gets or sets the date the server was accessed by the user.

Type: StringA string containing the date of the last server access.

Gets or sets the time the server was accessed by the user.

Type: DateTimeContains the time of the last server access.

Gets or sets the maximum number of the attributes used in the quick find search query, after which the indexes are not created. Required.

Type: Int32The maximum number of the attributes used in the quick find search query, after which the indexes are not created. The default value for this setting is 20.

Gets or sets the maximum number of records that match the quick find query criteria before an exception error is thrown. This is needed for faster execution of the quick find searches. Required.

Type: Int32The maximum number of records that match the quick find query criteria before an exception error is thrown. The default value for this setting is 10000.

For internal use only.

Type: String

For internal use only.

Type:

For internal use only.

Type: String

Gets or sets the set of columns or attributes to be retrieved.

Type: The set of columns or attributes to be retrieved.

Gets of sets the name of the configuration entity.

Type: StringThe name of the configuration entity. This is the configuration database table name.

Gets or sets the ID of the record to be retrieved.

Type: GuidThe ID of the record to be retrieved.

Gets or sets the configuration entity that was retrieved.

Returns The configuration entity that was retrieved. The configuration entity retrieved contains an collection of attribute values.

Gets or sets the type of deployment entity to be retrieved.

Type: The type of deployment entity to be retrieved. Deployment entities and deployment configuration settings

Gets or sets the collection of IDs or instance tags for all the deployment records retrieved.

Type: <>The collection of IDs or instance tags for all the deployment records retrieved.

Gets or sets the time to filter test results that were reported earlier than the specified time.

Type DateTimeTime to filter test results that were reported earlier than the specified time.

Gets or sets the Dynamics 365 roles to filter the test result data.

Type StringRoles to filter the test results. Roles that can be specified for filtering the results are: AppServer, AsyncService, SrsDataConnector, DiscoveryService, EmailService, WebService, SqlServer, ApiServer, HelpServer, DeploymentService, SrsSqlServer, SandboxServer, and DeploymentManagementTools.

Gets or sets the server name to filter the test result data.

Type StringServer name to filter the test results.

Gets or sets a value that indicates whether to filter test results data on the deployment service health status.

Type BooleanIndicates whether to filter test results data on the deployment service health status. Service health status can have one of the values as specified in the .

Gets or sets the time to filter test results that were reported later than the specified time.

Type DateTimeTime to filter test results that were reported later than the specified time.

Gets or sets the test status to filter the test result data.

Type StringTest status to filter the test result data. You can use the test status values as specified in .

Gets or sets the name of the test to filter the test result data.

Type StringName of the test to filter the test result data. You can specify one of the following test names to filter your test result data: VerifyAsyncServiceMaintenanceRunning, VerifyAsyncServiceRunning, VerifySandboxServiceIsRunning, VerifyUnZipServiceIsRunning, VerifyVSSWriterServiceIsRunning, VerifyWebsiteIsRunning, VerifyApplicationAppPoolIsRunning, VerifyDeploymentWebServiceAppPoolIsRunning, CheckApiServer, CheckWebApp, VerifyActiveCrmKeys, VerifyAsyncBacklogTest, VerifyHelpContent, CheckReportServer, CheckCrmReporting, CheckReportServerFromSrsDataConnector, and CheckFetchBasedReport.

Gets or sets the retrieved monitoring results.

Type Retrieved monitoring results.

Gets or sets the retrieved service health status.

Type Retrieved service health status. Service health status can be one of the values as specified in .

Gets or sets the type of deployment entity to be retrieved.

Type: The type of deployment entity to be retrieved.

Gets or sets the ID or instance tag of the deployment record to be retrieved.

Type: The ID or instance tag of the deployment record to be retrieved. To retrieve the status of an asynchronous operation, use the property to set the value of this property.

Gets or sets the record that was retrieved.

Type: The record that was retrieved. Deployment web service object model

Gets or sets the name of the Dynamics 365 database to import from.

Type StringName of the Dynamics 365 database to import from.

Gets or sets the name of the Microsoft SQL Server instance that hosts the Dynamics 365 database from where you want to import.

Type StringName of the Microsoft SQL Server instance that hosts the Dynamics 365 database from where you want to import.

Gets or sets the retrieved user mapping information.

Type StringRetrieved user mapping information. The information is returned in an XML format that can be used for mapping the users in the target system.

Gets or sets the full name of the server.

Type: String The name of the server.

Gets the organization ID.

Type: GuidThe organization ID. This property is assigned a value when the server is created.

Gets the name of the server.

Type: String The name of the server.

Gets the set of roles configured for the server.

Type: The set of roles configured for the server.

Gets or sets the state of the server.

Type: The state of the server.

Gets the version number of the server.

Type: String The version number of the server.

Gets or sets the maximum duration, in seconds, after which the service checks an active mailbox for appointments, contacts, or tasks.

Type: Int32The maximum duration.

Gets or sets the minimum duration, in seconds, after which the service checks an active mailbox for appointments, contacts, or tasks.

Type: Int32The minimum duration.

Gets or sets the maximum duration, in seconds, after which the service checks an idle mailbox for appointments, contacts, or tasks.

Type: Int32The maximum duration.

Gets or sets the minimum duration, in seconds, after which the service checks an idle mailbox for appointments, contacts, or tasks.

Type: Int32The minimum duration.

Gets or sets the duration, in seconds, to postpone synchronizing appointments, contacts, or tasks for a mailbox on an Exchange server request time-out.

Type: Int32The duration.

Gets or sets the duration, in seconds, to postpone synchronizing appointments, contacts, or tasks for a mailbox after encountering a transient error.

Type: Int32The duration.

Gets or sets the maximum number of appointments, contacts, or tasks processed by an Exchange server in a cycle.

Type: Int32The maximum number.

Gets or sets the maximum number of transient failures that can occur before a mailbox is disabled for synchronizing appointments, contacts, or tasks.

Type: Int32The maximum number.

Gets or sets the maximum number of attempts allowed to synchronize an appointment, contact, or task.

Type: Int32The maximum number.

Gets or sets the batch size for retrieving appointments, contacts, tasks from an Exchange server.

Type: Int32The batch size.

Gets or sets the maximum duration, in seconds, after which the service checks an active mailbox for the user’s email.

Type: Int32The maximum duration.

Gets or sets the minimum duration, in seconds, after which the service checks an active mailbox for the user’s email.

Type: Int32The minimum duration.

Gets or sets a value that specifies whether to allow Active Directory based authentication to connect with email servers.

Type: Booleantrue to allow Active Directory authentication; otherwise, false. The default value for Microsoft Dynamics 365 (online) is false, and for Microsoft Dynamics 365 on premises the default value is true.

Gets or sets a value that specifies whether Microsoft Dynamics 365 is allowed to connect to an email server on a non-secure channel using Basic/Clear Text authentication, for both outgoing and incoming email.

Type: Booleantrue to allow basic authentication; otherwise, false.

Gets or sets a value that specifies whether to allow entering the user credentials via a non-secure channel.

Type: Booleantrue to allow non-secure authentication; otherwise, false.

Gets or sets a value that specifies whether Microsoft Dynamics 365 is allowed to connect to an email server on a non-secure channel, for both outgoing and incoming email.

Type: Booleantrue to allow non-secure email; otherwise, false.

Gets or sets the maximum number of parallel migration processes on the server for an organization. Any migration request exceeding this value is rejected.

Type: Int32The maximum number of parallel migration processes.

Gets or sets the maximum batch size for discovering Exchange web services URL in a single request.

Type: Int32The batch size.

Gets or sets the maximum redirects honored in an Exchange web services auto-discover request.

Type: Int32The maximum number of redirects.

Gets or sets the maximum duration, in seconds, after which the service checks an idle mailbox for the user’s email.

Type: Int32The maximum duration, in seconds.

Gets or sets the minimum duration, in seconds, after which the service checks an idle mailbox for the user’s email.

Type: Int32The minimum duration, in seconds.

Gets or sets the email retrieval batch size of the Exchange server.

Type: Int32The email retrieval batch size.

Gets or sets the maximum limit, in bytes, for the incoming message size. This setting applies to email received from an Exchange or POP3 email server type.

Type: Int32The maximum email size limit.

Gets or sets the maximum number of messages that an incoming provider can process in a cycle.

Type: Int32The maximum number of messages.

Gets or sets a value that specifies whether to enable logging of Exchange web services response headers in Microsoft Dynamics 365 traces.

Type: Booleantrue if logging is enabled; otherwise, false.

Gets or sets the duration, in seconds, that sending or receiving email is postponed for a mailbox when a request to the email server times out.

Type: Int32The maximum duration, in seconds.

Gets or sets the duration, in seconds, to postpone sending or receiving email for a mailbox after a transient error occurs.

Type: Int32The maximum duration, in seconds.

Gets or sets the duration, in minutes, that sending email from a mailbox is postponed when the Exchange submission quota is exceeded.

Type: Int32The maximum duration, in seconds.

Gets or sets the maximum number of attempts that can be made to send an email.

Type: Int32The maximum number of attempts.

Gets or sets the maximum size of response, in KB, from Exchange using Exchange web services.

Type: Int32The maximum response size in KB.

Gets or sets the number of transient failures that can occur before the mailbox is automatically disabled.

Type: Int32The maximum number of failures.

Gets or sets the capacity of the message ID cache for server-side synchronization.

Type: Int32The cache capacity.

Gets or sets the time, in minutes, that the email message ID is retained in the cache.

Type: Int32The maximum time, in minutes.

Gets or sets the interval in minutes after which an email in pending send status is picked up for retry.

Type: Int32The maximum interval, in minutes.

Gets or sets the maximum number of days before the current date or time that server-side synchronization can be configured to process email. This information is provided in an email server profile record in Microsoft Dynamics 365.

Type: Int32The maximum number of days.

Gets or sets the interval, in minutes, after which an email in sending status is picked up for retry.

Type: Int32The maximum interval, in minutes.

Gets or sets the interval, in minutes, to attempt the email test configuration again.

Type: Int32The maximum interval, in minutes.

Gets or sets the number of activities to be removed from a queue per asynchronous event.

Type: Int32 The number of activities to be removed.

Defines the upper limit of the number of activity batches held in memory at any point of time.

Type: Int32The maximum number of items held in memory.

Defines the lower limit beyond which the service will stop removing activity batches held in memory from the queue.

Type: Int32The minimum number of items held in memory.

Defines the maximum percentage of worker threads to be used for running asynchronous operations.

Type: DoubleThe maximum percentage of threads.

Defines the maximum number of threads per CPU to be used for running asynchronous operations.

Type: Int32The maximum number of threads.

Defines how frequently to poll the organization database activity pointer table to check for any new outgoing emails that have to be sent.

Type: Int32The polling interval, in seconds.

Controls the number of mailboxes to be removed from a queue per asynchronous event.

Type: Int32The number of mailboxes removed from a queue.

Gets or sets the upper limit on the number of mailbox batches held in memory, beyond which the service will stop removing mailboxes from the queue.

Type: Int32The maximum number of mailbox batches to be held in memory.

Gest or sets the lower limit on the number of mailbox batches held in memory, beyond which the service will stop removing mailboxes from the queue.

Type: Int32The minimum number of mailbox batches to be held in memory.

Defines the maximum percentage of worker threads for running asynchronous operations.

Type: DoubleThe maximum percentage of threads.

Defines the maximum number of threads per CPU for running asynchronous operations.

Type: Int32The maximum number of threads.

Defines the recurrence period, in seconds, of removing mailboxes from the queue in the database.

Type: Int32The recurrence period, in seconds.

Defines the number of minutes after which a locked mailbox record is checked again for incoming email processing in case of a service crash.

Type: Int32The retry delay, in minutes.

Controls the maximum number of activities that can be removed from the queue for an organization per select interval.

Type: Int32The maximum number per interval.

Defines the maximum time allowed for any call to the email server to complete. If a response isn’t received from the email server within this time period, the request is aborted. This setting applies to both Exchange and POP3/SMTP.

Type: Int32The waiting operation timeout.

Gets or sets the value that indicates whether collection of information for the customer experience improvement program is enabled.

Type: Booleantrue if the information collection for the customer experience program is enabled; otherwise, false.

Gets or sets the maximum number of auto created (system-managed) access teams per entity. Required.

Type: Int32The maximum number of auto created (system-managed) access teams per entity. The default value for this setting is 2.

Gets or sets the maximum number of entities that can be enabled for auto created (system-managed) access teams. Required.

Type: Int32The maximum number of entities that can be enabled for auto created (system-managed) access teams. The default value for this setting is 5.

Gets or sets the maximum number of concurrent asynchronous execute operations per organization.

Type: Int32The maximum number. Execute messages in the background (asynchronously)

Gets or sets the maximum number of concurrent execute multiple operations per organization per server.

Type: Int32The maximum number. Execute messages in the background (asynchronously)

Gets or sets the maximum number of concurrent execute multiple operations per organization.

Type: Int32The maximum number of concurrent execute multiple operations per organization. Use ExecuteMultiple to improve performance for bulk data load

Gets or sets the maximum number of concurrent execute multiple operations per organization per server.

Type: Int32The maximum number of concurrent execute multiple operations per organization per server. Use ExecuteMultiple to improve performance for bulk data load

For internal use only.

Type: Int32

For internal use only.

Type: Int32

Gets or sets the server setting to control the maximum number of MAPI sync operations.

Type: Int32The maximum number of MAPI sync operations.

Gets or sets the server setting to control the maximum number of MAPI sync operations per organization.

Type: Int32The maximum number of MAPI sync operations per organization.

Gets or sets the Server setting to control the maximum number of background email send operations per organization.

Type: Int32The maximum number of background email send operations per organization.

Gets or sets the server setting to control the maximum number of background email send operations.

Type: Int32The maximum number of background email send operations.

Gets or sets the maximum number of Microsoft SharePoint threads allowed per organization.

Type: Int32The maximum number of threads allowed.

Gets or sets the maximum number of Microsoft SharePoint threads allowed per user.

Type: Int32The maximum number of threads allowed.

Gets or sets the server setting to control the maximum number of offline sync operations.

Type: Int32Gets or sets the server setting to control the maximum number of offline sync operations.

Gets or sets the server setting to control the maximum number of offline sync operations per organization.

Type: Int32The maximum number of offline sync operations per organization.

Gets or sets the server setting to control the maximum number of Dynamics 365 for Outlook sync operations.

Type: Int32The maximum number of sync operations.

Gets or sets the server setting to control the maximum number of Dynamics 365 for Outlook sync operations per organization.

Type: Int32The maximum number of sync operations per organization.

Gets or sets whether to save the call stack.

Type: Booleantrue if saving the call stack is enabled; otherwise, false.

Gets or sets the categories to trace.

Type: String The categories to trace.

Gets or sets the directory for the trace files.

Type: String The directory for the trace files.

Gets or sets whether tracing is enabled.

Type: Booleantrue if tracing is enabled; otherwise, false.

Gets or sets the trace file size limit (MB).

Type: Int32 The size limit of the trace file in MB.

Gets or sets the end date for the license.

Type: DateTimeThe end date.

Gets or sets the type of license.

Type: The type of license.

Gets or sets the start date for the license.

Type: DateTimeThe start date.

Gets or sets the servers returned from the license request.

Type: <String>The collection of servers.

Gets or sets the users returned from the license request.

Type:<>The collection of users.

Gets or sets the configuration entity to be updated.

Type: The configuration entity to be updated. You must use the message to retrieve the entity before using this message.

Gets or sets the product key to update.

Type: StringThe product key to update.

Gets or sets the configuration entity to be updated.

Type: The configuration entity to be updated. You must use the message to retrieve the entity before using this message.

Gets or sets the root domain for the deployment Web service (SDK).

Type: StringThe root domain for the deployment Web service (SDK).

Gets or sets the root domain for the discovery Web service.

Type: StringThe root domain for the discovery Web service.

Gets or sets the URL for help content server.

Type: StringThe URL for help content server.

Gets or sets whether network load balancing (NLB) is enabled.

Type: Booleantrue if network load balancing (NLB) is enabled; otherwise, false.

Gets or sets the root domain scheme: http or https.

Type: The root domain scheme: http or https.

Gets or sets the root domain for the organization Web service (SDK).

Type: StringThe root domain for the organization Web service (SDK).

Gets or sets the secured sockets layer (SSL) header.

Type: StringThe secured sockets layer (SSL) header.

Gets or sets the root domain for the Web application.

Type: StringThe root domain for the Web application.

Gets or sets the maximum depth for a workflow.

Type: Int32The maximum depth for a workflow.

Gets or sets the maximum number of seconds a workflow can be inactive.

Type: Int32The maximum number of seconds a workflow can be inactive.

Gets or sets the application ID.

Type: StringThe application ID. The application ID is retrieved from yammer.com when you register your application on Yammer.

Gets or sets the application secret.

Type: StringThe application secret. The application secret is provided by yammer.com when you register your application on Yammer.

Contains the data that is needed to add a Microsoft Dynamics 365 organization database to your deployment from a database backup or from a detached database.

Usage Pass an instance of this class to the method, which returns an instance of the class. Notes for Callers You can also use the Add-CrmDatabaseWindows PowerShell command. For more information, see Microsoft Dynamics CRM PowerShell Reference. Deployment web service messagesAdd-CrmDatabasehttps://technet.microsoft.com/en-us/library/dn833078.aspx

Contains the response from .

There is no return value from this operation.

Contains the data that is needed to add a deployment administrator. The user must already exist in Active Directory.

Usage Pass an instance of this class to the method, which returns an instance of . Notes for Callers You can also use the New-CrmDeploymentAdministratorWindows PowerShell command. For more information, see Administer the deployment using Windows PowerShell.


// The user must already exist in AD.
AddDeploymentAdministratorRequest request = new AddDeploymentAdministratorRequest();
request.Name = Config.AdminDomain + "\\" + userName;

_deploymentService.Execute(request);

Deployment web service messagesNew-CrmDeploymentAdministratorhttps://technet.microsoft.com/en-us/library/dn833060.aspx

Contains the response from the .

There is no return value from this operation.

The address scheme: http or https.

The address scheme is hypertext transfer protocol.

The address scheme is secure hypertext transfer protocol.

Contains setting values that can be changed to tune a Microsoft Dynamics 365 deployment.

You can also use Windows PowerShell to retrieve or update these settings. Deployment web service messagesDeployment entities and deployment configuration settingsAdminister the deployment using Windows PowerShelhttp://go.microsoft.com/fwlink/p/?LinkID=313999

Contains a collection of attributes.

Used in the class to hold a set of configuration attributes.

For internal use only.

Contains the data that is needed to initiate the asynchronous operation to create an organization.

Usage Pass an instance of this class to the method, which returns an instance of . Notes for Callers You can also use the New-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 message using the property to set the property.

Guid operationId = Guid.Empty;
            // instantiating the DeploymentServiceClient in a using statement ensures that the client
            // communication channel is closed and the object is disposed when falling out of scope.

            // CustomBinding_IDeploymenService is the name of the configuration setting for the CustomBinding
            using (DeploymentServiceClient client = new DeploymentServiceClient("CustomBinding_IDeploymentService"))
            {
                // Set properties for the new organization
                Organization organization = new Organization
                {
                    BaseCurrencyCode = "USD",
                    BaseCurrencyName = "US Dollar",
                    BaseCurrencyPrecision = 2,
                    BaseCurrencySymbol = "$",
                    BaseLanguageCode = 1033,
                    FriendlyName = "Alpine Ski House",
                    UniqueName = "AlpineSkiHouse",
                    SqlCollation = "Latin1_General_CI_AI",
                    SqlServerName = "CRM01",
                    SrsUrl = "http://CRM01/ReportServer",
                    SqmIsEnabled = false
                };

                // Create a request for the deployment service
                BeginCreateOrganizationRequest request = new BeginCreateOrganizationRequest();
                request.Organization = organization;

                // Execute the request
                BeginCreateOrganizationResponse response = (BeginCreateOrganizationResponse)client.Execute(request);

                // The operation is asynchronous, so the response object contains a unique identifier
                // for the operation
                operationId = response.OperationId;
             
            }

New-CrmOrganizationhttps://technet.microsoft.com/en-us/library/dn833086.aspxGet-CrmOperationStatushttps://technet.microsoft.com/en-us/library/dn833061.aspx

Contains the response from the.

There is no return value from this operation.

Contains the data that is needed to begin the asynchronous operation to import an organization.

Usage Pass an instance of this class to the method, which returns an instance of . 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 message using the property to set the property.


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

Import-CrmOrganizationhttps://technet.microsoft.com/en-us/library/dn833059.aspxGet-CrmOperationStatushttps://technet.microsoft.com/en-us/library/dn833061.aspx

Contains the response from the .

There is no return value from this operation.

Contains the data that is needed to begin the asynchronous operation to update an organization.

Pass an instance of this class to the method, which returns an instance of . You can also use the Update-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 message using the property to set the property. Deployment web service messagesUpdate-CrmOrganizationhttps://technet.microsoft.com/en-us/library/dn833062.aspxGet-CrmOperationStatushttps://technet.microsoft.com/en-us/library/dn833061.aspx

Contains the response from the.

There is no return value from this operation.

Contains the data that is needed to begin the asynchronous operation to upgrade an organization.

Pass an instance of this class to the method, which returns an instance of . You can use the Get-CrmOperationStatusWindows PowerShell command to check the status of this asynchronous request. Or, you can use the message using the property to set the property. Get-CrmOperationStatushttps://technet.microsoft.com/en-us/library/dn833061.aspx

Contains the response from the.

There is no return value from this operation.

Contains information about a certificate.

Contains the settings for claims based authentication using Active Directory Federation Services 2.0 (AD FS 2.0).

ClaimsSettings claimsSettings = 
    (ClaimsSettings)deploymentService.Retrieve(DeploymentEntityType.ClaimsSettings, null);

//Disable Claims using SDK
claimsSettings.Enabled = false;
deploymentService.Update(claimsSettings);

Deployment entities and deployment configuration settingsActive Directory and claims-based authentication

Base class for claims settings types.

Deployment entities and deployment configuration settings

Contains attributes for a specific table in the configuration database.

Server level settings that control use of custom code.

Deployment entities and deployment configuration settings

Server level dashboard settings.

You can also use Windows PowerShell to get or set this value. For more information, see Set the number of dashboard controls. Analyze data with dashboards

Contains information about an error that occurred with a deferred operation.

Used in the property.

Base class for all asynchronous requests for the deployment Web service.

Deployment web service messages

Base class for all asynchronous responses for the deployment Web service.

Deployment web service messages

Describes the possible states for an asynchronous operation.

Deployment web service messages

Specifies that the operation state is unknown. Value = 0.

Specifies that the operation is queued but has not been started. Value = 1.

Specifies that the operation is in progress. Value = 2.

Specifies that the operation has completed. Value = 3.

Specifies that the operation has failed. Value = 4.

Contains information about the status of a deferred operation.

Contains the data that’s needed to delete a Microsoft Dynamics 365 organization.

Usage Pass an instance of this class to the method, which returns an instance of the class. Notes for Callers You can also use the Remove-CrmOrganizationWindows PowerShell command. For more information, see Administer the deployment using Windows PowerShell. Remove-CrmOrganizationhttps://technet.microsoft.com/en-us/library/dn833057.aspx

Contains the response from .

There is no return value from this operation.

Contains the data that is needed to delete a deployment record.

Pass an instance of this class to the method, which returns an instance of . Note that this is the Deployment Web Service. To delete organization data records in Microsoft Dynamics 365, use . The following code shows how to delete an organization.

using (DeploymentServiceClient client = new DeploymentServiceClient("CustomBinding_IDeploymentService"))
{
    EntityInstanceId id = new EntityInstanceId
    {
        Name = "AlpineSkiHouse2"
    };

    // disable the organization
    Organization organization = (Organization)client.Retrieve(DeploymentEntityType.Organization, id);
    organization.State = OrganizationState.Disabled;
    client.Update(organization);


    // delete the organization
    DeleteRequest request = new DeleteRequest
    {
        EntityType = DeploymentEntityType.Organization,
        InstanceTag = id
    };
    DeleteResponse response = (DeleteResponse)client.Execute(request);

    client.Close();
}

Introduction to the deployment web service

Contains the response from the .

There is no return value from this operation.

Contains information about a deployment administrator in a Microsoft Dynamics 365 deployment.

There can be multiple deployment administrators per deployment. You can also use Windows PowerShell to access the deployment administrator information. Deployment web service messagesDeployment entities and deployment configuration settingsAdminister the deployment using Windows PowerShelhttp://go.microsoft.com/fwlink/p/?LinkID=313999

Base class for configuration settings entities.

Deployment entities and deployment configuration settings

Base class for deployment entities.

Deployment entities and deployment configuration settings

Describes the type of deployment entity.

The asynchronous settings entity. Value = 0.

The claims settings entity. Value = 1.

The OAuth claims settings entity. Value = 2.

The dashboard settings entity. Value = 3.

The duplicate detection settings entity. Value = 4.

The ETM settings entity. Value = 5.

The Internet-facing deployment (IFD) settings entity. Value = 6.

The data import settings entity. Value = 7.

The throttle settings entity. Value = 8.

The trace settings entity. Value = 9.

The web address settings entity. Value = 10.

The workflow settings entity. Value = 11.

The service quality metrics (SQM) settings entity. Value = 12.

The marketplace settings entity. Value = 13.

The custom code settings entity. Value = 14.

The team settings entity. Value = 15.

The multi-entity quick find settings entity. Value = 16.

The quick find settings entity. Value = 17.

The certificate entity. Value = 18.

The deployment administrator entity. Value = 19.

The server entity. Value = 20.

The organization entity. Value = 21.

The license properties entity. Value = 22.

The deferred operation status entity. Value = 23.

The monitoring settings entity. Value = 24.

The Yammer settings entity. Value = 25.

The server-side synchronization email settings entity. Value = 26.

The server-side synchronization queue settings entity. Value = 27.

The server side synchronization ACT settings entity. Value = 28.

Contains information about an error with the deployment web service.

The operation succeeded. Value = 0.

Information about the operation. Value = 1.

An operation was skipped. Value = 2.

A warning about the operation. Value = 3.

An error occurred. Value = 4.

Base class for deployment Web service entities and settings.

Implements interface and provides an authenticated WCF channel to the deployment service..

Introduction to the deployment web service

Represents a deployment service fault.

Contains the data that is needed to execute a request and the base class for all deployment service requests.

This is the base class for all deployment Web service requests. Pass an instance of a request class to the method. Introduction to the deployment web serviceDeployment web service messages

Contains the response from the request and the base class for all deployment Web service responses.

This is the base class for all deployment Web service responses. An instance of a response class is returned from the method. Some messages do not have a return value. Deployment web service messages

Contains duplicate detection settings that can be used to tune a deployment.

Contains the information needed to identify a deployment entity record: deployment entity type and ID.

Contains the collection of error details.

Contains Enterprise Transaction Monitor (ETM) settings.

Provides programmatic access to deployment information.

Introduction to the deployment web service

Interface for the deployment web service channel.

Contains settings for configuring Internet-facing deployments (IFDs).

Deployment entities and deployment configuration settings

Contains settings that can be changed to tune data import.

Defines the possible methods for mapping users when importing an organization.

Specifies to keep the existing user mappings in the organization database. Typically, you select this option if you’re importing an organization database that is located in the same Active Directory domain as the Microsoft Dynamics 365 server where the organization is to be imported. For users external to the Active Directory domain, who were added with their UPN, the user information will be mapped across without any changes or validation. Value = 0.

Specifies to automatically map the users' Active Directory account names to Microsoft Dynamics 365 accounts. Value = 1.

Specifies custom user account matching options in an XML string. Value = 2.

Specifies to look up Active Directory users in the new domain by using the user’s display name . Value = 3.

Specifies to map users with a mapping file. Value = 4.

Contains information about a license for Microsoft Dynamics CRM 2011.

Indicates the type of license.

Microsoft Dynamics CRM Small Business Edition. Value = 0.

Microsoft Dynamics CRM Professional Edition. Value = 1.

Microsoft Dynamics CRM Enterprise Edition. Value = 2.

Microsoft Dynamics Partner Hosted CRM Edition. Value = 3.

Microsoft Dynamics CRM Online Edition. Value = 4.

Contains settings for the Microsoft AppSource.

Deployment web service messagesDeployment entities and deployment configuration settingsAdminister the deployment using Windows PowerShelhttp://go.microsoft.com/fwlink/p/?LinkID=313999Microsoft Dynamics CRM Marketplacehttps://go.microsoft.com/fwlink/p/?LinkId=786912

Contains information about the result of a test run by the Microsoft Dynamics 365 monitoring service.

Contains settings used to manage or configure the monitoring service and the tests executed by the service.

At this time, the only tests run are those that monitor the remaining life for certificates installed for Microsoft Dynamics 365. Deployment web service messagesDeployment entities and deployment configuration settingsAdminister the deployment using Windows PowerShelhttp://go.microsoft.com/fwlink/p/?LinkID=313999

Contains settings for multi-entity quick find (finds records of different types).

You can use Windows PowerShell to retrieve or update these settings. Deployment web service messagesDeployment entities and deployment configuration settingsAdminister the deployment using Windows PowerShellhttp://go.microsoft.com/fwlink/p/?LinkID=313999

Contains the settings for claims based OAuth authentication.

OAuth 2.0http://oauth.net/2/

Contains information about an organization in a Microsoft Dynamics 365 deployment.

The properties for an organization are set when the organization is created. Most of the properties can’t be updated after the fact. You can also use Windows PowerShell to access the same organization information. Deployment web service messagesDeployment entities and deployment configuration settingsAdminister the deployment using Windows PowerShelhttp://go.microsoft.com/fwlink/p/?LinkID=313999

Describes the state of the organization.

Specifies that the organization is disabled. Value = 0.

Specifies that the organization is enabled. Value = 1.

Specifies that the organization is pending. Value = 2.

Specifies that the organization is in a failure state. Value = 3.

Specifies that the organization is undergoing maintenance. Value = 4.

Contains information about a user in an organization.

Provides helper methods to create a deployment service client class.


DeploymentServiceClient service = Microsoft.Xrm.Sdk.Deployment.Proxy.ProxyClientHelper.CreateClient(new Uri("http://MyServerName/XRMDeployment/2011/Deployment.svc"));

Introduction to the deployment web service

Contains settings for quick find (finds records of one type).

For internal use only.

Contains the data that is needed to retrieve advanced settings from the configuration database. For internal use only.

Pass an instance of this class to the method, which returns an instance of . You can also use the Get-CrmAdvancedSettingWindows PowerShell command. For more information, see Administer the deployment using Windows PowerShell. Note that only the settings that are writable are documented in the SDK. Get-CrmAdvancedSettinghttps://technet.microsoft.com/en-us/library/dn833082.aspx

Contains the response from the .

Contains the data that is needed to retrieve all deployment records of the specified deployment entity type.

Pass an instance of this class to the method, which returns an instance of . You can also use the corresponding Windows PowerShell command for the deployment entity you want to retrieve. For example, Get-CrmOrganization or Get-CrmSetting. For more information, see Administer the deployment using Windows PowerShell. Administer the deployment using Windows PowerShellhttp://go.microsoft.com/fwlink/p/?LinkID=313999

Contains the response from the .

Contains the data that’s required to retrieve results from the monitoring service operation tests for your Microsoft Dynamics 365 deployment.

Usage Pass an instance of this class to the method, which returns an instance of the class. Notes for Callers You can also use the Get-CrmMonitoringResultWindows PowerShell command. For more information, see Microsoft Dynamics CRM PowerShell Reference. Deployment web service messagesGet-CrmMonitoringResulthttp://technet.microsoft.com/en-us/library/dn833074.aspx

Contains the response from .

Contains the data that is needed to retrieve a deployment entity or configuration settings record.

Pass an instance of this class to the method, which returns an instance of . You can use this message to retrieve any of the valid entity types as specified by the enumeration. An organization deployment object has five possible states as defined by the enumeration. You can also use the corresponding Windows PowerShell command for the deployment entity you want to retrieve, for example, Get-CrmOrganization or Get-CrmSetting. For more information, see Administer the deployment using Windows PowerShell. Note that this is for the Deployment Web service. To retrieve organization data records, use .

// By instantiating the DeploymentServiceClient in a using statement you ensure that the client
// communication channel is closed and the object is disposed when it goes out of scope.

// CustomBinding_IDeploymenService is the name of the configuration setting for the CustomBinding

using (DeploymentServiceClient client = new DeploymentServiceClient("CustomBinding_IDeploymentService"))
{
             
    //The EntityIstanceId class is used to identify the object you want to
    // retrieve. You have the option of using name or ID.
    EntityInstanceId id = new EntityInstanceId
    {
        Name = "AlpineSkiHouse"
    };
    //Retrieve the organization
    Organization organization = (Organization)client.Retrieve(DeploymentEntityType.Organization, id);
             
    client.Close();
}

The following is an example of an Organization class instance serialized to XML:<?xml version="1.0" encoding="utf-8"?><Organization xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <ExtensionData /> <BaseCurrencyCode>USD</BaseCurrencyCode> <BaseCurrencyName>US Dollar</BaseCurrencyName> <BaseCurrencyPrecision>2</BaseCurrencyPrecision> <BaseCurrencySymbol>$</BaseCurrencySymbol> <BaseLanguageCode>1033</BaseLanguageCode> <DatabaseName>AlpineSkiHouse_MSCRM</DatabaseName> <FriendlyName>Alpine Ski House</FriendlyName> <Id>273c0010-5973-43d4-b666-8d899ca8c6ab</Id> <SqlCollation>Latin1_General_CI_AI</SqlCollation> <SqlServerName>CRM01</SqlServerName> <SqmIsEnabled>false</SqmIsEnabled> <SrsUrl>http://crm01/reportserver</SrsUrl> <State>Pending</State> <UniqueName>AlpineSkiHouse</UniqueName>Deployment entities and deployment configuration settingsAdminister the deployment using Windows PowerShellhttp://go.microsoft.com/fwlink/p/?LinkID=313999

Contains the response from the .

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

Usage Pass an instance of this class to the method, which returns an instance of the 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. Get-CrmOrganizationUserMaphttps://technet.microsoft.com/en-us/library/dn833071.aspx

Contains the response from .

Contains information about a server in a Microsoft Dynamics 365 deployment.

The properties for a server are set when the server is created. Most cannot be updated after the fact. You can also use Windows PowerShell to access the same organization information. Deployment web service messagesDeployment entities and deployment configuration settingsAdminister the deployment using Windows PowerShelhttp://go.microsoft.com/fwlink/p/?LinkID=313999

Describes specific server functionality, components, and services.

Blog: Making Sense of Server Roleshttp://blogs.msdn.com/b/crm/archive/2008/08/20/making-sense-of-server-roles.aspx

Indicates no roles. Value = 0.

The role that runs the Web application server that is used to connect users to Microsoft Dynamics CRM data. Value = 1.

The role that allows processing of queued asynchronous events, such as workflows, asynchronous plug-ins, bulk e-mail, or data import. Value = 2.

The role that provides reporting functionality by interfacing with the Microsoft Dynamics 365 system and Microsoft SQL Server Reporting Services. Value = 4.

The role that allows discovery of organizations. Value = 8.

For internal use only.. Value = 0x10.

Obsolete. Value = 0x20.

For internal use only.. Value = 0x40.

For internal use only.. Value = 0x80.

The role that installs the configuration database (MSCRM_CONFIG) on the SQL Server. Value = 0x100.

For internal use only.. Value = 0x200.

For internal use only.. Value = 0x400.

For internal use only.. Value = 0x800.

For internal use only.. Value = 0x1000.

For internal use only.. Value = 0x2000.

For internal use only.. Value = 0x4000.

The role that allows programmatic access to the organization Web service. Value = 0x8000.

For internal use only.. Value = 0x10000.

For internal use only.. Value = 0x20000.

The role that makes Microsoft Dynamics 365 help available to users. Value = 0x40000.

For internal use only.. Value = 0x80000.

For internal use only.. Value = 0x100000.

The role that allows programmatic access to deployment management. Value = 0x200000.

For internal use only.. Value = 0x400000.

For internal use only.. Value = 0x800000.

The role that enables an isolated environment for the execution of custom code, such as plug-ins. This isolated environment reduces the possibility of custom code affecting the operation of the organizations. Value = 0x1000000.

The role that allows the use of the Deployment Manager and Windows PowerShell cmdlets. Microsoft Dynamics 365 administrators can use the Windows PowerShell cmdlets to automate Deployment Manager tasks. Deployment Manager is a Microsoft Management Console (MMC) snap-in that system administrators can use to manage organizations, servers, and licenses for deployments of Microsoft Dynamics 365. Value = 0x4000000.

For internal use only.. Value = 0x8000000.

For internal use only.. Value = 0x10000000.

For internal use only.. Value = 0x20000000.

The role for the email connector. Value = 0x40000000.

Describes the state of a server.

Specifies that no server state. Value = -1.

Specifies that the server is disabled. Value = 0.

Specifies that the server is enabled. Value = 1.

Describes the deployment service health status.

Tests that didn’t require a test organization passed successfully.

Tests passed successfully.

Tests failed.

No tests have been run.

Contains settings about the Microsoft customer experience improvement program.

Deployment web service messagesDeployment entities and deployment configuration settingsAdminister the deployment using Windows PowerShelhttp://go.microsoft.com/fwlink/p/?LinkID=313999

Contains settings for the auto created (system-managed) access teams.

Indicates the result of a monitoring service operation test.

Test succeeded.

Test failed.

Test hasn’t run yet.

Contains information about service throttling.

Deployment web service messagesDeployment entities and deployment configuration settingsAdminister the deployment using Windows PowerShelhttp://go.microsoft.com/fwlink/p/?LinkID=313999Import data

Contains trace settings for a deployment.

Describes the type of license.

A professional client access license (CAL). Value = 0.

An essential client access license (CAL). Value = 1.

An administrative client access license (CAL). Value = 2.

A basic client access license (CAL). Value = 3.

A device professional client access license (CAL). Value = 4.

A device basic client access license (CAL). Value = 5.

A device enterprise client access license (CAL). Value = 6.

A workgroup server client access license (CAL). Value = 7.

A professional server client access license (CAL). Value = 8.

An enterprise client access license (CAL). Value = 9.

A service provider licensing agreement (SPLA) client access license (CAL). Value = 10.

An online server client access license (CAL). Value =11 .

An enterprise client access license (CAL). Value = 12.

A device essential client access license (CAL). Value = 13.

Contains the data that is needed to track the licenses for a deployment.

Pass an instance of this class to the method, which returns an instance of . Notes for Callers You can also use the Get-CrmAccessLicenseWindows PowerShell command to retrieve license information. For more information, see Administer the deployment using Windows PowerShell. Deployment entities and deployment configuration settingsGet-CrmAccessLicensehttps://technet.microsoft.com/en-us/library/dn833080.aspx

Contains the response from the.

Contains the data that is needed to update advanced settings from the configuration database. For internal use only.

Pass an instance of this class to the method, which returns an instance of . You can also use the Set-CrmAdvancedSettingWindows PowerShell command. For more information, see Administer the deployment using Windows PowerShell. Note that only the settings that are writable are documented in the SDK. Set-CrmAdvancedSettinghttps://technet.microsoft.com/en-us/library/dn833085.aspx

Contains the response from the.

There is no return value from this operation.

Contains the data that is needed to update a product key.

Pass an instance of this class to the method, which returns an instance of . Notes for Callers You can also use the Set-CrmProductKeyWindows PowerShell command. For more information, see Administer the deployment using Windows PowerShell. Introduction to the deployment web serviceSet-CrmProductKeyhttps://technet.microsoft.com/en-us/library/dn833072.aspx

Contains the response from the .

There is no return value from this operation.

Contains the data that is needed to update a deployment record.

Pass an instance of this class to the method, which returns an instance of . You can also use the corresponding Windows PowerShell command for the deployment entity you want to update. For example, Set-CrmProductKey or Set-CrmSetting. For more information, see Administer the deployment using Windows PowerShell. Note that this is for the Deployment Web service. To update organization data records use . The following code shows how to disable an organization.

using (DeploymentServiceClient client = new DeploymentServiceClient("CustomBinding_IDeploymentService"))
{
    EntityInstanceId id = new EntityInstanceId
    {
        Name = "AlpineSkiHouse"
    };

    Organization organization = (Organization)client.Retrieve(DeploymentEntityType.Organization, id);
    organization.State = OrganizationState.Disabled;
    client.Update(organization);

    client.Close();
}

The following code shows how to enable an organization.

using (DeploymentServiceClient client = new DeploymentServiceClient("CustomBinding_IDeploymentService"))
{
    EntityInstanceId id = new EntityInstanceId
    {
        Name = "AlpineSkiHouse"
    };


    Organization organization = (Organization)client.Retrieve(DeploymentEntityType.Organization, id);
    organization.State = OrganizationState.Enabled;
    client.Update(organization);


    client.Close();
}

Deployment entities and deployment configuration settingsAdminister the deployment using Windows PowerShellhttp://go.microsoft.com/fwlink/p/?LinkID=313999

Contains the response from the.

There is no return value from this operation.

Contains deployment specific root domain address values.

Deployment web service messagesDeployment entities and deployment configuration settingsAdminister the deployment using Windows PowerShellhttp://go.microsoft.com/fwlink/p/?LinkID=313999

Contains workflow setting values which can be changed to tune a Microsoft Dynamics 365 deployment.

Contains settings for Yammer.

The application Id and the application secret are passed to Yammer when you make an API call from Microsoft Dynamics 365 to Yammer. Yammer verifies that the API call is coming from the registered Dynamics 365 application. If the application Id and application secret passed in the API call don’t match the application Id and application secret in the Yammer database, the API call is rejected. For the API call to be acknowledged, both values must match. You can use Windows PowerShell to retrieve or update these settings. Deployment web service messagesDeployment entities and deployment configuration settingsAdminister the deployment using Windows PowerShellhttp://go.microsoft.com/fwlink/p/?LinkID=313999