Share via

SyncAgent Class

An Azure SQL Database sync agent.

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

Constructor

SyncAgent(*, sync_database_id: str | None = None, **kwargs)

Parameters

Name Description
sync_database_id
Required
str

ARM resource id of the sync database in the sync agent.

Keyword-Only Parameters

Name Description
sync_database_id
Default value: None

Variables

Name Description
id
str

Resource ID.
name
str

Resource name.
type
str

Resource type.
name_properties_name
str

Name of the sync agent.
last_alive_time
datetime

Last alive time of the sync agent.
state
str or SyncAgentState

State of the sync agent. Possible values include: "Online", "Offline", "NeverConnected".
is_up_to_date
bool

If the sync agent version is up to date.
expiry_time
datetime

Expiration time of the sync agent version.
version
str

Version of the sync agent.