SyncMemberProperties interface

Properties of a sync member with support to MI.

Properties

databaseName

Database name of the member database in the sync member.

databaseType

Database type of the sync member.

password

Password of the member database in the sync member.

privateEndpointName

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

serverName

Server name of the member database in the sync member

sqlServerDatabaseId

SQL Server database id of the sync member.

syncAgentId

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

syncDirection

Sync direction of the sync member.

syncMemberAzureDatabaseResourceId

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

syncState

Sync state of the sync member.

usePrivateLinkConnection

Whether to use private link connection.

userName

User name of the member database in the sync member.

Property Details

databaseName

Database name of the member database in the sync member.

databaseName?: string

Property Value

string

databaseType

Database type of the sync member.

databaseType?: string

Property Value

string

password

Password of the member database in the sync member.

password?: string

Property Value

string

privateEndpointName

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

privateEndpointName?: string

Property Value

string

serverName

Server name of the member database in the sync member

serverName?: string

Property Value

string

sqlServerDatabaseId

SQL Server database id of the sync member.

sqlServerDatabaseId?: string

Property Value

string

syncAgentId

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

syncAgentId?: string

Property Value

string

syncDirection

Sync direction of the sync member.

syncDirection?: string

Property Value

string

syncMemberAzureDatabaseResourceId

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

syncMemberAzureDatabaseResourceId?: string

Property Value

string

syncState

Sync state of the sync member.

syncState?: string

Property Value

string

usePrivateLinkConnection

Whether to use private link connection.

usePrivateLinkConnection?: boolean

Property Value

boolean

userName

User name of the member database in the sync member.

userName?: string

Property Value

string