IEndpointSwitch Interface

 

Applies To: Dynamics CRM 2015

Represents the switching of a web service endpoint for an organization from a primary URL to an alternate URL.

Namespace:   Microsoft.Xrm.Sdk.Client
Assembly:  Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)

Syntax

public interface IEndpointSwitch
public interface class IEndpointSwitch
type IEndpointSwitch = interface end
Public Interface IEndpointSwitch

Properties

Name Description
System_CAPS_pubproperty AlternateEndpoint

Gets the alternate web service endpoint for accessing an organization, if one exists.

System_CAPS_pubproperty EndpointAutoSwitchEnabled

Gets or sets whether automatic switching from the current endpoint of the web service to an alternate endpoint is enabled.

System_CAPS_pubproperty IsPrimaryEndpoint

Gets whether the organization’s current endpoint is the primary endpoint.

System_CAPS_pubproperty PrimaryEndpoint

Gets the primary web service endpoint for accessing an organization.

Methods

Name Description
System_CAPS_pubmethod CanSwitch(Uri)

Checks if the specified endpoint URI is different from the organization’s alternate endpoint URI.

System_CAPS_pubmethod HandleEndpointSwitch()

Fires the EndpointSwitchRequired event, then if EndpointAutoSwitchEnabled is true, switches the organization’s endpoints by calling SwitchEndpoint.

System_CAPS_pubmethod SwitchEndpoint()

Switches the organization’s current endpoint to an alternate endpoint.

Events

Name Description
System_CAPS_pubevent EndpointSwitched

Notification event that a failover has completed and the organization’s current endpoint has been switched to an alternate endpoint.

System_CAPS_pubevent EndpointSwitchRequired

Notification event that a failover has occurred and a switch from the organization’s current endpoint to an alternate endpoint is required.

See Also

Microsoft.Xrm.Sdk.Client Namespace
Disaster recovery in Microsoft Dynamics CRM Online

Return to top

© 2016 Microsoft. All rights reserved. Copyright