Failover Groups - Update

Szolgáltatás:: SQL Database

API-verzió:: 2025-01-01

Feladatátvételi csoport frissítése.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
failoverGroupName	path	True	string	A feladatátvételi csoport neve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
serverName	path	True	string	A kiszolgáló neve.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.

Kérelem törzse

Name	Típus	Description
properties.databases	string[] (arm-id)	A feladatátvételi csoport adatbázisainak listája.
properties.partnerServers	PartnerInfo[]	A feladatátvételi csoport partnerkiszolgálói adatainak listája.
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	A feladatátvételi csoportpéldány írásvédett végpontja.
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	A feladatátvételi csoportpéldány olvasási-írási végpontja.
properties.secondaryType	FailoverGroupDatabasesSecondaryType	Másodlagos típusú adatbázisok a partnerkiszolgálón.
tags	object	Erőforráscímkék.

Válaszok

Name	Típus	Description
200 OK	FailoverGroup	Az Azure működése sikeresen befejeződött.
202 Accepted		Az erőforrás-frissítési kérelem elfogadva. Fejlécek Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Name

Típus

Description

200 OK

FailoverGroup

Az Azure működése sikeresen befejeződött.

202 Accepted

Az erőforrás-frissítési kérelem elfogadva.

Fejlécek

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

Váratlan hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

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.

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

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

Mintaválasz

Állapotkód:: 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"
  }
}

Állapotkód:: 202

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

Update failover group

Mintakérelem

HTTP
dotnet

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

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

Mintaválasz

Állapotkód:: 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"
  }
}

Állapotkód:: 202

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

Definíciók

Name	Description
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
FailoverGroup	Feladatátvételi csoport.
FailoverGroupDatabasesSecondaryType	Másodlagos típusú adatbázisok a partnerkiszolgálón.
FailoverGroupReadOnlyEndpoint	A feladatátvételi csoportpéldány írásvédett végpontja.
FailoverGroupReadWriteEndpoint	A feladatátvételi csoportpéldány olvasási-írási végpontja.
FailoverGroupReplicationRole	A feladatátvételi csoportpéldány helyi replikációs szerepköre.
FailoverGroupUpdate	Feladatátvételi csoport frissítési kérése.
PartnerInfo	Partnerkiszolgáló adatai a feladatátvételi csoporthoz.
ReadOnlyEndpointFailoverPolicy	A feladatátvételi csoport írásvédett végpontjának feladatátvételi szabályzata.
ReadWriteEndpointFailoverPolicy	A feladatátvételi csoport olvasási-írási végpontjának feladatátvételi szabályzata. Ha a feladatátvételi házirend automatikus, akkor a feladatátvételWithDataLossGracePeriodMinutes szükséges.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

createdByType

Felsorolás

Az erőforrást létrehozó identitás típusa.

Érték	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Tárgy

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Tárgy

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célpontja.

ErrorResponse

Tárgy

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

FailoverGroup

Tárgy

Feladatátvételi csoport.

Name	Típus	Description
id	string (arm-id)	Az erőforrás teljes erőforrás-azonosítója. Például: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Erőforrás helye.
name	string	Az erőforrás neve
properties.databases	string[] (arm-id)	A feladatátvételi csoport adatbázisainak listája.
properties.partnerServers	PartnerInfo[]	A feladatátvételi csoport partnerkiszolgálói adatainak listája.
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	A feladatátvételi csoportpéldány írásvédett végpontja.
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	A feladatátvételi csoportpéldány olvasási-írási végpontja.
properties.replicationRole	FailoverGroupReplicationRole	A feladatátvételi csoportpéldány helyi replikációs szerepköre.
properties.replicationState	string	A feladatátvételi csoportpéldány replikációs állapota.
properties.secondaryType	FailoverGroupDatabasesSecondaryType	Másodlagos típusú adatbázisok a partnerkiszolgálón.
systemData	systemData	Azure Resource Manager metaadat, amely createdBy és modifiedBy információkat tartalmaz.
tags	object	Erőforráscímkék.
type	string	Az erőforrás típusa. Például: "Microsoft. Compute/virtualMachines" vagy "Microsoft. Tárhely/tárolásFiókok"

FailoverGroupDatabasesSecondaryType

Felsorolás

Másodlagos típusú adatbázisok a partnerkiszolgálón.

Érték	Description
Geo	Földrajz
Standby	készenlét

FailoverGroupReadOnlyEndpoint

Tárgy

A feladatátvételi csoportpéldány írásvédett végpontja.

Name	Típus	Description
failoverPolicy	ReadOnlyEndpointFailoverPolicy	A feladatátvételi csoport írásvédett végpontjának feladatátvételi szabályzata.
targetServer	string (arm-id)	A célpartner-kiszolgáló, amelyre az írásvédett végpont mutat.

FailoverGroupReadWriteEndpoint

Tárgy

A feladatátvételi csoportpéldány olvasási-írási végpontja.

Name	Típus	Description
failoverPolicy	ReadWriteEndpointFailoverPolicy	A feladatátvételi csoport olvasási-írási végpontjának feladatátvételi szabályzata. Ha a feladatátvételi házirend automatikus, akkor a feladatátvételWithDataLossGracePeriodMinutes szükséges.
failoverWithDataLossGracePeriodMinutes	integer (int32)	Az olvasási-írási végpont esetében a feladatátvételt megelőző türelmi időszak adatvesztéssel történik. Ha a feladatátvételi házirend automatikus, akkor a feladatátvételWithDataLossGracePeriodMinutes szükséges.

FailoverGroupReplicationRole

Felsorolás

A feladatátvételi csoportpéldány helyi replikációs szerepköre.

Érték	Description
Primary	Elsődleges
Secondary	Másodlagos

FailoverGroupUpdate

Tárgy

Feladatátvételi csoport frissítési kérése.

Name	Típus	Description
properties.databases	string[] (arm-id)	A feladatátvételi csoport adatbázisainak listája.
properties.partnerServers	PartnerInfo[]	A feladatátvételi csoport partnerkiszolgálói adatainak listája.
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	A feladatátvételi csoportpéldány írásvédett végpontja.
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	A feladatátvételi csoportpéldány olvasási-írási végpontja.
properties.secondaryType	FailoverGroupDatabasesSecondaryType	Másodlagos típusú adatbázisok a partnerkiszolgálón.
tags	object	Erőforráscímkék.

PartnerInfo

Tárgy

Partnerkiszolgáló adatai a feladatátvételi csoporthoz.

Name	Típus	Description
id	string (arm-id)	A partnerkiszolgáló erőforrás-azonosítója.
location	string	A partnerkiszolgáló földrajzi helye.
replicationRole	FailoverGroupReplicationRole	A partnerkiszolgáló replikációs szerepköre.

ReadOnlyEndpointFailoverPolicy

Felsorolás

A feladatátvételi csoport írásvédett végpontjának feladatátvételi szabályzata.

Érték	Description
Disabled	Disabled
Enabled	Engedélyezett

ReadWriteEndpointFailoverPolicy

Felsorolás

A feladatátvételi csoport olvasási-írási végpontjának feladatátvételi szabályzata. Ha a feladatátvételi házirend automatikus, akkor a feladatátvételWithDataLossGracePeriodMinutes szükséges.

Érték	Description
Manual	Kézikönyv
Automatic	Automatikus

systemData

Tárgy

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.