Failover Groups - Update

Layanan:

SQL Database

Versi API:

2025-01-01

Memperbarui grup failover.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups/{failoverGroupName}?api-version=2025-01-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
failoverGroupName	path	True	string	Nama grup failover.
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.

Isi Permintaan

Nama	Jenis	Deskripsi
properties.databases	string[] (arm-id)	Daftar database dalam grup failover.
properties.partnerServers	PartnerInfo[]	Daftar informasi server mitra untuk grup failover.
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	Titik akhir baca-saja dari instans grup failover.
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	Titik akhir baca-tulis dari instans grup failover.
properties.secondaryType	FailoverGroupDatabasesSecondaryType	Jenis sekunder database di server mitra.
tags	object	Tag sumber daya.

Respons

Nama	Jenis	Deskripsi
200 OK	FailoverGroup	Operasi Azure berhasil diselesaikan.
202 Accepted		Permintaan pembaruan 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

Add database to failover group with standby secondary on partner server.

Update failover group

Add database to failover group with standby secondary on partner server.

Permintaan sampel

HTTP

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-1?api-version=2025-01-01

{
  "properties": {
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1"
    ],
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 120
    },
    "secondaryType": "Standby"
  }
}

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/FailoverGroupUpdateStandbySecondary.json
// this example is just showing the usage of "FailoverGroups_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 FailoverGroupResource created on azure
// for more information of creating FailoverGroupResource, please refer to the document of FailoverGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default";
string serverName = "failover-group-primary-server";
string failoverGroupName = "failover-group-test-1";
ResourceIdentifier failoverGroupResourceId = FailoverGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, failoverGroupName);
FailoverGroupResource failoverGroup = client.GetFailoverGroupResource(failoverGroupResourceId);

// invoke the operation
FailoverGroupPatch patch = new FailoverGroupPatch
{
    ReadWriteEndpoint = new FailoverGroupReadWriteEndpoint(ReadWriteEndpointFailoverPolicy.Automatic)
    {
        FailoverWithDataLossGracePeriodMinutes = 120,
    },
    FailoverDatabases = { new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1") },
    SecondaryType = FailoverGroupDatabasesSecondaryType.Standby,
};
ArmOperation<FailoverGroupResource> lro = await failoverGroup.UpdateAsync(WaitUntil.Completed, patch);
FailoverGroupResource 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
FailoverGroupData 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": "failover-group-test-3",
  "type": "Microsoft.Sql/servers/failoverGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-3",
  "location": "Japan East",
  "properties": {
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1"
    ],
    "partnerServers": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server",
        "location": "Japan West",
        "replicationRole": "Secondary"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled",
      "targetServer": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 120
    },
    "replicationRole": "Primary",
    "replicationState": "CATCH_UP"
  }
}

Kode status:

202

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

Update failover group

Permintaan sampel

HTTP

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-1?api-version=2025-01-01

{
  "properties": {
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1"
    ],
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 120
    }
  }
}

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/FailoverGroupUpdate.json
// this example is just showing the usage of "FailoverGroups_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 FailoverGroupResource created on azure
// for more information of creating FailoverGroupResource, please refer to the document of FailoverGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default";
string serverName = "failover-group-primary-server";
string failoverGroupName = "failover-group-test-1";
ResourceIdentifier failoverGroupResourceId = FailoverGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, failoverGroupName);
FailoverGroupResource failoverGroup = client.GetFailoverGroupResource(failoverGroupResourceId);

// invoke the operation
FailoverGroupPatch patch = new FailoverGroupPatch
{
    ReadWriteEndpoint = new FailoverGroupReadWriteEndpoint(ReadWriteEndpointFailoverPolicy.Automatic)
    {
        FailoverWithDataLossGracePeriodMinutes = 120,
    },
    FailoverDatabases = { new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1") },
};
ArmOperation<FailoverGroupResource> lro = await failoverGroup.UpdateAsync(WaitUntil.Completed, patch);
FailoverGroupResource 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
FailoverGroupData 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": "failover-group-test-3",
  "type": "Microsoft.Sql/servers/failoverGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-3",
  "location": "Japan East",
  "properties": {
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1"
    ],
    "partnerServers": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server",
        "location": "Japan West",
        "replicationRole": "Secondary"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled",
      "targetServer": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 120
    },
    "replicationRole": "Primary",
    "replicationState": "CATCH_UP"
  }
}

Kode status:

202

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

Definisi

Nama	Deskripsi
createdByType	Jenis identitas yang membuat sumber daya.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan
FailoverGroup	Grup failover.
FailoverGroupDatabasesSecondaryType	Jenis sekunder database di server mitra.
FailoverGroupReadOnlyEndpoint	Titik akhir baca-saja dari instans grup failover.
FailoverGroupReadWriteEndpoint	Titik akhir baca-tulis dari instans grup failover.
FailoverGroupReplicationRole	Peran replikasi lokal instans grup failover.
FailoverGroupUpdate	Permintaan pembaruan grup failover.
PartnerInfo	Informasi server mitra untuk grup failover.
ReadOnlyEndpointFailoverPolicy	Kebijakan failover dari titik akhir baca-saja untuk grup failover.
ReadWriteEndpointFailoverPolicy	Kebijakan failover dari titik akhir baca-tulis untuk grup failover. Jika failoverPolicy Adalah Otomatis, maka failoverWithDataLossGracePeriodMinutes diperlukan.
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.

FailoverGroup

Objek

Grup failover.

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}"
location	string	Lokasi sumber daya.
name	string	Nama sumber daya
properties.databases	string[] (arm-id)	Daftar database dalam grup failover.
properties.partnerServers	PartnerInfo[]	Daftar informasi server mitra untuk grup failover.
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	Titik akhir baca-saja dari instans grup failover.
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	Titik akhir baca-tulis dari instans grup failover.
properties.replicationRole	FailoverGroupReplicationRole	Peran replikasi lokal instans grup failover.
properties.replicationState	string	Status replikasi instans grup failover.
properties.secondaryType	FailoverGroupDatabasesSecondaryType	Jenis sekunder database di server mitra.
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createdBy dan modifiedBy.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya. Misalnya "Microsoft. Komputasi/virtualMachines" atau "Microsoft. Akun penyimpanan/penyimpanan"

FailoverGroupDatabasesSecondaryType

Enumerasi

Jenis sekunder database di server mitra.

Nilai	Deskripsi
Geo	Geografi
Standby	Siaga

FailoverGroupReadOnlyEndpoint

Objek

Titik akhir baca-saja dari instans grup failover.

Nama	Jenis	Deskripsi
failoverPolicy	ReadOnlyEndpointFailoverPolicy	Kebijakan failover dari titik akhir baca-saja untuk grup failover.
targetServer	string (arm-id)	Server mitra target tempat titik akhir baca-saja menunjuk.

FailoverGroupReadWriteEndpoint

Objek

Titik akhir baca-tulis dari instans grup failover.

Nama	Jenis	Deskripsi
failoverPolicy	ReadWriteEndpointFailoverPolicy	Kebijakan failover dari titik akhir baca-tulis untuk grup failover. Jika failoverPolicy Adalah Otomatis, maka failoverWithDataLossGracePeriodMinutes diperlukan.
failoverWithDataLossGracePeriodMinutes	integer (int32)	Masa tenggang sebelum failover dengan kehilangan data dicoba untuk titik akhir baca-tulis. Jika failoverPolicy Adalah Otomatis, maka failoverWithDataLossGracePeriodMinutes diperlukan.

FailoverGroupReplicationRole

Enumerasi

Peran replikasi lokal instans grup failover.

Nilai	Deskripsi
Primary	Primary
Secondary	Secondary

FailoverGroupUpdate

Objek

Permintaan pembaruan grup failover.

Nama	Jenis	Deskripsi
properties.databases	string[] (arm-id)	Daftar database dalam grup failover.
properties.partnerServers	PartnerInfo[]	Daftar informasi server mitra untuk grup failover.
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	Titik akhir baca-saja dari instans grup failover.
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	Titik akhir baca-tulis dari instans grup failover.
properties.secondaryType	FailoverGroupDatabasesSecondaryType	Jenis sekunder database di server mitra.
tags	object	Tag sumber daya.

PartnerInfo

Objek

Informasi server mitra untuk grup failover.

Nama	Jenis	Deskripsi
id	string (arm-id)	Pengidentifikasi sumber daya server mitra.
location	string	Lokasi geografis server mitra.
replicationRole	FailoverGroupReplicationRole	Peran replikasi server mitra.

ReadOnlyEndpointFailoverPolicy

Enumerasi

Kebijakan failover dari titik akhir baca-saja untuk grup failover.

Nilai	Deskripsi
Disabled	Nonaktif
Enabled	Enabled

ReadWriteEndpointFailoverPolicy

Enumerasi

Kebijakan failover dari titik akhir baca-tulis untuk grup failover. Jika failoverPolicy Adalah Otomatis, maka failoverWithDataLossGracePeriodMinutes diperlukan.

Nilai	Deskripsi
Manual	Manual
Automatic	Otomatis

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.