InstanceFailoverGroup Class

An instance failover group.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

InstanceFailoverGroup(*, secondary_type: str | _models.SecondaryInstanceType | None = None, read_write_endpoint: _models.InstanceFailoverGroupReadWriteEndpoint | None = None, read_only_endpoint: _models.InstanceFailoverGroupReadOnlyEndpoint | None = None, partner_regions: list['_models.PartnerRegionInfo'] | None = None, managed_instance_pairs: list['_models.ManagedInstancePairInfo'] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
secondary_type	str or SecondaryInstanceType Type of the geo-secondary instance. Set 'Standby' if the instance is used as a DR option only. Known values are: "Geo" and "Standby". Default value: None
read_write_endpoint	InstanceFailoverGroupReadWriteEndpoint Read-write endpoint of the failover group instance. Default value: None
read_only_endpoint	InstanceFailoverGroupReadOnlyEndpoint Read-only endpoint of the failover group instance. Default value: None
partner_regions	list[PartnerRegionInfo] Partner region information for the failover group. Default value: None
managed_instance_pairs	list[ManagedInstancePairInfo] List of managed instance pairs in the failover group. Default value: None

Variables

Name	Description
id	str Resource ID.
name	str Resource name.
type	str Resource type.
secondary_type	str or SecondaryInstanceType Type of the geo-secondary instance. Set 'Standby' if the instance is used as a DR option only. Known values are: "Geo" and "Standby".
read_write_endpoint	InstanceFailoverGroupReadWriteEndpoint Read-write endpoint of the failover group instance.
read_only_endpoint	InstanceFailoverGroupReadOnlyEndpoint Read-only endpoint of the failover group instance.
replication_role	str or InstanceFailoverGroupReplicationRole Local replication role of the failover group instance. Known values are: "Primary" and "Secondary".
replication_state	str Replication state of the failover group instance.
partner_regions	list[PartnerRegionInfo] Partner region information for the failover group.
managed_instance_pairs	list[ManagedInstancePairInfo] List of managed instance pairs in the failover group.