AvailabilityGroupReplica Class

Definition

Namespace:

Microsoft.SqlServer.Management.HadrData

Assembly:

Microsoft.SqlServer.Management.HadrData.dll

Package:

Microsoft.SqlServer.SqlManagementObjects v160.2004021.0

Class representing an AG replica

public class AvailabilityGroupReplica

type AvailabilityGroupReplica = class

Public Class AvailabilityGroupReplica

Inheritance

Object

AvailabilityGroupReplica

Constructors

AvailabilityGroupReplica(AvailabilityGroupReplicaData)

Constructor

Fields

DefaultBackupPriority	The default backup priority
DefaultEndpointName	The Default Endpoint Name
DefaultEndpointPortNumber	Default endpoint port number
GetServerSleepTime	Server sleep time
SidConditionFormat	The format string used in ExistsSID method can move to extension

Properties

AvailabilityGroupReplicaData	The AvailabilityGroupReplicaData Object
BackupPriority	Property for availabilityGroupReplicaData.backupPriority
ConnectedAs	Returns the login with which the replicas are connected
EndpointEncryption	property for this.availabilityGroupReplicaData.encryption, since encryption need a initial value, we have to write get/set
EndpointEncryptionAlgorithm	internal class for get/set EndpointEncryptionAlgorithm, since encryptionAlgorithm need a initial value, we have to write get/set
EndpointName	Endpoint name
EndpointPortNumber	Endpoint port address
InitialRoleString	Localizable String for InitialRole enum
IsEndpointEncrypted	True if the endpoint is encrypted
IsValidDomainUserForWinAuthentication	Use the EndpointPresent in place of (endpoint==null). When a replica does not have the database mirroring endpoint and users navigate to the summary page and click the script button, the script action runs the whole process to configure the endpoint in capture mode to generate the scripts and assigns a memory endpoint objects to the endpoint variable. After navigating back to replicate page and forward to the summary page again, the endpoint is not null this time and PropertyNotSet exception is thrown by endpoint.Payload.DatabaseMirroring.EndpointAuthenticationOrder
ReadableSecondaryRole	Readable secondary role of the availability replica

Methods

AddGrantServiceAccount(IEnumerable<String>)	Grant the connect right to a set of users
AdjustEndpointEncryption(AvailabilityGroupReplica)	will use the primary replica endpoint encryption setting to adjust this replica endpoint encryption setting
ConfigureEndpoint()	Configure Endpoint of this replica
CreateLogins(IEnumerable<String>)	Create logins for the service accounts of other replicas, which do not exist.
GetLoginsForRemoteReplicas(IEnumerable<KeyValuePair<Byte[],String>>)	Retrieve a list of pairs of a login name and if it exists in the replica KeyValuePair contains a localServiceAccount and a flag for the existance of sid
GetServer()	Get the Server object
IsValidEndpoint()	method to determine if it is a valid endpoint
SetEndpointUrl()	Set Endpoint URL method