SyncAgents interface
Interface representing a SyncAgents.
Methods
| begin |
Creates or updates a sync agent. |
| begin |
Creates or updates a sync agent. |
| begin |
Deletes a sync agent. |
| begin |
Deletes a sync agent. |
| generate |
Generates a sync agent key. |
| get(string, string, string, Sync |
Gets a sync agent. |
| list |
Lists sync agents in a server. |
| list |
Lists databases linked to a sync agent. |
Method Details
beginCreateOrUpdate(string, string, string, SyncAgent, SyncAgentsCreateOrUpdateOptionalParams)
Creates or updates a sync agent.
function beginCreateOrUpdate(resourceGroupName: string, serverName: string, syncAgentName: string, parameters: SyncAgent, options?: SyncAgentsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SyncAgent>, SyncAgent>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<SyncAgent>, SyncAgent>>
beginCreateOrUpdateAndWait(string, string, string, SyncAgent, SyncAgentsCreateOrUpdateOptionalParams)
Creates or updates a sync agent.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, syncAgentName: string, parameters: SyncAgent, options?: SyncAgentsCreateOrUpdateOptionalParams): Promise<SyncAgent>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.
The options parameters.
Returns
Promise<SyncAgent>
beginDelete(string, string, string, SyncAgentsDeleteOptionalParams)
Deletes a sync agent.
function beginDelete(resourceGroupName: string, serverName: string, syncAgentName: string, options?: SyncAgentsDeleteOptionalParams): 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 on which the sync agent is hosted.
- syncAgentName
-
string
The name of the sync agent.
- options
- SyncAgentsDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, SyncAgentsDeleteOptionalParams)
Deletes a sync agent.
function beginDeleteAndWait(resourceGroupName: string, serverName: string, syncAgentName: string, options?: SyncAgentsDeleteOptionalParams): 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 on which the sync agent is hosted.
- syncAgentName
-
string
The name of the sync agent.
- options
- SyncAgentsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
generateKey(string, string, string, SyncAgentsGenerateKeyOptionalParams)
Generates a sync agent key.
function generateKey(resourceGroupName: string, serverName: string, syncAgentName: string, options?: SyncAgentsGenerateKeyOptionalParams): Promise<SyncAgentKeyProperties>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.
The options parameters.
Returns
Promise<SyncAgentKeyProperties>
get(string, string, string, SyncAgentsGetOptionalParams)
Gets a sync agent.
function get(resourceGroupName: string, serverName: string, syncAgentName: string, options?: SyncAgentsGetOptionalParams): Promise<SyncAgent>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.
- options
- SyncAgentsGetOptionalParams
The options parameters.
Returns
Promise<SyncAgent>
listByServer(string, string, SyncAgentsListByServerOptionalParams)
Lists sync agents in a server.
function listByServer(resourceGroupName: string, serverName: string, options?: SyncAgentsListByServerOptionalParams): PagedAsyncIterableIterator<SyncAgent, SyncAgent[], 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 on which the sync agent is hosted.
The options parameters.
Returns
listLinkedDatabases(string, string, string, SyncAgentsListLinkedDatabasesOptionalParams)
Lists databases linked to a sync agent.
function listLinkedDatabases(resourceGroupName: string, serverName: string, syncAgentName: string, options?: SyncAgentsListLinkedDatabasesOptionalParams): PagedAsyncIterableIterator<SyncAgentLinkedDatabase, SyncAgentLinkedDatabase[], 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 on which the sync agent is hosted.
- syncAgentName
-
string
The name of the sync agent.
The options parameters.