SyncMembers interface
Interface representing a SyncMembers.
Methods
Method Details
beginCreateOrUpdate(string, string, string, string, string, SyncMember, SyncMembersCreateOrUpdateOptionalParams)
Creates or updates a sync member.
function beginCreateOrUpdate(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, syncMemberName: string, parameters: SyncMember, options?: SyncMembersCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SyncMember>, SyncMember>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<SyncMember>, SyncMember>>
beginCreateOrUpdateAndWait(string, string, string, string, string, SyncMember, SyncMembersCreateOrUpdateOptionalParams)
Creates or updates a sync member.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, syncMemberName: string, parameters: SyncMember, options?: SyncMembersCreateOrUpdateOptionalParams): Promise<SyncMember>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.
The options parameters.
Returns
Promise<SyncMember>
beginDelete(string, string, string, string, string, SyncMembersDeleteOptionalParams)
Deletes a sync member.
function beginDelete(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, syncMemberName: string, options?: SyncMembersDeleteOptionalParams): 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 on which the sync member is hosted.
- syncMemberName
-
string
The name of the sync member.
- options
- SyncMembersDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, string, string, SyncMembersDeleteOptionalParams)
Deletes a sync member.
function beginDeleteAndWait(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, syncMemberName: string, options?: SyncMembersDeleteOptionalParams): 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 on which the sync member is hosted.
- syncMemberName
-
string
The name of the sync member.
- options
- SyncMembersDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginRefreshMemberSchema(string, string, string, string, string, SyncMembersRefreshMemberSchemaOptionalParams)
Refreshes a sync member database schema.
function beginRefreshMemberSchema(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, syncMemberName: string, options?: SyncMembersRefreshMemberSchemaOptionalParams): 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 on which the sync member is hosted.
- syncMemberName
-
string
The name of the sync member.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginRefreshMemberSchemaAndWait(string, string, string, string, string, SyncMembersRefreshMemberSchemaOptionalParams)
Refreshes a sync member database schema.
function beginRefreshMemberSchemaAndWait(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, syncMemberName: string, options?: SyncMembersRefreshMemberSchemaOptionalParams): 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 on which the sync member is hosted.
- syncMemberName
-
string
The name of the sync member.
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, string, string, string, SyncMember, SyncMembersUpdateOptionalParams)
Updates an existing sync member.
function beginUpdate(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, syncMemberName: string, parameters: SyncMember, options?: SyncMembersUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SyncMember>, SyncMember>>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.
- options
- SyncMembersUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<SyncMember>, SyncMember>>
beginUpdateAndWait(string, string, string, string, string, SyncMember, SyncMembersUpdateOptionalParams)
Updates an existing sync member.
function beginUpdateAndWait(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, syncMemberName: string, parameters: SyncMember, options?: SyncMembersUpdateOptionalParams): Promise<SyncMember>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.
- options
- SyncMembersUpdateOptionalParams
The options parameters.
Returns
Promise<SyncMember>
get(string, string, string, string, string, SyncMembersGetOptionalParams)
Gets a sync member.
function get(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, syncMemberName: string, options?: SyncMembersGetOptionalParams): Promise<SyncMember>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.
- options
- SyncMembersGetOptionalParams
The options parameters.
Returns
Promise<SyncMember>
listBySyncGroup(string, string, string, string, SyncMembersListBySyncGroupOptionalParams)
Lists sync members in the given sync group.
function listBySyncGroup(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, options?: SyncMembersListBySyncGroupOptionalParams): PagedAsyncIterableIterator<SyncMember, SyncMember[], 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.
The options parameters.
Returns
listMemberSchemas(string, string, string, string, string, SyncMembersListMemberSchemasOptionalParams)
Gets a sync member database schema.
function listMemberSchemas(resourceGroupName: string, serverName: string, databaseName: string, syncGroupName: string, syncMemberName: string, options?: SyncMembersListMemberSchemasOptionalParams): 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 on which the sync member is hosted.
- syncMemberName
-
string
The name of the sync member.
The options parameters.