Class ResignationRequestOptions

Namespace

Azure.Iot.Operations.Services.LeaderElection

Assembly

Azure.Iot.Operations.Services.dll

public class ResignationRequestOptions

Inheritance

object

ResignationRequestOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

CancelAutomaticRenewal

If true, this operation will also stop any auto-renewing configured by AutomaticRenewalOptions. If false, any auto-renewing will continue as-is.

public bool CancelAutomaticRenewal { get; set; }

Property Value

bool

Remarks

By default, auto-renewal will be cancelled.

SessionId

The optional value to include in the lock's value.

public string? SessionId { get; set; }

Property Value

string

Remarks

Only provide this value if the sessionId was set when campaigning to be leader in SessionId. If the sessionId was set when campaigning, but not when resigning (or vice versa), then attempts to resign will fail.

By providing a unique sessionId, an application can use the same candidate name and/or the same MQTT client in different threads to campaign to be leader on the same lock without worrying about accidentally allowing two clients to both be leader at the same time.