IEndpointSwitch Interface

 

Updated: November 29, 2016

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

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)

public interface IEndpointSwitch

NameDescription
System_CAPS_pubpropertyAlternateEndpoint

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

System_CAPS_pubpropertyEndpointAutoSwitchEnabled

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

System_CAPS_pubpropertyIsPrimaryEndpoint

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

System_CAPS_pubpropertyPrimaryEndpoint

Gets the primary web service endpoint for accessing an organization.

NameDescription
System_CAPS_pubmethodCanSwitch(Uri)

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

System_CAPS_pubmethodHandleEndpointSwitch()

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

System_CAPS_pubmethodSwitchEndpoint()

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

NameDescription
System_CAPS_pubeventEndpointSwitched

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

System_CAPS_pubeventEndpointSwitchRequired

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

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show: