SyncAgentsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SqlManagementClient's

<xref:sync_agents> attribute.

Constructor

SyncAgentsOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates a sync agent.
begin_delete	Deletes a sync agent.
generate_key	Generates a sync agent key.
get	Gets a sync agent.
list_by_server	Lists sync agents in a server.
list_linked_databases	Lists databases linked to a sync agent.

begin_create_or_update

Creates or updates a sync agent.

async begin_create_or_update(resource_group_name: str, server_name: str, sync_agent_name: str, parameters: _models.SyncAgent, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.SyncAgent]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server on which the sync agent is hosted. Required.
sync_agent_name Required	str The name of the sync agent. Required.
parameters Required	SyncAgent or IO[bytes] The requested sync agent resource state. Is either a SyncAgent type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[SyncAgent]	An instance of AsyncLROPoller that returns either SyncAgent or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a sync agent.

async begin_delete(resource_group_name: str, server_name: str, sync_agent_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server on which the sync agent is hosted. Required.
sync_agent_name Required	str The name of the sync agent. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

generate_key

Generates a sync agent key.

async generate_key(resource_group_name: str, server_name: str, sync_agent_name: str, **kwargs: Any) -> SyncAgentKeyProperties

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server on which the sync agent is hosted. Required.
sync_agent_name Required	str The name of the sync agent. Required.

Returns

Type	Description
SyncAgentKeyProperties	SyncAgentKeyProperties or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets a sync agent.

async get(resource_group_name: str, server_name: str, sync_agent_name: str, **kwargs: Any) -> SyncAgent

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server on which the sync agent is hosted. Required.
sync_agent_name Required	str The name of the sync agent. Required.

Returns

Type	Description
SyncAgent	SyncAgent or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_server

Lists sync agents in a server.

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) -> AsyncItemPaged[SyncAgent]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server on which the sync agent is hosted. Required.

Returns

Type	Description
AsyncItemPaged[SyncAgent]	An iterator like instance of either SyncAgent or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_linked_databases

Lists databases linked to a sync agent.

list_linked_databases(resource_group_name: str, server_name: str, sync_agent_name: str, **kwargs: Any) -> AsyncItemPaged[SyncAgentLinkedDatabase]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server on which the sync agent is hosted. Required.
sync_agent_name Required	str The name of the sync agent. Required.

Returns

Type	Description
AsyncItemPaged[SyncAgentLinkedDatabase]	An iterator like instance of either SyncAgentLinkedDatabase or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.sql.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv268\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>