SyncAgentsOperations Class

SyncAgentsOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

SyncAgentsOperations

Constructor

SyncAgentsOperations(client, config, serializer, deserializer)

Parameters

Name	Description
client Required	Client for service requests.
config Required	Configuration of service client.
serializer Required	An object model serializer.
deserializer Required	An object model deserializer.

Variables

Name	Description
models	Alias to model classes used in this operation group.

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: SyncAgent, **kwargs: Any) -> AsyncLROPoller[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.
server_name Required	str The name of the server on which the sync agent is hosted.
sync_agent_name Required	str The name of the sync agent.
parameters Required	SyncAgent The requested sync agent resource state.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or AsyncPollingMethod By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

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.
server_name Required	str The name of the server on which the sync agent is hosted.
sync_agent_name Required	str The name of the sync agent.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or AsyncPollingMethod By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

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.
server_name Required	str The name of the server on which the sync agent is hosted.
sync_agent_name Required	str The name of the sync agent.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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.
server_name Required	str The name of the server on which the sync agent is hosted.
sync_agent_name Required	str The name of the sync agent.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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) -> AsyncIterable[SyncAgentListResult]

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.
server_name Required	str The name of the server on which the sync agent is hosted.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncItemPaged[SyncAgentListResult]	An iterator like instance of either SyncAgentListResult 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) -> AsyncIterable[SyncAgentLinkedDatabaseListResult]

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.
server_name Required	str The name of the server on which the sync agent is hosted.
sync_agent_name Required	str The name of the sync agent.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.sql.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>