SyncGroupsOperations interface

Package:
@azure/arm-sql

Interface representing a SyncGroups operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginRefreshHubSchema
beginRefreshHubSchemaAndWait
beginUpdate
beginUpdateAndWait
cancelSync

Cancels a sync group synchronization.
createOrUpdate

Creates or updates a sync group.
delete

Deletes a sync group.
get

Gets a sync group.
listByDatabase

Lists sync groups under a hub database.
listHubSchemas

Gets a collection of hub database schemas.
listLogs

Gets a collection of sync group logs.
listSyncDatabaseIds

Gets a collection of sync database ids.
refreshHubSchema

Refreshes a hub database schema.
triggerSync

Triggers a sync group synchronization.
update

Updates a sync group.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginRefreshHubSchema

Warning

This API is now deprecated.

use refreshHubSchema instead

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

Property Value

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

beginRefreshHubSchemaAndWait

Warning

This API is now deprecated.

use refreshHubSchema instead

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

Property Value

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

beginUpdate

Warning

This API is now deprecated.

use update instead

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

Property Value

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

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

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

Property Value

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

cancelSync

Cancels a sync group synchronization.

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

Property Value

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

createOrUpdate

Creates or updates a sync group.

createOrUpdate: (resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, parameters: SyncGroup, options?: SyncGroupsCreateOrUpdateOptionalParams) => PollerLike<OperationState<SyncGroup>, SyncGroup>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, parameters: SyncGroup, options?: SyncGroupsCreateOrUpdateOptionalParams) => PollerLike<OperationState<SyncGroup>, SyncGroup>

delete

Deletes a sync group.

delete: (resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, options?: SyncGroupsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, options?: SyncGroupsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets a sync group.

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

Property Value

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

listByDatabase

Lists sync groups under a hub database.

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

Property Value

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

listHubSchemas

Gets a collection of hub database schemas.

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

Property Value

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

listLogs

Gets a collection of sync group logs.

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

Property Value

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

listSyncDatabaseIds

Gets a collection of sync database ids.

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

Property Value

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

refreshHubSchema

Refreshes a hub database schema.

refreshHubSchema: (resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, options?: SyncGroupsRefreshHubSchemaOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, options?: SyncGroupsRefreshHubSchemaOptionalParams) => PollerLike<OperationState<void>, void>

triggerSync

Triggers a sync group synchronization.

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

Property Value

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

update

Updates a sync group.

update: (resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, parameters: SyncGroup, options?: SyncGroupsUpdateOptionalParams) => PollerLike<OperationState<SyncGroup>, SyncGroup>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, parameters: SyncGroup, options?: SyncGroupsUpdateOptionalParams) => PollerLike<OperationState<SyncGroup>, SyncGroup>