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/servers/{serverName}/failoverGroups/{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í.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
serverName	path	True	string	Název serveru.
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	FailoverGroup	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

Ukázkový požadavek

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


/**
 * Samples for FailoverGroups Get.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/FailoverGroupGet.json
     */
    /**
     * Sample code: Get failover group.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void getFailoverGroup(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getFailoverGroups().getWithResponse("Default", "failovergroupprimaryserver",
            "failovergrouptest3", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python failover_group_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.failover_groups.get(
        resource_group_name="Default",
        server_name="failovergroupprimaryserver",
        failover_group_name="failovergrouptest3",
    )
    print(response)


# x-ms-original-file: 2025-01-01/FailoverGroupGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to gets a failover group.
 *
 * @summary gets a failover group.
 * x-ms-original-file: 2025-01-01/FailoverGroupGet.json
 */
async function getFailoverGroup() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.failoverGroups.get(
    "Default",
    "failovergroupprimaryserver",
    "failovergrouptest3",
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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/FailoverGroupGet.json
// this example is just showing the usage of "FailoverGroups_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 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 = "failovergroupprimaryserver";
string failoverGroupName = "failovergrouptest3";
ResourceIdentifier failoverGroupResourceId = FailoverGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, failoverGroupName);
FailoverGroupResource failoverGroup = client.GetFailoverGroupResource(failoverGroupResourceId);

// invoke the operation
FailoverGroupResource result = await failoverGroup.GetAsync();

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

Ukázková odpověď

Stavový kód:: 200

{
  "name": "failovergrouptest3",
  "type": "Microsoft.Sql/servers/failoverGroups",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failovergroupprimaryserver/failoverGroups/failovergrouptest3",
  "location": "Japan West",
  "properties": {
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failovergroupprimaryserver/databases/testdb1",
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failovergroupprimaryserver/databases/testdb2"
    ],
    "partnerServers": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failovergroupsecondaryserver",
        "location": "Japan East",
        "replicationRole": "Secondary"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Enabled",
      "targetServer": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failovergroupsecondaryserver"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 120
    },
    "replicationRole": "Primary",
    "replicationState": "CATCH_UP"
  }
}

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ěď
FailoverGroup	Skupina převzetí služeb při selhání.
FailoverGroupDatabasesSecondaryType	Sekundární typ databáze na partnerském serveru.
FailoverGroupReadOnlyEndpoint	Koncový bod skupiny převzetí služeb při selhání jen pro čtení.
FailoverGroupReadWriteEndpoint	Koncový bod pro čtení i zápis instance skupiny převzetí služeb při selhání
FailoverGroupReplicationRole	Role místní replikace instance skupiny převzetí služeb při selhání
PartnerInfo	Informace o partnerském serveru 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.
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.

FailoverGroup

Objekt

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

Name	Typ	Description
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Např. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Umístění prostředku
name	string	Název prostředku
properties.databases	string[] (arm-id)	Seznam databází ve skupině převzetí služeb při selhání
properties.partnerServers	PartnerInfo[]	Seznam informací o partnerském serveru pro skupinu převzetí služeb při selhání
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	Koncový bod skupiny převzetí služeb při selhání jen pro čtení.
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	Koncový bod pro čtení i zápis instance skupiny převzetí služeb při selhání
properties.replicationRole	FailoverGroupReplicationRole	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	FailoverGroupDatabasesSecondaryType	Sekundární typ databáze na partnerském serveru.
systemData	systemData	Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.
tags	object	Značky prostředků
type	string	Typ prostředku. Například "Microsoft. Compute/virtualMachines" nebo "Microsoft. Úložiště/úložištěÚčty"

FailoverGroupDatabasesSecondaryType

Výčet

Sekundární typ databáze na partnerském serveru.

Hodnota	Description
Geo	Geo
Standby	V pohotovosti

FailoverGroupReadOnlyEndpoint

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í
targetServer	string (arm-id)	Cílový partnerový server, na který koncový bod jen pro čtení odkazuje.

FailoverGroupReadWriteEndpoint

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.

FailoverGroupReplicationRole

Výčet

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

Hodnota	Description
Primary	Primary
Secondary	Secondary

PartnerInfo

Objekt

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

Name	Typ	Description
id	string (arm-id)	Identifikátor prostředku partnerského serveru.
location	string	Geografické umístění partnerského serveru
replicationRole	FailoverGroupReplicationRole	Role replikace partnerského serveru

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é

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.