SyncMember Class

An Azure SQL Database sync member.

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

Constructor

SyncMember(*, database_type: str | _models.SyncMemberDbType | None = None, sync_agent_id: str | None = None, sql_server_database_id: str | None = None, sync_member_azure_database_resource_id: str | None = None, use_private_link_connection: bool | None = None, server_name: str | None = None, database_name: str | None = None, user_name: str | None = None, password: str | None = None, sync_direction: str | _models.SyncDirection | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
database_type	str or SyncMemberDbType Database type of the sync member. Known values are: "AzureSqlDatabase" and "SqlServerDatabase". Default value: None
sync_agent_id	str ARM resource id of the sync agent in the sync member. Default value: None
sql_server_database_id	str SQL Server database id of the sync member. Default value: None
sync_member_azure_database_resource_id	str ARM resource id of the sync member logical database, for sync members in Azure. Default value: None
use_private_link_connection	bool Whether to use private link connection. Default value: None
server_name	str Server name of the member database in the sync member. Default value: None
database_name	str Database name of the member database in the sync member. Default value: None
user_name	str User name of the member database in the sync member. Default value: None
password	str Password of the member database in the sync member. Default value: None
sync_direction	str or SyncDirection Sync direction of the sync member. Known values are: "Bidirectional", "OneWayMemberToHub", and "OneWayHubToMember". Default value: None

Variables

Name	Description
id	str Resource ID.
name	str Resource name.
type	str Resource type.
database_type	str or SyncMemberDbType Database type of the sync member. Known values are: "AzureSqlDatabase" and "SqlServerDatabase".
sync_agent_id	str ARM resource id of the sync agent in the sync member.
sql_server_database_id	str SQL Server database id of the sync member.
sync_member_azure_database_resource_id	str ARM resource id of the sync member logical database, for sync members in Azure.
use_private_link_connection	bool Whether to use private link connection.
private_endpoint_name	str Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure.
server_name	str Server name of the member database in the sync member.
database_name	str Database name of the member database in the sync member.
user_name	str User name of the member database in the sync member.
password	str Password of the member database in the sync member.
sync_direction	str or SyncDirection Sync direction of the sync member. Known values are: "Bidirectional", "OneWayMemberToHub", and "OneWayHubToMember".
sync_state	str or SyncMemberState Sync state of the sync member. Known values are: "SyncInProgress", "SyncSucceeded", "SyncFailed", "DisabledTombstoneCleanup", "DisabledBackupRestore", "SyncSucceededWithWarnings", "SyncCancelling", "SyncCancelled", "UnProvisioned", "Provisioning", "Provisioned", "ProvisionFailed", "DeProvisioning", "DeProvisioned", "DeProvisionFailed", "Reprovisioning", "ReprovisionFailed", and "UnReprovisioned".