SyncGroup interface

An Azure SQL Database sync group.

Extends

Properties

conflictLoggingRetentionInDays

Conflict logging retention period.

conflictResolutionPolicy

Conflict resolution policy of the sync group.

enableConflictLogging

If conflict logging is enabled.

hubDatabasePassword

Password for the sync group hub database credential.

hubDatabaseUserName

User name for the sync group hub database credential.

interval

Sync interval of the sync group.

lastSyncTime

Last sync time of the sync group. NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpointName

Private endpoint name of the sync group if use private link connection is enabled. NOTE: This property will not be serialized. It can only be populated by the server.

schema

Sync schema of the sync group.

sku

The name and capacity of the SKU.

syncDatabaseId

ARM resource id of the sync database in the sync group.

syncState

Sync state of the sync group. NOTE: This property will not be serialized. It can only be populated by the server.

usePrivateLinkConnection

If use private link connection is enabled.

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

conflictLoggingRetentionInDays

Conflict logging retention period.

conflictLoggingRetentionInDays?: number

Property Value

number

conflictResolutionPolicy

Conflict resolution policy of the sync group.

conflictResolutionPolicy?: string

Property Value

string

enableConflictLogging

If conflict logging is enabled.

enableConflictLogging?: boolean

Property Value

boolean

hubDatabasePassword

Password for the sync group hub database credential.

hubDatabasePassword?: string

Property Value

string

hubDatabaseUserName

User name for the sync group hub database credential.

hubDatabaseUserName?: string

Property Value

string

interval

Sync interval of the sync group.

interval?: number

Property Value

number

lastSyncTime

Last sync time of the sync group. NOTE: This property will not be serialized. It can only be populated by the server.

lastSyncTime?: Date

Property Value

Date

privateEndpointName

Private endpoint name of the sync group if use private link connection is enabled. NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpointName?: string

Property Value

string

schema

Sync schema of the sync group.

schema?: SyncGroupSchema

Property Value

sku

The name and capacity of the SKU.

sku?: Sku

Property Value

Sku

syncDatabaseId

ARM resource id of the sync database in the sync group.

syncDatabaseId?: string

Property Value

string

syncState

Sync state of the sync group. NOTE: This property will not be serialized. It can only be populated by the server.

syncState?: string

Property Value

string

usePrivateLinkConnection

If use private link connection is enabled.

usePrivateLinkConnection?: boolean

Property Value

boolean

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