Instance Failover Groups - Get

Služba:: SQL Database

Verze rozhraní API:: 2025-01-01

Získá skupinu převzetí služeb při selhání.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
failoverGroupName	path	True	string	Název skupiny převzetí služeb při selhání.
locationName	path	True	string	Název oblasti, ve které se prostředek nachází.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	InstanceFailoverGroup	Operace Azure byla úspěšně dokončena.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Ukázková odpověď

Stavový kó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"
  }
}

Definice

Name	Description
createdByType	Typ identity, která prostředek vytvořila.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
InstanceFailoverGroup	Skupina převzetí služeb při selhání instance.
InstanceFailoverGroupReadOnlyEndpoint	Koncový bod skupiny převzetí služeb při selhání jen pro čtení.
InstanceFailoverGroupReadWriteEndpoint	Koncový bod pro čtení i zápis instance skupiny převzetí služeb při selhání
InstanceFailoverGroupReplicationRole	Role místní replikace instance skupiny převzetí služeb při selhání
ManagedInstancePairInfo	Dvojice spravovaných instancí ve skupině převzetí služeb při selhání
PartnerRegionInfo	Informace o partnerské oblasti pro skupinu převzetí služeb při selhání
ReadOnlyEndpointFailoverPolicy	Zásady převzetí služeb při selhání koncového bodu jen pro čtení pro skupinu převzetí služeb při selhání
ReadWriteEndpointFailoverPolicy	Zásady převzetí služeb při selhání koncového bodu pro čtení a zápis pro skupinu převzetí služeb při selhání Pokud je hodnota failoverPolicy automatická, je vyžadováno převzetí služeb při selháníWithDataLossGracePeriodMinutes.
SecondaryInstanceType	Typ instance sekundární geografické oblasti. Pokud se instance používá pouze jako možnost zotavení po havárii, nastavte pohotovostní režim.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

InstanceFailoverGroup

Objekt

Skupina převzetí služeb při selhání instance.

Name	Typ	Description
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Např. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Název prostředku
properties.managedInstancePairs	ManagedInstancePairInfo[]	Seznam párů spravovaných instancí ve skupině převzetí služeb při selhání
properties.partnerRegions	PartnerRegionInfo[]	Informace o partnerské oblasti pro skupinu převzetí služeb při selhání
properties.readOnlyEndpoint	InstanceFailoverGroupReadOnlyEndpoint	Koncový bod skupiny převzetí služeb při selhání jen pro čtení.
properties.readWriteEndpoint	InstanceFailoverGroupReadWriteEndpoint	Koncový bod pro čtení i zápis instance skupiny převzetí služeb při selhání
properties.replicationRole	InstanceFailoverGroupReplicationRole	Role místní replikace instance skupiny převzetí služeb při selhání
properties.replicationState	string	Stav replikace instance skupiny převzetí služeb při selhání
properties.secondaryType	SecondaryInstanceType	Typ instance sekundární geografické oblasti. Pokud se instance používá pouze jako možnost zotavení po havárii, nastavte pohotovostní režim.
systemData	systemData	Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.
type	string	Typ prostředku. Například "Microsoft. Compute/virtualMachines" nebo "Microsoft. Úložiště/úložištěÚčty"

InstanceFailoverGroupReadOnlyEndpoint

Objekt

Koncový bod skupiny převzetí služeb při selhání jen pro čtení.

Name	Typ	Description
failoverPolicy	ReadOnlyEndpointFailoverPolicy	Zásady převzetí služeb při selhání koncového bodu jen pro čtení pro skupinu převzetí služeb při selhání

InstanceFailoverGroupReadWriteEndpoint

Objekt

Koncový bod pro čtení i zápis instance skupiny převzetí služeb při selhání

Name	Typ	Description
failoverPolicy	ReadWriteEndpointFailoverPolicy	Zásady převzetí služeb při selhání koncového bodu pro čtení a zápis pro skupinu převzetí služeb při selhání Pokud je hodnota failoverPolicy automatická, je vyžadováno převzetí služeb při selháníWithDataLossGracePeriodMinutes.
failoverWithDataLossGracePeriodMinutes	integer (int32)	Období odkladu před převzetím služeb při selhání se ztrátou dat se pokusí o koncový bod pro čtení i zápis. Pokud je hodnota failoverPolicy automatická, je vyžadováno převzetí služeb při selháníWithDataLossGracePeriodMinutes.

InstanceFailoverGroupReplicationRole

Výčet

Role místní replikace instance skupiny převzetí služeb při selhání

Hodnota	Description
Primary	Primary
Secondary	Secondary

ManagedInstancePairInfo

Objekt

Dvojice spravovaných instancí ve skupině převzetí služeb při selhání

Name	Typ	Description
partnerManagedInstanceId	string	Id Partner Managed Instance v páru.
primaryManagedInstanceId	string	Id Primary Managed Instance v páru.

PartnerRegionInfo

Objekt

Informace o partnerské oblasti pro skupinu převzetí služeb při selhání

Name	Typ	Description
location	string	Geografické umístění partnerských spravovaných instancí
replicationRole	InstanceFailoverGroupReplicationRole	Role replikace partnerských spravovaných instancí

ReadOnlyEndpointFailoverPolicy

Výčet

Zásady převzetí služeb při selhání koncového bodu jen pro čtení pro skupinu převzetí služeb při selhání

Hodnota	Description
Disabled	Disabled
Enabled	Enabled

ReadWriteEndpointFailoverPolicy

Výčet

Zásady převzetí služeb při selhání koncového bodu pro čtení a zápis pro skupinu převzetí služeb při selhání Pokud je hodnota failoverPolicy automatická, je vyžadováno převzetí služeb při selháníWithDataLossGracePeriodMinutes.

Hodnota	Description
Manual	Příručka
Automatic	Automatické

SecondaryInstanceType

Výčet

Typ instance sekundární geografické oblasti. Pokud se instance používá pouze jako možnost zotavení po havárii, nastavte pohotovostní režim.

Hodnota	Description
Geo	Geo
Standby	V pohotovosti

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.