ReplicationLinksOperations Class
ReplicationLinksOperations 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.objectReplicationLinksOperations
Constructor
ReplicationLinksOperations(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_failover |
Sets which replica database is primary by failing over from the current primary replica database. |
| begin_failover_allow_data_loss |
Sets which replica database is primary by failing over from the current primary replica database. This operation might result in data loss. |
| begin_unlink |
Deletes a database replication link in forced or friendly way. |
| delete |
Deletes a database replication link. Cannot be done during failover. |
| get |
Gets a replication link. |
| list_by_database |
Gets a list of replication links on database. |
| list_by_server |
Gets a list of replication links. |
begin_failover
Sets which replica database is primary by failing over from the current primary replica database.
begin_failover(resource_group_name: str, server_name: str, database_name: str, link_id: str, **kwargs: Any) -> LROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
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
Required
|
The name of the server. |
|
database_name
Required
|
The name of the database that has the replication link to be failed over. |
|
link_id
Required
|
The ID of the replication link to be failed over. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
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
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_failover_allow_data_loss
Sets which replica database is primary by failing over from the current primary replica database. This operation might result in data loss.
begin_failover_allow_data_loss(resource_group_name: str, server_name: str, database_name: str, link_id: str, **kwargs: Any) -> LROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
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
Required
|
The name of the server. |
|
database_name
Required
|
The name of the database that has the replication link to be failed over. |
|
link_id
Required
|
The ID of the replication link to be failed over. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
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
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_unlink
Deletes a database replication link in forced or friendly way.
begin_unlink(resource_group_name: str, server_name: str, database_name: str, link_id: str, parameters: '_models.UnlinkParameters', **kwargs: Any) -> LROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
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
Required
|
The name of the server. |
|
database_name
Required
|
The name of the database that has the replication link to be failed over. |
|
link_id
Required
|
The ID of the replication link to be failed over. |
|
parameters
Required
|
The required parameters for unlinking replication link. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
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
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
delete
Deletes a database replication link. Cannot be done during failover.
delete(resource_group_name: str, server_name: str, database_name: str, link_id: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
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
Required
|
The name of the server. |
|
database_name
Required
|
The name of the database that has the replication link to be dropped. |
|
link_id
Required
|
The ID of the replication link to be deleted. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
None, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Gets a replication link.
get(resource_group_name: str, server_name: str, database_name: str, link_id: str, **kwargs: Any) -> _models.ReplicationLinkParameters
| Name | Description |
|---|---|
|
resource_group_name
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
Required
|
The name of the server. |
|
database_name
Required
|
The name of the database. |
|
link_id
Required
|
The name of the replication link. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
ReplicationLink, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_database
Gets a list of replication links on database.
list_by_database(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) -> Iterable['_models.ReplicationLinkListResult']Parameters
| Name | Description |
|---|---|
|
resource_group_name
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
Required
|
The name of the server. |
|
database_name
Required
|
The name of the database. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either ReplicationLinkListResult or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_server
Gets a list of replication links.
list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) -> Iterable['_models.ReplicationLinkListResult']Parameters
| Name | Description |
|---|---|
|
resource_group_name
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
Required
|
The name of the server. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either ReplicationLinkListResult or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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'>
Azure SDK for Python
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for