SyncGroups interface

Package:

@azure/arm-sql

Interface representing a SyncGroups.

Methods

beginCreateOrUpdate(string, string, string, string, SyncGroup, SyncGroupsCreateOrUpdateOptionalParams)	Creates or updates a sync group.
beginCreateOrUpdateAndWait(string, string, string, string, SyncGroup, SyncGroupsCreateOrUpdateOptionalParams)	Creates or updates a sync group.
beginDelete(string, string, string, string, SyncGroupsDeleteOptionalParams)	Deletes a sync group.
beginDeleteAndWait(string, string, string, string, SyncGroupsDeleteOptionalParams)	Deletes a sync group.
beginRefreshHubSchema(string, string, string, string, SyncGroupsRefreshHubSchemaOptionalParams)	Refreshes a hub database schema.
beginRefreshHubSchemaAndWait(string, string, string, string, SyncGroupsRefreshHubSchemaOptionalParams)	Refreshes a hub database schema.
beginUpdate(string, string, string, string, SyncGroup, SyncGroupsUpdateOptionalParams)	Updates a sync group.
beginUpdateAndWait(string, string, string, string, SyncGroup, SyncGroupsUpdateOptionalParams)	Updates a sync group.
cancelSync(string, string, string, string, SyncGroupsCancelSyncOptionalParams)	Cancels a sync group synchronization.
get(string, string, string, string, SyncGroupsGetOptionalParams)	Gets a sync group.
listByDatabase(string, string, string, SyncGroupsListByDatabaseOptionalParams)	Lists sync groups under a hub database.
listHubSchemas(string, string, string, string, SyncGroupsListHubSchemasOptionalParams)	Gets a collection of hub database schemas.
listLogs(string, string, string, string, string, string, string, SyncGroupsListLogsOptionalParams)	Gets a collection of sync group logs.
listSyncDatabaseIds(string, SyncGroupsListSyncDatabaseIdsOptionalParams)	Gets a collection of sync database ids.
triggerSync(string, string, string, string, SyncGroupsTriggerSyncOptionalParams)	Triggers a sync group synchronization.

Method Details

beginCreateOrUpdate(string, string, string, string, SyncGroup, SyncGroupsCreateOrUpdateOptionalParams)

Creates or updates a sync group.

function beginCreateOrUpdate(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, parameters: SyncGroup, options?: SyncGroupsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SyncGroup>, SyncGroup>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database on which the sync group is hosted.

syncGroupName

string

The name of the sync group.

parameters

SyncGroup

The requested sync group resource state.

options

SyncGroupsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<SyncGroup>, SyncGroup>>

beginCreateOrUpdateAndWait(string, string, string, string, SyncGroup, SyncGroupsCreateOrUpdateOptionalParams)

Creates or updates a sync group.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, parameters: SyncGroup, options?: SyncGroupsCreateOrUpdateOptionalParams): Promise<SyncGroup>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database on which the sync group is hosted.

syncGroupName

string

The name of the sync group.

parameters

SyncGroup

The requested sync group resource state.

options

SyncGroupsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<SyncGroup>

beginDelete(string, string, string, string, SyncGroupsDeleteOptionalParams)

Deletes a sync group.

function beginDelete(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, options?: SyncGroupsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database on which the sync group is hosted.

syncGroupName

string

The name of the sync group.

options

SyncGroupsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, string, SyncGroupsDeleteOptionalParams)

Deletes a sync group.

function beginDeleteAndWait(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, options?: SyncGroupsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database on which the sync group is hosted.

syncGroupName

string

The name of the sync group.

options

SyncGroupsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginRefreshHubSchema(string, string, string, string, SyncGroupsRefreshHubSchemaOptionalParams)

Refreshes a hub database schema.

function beginRefreshHubSchema(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, options?: SyncGroupsRefreshHubSchemaOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database on which the sync group is hosted.

syncGroupName

string

The name of the sync group.

options

SyncGroupsRefreshHubSchemaOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginRefreshHubSchemaAndWait(string, string, string, string, SyncGroupsRefreshHubSchemaOptionalParams)

Refreshes a hub database schema.

function beginRefreshHubSchemaAndWait(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, options?: SyncGroupsRefreshHubSchemaOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database on which the sync group is hosted.

syncGroupName

string

The name of the sync group.

options

SyncGroupsRefreshHubSchemaOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, string, SyncGroup, SyncGroupsUpdateOptionalParams)

Updates a sync group.

function beginUpdate(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, parameters: SyncGroup, options?: SyncGroupsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SyncGroup>, SyncGroup>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database on which the sync group is hosted.

syncGroupName

string

The name of the sync group.

parameters

SyncGroup

The requested sync group resource state.

options

SyncGroupsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<SyncGroup>, SyncGroup>>

beginUpdateAndWait(string, string, string, string, SyncGroup, SyncGroupsUpdateOptionalParams)

Updates a sync group.

function beginUpdateAndWait(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, parameters: SyncGroup, options?: SyncGroupsUpdateOptionalParams): Promise<SyncGroup>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database on which the sync group is hosted.

syncGroupName

string

The name of the sync group.

parameters

SyncGroup

The requested sync group resource state.

options

SyncGroupsUpdateOptionalParams

The options parameters.

Returns

Promise<SyncGroup>

cancelSync(string, string, string, string, SyncGroupsCancelSyncOptionalParams)

Cancels a sync group synchronization.

function cancelSync(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, options?: SyncGroupsCancelSyncOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database on which the sync group is hosted.

syncGroupName

string

The name of the sync group.

options

SyncGroupsCancelSyncOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, SyncGroupsGetOptionalParams)

Gets a sync group.

function get(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, options?: SyncGroupsGetOptionalParams): Promise<SyncGroup>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database on which the sync group is hosted.

syncGroupName

string

The name of the sync group.

options

SyncGroupsGetOptionalParams

The options parameters.

Returns

Promise<SyncGroup>

listByDatabase(string, string, string, SyncGroupsListByDatabaseOptionalParams)

Lists sync groups under a hub database.

function listByDatabase(resourceGroupName: string, serverName: string, databaseName: string, options?: SyncGroupsListByDatabaseOptionalParams): PagedAsyncIterableIterator<SyncGroup, SyncGroup[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database on which the sync group is hosted.

options

SyncGroupsListByDatabaseOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SyncGroup, SyncGroup[], PageSettings>

listHubSchemas(string, string, string, string, SyncGroupsListHubSchemasOptionalParams)

Gets a collection of hub database schemas.

function listHubSchemas(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, options?: SyncGroupsListHubSchemasOptionalParams): PagedAsyncIterableIterator<SyncFullSchemaProperties, SyncFullSchemaProperties[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database on which the sync group is hosted.

syncGroupName

string

The name of the sync group.

options

SyncGroupsListHubSchemasOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SyncFullSchemaProperties, SyncFullSchemaProperties[], PageSettings>

listLogs(string, string, string, string, string, string, string, SyncGroupsListLogsOptionalParams)

Gets a collection of sync group logs.

function listLogs(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, startTime: string, endTime: string, typeParam: string, options?: SyncGroupsListLogsOptionalParams): PagedAsyncIterableIterator<SyncGroupLogProperties, SyncGroupLogProperties[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database on which the sync group is hosted.

syncGroupName

string

The name of the sync group.

startTime

string

Get logs generated after this time.

endTime

string

Get logs generated before this time.

typeParam

string

The types of logs to retrieve.

options

SyncGroupsListLogsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SyncGroupLogProperties, SyncGroupLogProperties[], PageSettings>

listSyncDatabaseIds(string, SyncGroupsListSyncDatabaseIdsOptionalParams)

Gets a collection of sync database ids.

function listSyncDatabaseIds(locationName: string, options?: SyncGroupsListSyncDatabaseIdsOptionalParams): PagedAsyncIterableIterator<SyncDatabaseIdProperties, SyncDatabaseIdProperties[], PageSettings>

Parameters

locationName

string

The name of the region where the resource is located.

options

SyncGroupsListSyncDatabaseIdsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SyncDatabaseIdProperties, SyncDatabaseIdProperties[], PageSettings>

triggerSync(string, string, string, string, SyncGroupsTriggerSyncOptionalParams)

Triggers a sync group synchronization.

function triggerSync(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, options?: SyncGroupsTriggerSyncOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

databaseName

string

The name of the database on which the sync group is hosted.

syncGroupName

string

The name of the sync group.

options

SyncGroupsTriggerSyncOptionalParams

The options parameters.

Returns

Promise<void>