InstanceFailoverGroup interface
An instance failover group.
- Extends
Properties
managed |
List of managed instance pairs in the failover group. |
partner |
Partner region information for the failover group. |
read |
Read-only endpoint of the failover group instance. |
read |
Read-write endpoint of the failover group instance. |
replication |
Local replication role of the failover group instance. NOTE: This property will not be serialized. It can only be populated by the server. |
replication |
Replication state of the failover group instance. NOTE: This property will not be serialized. It can only be populated by the server. |
secondary |
Type of the geo-secondary instance. Set 'Standby' if the instance is used as a DR option only. |
Inherited Properties
id | Resource ID. NOTE: This property will not be serialized. It can only be populated by the server. |
name | Resource name. NOTE: This property will not be serialized. It can only be populated by the server. |
type | Resource type. NOTE: This property will not be serialized. It can only be populated by the server. |
Property Details
managedInstancePairs
List of managed instance pairs in the failover group.
managedInstancePairs?: ManagedInstancePairInfo[]
Property Value
partnerRegions
Partner region information for the failover group.
partnerRegions?: PartnerRegionInfo[]
Property Value
readOnlyEndpoint
Read-only endpoint of the failover group instance.
readOnlyEndpoint?: InstanceFailoverGroupReadOnlyEndpoint
Property Value
readWriteEndpoint
Read-write endpoint of the failover group instance.
readWriteEndpoint?: InstanceFailoverGroupReadWriteEndpoint
Property Value
replicationRole
Local replication role of the failover group instance. NOTE: This property will not be serialized. It can only be populated by the server.
replicationRole?: string
Property Value
string
replicationState
Replication state of the failover group instance. NOTE: This property will not be serialized. It can only be populated by the server.
replicationState?: string
Property Value
string
secondaryType
Type of the geo-secondary instance. Set 'Standby' if the instance is used as a DR option only.
secondaryType?: string
Property Value
string
Inherited Property Details
id
Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.
id?: string
Property Value
string
Inherited From ProxyResource.id
name
Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
name?: string
Property Value
string
Inherited From ProxyResource.name
type
Resource type. NOTE: This property will not be serialized. It can only be populated by the server.
type?: string
Property Value
string
Inherited From ProxyResource.type