Share via

SyncMember interface

Package:
@azure/arm-sql

An Azure SQL Database sync member.

Extends
ProxyResource

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. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
usePrivateLinkConnection

Whether to use private link connection.
userName

User name of the member database in the sync member.

Inherited Properties

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.
name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

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

Inherited Property Details

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type