Failover Groups - Update

Hizmet:

SQL Database

API Sürümü:

2025-01-01

Yük devretme grubunu güncelleştirir.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
failoverGroupName	path	True	string	Yük devretme grubunun adı.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. İsim büyük/küçük harfe duyarsızdır.
serverName	path	True	string	Sunucunun adı.
subscriptionId	path	True	string (uuid)	Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Tür	Description
properties.databases	string[] (arm-id)	Yük devretme grubundaki veritabanlarının listesi.
properties.partnerServers	PartnerInfo[]	Yük devretme grubu için iş ortağı sunucu bilgilerinin listesi.
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	Yük devretme grubu örneğinin salt okunur uç noktası.
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	Yük devretme grubu örneğinin okuma-yazma uç noktası.
properties.secondaryType	FailoverGroupDatabasesSecondaryType	İş ortağı sunucusunda veritabanları ikincil türü.
tags	object	Kaynak etiketleri.

Yanıtlar

Name	Tür	Description
200 OK	FailoverGroup	Azure işlemi başarıyla tamamlandı.
202 Accepted		Kaynak güncelleştirme isteği kabul edildi. Üst Bilgiler Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Beklenmeyen bir hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

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.

Örnek isteği

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

Örnek yanıt

Durum kodu:

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"
  }
}

Durum kodu:

202

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

Update failover group

Örnek isteği

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

Örnek yanıt

Durum kodu:

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"
  }
}

Durum kodu:

202

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

Tanımlar

Name	Description
createdByType	Kaynağı oluşturan kimliğin türü.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
FailoverGroup	Yük devretme grubu.
FailoverGroupDatabasesSecondaryType	İş ortağı sunucusunda veritabanları ikincil türü.
FailoverGroupReadOnlyEndpoint	Yük devretme grubu örneğinin salt okunur uç noktası.
FailoverGroupReadWriteEndpoint	Yük devretme grubu örneğinin okuma-yazma uç noktası.
FailoverGroupReplicationRole	Yük devretme grubu örneğinin yerel çoğaltma rolü.
FailoverGroupUpdate	Yük devretme grubu güncelleştirme isteği.
PartnerInfo	Yük devretme grubu için iş ortağı sunucusu bilgileri.
ReadOnlyEndpointFailoverPolicy	Yük devretme grubu için salt okunur uç noktanın yük devretme ilkesi.
ReadWriteEndpointFailoverPolicy	Yük devretme grubu için okuma-yazma uç noktasının yük devretme ilkesi. FailoverPolicy Otomatik ise failoverWithDataLossGracePeriodMinutes gereklidir.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

createdByType

Numaralandırma

Kaynağı oluşturan kimliğin türü.

Değer	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Nesne

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Nesne

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi

ErrorResponse

Nesne

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

FailoverGroup

Nesne

Yük devretme grubu.

Name	Tür	Description
id	string (arm-id)	Kaynağın tam kaynak kimliği. Örneğin "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Kaynak konumu.
name	string	Kaynağın adı
properties.databases	string[] (arm-id)	Yük devretme grubundaki veritabanlarının listesi.
properties.partnerServers	PartnerInfo[]	Yük devretme grubu için iş ortağı sunucu bilgilerinin listesi.
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	Yük devretme grubu örneğinin salt okunur uç noktası.
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	Yük devretme grubu örneğinin okuma-yazma uç noktası.
properties.replicationRole	FailoverGroupReplicationRole	Yük devretme grubu örneğinin yerel çoğaltma rolü.
properties.replicationState	string	Yük devretme grubu örneğinin çoğaltma durumu.
properties.secondaryType	FailoverGroupDatabasesSecondaryType	İş ortağı sunucusunda veritabanları ikincil türü.
systemData	systemData	Azure Resource Manager metadata içeren createdBy ve modifiedBy bilgileri.
tags	object	Kaynak etiketleri.
type	string	Kaynağın türü. Örneğin "Microsoft. Compute/virtualMachines" veya "Microsoft. Depo/Depolama Hesapları"

FailoverGroupDatabasesSecondaryType

Numaralandırma

İş ortağı sunucusunda veritabanları ikincil türü.

Değer	Description
Geo	Coğrafya
Standby	Bekleme

FailoverGroupReadOnlyEndpoint

Nesne

Yük devretme grubu örneğinin salt okunur uç noktası.

Name	Tür	Description
failoverPolicy	ReadOnlyEndpointFailoverPolicy	Yük devretme grubu için salt okunur uç noktanın yük devretme ilkesi.
targetServer	string (arm-id)	Salt okunur uç noktanın işaret ettiği hedef iş ortağı sunucusu.

FailoverGroupReadWriteEndpoint

Nesne

Yük devretme grubu örneğinin okuma-yazma uç noktası.

Name	Tür	Description
failoverPolicy	ReadWriteEndpointFailoverPolicy	Yük devretme grubu için okuma-yazma uç noktasının yük devretme ilkesi. FailoverPolicy Otomatik ise failoverWithDataLossGracePeriodMinutes gereklidir.
failoverWithDataLossGracePeriodMinutes	integer (int32)	Okuma-yazma uç noktası için veri kaybıyla yük devretmeden önce yetkisiz kullanım süresi denendi. FailoverPolicy Otomatik ise failoverWithDataLossGracePeriodMinutes gereklidir.

FailoverGroupReplicationRole

Numaralandırma

Yük devretme grubu örneğinin yerel çoğaltma rolü.

Değer	Description
Primary	Birincil
Secondary	Secondary

FailoverGroupUpdate

Nesne

Yük devretme grubu güncelleştirme isteği.

Name	Tür	Description
properties.databases	string[] (arm-id)	Yük devretme grubundaki veritabanlarının listesi.
properties.partnerServers	PartnerInfo[]	Yük devretme grubu için iş ortağı sunucu bilgilerinin listesi.
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	Yük devretme grubu örneğinin salt okunur uç noktası.
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	Yük devretme grubu örneğinin okuma-yazma uç noktası.
properties.secondaryType	FailoverGroupDatabasesSecondaryType	İş ortağı sunucusunda veritabanları ikincil türü.
tags	object	Kaynak etiketleri.

PartnerInfo

Nesne

Yük devretme grubu için iş ortağı sunucusu bilgileri.

Name	Tür	Description
id	string (arm-id)	İş ortağı sunucusunun kaynak tanımlayıcısı.
location	string	İş ortağı sunucusunun coğrafi konumu.
replicationRole	FailoverGroupReplicationRole	İş ortağı sunucusunun çoğaltma rolü.

ReadOnlyEndpointFailoverPolicy

Numaralandırma

Yük devretme grubu için salt okunur uç noktanın yük devretme ilkesi.

Değer	Description
Disabled	Disabled
Enabled	Enabled

ReadWriteEndpointFailoverPolicy

Numaralandırma

Yük devretme grubu için okuma-yazma uç noktasının yük devretme ilkesi. FailoverPolicy Otomatik ise failoverWithDataLossGracePeriodMinutes gereklidir.

Değer	Description
Manual	Kılavuz
Automatic	Automatic

systemData

Nesne

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string (date-time)	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string (date-time)	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimlik türü.