Instance Failover Groups - Create Or Update

Layanan:

SQL Database

Versi API:

2025-01-01

Membuat atau memperbarui grup failover.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups/{failoverGroupName}?api-version=2025-01-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
failoverGroupName	path	True	string	Nama grup failover.
locationName	path	True	string	Nama wilayah tempat sumber daya berada.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
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	Diperlukan	Jenis	Deskripsi
properties.managedInstancePairs	True	ManagedInstancePairInfo[]	Daftar pasangan instans terkelola dalam grup failover.
properties.partnerRegions	True	PartnerRegionInfo[]	Informasi wilayah mitra untuk grup failover.
properties.readWriteEndpoint	True	InstanceFailoverGroupReadWriteEndpoint	Titik akhir baca-tulis dari instans grup failover.
properties.readOnlyEndpoint		InstanceFailoverGroupReadOnlyEndpoint	Titik akhir baca-saja dari instans grup failover.
properties.secondaryType		SecondaryInstanceType	Jenis instans geo-sekunder. Atur 'Siaga' jika instans hanya digunakan sebagai opsi DR.

Respons

Nama	Jenis	Deskripsi
200 OK	InstanceFailoverGroup	Operasi pembaruan 'InstanceFailoverGroup' sumber daya berhasil
201 Created	InstanceFailoverGroup	Resource 'InstanceFailoverGroup' membuat operasi berhasil Header Location: string Retry-After: integer
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

Create failover group

Permintaan sampel

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/Japan East/instanceFailoverGroups/failover-group-test-3?api-version=2025-01-01

{
  "properties": {
    "managedInstancePairs": [
      {
        "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance",
        "primaryManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance"
      }
    ],
    "partnerRegions": [
      {
        "location": "Japan West"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 480
    },
    "secondaryType": "Geo"
  }
}

Java

import com.azure.resourcemanager.sql.fluent.models.InstanceFailoverGroupInner;
import com.azure.resourcemanager.sql.models.InstanceFailoverGroupReadOnlyEndpoint;
import com.azure.resourcemanager.sql.models.InstanceFailoverGroupReadWriteEndpoint;
import com.azure.resourcemanager.sql.models.ManagedInstancePairInfo;
import com.azure.resourcemanager.sql.models.PartnerRegionInfo;
import com.azure.resourcemanager.sql.models.ReadOnlyEndpointFailoverPolicy;
import com.azure.resourcemanager.sql.models.ReadWriteEndpointFailoverPolicy;
import com.azure.resourcemanager.sql.models.SecondaryInstanceType;
import java.util.Arrays;

/**
 * Samples for InstanceFailoverGroups CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/InstanceFailoverGroupCreateOrUpdate.json
     */
    /**
     * Sample code: Create failover group.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void createFailoverGroup(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getInstanceFailoverGroups().createOrUpdate("Default", "Japan East",
            "failover-group-test-3",
            new InstanceFailoverGroupInner().withSecondaryType(SecondaryInstanceType.GEO)
                .withReadWriteEndpoint(new InstanceFailoverGroupReadWriteEndpoint()
                    .withFailoverPolicy(ReadWriteEndpointFailoverPolicy.AUTOMATIC)
                    .withFailoverWithDataLossGracePeriodMinutes(480))
                .withReadOnlyEndpoint(new InstanceFailoverGroupReadOnlyEndpoint()
                    .withFailoverPolicy(ReadOnlyEndpointFailoverPolicy.DISABLED))
                .withPartnerRegions(Arrays.asList(new PartnerRegionInfo().withLocation("Japan West")))
                .withManagedInstancePairs(Arrays.asList(new ManagedInstancePairInfo().withPrimaryManagedInstanceId(
                    "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance")
                    .withPartnerManagedInstanceId(
                        "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance"))),
            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 instance_failover_group_create_or_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="SUBSCRIPTION_ID",
    )

    response = client.instance_failover_groups.begin_create_or_update(
        resource_group_name="Default",
        location_name="Japan East",
        failover_group_name="failover-group-test-3",
        parameters={
            "properties": {
                "managedInstancePairs": [
                    {
                        "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance",
                        "primaryManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance",
                    }
                ],
                "partnerRegions": [{"location": "Japan West"}],
                "readOnlyEndpoint": {"failoverPolicy": "Disabled"},
                "readWriteEndpoint": {"failoverPolicy": "Automatic", "failoverWithDataLossGracePeriodMinutes": 480},
                "secondaryType": "Geo",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: 2025-01-01/InstanceFailoverGroupCreateOrUpdate.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 creates or updates a failover group.
 *
 * @summary creates or updates a failover group.
 * x-ms-original-file: 2025-01-01/InstanceFailoverGroupCreateOrUpdate.json
 */
async function createFailoverGroup() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.instanceFailoverGroups.createOrUpdate(
    "Default",
    "Japan East",
    "failover-group-test-3",
    {
      managedInstancePairs: [
        {
          partnerManagedInstanceId:
            "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance",
          primaryManagedInstanceId:
            "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance",
        },
      ],
      partnerRegions: [{ location: "Japan West" }],
      readOnlyEndpoint: { failoverPolicy: "Disabled" },
      readWriteEndpoint: {
        failoverPolicy: "Automatic",
        failoverWithDataLossGracePeriodMinutes: 480,
      },
      secondaryType: "Geo",
    },
  );
  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.Resources;
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/InstanceFailoverGroupCreateOrUpdate.json
// this example is just showing the usage of "InstanceFailoverGroups_CreateOrUpdate" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this InstanceFailoverGroupResource
AzureLocation locationName = new AzureLocation("Japan East");
InstanceFailoverGroupCollection collection = resourceGroupResource.GetInstanceFailoverGroups(locationName);

// invoke the operation
string failoverGroupName = "failover-group-test-3";
InstanceFailoverGroupData data = new InstanceFailoverGroupData
{
    SecondaryType = GeoSecondaryInstanceType.Geo,
    ReadWriteEndpoint = new InstanceFailoverGroupReadWriteEndpoint(ReadWriteEndpointFailoverPolicy.Automatic)
    {
        FailoverWithDataLossGracePeriodMinutes = 480,
    },
    ReadOnlyEndpointFailoverPolicy = ReadOnlyEndpointFailoverPolicy.Disabled,
    PartnerRegions = {new PartnerRegionInfo
    {
    Location = new AzureLocation("Japan West"),
    }},
    ManagedInstancePairs = {new ManagedInstancePairInfo
    {
    PrimaryManagedInstanceId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance"),
    PartnerManagedInstanceId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance"),
    }},
};
ArmOperation<InstanceFailoverGroupResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, failoverGroupName, data);
InstanceFailoverGroupResource 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
InstanceFailoverGroupData 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/locations/instanceFailoverGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/JapanEast/instanceFailoverGroups/failover-group-test-3",
  "properties": {
    "managedInstancePairs": [
      {
        "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance",
        "primaryManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance"
      }
    ],
    "partnerRegions": [
      {
        "location": "Japan West",
        "replicationRole": "Secondary"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 480
    },
    "replicationRole": "Primary",
    "replicationState": "CATCH_UP",
    "secondaryType": "Geo"
  }
}

Kode status:

201

{
  "name": "failover-group-test-3",
  "type": "Microsoft.Sql/locations/instanceFailoverGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/JapanEast/instanceFailoverGroups/failover-group-test-3",
  "properties": {
    "managedInstancePairs": [
      {
        "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance",
        "primaryManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance"
      }
    ],
    "partnerRegions": [
      {
        "location": "Japan West",
        "replicationRole": "Secondary"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 480
    },
    "replicationRole": "Primary",
    "replicationState": "CATCH_UP",
    "secondaryType": "Geo"
  }
}

Kode status:

202

Definisi

Nama	Deskripsi
createdByType	Jenis identitas yang membuat sumber daya.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan
InstanceFailoverGroup	Grup failover instans.
InstanceFailoverGroupReadOnlyEndpoint	Titik akhir baca-saja dari instans grup failover.
InstanceFailoverGroupReadWriteEndpoint	Titik akhir baca-tulis dari instans grup failover.
InstanceFailoverGroupReplicationRole	Peran replikasi lokal instans grup failover.
ManagedInstancePairInfo	Pasangan Instans Terkelola dalam grup failover.
PartnerRegionInfo	Informasi wilayah 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.
SecondaryInstanceType	Jenis instans geo-sekunder. Atur 'Siaga' jika instans hanya digunakan sebagai opsi DR.
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.

InstanceFailoverGroup

Objek

Grup failover instans.

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.managedInstancePairs	ManagedInstancePairInfo[]	Daftar pasangan instans terkelola dalam grup failover.
properties.partnerRegions	PartnerRegionInfo[]	Informasi wilayah mitra untuk grup failover.
properties.readOnlyEndpoint	InstanceFailoverGroupReadOnlyEndpoint	Titik akhir baca-saja dari instans grup failover.
properties.readWriteEndpoint	InstanceFailoverGroupReadWriteEndpoint	Titik akhir baca-tulis dari instans grup failover.
properties.replicationRole	InstanceFailoverGroupReplicationRole	Peran replikasi lokal instans grup failover.
properties.replicationState	string	Status replikasi instans grup failover.
properties.secondaryType	SecondaryInstanceType	Jenis instans geo-sekunder. Atur 'Siaga' jika instans hanya digunakan sebagai opsi DR.
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"

InstanceFailoverGroupReadOnlyEndpoint

Objek

Titik akhir baca-saja dari instans grup failover.

Nama	Jenis	Deskripsi
failoverPolicy	ReadOnlyEndpointFailoverPolicy	Kebijakan failover dari titik akhir baca-saja untuk grup failover.

InstanceFailoverGroupReadWriteEndpoint

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.

InstanceFailoverGroupReplicationRole

Enumerasi

Peran replikasi lokal instans grup failover.

Nilai	Deskripsi
Primary	Primary
Secondary	Secondary

ManagedInstancePairInfo

Objek

Pasangan Instans Terkelola dalam grup failover.

Nama	Jenis	Deskripsi
partnerManagedInstanceId	string	Id Partner Managed Instance berpasangan.
primaryManagedInstanceId	string	Id Primary Managed Instance secara berpasangan.

PartnerRegionInfo

Objek

Informasi wilayah mitra untuk grup failover.

Nama	Jenis	Deskripsi
location	string	Lokasi geografis instans terkelola mitra.
replicationRole	InstanceFailoverGroupReplicationRole	Peran replikasi instans terkelola 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

SecondaryInstanceType

Enumerasi

Jenis instans geo-sekunder. Atur 'Siaga' jika instans hanya digunakan sebagai opsi DR.

Nilai	Deskripsi
Geo	Geografi
Standby	Siaga

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.