Failover Groups - List By Server

Servizio:: SQL Database

Versione API:: 2025-01-01

Elenca i gruppi di failover in un server.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
serverName	path	True	string	Il nome del server.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	FailoverGroupListResult	Operazione Azure completata con successo.
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

List failover group

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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"
      }
    }
  ]
}

Definizioni

Nome	Descrizione
createdByType	Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
FailoverGroup	Un gruppo di failover.
FailoverGroupDatabasesSecondaryType	Tipo secondario di database nel server partner.
FailoverGroupListResult	La risposta di un'operazione di lista FailoverGroup.
FailoverGroupReadOnlyEndpoint	Endpoint di sola lettura dell'istanza del gruppo di failover.
FailoverGroupReadWriteEndpoint	Endpoint di lettura/scrittura dell'istanza del gruppo di failover.
FailoverGroupReplicationRole	Ruolo di replica locale dell'istanza del gruppo di failover.
PartnerInfo	Informazioni sul server partner per il gruppo di failover.
ReadOnlyEndpointFailoverPolicy	Criteri di failover dell'endpoint di sola lettura per il gruppo di failover.
ReadWriteEndpointFailoverPolicy	Criteri di failover dell'endpoint di lettura/scrittura per il gruppo di failover. Se failoverPolicy è Automatico, è necessario failoverWithDataLossGracePeriodMinutes.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

FailoverGroup

Oggetto

Un gruppo di failover.

Nome	Tipo	Descrizione
id	string (arm-id)	ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Percorso della risorsa.
name	string	Nome della risorsa
properties.databases	string[] (arm-id)	Elenco di database nel gruppo di failover.
properties.partnerServers	PartnerInfo[]	Elenco delle informazioni sul server partner per il gruppo di failover.
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	Endpoint di sola lettura dell'istanza del gruppo di failover.
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	Endpoint di lettura/scrittura dell'istanza del gruppo di failover.
properties.replicationRole	FailoverGroupReplicationRole	Ruolo di replica locale dell'istanza del gruppo di failover.
properties.replicationState	string	Stato di replica dell'istanza del gruppo di failover.
properties.secondaryType	FailoverGroupDatabasesSecondaryType	Tipo secondario di database nel server partner.
systemData	systemData	Azure Resource Manager metadati contenenti informazioni createBy e modifiedBy.
tags	object	Tag di risorsa.
type	string	Tipo di risorsa. Ad esempio: "Microsoft. Compute/virtualMachines" oppure "Microsoft. Storage/storageAccounts"

FailoverGroupDatabasesSecondaryType

Enumerazione

Tipo secondario di database nel server partner.

Valore	Descrizione
Geo	Geo
Standby	Attesa

FailoverGroupListResult

Oggetto

La risposta di un'operazione di lista FailoverGroup.

Nome	Tipo	Descrizione
nextLink	string (uri)	Il link alla pagina successiva degli elementi
value	FailoverGroup[]	Gli elementi del Gruppo di Failover in questa pagina

FailoverGroupReadOnlyEndpoint

Oggetto

Endpoint di sola lettura dell'istanza del gruppo di failover.

Nome	Tipo	Descrizione
failoverPolicy	ReadOnlyEndpointFailoverPolicy	Criteri di failover dell'endpoint di sola lettura per il gruppo di failover.
targetServer	string (arm-id)	Server partner di destinazione in cui punta l'endpoint di sola lettura.

FailoverGroupReadWriteEndpoint

Oggetto

Endpoint di lettura/scrittura dell'istanza del gruppo di failover.

Nome	Tipo	Descrizione
failoverPolicy	ReadWriteEndpointFailoverPolicy	Criteri di failover dell'endpoint di lettura/scrittura per il gruppo di failover. Se failoverPolicy è Automatico, è necessario failoverWithDataLossGracePeriodMinutes.
failoverWithDataLossGracePeriodMinutes	integer (int32)	Periodo di tolleranza prima del tentativo di failover con perdita di dati per l'endpoint di lettura/scrittura. Se failoverPolicy è Automatico, è necessario failoverWithDataLossGracePeriodMinutes.

FailoverGroupReplicationRole

Enumerazione

Ruolo di replica locale dell'istanza del gruppo di failover.

Valore	Descrizione
Primary	Primary
Secondary	Secondario

PartnerInfo

Oggetto

Informazioni sul server partner per il gruppo di failover.

Nome	Tipo	Descrizione
id	string (arm-id)	Identificatore della risorsa del server partner.
location	string	Posizione geografica del server partner.
replicationRole	FailoverGroupReplicationRole	Ruolo di replica del server partner.

ReadOnlyEndpointFailoverPolicy

Enumerazione

Criteri di failover dell'endpoint di sola lettura per il gruppo di failover.

Valore	Descrizione
Disabled	Disattivato
Enabled	Enabled

ReadWriteEndpointFailoverPolicy

Enumerazione

Criteri di failover dell'endpoint di lettura/scrittura per il gruppo di failover. Se failoverPolicy è Automatico, è necessario failoverWithDataLossGracePeriodMinutes.

Valore	Descrizione
Manual	Manuale
Automatic	Automatico

systemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Il timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

Condividi tramite

Failover Groups - List By Server

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

List failover group

Esempio di richiesta

Risposta di esempio

Definizioni

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FailoverGroup

FailoverGroupDatabasesSecondaryType

FailoverGroupListResult

FailoverGroupReadOnlyEndpoint

FailoverGroupReadWriteEndpoint

FailoverGroupReplicationRole

PartnerInfo

ReadOnlyEndpointFailoverPolicy

ReadWriteEndpointFailoverPolicy

systemData