SyncMembersOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SqlManagementClient's

<xref:sync_members> attribute.

Constructor

SyncMembersOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates a sync member.
begin_delete	Deletes a sync member.
begin_refresh_member_schema	Refreshes a sync member database schema.
begin_update	Updates an existing sync member.
get	Gets a sync member.
list_by_sync_group	Lists sync members in the given sync group.
list_member_schemas	Gets a sync member database schema.

begin_create_or_update

Creates or updates a sync member.

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

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. Required.
database_name Required	str The name of the database on which the sync group is hosted. Required.
sync_group_name Required	str The name of the sync group on which the sync member is hosted. Required.
sync_member_name Required	str The name of the sync member. Required.
parameters Required	SyncMember or IO[bytes] The requested sync member resource state. Is either a SyncMember type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a sync member.

async begin_delete(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, sync_member_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. Required.
database_name Required	str The name of the database on which the sync group is hosted. Required.
sync_group_name Required	str The name of the sync group on which the sync member is hosted. Required.
sync_member_name Required	str The name of the sync member. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_refresh_member_schema

Refreshes a sync member database schema.

async begin_refresh_member_schema(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, sync_member_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. Required.
database_name Required	str The name of the database on which the sync group is hosted. Required.
sync_group_name Required	str The name of the sync group on which the sync member is hosted. Required.
sync_member_name Required	str The name of the sync member. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_update

Updates an existing sync member.

async begin_update(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, sync_member_name: str, parameters: _models.SyncMember, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.SyncMember]

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. Required.
database_name Required	str The name of the database on which the sync group is hosted. Required.
sync_group_name Required	str The name of the sync group on which the sync member is hosted. Required.
sync_member_name Required	str The name of the sync member. Required.
parameters Required	SyncMember or IO[bytes] The requested sync member resource state. Is either a SyncMember type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Gets a sync member.

async get(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, sync_member_name: str, **kwargs: Any) -> SyncMember

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. Required.
database_name Required	str The name of the database on which the sync group is hosted. Required.
sync_group_name Required	str The name of the sync group on which the sync member is hosted. Required.
sync_member_name Required	str The name of the sync member. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_sync_group

Lists sync members in the given sync group.

list_by_sync_group(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, **kwargs: Any) -> AsyncItemPaged[SyncMember]

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. Required.
database_name Required	str The name of the database on which the sync group is hosted. Required.
sync_group_name Required	str The name of the sync group. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

list_member_schemas

Gets a sync member database schema.

list_member_schemas(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, sync_member_name: str, **kwargs: Any) -> AsyncItemPaged[SyncFullSchemaProperties]

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. Required.
database_name Required	str The name of the database on which the sync group is hosted. Required.
sync_group_name Required	str The name of the sync group on which the sync member is hosted. Required.
sync_member_name Required	str The name of the sync member. Required.

Returns

Type	Description
AsyncItemPaged[SyncFullSchemaProperties]	An iterator like instance of either SyncFullSchemaProperties 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'>