Package version:

Interface SyncGroups

Interface representing a SyncGroups.

Hierarchy

SyncGroups

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginRefreshHubSchema beginRefreshHubSchemaAndWait beginUpdate beginUpdateAndWait cancelSync get listByDatabase listHubSchemas listLogs listSyncDatabaseIds triggerSync

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, parameters: SyncGroup, options?: SyncGroupsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SyncGroup>, SyncGroup>>
Creates or updates a sync group.
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.
- Optional options: SyncGroupsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<SyncGroup>, SyncGroup>>
- Defined in operationsInterfaces/syncGroups.ts:187

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, parameters: SyncGroup, options?: SyncGroupsCreateOrUpdateOptionalParams): Promise<SyncGroup>
Creates or updates a sync group.
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.
- Optional options: SyncGroupsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SyncGroup>
- Defined in operationsInterfaces/syncGroups.ts:210

beginDelete

beginDelete(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, options?: SyncGroupsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes a sync group.
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.
- Optional options: SyncGroupsDeleteOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/syncGroups.ts:227

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, options?: SyncGroupsDeleteOptionalParams): Promise<void>
Deletes a sync group.
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.
- Optional options: SyncGroupsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/syncGroups.ts:243

beginRefreshHubSchema

beginRefreshHubSchema(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, options?: SyncGroupsRefreshHubSchemaOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Refreshes a hub database schema.
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.
- Optional options: SyncGroupsRefreshHubSchemaOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/syncGroups.ts:106

beginRefreshHubSchemaAndWait

beginRefreshHubSchemaAndWait(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, options?: SyncGroupsRefreshHubSchemaOptionalParams): Promise<void>
Refreshes a hub database schema.
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.
- Optional options: SyncGroupsRefreshHubSchemaOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/syncGroups.ts:122

beginUpdate

beginUpdate(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, parameters: SyncGroup, options?: SyncGroupsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SyncGroup>, SyncGroup>>
Updates a sync group.
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.
- Optional options: SyncGroupsUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<SyncGroup>, SyncGroup>>
- Defined in operationsInterfaces/syncGroups.ts:260

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, parameters: SyncGroup, options?: SyncGroupsUpdateOptionalParams): Promise<SyncGroup>
Updates a sync group.
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.
- Optional options: SyncGroupsUpdateOptionalParams
  
  The options parameters.
Returns Promise<SyncGroup>
- Defined in operationsInterfaces/syncGroups.ts:283

cancelSync

cancelSync(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, options?: SyncGroupsCancelSyncOptionalParams): Promise<void>
Cancels a sync group synchronization.
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.
- Optional options: SyncGroupsCancelSyncOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/syncGroups.ts:138

get

get(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, options?: SyncGroupsGetOptionalParams): Promise<SyncGroup>
Gets a sync group.
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.
- Optional options: SyncGroupsGetOptionalParams
  
  The options parameters.
Returns Promise<SyncGroup>
- Defined in operationsInterfaces/syncGroups.ts:170

listByDatabase

listByDatabase(resourceGroupName: string, serverName: string, databaseName: string, options?: SyncGroupsListByDatabaseOptionalParams): PagedAsyncIterableIterator<SyncGroup>
Lists sync groups under a hub database.
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.
- Optional options: SyncGroupsListByDatabaseOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SyncGroup>
- Defined in operationsInterfaces/syncGroups.ts:91

listHubSchemas

listHubSchemas(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, options?: SyncGroupsListHubSchemasOptionalParams): PagedAsyncIterableIterator<SyncFullSchemaProperties>
Gets a collection of hub database schemas.
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.
- Optional options: SyncGroupsListHubSchemasOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SyncFullSchemaProperties>
- Defined in operationsInterfaces/syncGroups.ts:54

listLogs

listLogs(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, startTime: string, endTime: string, typeParam: string, options?: SyncGroupsListLogsOptionalParams): PagedAsyncIterableIterator<SyncGroupLogProperties>
Gets a collection of sync group logs.
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.
- Optional options: SyncGroupsListLogsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SyncGroupLogProperties>
- Defined in operationsInterfaces/syncGroups.ts:73

listSyncDatabaseIds

listSyncDatabaseIds(locationName: string, options?: SyncGroupsListSyncDatabaseIdsOptionalParams): PagedAsyncIterableIterator<SyncDatabaseIdProperties>
Gets a collection of sync database ids.
Parameters
- locationName: string
  
  The name of the region where the resource is located.
- Optional options: SyncGroupsListSyncDatabaseIdsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SyncDatabaseIdProperties>
- Defined in operationsInterfaces/syncGroups.ts:41

triggerSync

triggerSync(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, options?: SyncGroupsTriggerSyncOptionalParams): Promise<void>
Triggers a sync group synchronization.
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.
- Optional options: SyncGroupsTriggerSyncOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/syncGroups.ts:154

Interface SyncGroups

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serverName: string

databaseName: string

syncGroupName: string

parameters: SyncGroup

Optional options: SyncGroupsCreateOrUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<SyncGroup>, SyncGroup>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serverName: string

databaseName: string

syncGroupName: string

parameters: SyncGroup

Optional options: SyncGroupsCreateOrUpdateOptionalParams

Returns Promise<SyncGroup>

beginDelete

Parameters

resourceGroupName: string

serverName: string

databaseName: string

syncGroupName: string

Optional options: SyncGroupsDeleteOptionalParams

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

serverName: string

databaseName: string

syncGroupName: string

Optional options: SyncGroupsDeleteOptionalParams

Returns Promise<void>

beginRefreshHubSchema

Parameters

resourceGroupName: string

serverName: string

databaseName: string

syncGroupName: string

Optional options: SyncGroupsRefreshHubSchemaOptionalParams

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginRefreshHubSchemaAndWait

Parameters

resourceGroupName: string

serverName: string

databaseName: string

syncGroupName: string

Optional options: SyncGroupsRefreshHubSchemaOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

serverName: string

databaseName: string

syncGroupName: string

parameters: SyncGroup

Optional options: SyncGroupsUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<SyncGroup>, SyncGroup>>

beginUpdateAndWait

Parameters

resourceGroupName: string

serverName: string

databaseName: string

syncGroupName: string

parameters: SyncGroup

Optional options: SyncGroupsUpdateOptionalParams

Returns Promise<SyncGroup>

cancelSync

Parameters

resourceGroupName: string

serverName: string

databaseName: string

syncGroupName: string

Optional options: SyncGroupsCancelSyncOptionalParams

`Optional` options: SyncGroupsCreateOrUpdateOptionalParams

`Optional` options: SyncGroupsCreateOrUpdateOptionalParams

`Optional` options: SyncGroupsDeleteOptionalParams

`Optional` options: SyncGroupsDeleteOptionalParams

`Optional` options: SyncGroupsRefreshHubSchemaOptionalParams

`Optional` options: SyncGroupsRefreshHubSchemaOptionalParams

`Optional` options: SyncGroupsUpdateOptionalParams

`Optional` options: SyncGroupsUpdateOptionalParams

`Optional` options: SyncGroupsCancelSyncOptionalParams

`Optional` options: SyncGroupsGetOptionalParams

`Optional` options: SyncGroupsListByDatabaseOptionalParams

`Optional` options: SyncGroupsListHubSchemasOptionalParams

`Optional` options: SyncGroupsListLogsOptionalParams

`Optional` options: SyncGroupsListSyncDatabaseIdsOptionalParams

`Optional` options: SyncGroupsTriggerSyncOptionalParams