SyncAgentsOperations interface

Package:

@azure/arm-sql

Interface representing a SyncAgents operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
createOrUpdate	Creates or updates a sync agent.
delete	Deletes a sync agent.
generateKey	Generates a sync agent key.
get	Gets a sync agent.
listByServer	Lists sync agents in a server.
listLinkedDatabases	Lists databases linked to a sync agent.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, serverName: string, syncAgentName: string, parameters: SyncAgent, options?: SyncAgentsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<SyncAgent>, SyncAgent>>

Property Value

(resourceGroupName: string, serverName: string, syncAgentName: string, parameters: SyncAgent, options?: SyncAgentsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<SyncAgent>, SyncAgent>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, serverName: string, syncAgentName: string, parameters: SyncAgent, options?: SyncAgentsCreateOrUpdateOptionalParams) => Promise<SyncAgent>

Property Value

(resourceGroupName: string, serverName: string, syncAgentName: string, parameters: SyncAgent, options?: SyncAgentsCreateOrUpdateOptionalParams) => Promise<SyncAgent>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, serverName: string, syncAgentName: string, options?: SyncAgentsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, serverName: string, syncAgentName: string, options?: SyncAgentsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, serverName: string, syncAgentName: string, options?: SyncAgentsDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, serverName: string, syncAgentName: string, options?: SyncAgentsDeleteOptionalParams) => Promise<void>

createOrUpdate

Creates or updates a sync agent.

createOrUpdate: (resourceGroupName: string, serverName: string, syncAgentName: string, parameters: SyncAgent, options?: SyncAgentsCreateOrUpdateOptionalParams) => PollerLike<OperationState<SyncAgent>, SyncAgent>

Property Value

(resourceGroupName: string, serverName: string, syncAgentName: string, parameters: SyncAgent, options?: SyncAgentsCreateOrUpdateOptionalParams) => PollerLike<OperationState<SyncAgent>, SyncAgent>

delete

Deletes a sync agent.

delete: (resourceGroupName: string, serverName: string, syncAgentName: string, options?: SyncAgentsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, serverName: string, syncAgentName: string, options?: SyncAgentsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

generateKey

Generates a sync agent key.

generateKey: (resourceGroupName: string, serverName: string, syncAgentName: string, options?: SyncAgentsGenerateKeyOptionalParams) => Promise<SyncAgentKeyProperties>

Property Value

(resourceGroupName: string, serverName: string, syncAgentName: string, options?: SyncAgentsGenerateKeyOptionalParams) => Promise<SyncAgentKeyProperties>

get

Gets a sync agent.

get: (resourceGroupName: string, serverName: string, syncAgentName: string, options?: SyncAgentsGetOptionalParams) => Promise<SyncAgent>

Property Value

(resourceGroupName: string, serverName: string, syncAgentName: string, options?: SyncAgentsGetOptionalParams) => Promise<SyncAgent>

listByServer

Lists sync agents in a server.

listByServer: (resourceGroupName: string, serverName: string, options?: SyncAgentsListByServerOptionalParams) => PagedAsyncIterableIterator<SyncAgent, SyncAgent[], PageSettings>

Property Value

(resourceGroupName: string, serverName: string, options?: SyncAgentsListByServerOptionalParams) => PagedAsyncIterableIterator<SyncAgent, SyncAgent[], PageSettings>

listLinkedDatabases

Lists databases linked to a sync agent.

listLinkedDatabases: (resourceGroupName: string, serverName: string, syncAgentName: string, options?: SyncAgentsListLinkedDatabasesOptionalParams) => PagedAsyncIterableIterator<SyncAgentLinkedDatabase, SyncAgentLinkedDatabase[], PageSettings>

Property Value

(resourceGroupName: string, serverName: string, syncAgentName: string, options?: SyncAgentsListLinkedDatabasesOptionalParams) => PagedAsyncIterableIterator<SyncAgentLinkedDatabase, SyncAgentLinkedDatabase[], PageSettings>