Replication Links - Update

Layanan:

SQL Database

Versi API:

2023-05-01-preview

Updates jenis tautan replikasi.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
databaseName	path	True	string	Nama database.
linkId	path	True	string
resourceGroupName	path	True	string	Nama grup sumber daya yang berisi sumber daya. Anda dapat memperoleh nilai ini dari Azure Resource Manager API atau portal.
serverName	path	True	string	Nama server.
subscriptionId	path	True	string	ID langganan yang mengidentifikasi langganan Azure.
api-version	query	True	string	Versi API yang digunakan untuk permintaan.

Isi Permintaan

Nama	Jenis	Deskripsi
properties.linkType	ReplicationLinkType	Jenis tautan (GEO, NAMED, STANDBY). Operasi pembaruan tidak mendukung NAMED.

Respons

Nama	Jenis	Deskripsi
200 OK	ReplicationLink	Berhasil memperbarui tautan replikasi.
202 Accepted		Operasi pembaruan sedang berlangsung.
Other Status Codes	ErrorResponse	Respons Kesalahan: *** 400 ReplicationLinksReplicationLinkNameIsInvalid - Nama tautan replikasi harus menjadi panduan yang valid. 400 GeoReplicationDatabaseNotSecondary - Operasi mengharapkan database menjadi target replikasi. 400 ReplicationLinksReplicationLinkTypeIsInvalid - LinkType tidak valid. Nilai yang valid adalah STANDBY dan GEO. 400 ReplicationLinksCreateIsNotSupported - Pembuatan Tautan Replikasi tidak didukung. 400 LedgerNoDropLink - Replikasi geografis tidak dapat dihentikan karena database mengaktifkan Unggahan Ledger Digest. Nonaktifkan Ledger Digest Uploads dan coba lagi operasi. 400 CannotUseTrailingWhitespacesInDatabaseName - Validasi nama database gagal. 400 GeoReplicationDatabaseNotSecondary - Operasi mengharapkan database menjadi target replikasi. 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - Mengonfigurasi geo-replikasi tidak didukung untuk database menggunakan nilai yang berbeda dari properti preferredEnclaveType. Database utama {0} di {1} server menggunakan {2} preferredEnclaveType, sedangkan preferredEnclaveType yang ditentukan untuk database sekunder {3} di {4} server adalah {5}. 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes - Failover terencana antara database primer dan sekunder dengan preferredEnclaveType yang berbeda tidak didukung untuk enklave keamanan berbasis Virtualisasi (VBS). 400 CannotUseReservedDatabaseName - Tidak dapat menggunakan nama database yang dipesan dalam operasi ini. 400 InvalidServerName - Nama server yang ditentukan tidak valid. 400 PlannedFailoverTimedOut - Pengguna memanggil penyelamatan kegagalan yang terjadwal, dan kehabisan waktu saat mencoba menghubungi layanan manajemen mitra. 400 InvalidIdentifier - Pengidentifikasi berisi NULL atau karakter unicode yang tidak valid. 400 IncorrectReplicationLinkState - Operasi mengharapkan database berada dalam status yang diharapkan pada tautan replikasi. 404 OperationIdNotFound - Operasi dengan Id tidak ada. 404 ResourceNotFound - Sumber daya yang diminta tidak ditemukan. 404 OperationIdNotFound - Operasi dengan Id tidak ada. 404 DatabaseDoesNotExist - Pengguna telah menentukan nama database yang tidak ada pada instans server ini. 409 CannotCancelOperation - Operasi manajemen dalam keadaan yang tidak dapat dibatalkan. 409 OperationCancelled - Operasi telah dibatalkan oleh pengguna. 409 OperationInterrupted - Operasi pada sumber daya tidak dapat diselesaikan karena terganggu oleh operasi lain pada sumber daya yang sama. 409 InvalidOperationForDatabaseNotInReplicationRelationship - Operasi replikasi dilakukan pada database yang tidak berada dalam hubungan replikasi. 409 GeoReplicationCannotBecomePrimaryDuringUndo - Pengguna mencoba melakukan failover atau menghentikan paksa geo-link saat sekunder berada dalam keadaan di mana mungkin tidak konsisten secara fisik sehingga tidak dapat memasukkan peran utama. 409 DuplicateGeoDrRelation - Database sudah berada dalam relasi replikasi. Ini adalah permintaan duplikat. 409 UpdateSloInProgress - Pengguna mencoba memulai operasi yang tidak kompatibel saat pembaruan SLO sedang berlangsung. 409 ManagementServiceDatabaseBusy - Database '{0}' sibuk dengan operasi lain. Silakan coba operasi Anda nanti. 409 ConflictingSystemOperationInProgress - Operasi pemeliharaan sistem sedang berlangsung pada database dan operasi lebih lanjut perlu menunggu sampai selesai. 409 FailoverGroupAlreadySetup - Operasi tidak dapat dilakukan karena tautan replikasi geografis adalah bagian dari Grup Failover. Anda harus menghapus database dari grup untuk mengakhiri atau failover satu per satu. 429 SubscriptionTooManyCreateUpdateRequests - Permintaan di luar permintaan maks yang dapat diproses oleh sumber daya yang tersedia. 429 SubscriptionTooManyRequests - Permintaan di luar permintaan maks yang dapat diproses oleh sumber daya yang tersedia. 500 OperationTimedOut - Waktu operasi habis dan secara otomatis digulung balik. Coba lagi operasi ini. 503 TooManyRequests - Permintaan di luar permintaan maks yang dapat diproses oleh sumber daya yang tersedia.

Contoh

Update Replication Link

Permintaan sampel

HTTP

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/sourcesvr/databases/gamma-db/replicationLinks/00000000-1111-2222-3333-666666666666?api-version=2023-05-01-preview

{
  "properties": {
    "linkType": "STANDBY"
  }
}

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_update.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="00000000-1111-2222-3333-444444444444",
    )

    response = client.replication_links.begin_update(
        resource_group_name="Default",
        server_name="sourcesvr",
        database_name="gamma-db",
        link_id="00000000-1111-2222-3333-666666666666",
        parameters={"properties": {"linkType": "STANDBY"}},
    ).result()
    print(response)


# x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/preview/2023-05-01-preview/examples/ReplicationLinkUpdate.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

Go

package armsql_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/sql/armsql/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/a3913f4b26467aed413cdc907116e99894f08994/specification/sql/resource-manager/Microsoft.Sql/preview/2023-05-01-preview/examples/ReplicationLinkUpdate.json
func ExampleReplicationLinksClient_BeginUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsql.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewReplicationLinksClient().BeginUpdate(ctx, "Default", "sourcesvr", "gamma-db", "00000000-1111-2222-3333-666666666666", armsql.ReplicationLinkUpdate{
		Properties: &armsql.ReplicationLinkUpdateProperties{
			LinkType: to.Ptr(armsql.ReplicationLinkTypeSTANDBY),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ReplicationLink = armsql.ReplicationLink{
	// 	Name: to.Ptr("00000000-1111-2222-3333-666666666666"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/sourcesvr/databases/gamma-db/replicationLinks/4891ca10-ebd0-47d7-9182-c722651780fb"),
	// 	Properties: &armsql.ReplicationLinkProperties{
	// 		IsTerminationAllowed: to.Ptr(true),
	// 		LinkType: to.Ptr(armsql.ReplicationLinkTypeSTANDBY),
	// 		PartnerDatabase: to.Ptr("gamma-db"),
	// 		PartnerDatabaseID: to.Ptr("/subscriptions/00000000-1111-2222-3333-555555555555/resourceGroups/Second-Default/providers/Microsoft.Sql/servers/testsvr/databases/gamma-db"),
	// 		PartnerLocation: to.Ptr("Japan East"),
	// 		PartnerRole: to.Ptr(armsql.ReplicationRoleSecondary),
	// 		PartnerServer: to.Ptr("testsvr"),
	// 		PercentComplete: to.Ptr[int32](100),
	// 		ReplicationMode: to.Ptr("ASYNC"),
	// 		ReplicationState: to.Ptr(armsql.ReplicationStateCATCHUP),
	// 		Role: to.Ptr(armsql.ReplicationRolePrimary),
	// 		StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-21T08:12:43.783Z"); return t}()),
	// 	},
	// }
}

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 Updates the replication link type.
 *
 * @summary Updates the replication link type.
 * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/preview/2023-05-01-preview/examples/ReplicationLinkUpdate.json
 */
async function updateReplicationLink() {
  const subscriptionId =
    process.env["SQL_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const resourceGroupName = process.env["SQL_RESOURCE_GROUP"] || "Default";
  const serverName = "sourcesvr";
  const databaseName = "gamma-db";
  const linkId = "00000000-1111-2222-3333-666666666666";
  const parameters = { linkType: "STANDBY" };
  const credential = new DefaultAzureCredential();
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.replicationLinks.beginUpdateAndWait(
    resourceGroupName,
    serverName,
    databaseName,
    linkId,
    parameters,
  );
  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/preview/2023-05-01-preview/examples/ReplicationLinkUpdate.json
// this example is just showing the usage of "ReplicationLinks_Update" 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 = "00000000-1111-2222-3333-666666666666";
ResourceIdentifier sqlServerDatabaseReplicationLinkResourceId = SqlServerDatabaseReplicationLinkResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, linkId);
SqlServerDatabaseReplicationLinkResource sqlServerDatabaseReplicationLink = client.GetSqlServerDatabaseReplicationLinkResource(sqlServerDatabaseReplicationLinkResourceId);

// invoke the operation
SqlServerDatabaseReplicationLinkPatch patch = new SqlServerDatabaseReplicationLinkPatch()
{
    LinkType = ReplicationLinkType.Standby,
};
ArmOperation<SqlServerDatabaseReplicationLinkResource> lro = await sqlServerDatabaseReplicationLink.UpdateAsync(WaitUntil.Completed, patch);
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

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

Kode status:

202

Location: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/japaneast/replicationLinksOperationResults/11111111-1111-1111-1111-111111111111

Definisi

Nama	Deskripsi
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
ReplicationLink	Tautan replikasi.
ReplicationLinkType	Jenis tautan (GEO, NAMED, STANDBY). Operasi pembaruan tidak mendukung NAMED.
ReplicationLinkUpdate	Permintaan pembaruan tautan replikasi.
ReplicationRole	Peran replikasi lokal.
ReplicationState	Status replikasi (PENDING, SEEDING, CATCHUP, SUSPENDED).

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

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

ErrorDetail

Detail kesalahan.

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

ErrorResponse

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

ReplicationLink

Tautan replikasi.

Nama	Jenis	Deskripsi
id	string	ID Sumber Daya.
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	Persentase penyelesaian seeding 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	Waktu saat tautan dibuat.
type	string	Jenis sumber daya

ReplicationLinkType

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

Nama	Jenis	Deskripsi
GEO	string
NAMED	string
STANDBY	string

ReplicationLinkUpdate

Permintaan pembaruan tautan replikasi.

Nama	Jenis	Deskripsi
id	string	ID Sumber Daya.
name	string	Nama sumber daya.
properties.linkType	ReplicationLinkType	Jenis tautan (GEO, NAMED, STANDBY). Operasi pembaruan tidak mendukung NAMED.
type	string	Jenis sumber daya

ReplicationRole

Peran replikasi lokal.

Nama	Jenis	Deskripsi
Copy	string
NonReadableSecondary	string
Primary	string
Secondary	string
Source	string

ReplicationState

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

Nama	Jenis	Deskripsi
CATCH_UP	string
PENDING	string
SEEDING	string
SUSPENDED	string