SyncGroupsOperations Class

SyncGroupsOperations 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

SyncGroupsOperations

Constructor

SyncGroupsOperations(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 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.

begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, parameters: '_models.SyncGroup', **kwargs: Any) -> LROPoller['_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.
server_name Required	str The name of the server.
database_name Required	str The name of the database on which the sync group is hosted.
sync_group_name Required	str The name of the sync group.
parameters Required	SyncGroup The requested sync group 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 PollingMethod By default, your polling method will be ARMPolling. 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
LROPoller[SyncGroup]	An instance of LROPoller that returns either SyncGroup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a sync group.

begin_delete(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, **kwargs: Any) -> LROPoller[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.
database_name Required	str The name of the database on which the sync group is hosted.
sync_group_name Required	str The name of the sync group.

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 PollingMethod By default, your polling method will be ARMPolling. 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
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_refresh_hub_schema

Refreshes a hub database schema.

begin_refresh_hub_schema(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, **kwargs: Any) -> LROPoller[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.
database_name Required	str The name of the database on which the sync group is hosted.
sync_group_name Required	str The name of the sync group.

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 PollingMethod By default, your polling method will be ARMPolling. 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
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update

Updates a sync group.

begin_update(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, parameters: '_models.SyncGroup', **kwargs: Any) -> LROPoller['_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.
server_name Required	str The name of the server.
database_name Required	str The name of the database on which the sync group is hosted.
sync_group_name Required	str The name of the sync group.
parameters Required	SyncGroup The requested sync group 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 PollingMethod By default, your polling method will be ARMPolling. 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
LROPoller[SyncGroup]	An instance of LROPoller that returns either SyncGroup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

cancel_sync

Cancels a sync group synchronization.

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

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Gets a sync group.

get(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, **kwargs: Any) -> _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.
server_name Required	str The name of the server.
database_name Required	str The name of the database on which the sync group is hosted.
sync_group_name Required	str The name of the sync group.

Keyword-Only Parameters

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

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) -> Iterable['_models.SyncGroupListResult']

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

Keyword-Only Parameters

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

Returns

Type	Description
ItemPaged[SyncGroupListResult]	An iterator like instance of either SyncGroupListResult 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) -> Iterable['_models.SyncFullSchemaPropertiesListResult']

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

Keyword-Only Parameters

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

Returns

Type	Description
ItemPaged[SyncFullSchemaPropertiesListResult]	An iterator like instance of either SyncFullSchemaPropertiesListResult 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 | '_models.Enum77', continuation_token_parameter: str | None = None, **kwargs: Any) -> Iterable['_models.SyncGroupLogListResult']

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.
database_name Required	str The name of the database on which the sync group is hosted.
sync_group_name Required	str The name of the sync group.
start_time Required	str Get logs generated after this time.
end_time Required	str Get logs generated before this time.
type Required	str or Enum77 The types of logs to retrieve.
continuation_token_parameter	str The continuation token for this operation. Default value: None

Keyword-Only Parameters

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

Returns

Type	Description
ItemPaged[SyncGroupLogListResult]	An iterator like instance of either SyncGroupLogListResult 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) -> Iterable['_models.SyncDatabaseIdListResult']

Parameters

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

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

trigger_sync

Triggers a sync group synchronization.

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

Keyword-Only Parameters

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

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:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>