Instance Failover Groups - Get

Szolgáltatás:: SQL Database

API-verzió:: 2025-01-01

Feladatátvételi csoportot kap.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups/{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.
locationName	path	True	string	Annak a régiónak a neve, ahol az erőforrás található.
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.
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	InstanceFailoverGroup	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

Get failover group

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/Japan East/instanceFailoverGroups/failover-group-test?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.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/InstanceFailoverGroupGet.json
// this example is just showing the usage of "InstanceFailoverGroups_Get" 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";
NullableResponse<InstanceFailoverGroupResource> response = await collection.GetIfExistsAsync(failoverGroupName);
InstanceFailoverGroupResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // 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

Mintaválasz

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

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
InstanceFailoverGroup	Példány feladatátvételi csoportja.
InstanceFailoverGroupReadOnlyEndpoint	A feladatátvételi csoportpéldány írásvédett végpontja.
InstanceFailoverGroupReadWriteEndpoint	A feladatátvételi csoportpéldány olvasási-írási végpontja.
InstanceFailoverGroupReplicationRole	A feladatátvételi csoportpéldány helyi replikációs szerepköre.
ManagedInstancePairInfo	Felügyelt példánypárok a feladatátvételi csoportban.
PartnerRegionInfo	Partnerrégió 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.
SecondaryInstanceType	A geo-másodlagos példány típusa. Állítsa be a "Készenléti" beállítást, ha a példány csak DR-beállításként van használva.
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.

InstanceFailoverGroup

Tárgy

Példány feladatátvételi csoportja.

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}"
name	string	Az erőforrás neve
properties.managedInstancePairs	ManagedInstancePairInfo[]	Felügyelt példánypárok listája a feladatátvételi csoportban.
properties.partnerRegions	PartnerRegionInfo[]	Partnerrégió adatai a feladatátvételi csoporthoz.
properties.readOnlyEndpoint	InstanceFailoverGroupReadOnlyEndpoint	A feladatátvételi csoportpéldány írásvédett végpontja.
properties.readWriteEndpoint	InstanceFailoverGroupReadWriteEndpoint	A feladatátvételi csoportpéldány olvasási-írási végpontja.
properties.replicationRole	InstanceFailoverGroupReplicationRole	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	SecondaryInstanceType	A geo-másodlagos példány típusa. Állítsa be a "Készenléti" beállítást, ha a példány csak DR-beállításként van használva.
systemData	systemData	Azure Resource Manager metaadat, amely createdBy és modifiedBy információkat tartalmaz.
type	string	Az erőforrás típusa. Például: "Microsoft. Compute/virtualMachines" vagy "Microsoft. Tárhely/tárolásFiókok"

InstanceFailoverGroupReadOnlyEndpoint

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.

InstanceFailoverGroupReadWriteEndpoint

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.

InstanceFailoverGroupReplicationRole

Felsorolás

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

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

ManagedInstancePairInfo

Tárgy

Felügyelt példánypárok a feladatátvételi csoportban.

Name	Típus	Description
partnerManagedInstanceId	string	Partner Managed Instance azonosítója párosként.
primaryManagedInstanceId	string	Primary Managed Instance azonosítója párosként.

PartnerRegionInfo

Tárgy

Partnerrégió adatai a feladatátvételi csoporthoz.

Name	Típus	Description
location	string	A partner által felügyelt példányok földrajzi helye.
replicationRole	InstanceFailoverGroupReplicationRole	A partner által felügyelt példányok 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

SecondaryInstanceType

Felsorolás

A geo-másodlagos példány típusa. Állítsa be a "Készenléti" beállítást, ha a példány csak DR-beállításként van használva.

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

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.