Share via

SyncGroup Class

  • Reference

An Azure SQL Database sync group.

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

Constructor

SyncGroup(*, sku: Sku | None = None, interval: int | None = None, conflict_resolution_policy: str | SyncConflictResolutionPolicy | None = None, sync_database_id: str | None = None, hub_database_user_name: str | None = None, hub_database_password: str | None = None, schema: SyncGroupSchema | None = None, enable_conflict_logging: bool | None = None, conflict_logging_retention_in_days: int | None = None, use_private_link_connection: bool | None = None, **kwargs)

Parameters

Name Description
sku
Required
Sku

The name and capacity of the SKU.
interval
Required
int

Sync interval of the sync group.
conflict_resolution_policy
Required
str or SyncConflictResolutionPolicy

Conflict resolution policy of the sync group. Possible values include: "HubWin", "MemberWin".
sync_database_id
Required
str

ARM resource id of the sync database in the sync group.
hub_database_user_name
Required
str

User name for the sync group hub database credential.
hub_database_password
Required
str

Password for the sync group hub database credential.
schema
Required
SyncGroupSchema

Sync schema of the sync group.
enable_conflict_logging
Required
bool

If conflict logging is enabled.
conflict_logging_retention_in_days
Required
int

Conflict logging retention period.
use_private_link_connection
Required
bool

If use private link connection is enabled.

Keyword-Only Parameters

Name Description
sku
Default value: None
interval
Default value: None
conflict_resolution_policy
Default value: None
sync_database_id
Default value: None
hub_database_user_name
Default value: None
hub_database_password
Default value: None
schema
Default value: None
enable_conflict_logging
Default value: None
conflict_logging_retention_in_days
Default value: None
use_private_link_connection
Default value: None

Variables

Name Description
id
str

Resource ID.
name
str

Resource name.
type
str

Resource type.
last_sync_time
datetime

Last sync time of the sync group.
sync_state
str or SyncGroupState

Sync state of the sync group. Possible values include: "NotReady", "Error", "Warning", "Progressing", "Good".
private_endpoint_name
str

Private endpoint name of the sync group if use private link connection is enabled.