SyncMember Class

An Azure SQL Database sync member.

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

Inheritance
azure.mgmt.sql.models._models_py3.ProxyResource
SyncMember

Constructor

SyncMember(*, database_type: str | 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 | SyncDirection | None = None, **kwargs)

Parameters

Name Description
database_type
Required

Database type of the sync member. Possible values include: "AzureSqlDatabase", "SqlServerDatabase".

sync_agent_id
Required
str

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

sql_server_database_id
Required
str

SQL Server database id of the sync member.

sync_member_azure_database_resource_id
Required
str

ARM resource id of the sync member logical database, for sync members in Azure.

use_private_link_connection
Required

Whether to use private link connection.

server_name
Required
str

Server name of the member database in the sync member.

database_name
Required
str

Database name of the member database in the sync member.

user_name
Required
str

User name of the member database in the sync member.

password
Required
str

Password of the member database in the sync member.

sync_direction
Required

Sync direction of the sync member. Possible values include: "Bidirectional", "OneWayMemberToHub", "OneWayHubToMember".

Keyword-Only Parameters

Name Description
database_type
Required
sync_agent_id
Required
sql_server_database_id
Required
sync_member_azure_database_resource_id
Required
use_private_link_connection
Required
server_name
Required
database_name
Required
user_name
Required
password
Required
sync_direction
Required

Variables

Name Description
id
str

Resource ID.

name
str

Resource name.

type
str

Resource type.

private_endpoint_name
str

Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure.

sync_state

Sync state of the sync member. Possible values include: "SyncInProgress", "SyncSucceeded", "SyncFailed", "DisabledTombstoneCleanup", "DisabledBackupRestore", "SyncSucceededWithWarnings", "SyncCancelling", "SyncCancelled", "UnProvisioned", "Provisioning", "Provisioned", "ProvisionFailed", "DeProvisioning", "DeProvisioned", "DeProvisionFailed", "Reprovisioning", "ReprovisionFailed", "UnReprovisioned".