Package version:

Interface SyncAgents

Interface representing a SyncAgents.

Hierarchy

SyncAgents

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait generateKey get listByServer listLinkedDatabases

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serverName: string, syncAgentName: string, parameters: SyncAgent, options?: SyncAgentsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SyncAgent>, SyncAgent>>
Creates or updates a sync agent.
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 on which the sync agent is hosted.
- syncAgentName: string
  
  The name of the sync agent.
- parameters: SyncAgent
  
  The requested sync agent resource state.
- Optional options: SyncAgentsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<SyncAgent>, SyncAgent>>
- Defined in operationsInterfaces/syncAgents.ts:77

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, syncAgentName: string, parameters: SyncAgent, options?: SyncAgentsCreateOrUpdateOptionalParams): Promise<SyncAgent>
Creates or updates a sync agent.
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 on which the sync agent is hosted.
- syncAgentName: string
  
  The name of the sync agent.
- parameters: SyncAgent
  
  The requested sync agent resource state.
- Optional options: SyncAgentsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SyncAgent>
- Defined in operationsInterfaces/syncAgents.ts:98

beginDelete

beginDelete(resourceGroupName: string, serverName: string, syncAgentName: string, options?: SyncAgentsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes a sync agent.
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 on which the sync agent is hosted.
- syncAgentName: string
  
  The name of the sync agent.
- Optional options: SyncAgentsDeleteOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/syncAgents.ts:113

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, serverName: string, syncAgentName: string, options?: SyncAgentsDeleteOptionalParams): Promise<void>
Deletes a sync agent.
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 on which the sync agent is hosted.
- syncAgentName: string
  
  The name of the sync agent.
- Optional options: SyncAgentsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/syncAgents.ts:127

generateKey

generateKey(resourceGroupName: string, serverName: string, syncAgentName: string, options?: SyncAgentsGenerateKeyOptionalParams): Promise<SyncAgentKeyProperties>
Generates a sync agent key.
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 on which the sync agent is hosted.
- syncAgentName: string
  
  The name of the sync agent.
- Optional options: SyncAgentsGenerateKeyOptionalParams
  
  The options parameters.
Returns Promise<SyncAgentKeyProperties>
- Defined in operationsInterfaces/syncAgents.ts:141

get

get(resourceGroupName: string, serverName: string, syncAgentName: string, options?: SyncAgentsGetOptionalParams): Promise<SyncAgent>
Gets a sync agent.
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 on which the sync agent is hosted.
- syncAgentName: string
  
  The name of the sync agent.
- Optional options: SyncAgentsGetOptionalParams
  
  The options parameters.
Returns Promise<SyncAgent>
- Defined in operationsInterfaces/syncAgents.ts:62

listByServer

listByServer(resourceGroupName: string, serverName: string, options?: SyncAgentsListByServerOptionalParams): PagedAsyncIterableIterator<SyncAgent>
Lists sync agents in a server.
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 on which the sync agent is hosted.
- Optional options: SyncAgentsListByServerOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SyncAgent>
- Defined in operationsInterfaces/syncAgents.ts:35

listLinkedDatabases

listLinkedDatabases(resourceGroupName: string, serverName: string, syncAgentName: string, options?: SyncAgentsListLinkedDatabasesOptionalParams): PagedAsyncIterableIterator<SyncAgentLinkedDatabase>
Lists databases linked to a sync agent.
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 on which the sync agent is hosted.
- syncAgentName: string
  
  The name of the sync agent.
- Optional options: SyncAgentsListLinkedDatabasesOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SyncAgentLinkedDatabase>
- Defined in operationsInterfaces/syncAgents.ts:48

Interface SyncAgents

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serverName: string

syncAgentName: string

parameters: SyncAgent

Optional options: SyncAgentsCreateOrUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<SyncAgent>, SyncAgent>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serverName: string

syncAgentName: string

parameters: SyncAgent

Optional options: SyncAgentsCreateOrUpdateOptionalParams

Returns Promise<SyncAgent>

beginDelete

Parameters

resourceGroupName: string

serverName: string

syncAgentName: string

Optional options: SyncAgentsDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

serverName: string

syncAgentName: string

Optional options: SyncAgentsDeleteOptionalParams

Returns Promise<void>

generateKey

Parameters

resourceGroupName: string

serverName: string

syncAgentName: string

Optional options: SyncAgentsGenerateKeyOptionalParams

Returns Promise<SyncAgentKeyProperties>

get

Parameters

resourceGroupName: string

serverName: string

syncAgentName: string

Optional options: SyncAgentsGetOptionalParams

Returns Promise<SyncAgent>

listByServer

Parameters

resourceGroupName: string

serverName: string

Optional options: SyncAgentsListByServerOptionalParams

Returns PagedAsyncIterableIterator<SyncAgent>

listLinkedDatabases

Parameters

resourceGroupName: string

serverName: string

syncAgentName: string

Optional options: SyncAgentsListLinkedDatabasesOptionalParams

Returns PagedAsyncIterableIterator<SyncAgentLinkedDatabase>

Settings

Member Visibility

Theme

`Optional` options: SyncAgentsCreateOrUpdateOptionalParams

`Optional` options: SyncAgentsCreateOrUpdateOptionalParams

`Optional` options: SyncAgentsDeleteOptionalParams

`Optional` options: SyncAgentsDeleteOptionalParams

`Optional` options: SyncAgentsGenerateKeyOptionalParams

`Optional` options: SyncAgentsGetOptionalParams

`Optional` options: SyncAgentsListByServerOptionalParams

`Optional` options: SyncAgentsListLinkedDatabasesOptionalParams