Replication Links - Failover

Layanan:

SQL Database

Versi API:

2025-01-01

Failover dari server utama saat ini ke server ini.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}/failover?api-version=2025-01-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
databaseName	path	True	string	Nama database.
linkId	path	True	string	Nama tautan replikasi.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
serverName	path	True	string	Nama server.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus sebuah UUID.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	ReplicationLink	Operasi Azure berhasil diselesaikan.
202 Accepted		Operasi sumber daya diterima. Header Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Planned failover of a replication link

Permintaan sampel

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/sourcesvr/databases/gamma-db/replicationLinks/4891ca10-ebd0-47d7-9182-c722651780fb/failover?api-version=2025-01-01

Java

/**
 * Samples for ReplicationLinks Failover.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/ReplicationLinkFailover.json
     */
    /**
     * Sample code: Planned failover of a replication link.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void plannedFailoverOfAReplicationLink(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getReplicationLinks().failover("Default", "sourcesvr", "gamma-db",
            "4891ca10-ebd0-47d7-9182-c722651780fb", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python replication_link_failover.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.replication_links.begin_failover(
        resource_group_name="Default",
        server_name="sourcesvr",
        database_name="gamma-db",
        link_id="4891ca10-ebd0-47d7-9182-c722651780fb",
    ).result()
    print(response)


# x-ms-original-file: 2025-01-01/ReplicationLinkFailover.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to fails over from the current primary server to this server.
 *
 * @summary fails over from the current primary server to this server.
 * x-ms-original-file: 2025-01-01/ReplicationLinkFailover.json
 */
async function plannedFailoverOfAReplicationLink() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.replicationLinks.failover(
    "Default",
    "sourcesvr",
    "gamma-db",
    "4891ca10-ebd0-47d7-9182-c722651780fb",
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/ReplicationLinkFailover.json
// this example is just showing the usage of "ReplicationLinks_Failover" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerDatabaseReplicationLinkResource created on azure
// for more information of creating SqlServerDatabaseReplicationLinkResource, please refer to the document of SqlServerDatabaseReplicationLinkResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default";
string serverName = "sourcesvr";
string databaseName = "gamma-db";
string linkId = "4891ca10-ebd0-47d7-9182-c722651780fb";
ResourceIdentifier sqlServerDatabaseReplicationLinkResourceId = SqlServerDatabaseReplicationLinkResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, linkId);
SqlServerDatabaseReplicationLinkResource sqlServerDatabaseReplicationLink = client.GetSqlServerDatabaseReplicationLinkResource(sqlServerDatabaseReplicationLinkResourceId);

// invoke the operation
ArmOperation<SqlServerDatabaseReplicationLinkResource> lro = await sqlServerDatabaseReplicationLink.FailoverAsync(WaitUntil.Completed);
SqlServerDatabaseReplicationLinkResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlServerDatabaseReplicationLinkData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respon sampel

Kode status:

200

{
  "name": "4891ca10-ebd0-47d7-9182-c722651780fb",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/sourcesvr/databases/gamma-db/replicationLinks/4891ca10-ebd0-47d7-9182-c722651780fb",
  "properties": {
    "isTerminationAllowed": true,
    "linkType": "GEO",
    "partnerDatabase": "gamma-db",
    "partnerDatabaseId": "/subscriptions/00000000-1111-2222-3333-555555555555/resourceGroups/Second-Default/providers/Microsoft.Sql/servers/testsvr/databases/gamma-db",
    "partnerLocation": "Japan East",
    "partnerRole": "Secondary",
    "partnerServer": "testsvr",
    "percentComplete": 100,
    "replicationMode": "ASYNC",
    "replicationState": "CATCH_UP",
    "role": "Primary",
    "startTime": "2018-06-21T08:12:43.783Z"
  }
}

Kode status:

202

Location: https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/JapanWest/replicationLinksOperationResults/replicationlink-group-test-3?api-version=2022-05-01-preview

Definisi

Nama	Deskripsi
createdByType	Jenis identitas yang membuat sumber daya.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan
ReplicationLink	Tautan replikasi.
ReplicationLinkType	Jenis tautan (GEO, NAMED, STANDBY). Operasi pembaruan tidak mendukung NAMED.
ReplicationRole	Peran replikasi lokal.
ReplicationState	Status replikasi (PENDING, SEEDING, CATCHUP, SUSPENDED).
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Rincian kesalahan.
message	string	Pesan kesalahan.
target	string	Sasaran kesalahan.

ErrorResponse

Objek

Tanggapan kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

ReplicationLink

Objek

Tautan replikasi.

Nama	Jenis	Deskripsi
id	string (arm-id)	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nama sumber daya
properties.isTerminationAllowed	boolean	Apakah pengguna saat ini diizinkan untuk mengakhiri tautan.
properties.linkType	ReplicationLinkType	Jenis tautan (GEO, NAMED, STANDBY). Operasi pembaruan tidak mendukung NAMED.
properties.partnerDatabase	string	Database mitra sumber daya.
properties.partnerDatabaseId	string	Id database mitra sumber daya.
properties.partnerLocation	string	Lokasi mitra sumber daya.
properties.partnerRole	ReplicationRole	Peran replikasi mitra.
properties.partnerServer	string	Server mitra sumber daya.
properties.percentComplete	integer (int32)	Persentase penyelesaian penyelesaian penyemaian untuk tautan.
properties.replicationMode	string	Mode replikasi.
properties.replicationState	ReplicationState	Status replikasi (PENDING, SEEDING, CATCHUP, SUSPENDED).
properties.role	ReplicationRole	Peran replikasi lokal.
properties.startTime	string (date-time)	Waktu saat tautan dibuat.
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createdBy dan modifiedBy.
type	string	Jenis sumber daya. Misalnya "Microsoft. Komputasi/virtualMachines" atau "Microsoft. Akun penyimpanan/penyimpanan"

ReplicationLinkType

Enumerasi

Jenis tautan (GEO, NAMED, STANDBY). Operasi pembaruan tidak mendukung NAMED.

Nilai	Deskripsi
GEO	GEO
NAMED	BERNAMA
STANDBY	SIAGA

ReplicationRole

Enumerasi

Peran replikasi lokal.

Nilai	Deskripsi
Primary	Primary
Secondary	Secondary
NonReadableSecondary	Tidak Dapat DibacaSekunder
Source	Sumber
Copy	Copy

ReplicationState

Enumerasi

Status replikasi (PENDING, SEEDING, CATCHUP, SUSPENDED).

Nilai	Deskripsi
PENDING	TERTUNDA
SEEDING	PENYEMAIAN
CATCH_UP	MENGEJAR KETINGGALAN
SUSPENDED	DITANGGUHKAN

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Stempel waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.