SyncGroupsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SqlManagementClient's

<xref:sync_groups> attribute.

Constructor

SyncGroupsOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates a sync group.
begin_delete	Deletes a sync group.
begin_refresh_hub_schema	Refreshes a hub database schema.
begin_update	Updates a sync group.
cancel_sync	Cancels a sync group synchronization.
get	Gets a sync group.
list_by_database	Lists sync groups under a hub database.
list_hub_schemas	Gets a collection of hub database schemas.
list_logs	Gets a collection of sync group logs.
list_sync_database_ids	Gets a collection of sync database ids.
trigger_sync	Triggers a sync group synchronization.

begin_create_or_update

Creates or updates a sync group.

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

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.
parameters Required	SyncGroup or IO[bytes] The requested sync group resource state. Is either a SyncGroup type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a sync group.

async begin_delete(resource_group_name: str, server_name: str, database_name: str, sync_group_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. 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_hub_schema

Refreshes a hub database schema.

async begin_refresh_hub_schema(resource_group_name: str, server_name: str, database_name: str, sync_group_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. 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 a sync group.

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

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.
parameters Required	SyncGroup or IO[bytes] The requested sync group resource state. Is either a SyncGroup type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

cancel_sync

Cancels a sync group synchronization.

async cancel_sync(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, **kwargs: Any) -> 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. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Gets a sync group.

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

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
SyncGroup	SyncGroup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_database

Lists sync groups under a hub database.

list_by_database(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) -> AsyncItemPaged[SyncGroup]

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.

Returns

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

Exceptions

Type	Description
HttpResponseError

list_hub_schemas

Gets a collection of hub database schemas.

list_hub_schemas(resource_group_name: str, server_name: str, database_name: str, sync_group_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. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

list_logs

Gets a collection of sync group logs.

list_logs(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, start_time: str, end_time: str, type: str | SyncGroupsType, continuation_token_parameter: str | None = None, **kwargs: Any) -> AsyncItemPaged[SyncGroupLogProperties]

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.
start_time Required	str Get logs generated after this time. Required.
end_time Required	str Get logs generated before this time. Required.
type Required	str or SyncGroupsType The types of logs to retrieve. Known values are: "All", "Error", "Warning", and "Success". Required.
continuation_token_parameter	str The continuation token for this operation. Default value is None. Default value: None

Returns

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

Exceptions

Type	Description
HttpResponseError

list_sync_database_ids

Gets a collection of sync database ids.

list_sync_database_ids(location_name: str, **kwargs: Any) -> AsyncItemPaged[SyncDatabaseIdProperties]

Parameters

Name	Description
location_name Required	str The name of the region where the resource is located. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

trigger_sync

Triggers a sync group synchronization.

async trigger_sync(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, **kwargs: Any) -> 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. Required.

Returns

Type	Description
None	None 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'>