FailoverGroup Class

A failover group.

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

Constructor

FailoverGroup(*, tags: Dict[str, str] | None = None, read_write_endpoint: FailoverGroupReadWriteEndpoint | None = None, read_only_endpoint: FailoverGroupReadOnlyEndpoint | None = None, partner_servers: List[PartnerInfo] | None = None, databases: List[str] | None = None, **kwargs)

Parameters

Name	Description
tags Required	dict[str, str] A set of tags. Resource tags.
read_write_endpoint Required	FailoverGroupReadWriteEndpoint Read-write endpoint of the failover group instance.
read_only_endpoint Required	FailoverGroupReadOnlyEndpoint Read-only endpoint of the failover group instance.
partner_servers Required	list[PartnerInfo] List of partner server information for the failover group.
databases Required	list[str] List of databases in the failover group.

Keyword-Only Parameters

Name	Description
tags	Default value: None
read_write_endpoint	Default value: None
read_only_endpoint	Default value: None
partner_servers	Default value: None
databases	Default value: None

Variables

Name	Description
id	str Resource ID.
name	str Resource name.
type	str Resource type.
location	str Resource location.
replication_role	str or FailoverGroupReplicationRole Local replication role of the failover group instance. Possible values include: "Primary", "Secondary".
replication_state	str Replication state of the failover group instance.