Package version:

Interface SyncMembers

Interface representing a SyncMembers.

Hierarchy

SyncMembers

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginRefreshMemberSchema beginRefreshMemberSchemaAndWait beginUpdate beginUpdateAndWait get listBySyncGroup listMemberSchemas

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, syncMemberName: string, parameters: SyncMember, options?: SyncMembersCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SyncMember>, SyncMember>>
Creates or updates a sync member.
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 on which the sync member is hosted.
- syncMemberName: string
  
  The name of the sync member.
- parameters: SyncMember
  
  The requested sync member resource state.
- Optional options: SyncMembersCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<SyncMember>, SyncMember>>
- Defined in operationsInterfaces/syncMembers.ts:92

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, syncMemberName: string, parameters: SyncMember, options?: SyncMembersCreateOrUpdateOptionalParams): Promise<SyncMember>
Creates or updates a sync member.
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 on which the sync member is hosted.
- syncMemberName: string
  
  The name of the sync member.
- parameters: SyncMember
  
  The requested sync member resource state.
- Optional options: SyncMembersCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SyncMember>
- Defined in operationsInterfaces/syncMembers.ts:117

beginDelete

beginDelete(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, syncMemberName: string, options?: SyncMembersDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes a sync member.
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 on which the sync member is hosted.
- syncMemberName: string
  
  The name of the sync member.
- Optional options: SyncMembersDeleteOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/syncMembers.ts:136

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, syncMemberName: string, options?: SyncMembersDeleteOptionalParams): Promise<void>
Deletes a sync member.
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 on which the sync member is hosted.
- syncMemberName: string
  
  The name of the sync member.
- Optional options: SyncMembersDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/syncMembers.ts:154

beginRefreshMemberSchema

beginRefreshMemberSchema(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, syncMemberName: string, options?: SyncMembersRefreshMemberSchemaOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Refreshes a sync member 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 on which the sync member is hosted.
- syncMemberName: string
  
  The name of the sync member.
- Optional options: SyncMembersRefreshMemberSchemaOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/syncMembers.ts:217

beginRefreshMemberSchemaAndWait

beginRefreshMemberSchemaAndWait(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, syncMemberName: string, options?: SyncMembersRefreshMemberSchemaOptionalParams): Promise<void>
Refreshes a sync member 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 on which the sync member is hosted.
- syncMemberName: string
  
  The name of the sync member.
- Optional options: SyncMembersRefreshMemberSchemaOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/syncMembers.ts:235

beginUpdate

beginUpdate(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, syncMemberName: string, parameters: SyncMember, options?: SyncMembersUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SyncMember>, SyncMember>>
Updates an existing sync member.
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 on which the sync member is hosted.
- syncMemberName: string
  
  The name of the sync member.
- parameters: SyncMember
  
  The requested sync member resource state.
- Optional options: SyncMembersUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<SyncMember>, SyncMember>>
- Defined in operationsInterfaces/syncMembers.ts:173

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, syncMemberName: string, parameters: SyncMember, options?: SyncMembersUpdateOptionalParams): Promise<SyncMember>
Updates an existing sync member.
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 on which the sync member is hosted.
- syncMemberName: string
  
  The name of the sync member.
- parameters: SyncMember
  
  The requested sync member resource state.
- Optional options: SyncMembersUpdateOptionalParams
  
  The options parameters.
Returns Promise<SyncMember>
- Defined in operationsInterfaces/syncMembers.ts:198

get

get(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, syncMemberName: string, options?: SyncMembersGetOptionalParams): Promise<SyncMember>
Gets a sync member.
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 on which the sync member is hosted.
- syncMemberName: string
  
  The name of the sync member.
- Optional options: SyncMembersGetOptionalParams
  
  The options parameters.
Returns Promise<SyncMember>
- Defined in operationsInterfaces/syncMembers.ts:73

listBySyncGroup

listBySyncGroup(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, options?: SyncMembersListBySyncGroupOptionalParams): PagedAsyncIterableIterator<SyncMember>
Lists sync members in the given 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: SyncMembersListBySyncGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SyncMember>
- Defined in operationsInterfaces/syncMembers.ts:38

listMemberSchemas

listMemberSchemas(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, syncMemberName: string, options?: SyncMembersListMemberSchemasOptionalParams): PagedAsyncIterableIterator<SyncFullSchemaProperties>
Gets a sync member 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 on which the sync member is hosted.
- syncMemberName: string
  
  The name of the sync member.
- Optional options: SyncMembersListMemberSchemasOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SyncFullSchemaProperties>
- Defined in operationsInterfaces/syncMembers.ts:55

Interface SyncMembers

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serverName: string

databaseName: string

syncGroupName: string

syncMemberName: string

parameters: SyncMember

Optional options: SyncMembersCreateOrUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<SyncMember>, SyncMember>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serverName: string

databaseName: string

syncGroupName: string

syncMemberName: string

parameters: SyncMember

Optional options: SyncMembersCreateOrUpdateOptionalParams

Returns Promise<SyncMember>

beginDelete

Parameters

resourceGroupName: string

serverName: string

databaseName: string

syncGroupName: string

syncMemberName: string

Optional options: SyncMembersDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

serverName: string

databaseName: string

syncGroupName: string

syncMemberName: string

Optional options: SyncMembersDeleteOptionalParams

Returns Promise<void>

beginRefreshMemberSchema

Parameters

resourceGroupName: string

serverName: string

databaseName: string

syncGroupName: string

syncMemberName: string

Optional options: SyncMembersRefreshMemberSchemaOptionalParams

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

beginRefreshMemberSchemaAndWait

Parameters

resourceGroupName: string

serverName: string

databaseName: string

syncGroupName: string

syncMemberName: string

Optional options: SyncMembersRefreshMemberSchemaOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

serverName: string

databaseName: string

syncGroupName: string

syncMemberName: string

parameters: SyncMember

Optional options: SyncMembersUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<SyncMember>, SyncMember>>

beginUpdateAndWait

Parameters

resourceGroupName: string

serverName: string

databaseName: string

syncGroupName: string

syncMemberName: string

parameters: SyncMember

Optional options: SyncMembersUpdateOptionalParams

`Optional` options: SyncMembersCreateOrUpdateOptionalParams

`Optional` options: SyncMembersCreateOrUpdateOptionalParams

`Optional` options: SyncMembersDeleteOptionalParams

`Optional` options: SyncMembersDeleteOptionalParams

`Optional` options: SyncMembersRefreshMemberSchemaOptionalParams

`Optional` options: SyncMembersRefreshMemberSchemaOptionalParams

`Optional` options: SyncMembersUpdateOptionalParams

`Optional` options: SyncMembersUpdateOptionalParams

`Optional` options: SyncMembersGetOptionalParams

`Optional` options: SyncMembersListBySyncGroupOptionalParams

`Optional` options: SyncMembersListMemberSchemasOptionalParams