SyncMembersOperations Class

SyncMembersOperations 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
SyncMembersOperations

Constructor

SyncMembersOperations(client, config, serializer, deserializer)

Parameters

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

models

Alias to model classes used in this operation group.

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.

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, **kwargs: Any) -> LROPoller[_models.SyncMember]

Parameters

resource_group_name
str
Required

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
str
Required

The name of the server.

database_name
str
Required

The name of the database on which the sync group is hosted.

sync_group_name
str
Required

The name of the sync group on which the sync member is hosted.

sync_member_name
str
Required

The name of the sync member.

parameters
SyncMember
Required

The requested sync member resource state.

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

An instance of LROPoller that returns either SyncMember or the result of cls(response)

Return type

Exceptions

begin_delete

Deletes a sync member.

begin_delete(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, sync_member_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

resource_group_name
str
Required

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
str
Required

The name of the server.

database_name
str
Required

The name of the database on which the sync group is hosted.

sync_group_name
str
Required

The name of the sync group on which the sync member is hosted.

sync_member_name
str
Required

The name of the sync member.

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

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_refresh_member_schema

Refreshes a sync member database schema.

begin_refresh_member_schema(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, sync_member_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

resource_group_name
str
Required

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
str
Required

The name of the server.

database_name
str
Required

The name of the database on which the sync group is hosted.

sync_group_name
str
Required

The name of the sync group on which the sync member is hosted.

sync_member_name
str
Required

The name of the sync member.

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

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_update

Updates an existing sync member.

begin_update(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, sync_member_name: str, parameters: _models.SyncMember, **kwargs: Any) -> LROPoller[_models.SyncMember]

Parameters

resource_group_name
str
Required

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
str
Required

The name of the server.

database_name
str
Required

The name of the database on which the sync group is hosted.

sync_group_name
str
Required

The name of the sync group on which the sync member is hosted.

sync_member_name
str
Required

The name of the sync member.

parameters
SyncMember
Required

The requested sync member resource state.

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

An instance of LROPoller that returns either SyncMember or the result of cls(response)

Return type

Exceptions

get

Gets a sync member.

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

Parameters

resource_group_name
str
Required

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
str
Required

The name of the server.

database_name
str
Required

The name of the database on which the sync group is hosted.

sync_group_name
str
Required

The name of the sync group on which the sync member is hosted.

sync_member_name
str
Required

The name of the sync member.

cls
callable

A custom type or function that will be passed the direct response

Returns

SyncMember, or the result of cls(response)

Return type

Exceptions

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

Parameters

resource_group_name
str
Required

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
str
Required

The name of the server.

database_name
str
Required

The name of the database on which the sync group is hosted.

sync_group_name
str
Required

The name of the sync group.

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SyncMemberListResult or the result of cls(response)

Return type

Exceptions

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

Parameters

resource_group_name
str
Required

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
str
Required

The name of the server.

database_name
str
Required

The name of the database on which the sync group is hosted.

sync_group_name
str
Required

The name of the sync group on which the sync member is hosted.

sync_member_name
str
Required

The name of the sync member.

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SyncFullSchemaPropertiesListResult or the result of cls(response)

Return type

Exceptions

Attributes

models

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