IEndpointSwitch Interface

Definition

Namespace:

Microsoft.Xrm.Sdk.Client

Assembly:

Microsoft.Xrm.Sdk.dll

Package:

Microsoft.PowerPlatform.Dataverse.Client v1.1.32

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

public interface class IEndpointSwitch

public interface IEndpointSwitch

type IEndpointSwitch = interface

Public Interface IEndpointSwitch

Properties

AlternateEndpoint	Gets the alternate web service endpoint for accessing an organization, if one exists.
EndpointAutoSwitchEnabled	Gets or sets whether automatic switching from the current endpoint of the web service to an alternate endpoint is enabled.
IsPrimaryEndpoint	Gets whether the organization’s current endpoint is the primary endpoint.
PrimaryEndpoint	Gets the primary web service endpoint for accessing an organization.

Methods

CanSwitch(Uri)	Checks if the specified endpoint URI is different from the organization’s alternate endpoint URI.
HandleEndpointSwitch()	Fires the EndpointSwitchRequired event, then if EndpointAutoSwitchEnabled is true, switches the organization’s endpoints by calling SwitchEndpoint().
SwitchEndpoint()	Switches the organization’s current endpoint to an alternate endpoint.

Events

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