Failover Groups - List By Server

Szolgáltatás:: SQL Database

API-verzió:: 2025-01-01

A kiszolgáló feladatátvételi csoportjait sorolja fel.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
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ó.

Válaszok

Name	Típus	Description
200 OK	FailoverGroupListResult	Az Azure működése sikeresen befejeződött.
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

List failover group

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

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/FailoverGroupList.json
// this example is just showing the usage of "FailoverGroups_ListByServer" 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 SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default";
string serverName = "failover-group-primary-server";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this FailoverGroupResource
FailoverGroupCollection collection = sqlServer.GetFailoverGroups();

// invoke the operation and iterate over the result
await foreach (FailoverGroupResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

{
  "value": [
    {
      "name": "failover-group-test",
      "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",
      "location": "Japan East",
      "properties": {
        "databases": [],
        "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": 480
        },
        "replicationRole": "Primary",
        "replicationState": "CATCH_UP"
      }
    },
    {
      "name": "failover-group-test-2",
      "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-2",
      "location": "Japan East",
      "properties": {
        "databases": [],
        "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": 480
        },
        "replicationRole": "Primary",
        "replicationState": "CATCH_UP"
      }
    }
  ]
}

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.
FailoverGroupListResult	A FailoverGroup lista művelet válasza.
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.
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

FailoverGroupListResult

Tárgy

A FailoverGroup lista művelet válasza.

Name	Típus	Description
nextLink	string (uri)	A következő oldalra mutató link
value	FailoverGroup[]	A failovercsoportcsoport elemei ezen az oldalon

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

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.