Share via

Replica interface

Package:
@azure/arm-postgresql-flexible

Replica properties of a server.

Properties

capacity

Maximum number of read replicas allowed for a server. NOTE: This property will not be serialized. It can only be populated by the server.
promoteMode

Type of operation to apply on the read replica. This property is write only. Standalone means that the read replica will be promoted to a standalone server, and will become a completely independent entity from the replication set. Switchover means that the read replica will roles with the primary server.
promoteOption

Data synchronization option to use when processing the operation specified in the promoteMode property. This property is write only.
replicationState

Indicates the replication state of a read replica. This property is returned only when the target server is a read replica. Possible values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating NOTE: This property will not be serialized. It can only be populated by the server.
role

Role of the server in a replication set.

Property Details

capacity

Maximum number of read replicas allowed for a server. NOTE: This property will not be serialized. It can only be populated by the server.

capacity?: number

Property Value

number

promoteMode

Type of operation to apply on the read replica. This property is write only. Standalone means that the read replica will be promoted to a standalone server, and will become a completely independent entity from the replication set. Switchover means that the read replica will roles with the primary server.

promoteMode?: string

Property Value

string

promoteOption

Data synchronization option to use when processing the operation specified in the promoteMode property. This property is write only.

promoteOption?: string

Property Value

string

replicationState

Indicates the replication state of a read replica. This property is returned only when the target server is a read replica. Possible values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating NOTE: This property will not be serialized. It can only be populated by the server.

replicationState?: string

Property Value

string

role

Role of the server in a replication set.

role?: string

Property Value

string