Instance Failover Groups - List By Location

Servizio:: SQL Database

Versione API:: 2025-01-01

Elenca i gruppi di failover in una posizione.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
locationName	path	True	string	Nome dell'area in cui si trova la risorsa.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
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	InstanceFailoverGroupListResult	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/locations/Japan East/instanceFailoverGroups?api-version=2025-01-01

Risposta di esempio

Codice di stato:: 200

{
  "value": [
    {
      "name": "failover-group-test",
      "type": "Microsoft.Sql/locations/instanceFailoverGroups",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/JapanEast/instanceFailoverGroups/failover-group-test",
      "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"
      }
    },
    {
      "name": "failover-group-test-1",
      "type": "Microsoft.Sql/locations/instanceFailoverGroups",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/JapanEast/instanceFailoverGroups/failover-group-test-1",
      "properties": {
        "managedInstancePairs": [
          {
            "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance-1",
            "primaryManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance-1"
          }
        ],
        "partnerRegions": [
          {
            "location": "Japan West",
            "replicationRole": "Secondary"
          }
        ],
        "readOnlyEndpoint": {
          "failoverPolicy": "Disabled"
        },
        "readWriteEndpoint": {
          "failoverPolicy": "Automatic",
          "failoverWithDataLossGracePeriodMinutes": 480
        },
        "replicationRole": "Primary",
        "replicationState": "CATCH_UP",
        "secondaryType": "Geo"
      }
    }
  ]
}

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
InstanceFailoverGroup	Un gruppo di failover dell'istanza.
InstanceFailoverGroupListResult	La risposta di un'operazione di lista InstanceFailoverGroup.
InstanceFailoverGroupReadOnlyEndpoint	Endpoint di sola lettura dell'istanza del gruppo di failover.
InstanceFailoverGroupReadWriteEndpoint	Endpoint di lettura/scrittura dell'istanza del gruppo di failover.
InstanceFailoverGroupReplicationRole	Ruolo di replica locale dell'istanza del gruppo di failover.
ManagedInstancePairInfo	Coppie di istanze gestite nel gruppo di failover.
PartnerRegionInfo	Informazioni sull'area del 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.
SecondaryInstanceType	Tipo dell'istanza geografica secondaria. Impostare "Standby" se l'istanza viene usata solo come opzione di ripristino di emergenza.
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.

InstanceFailoverGroup

Oggetto

Un gruppo di failover dell'istanza.

Nome	Tipo	Descrizione
id	string (arm-id)	ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nome della risorsa
properties.managedInstancePairs	ManagedInstancePairInfo[]	Elenco di coppie di istanze gestite nel gruppo di failover.
properties.partnerRegions	PartnerRegionInfo[]	Informazioni sull'area del partner per il gruppo di failover.
properties.readOnlyEndpoint	InstanceFailoverGroupReadOnlyEndpoint	Endpoint di sola lettura dell'istanza del gruppo di failover.
properties.readWriteEndpoint	InstanceFailoverGroupReadWriteEndpoint	Endpoint di lettura/scrittura dell'istanza del gruppo di failover.
properties.replicationRole	InstanceFailoverGroupReplicationRole	Ruolo di replica locale dell'istanza del gruppo di failover.
properties.replicationState	string	Stato di replica dell'istanza del gruppo di failover.
properties.secondaryType	SecondaryInstanceType	Tipo dell'istanza geografica secondaria. Impostare "Standby" se l'istanza viene usata solo come opzione di ripristino di emergenza.
systemData	systemData	Azure Resource Manager metadati contenenti informazioni createBy e modifiedBy.
type	string	Tipo di risorsa. Ad esempio: "Microsoft. Compute/virtualMachines" oppure "Microsoft. Storage/storageAccounts"

InstanceFailoverGroupListResult

Oggetto

La risposta di un'operazione di lista InstanceFailoverGroup.

Nome	Tipo	Descrizione
nextLink	string (uri)	Il link alla pagina successiva degli elementi
value	InstanceFailoverGroup[]	Gli elementi InstanceFailoverGroup presenti in questa pagina

InstanceFailoverGroupReadOnlyEndpoint

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.

InstanceFailoverGroupReadWriteEndpoint

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.

InstanceFailoverGroupReplicationRole

Enumerazione

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

Valore	Descrizione
Primary	Primary
Secondary	Secondario

ManagedInstancePairInfo

Oggetto

Coppie di istanze gestite nel gruppo di failover.

Nome	Tipo	Descrizione
partnerManagedInstanceId	string	Id di Partner Istanza gestita in coppia.
primaryManagedInstanceId	string	Id di Primary Istanza gestita in coppia.

PartnerRegionInfo

Oggetto

Informazioni sull'area del partner per il gruppo di failover.

Nome	Tipo	Descrizione
location	string	Posizione geografica delle istanze gestite del partner.
replicationRole	InstanceFailoverGroupReplicationRole	Ruolo di replica delle istanze gestite del 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

SecondaryInstanceType

Enumerazione

Tipo dell'istanza geografica secondaria. Impostare "Standby" se l'istanza viene usata solo come opzione di ripristino di emergenza.

Valore	Descrizione
Geo	Geo
Standby	Attesa

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

Instance Failover Groups - List By Location

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

List failover group

Esempio di richiesta

Risposta di esempio

Definizioni

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InstanceFailoverGroup

InstanceFailoverGroupListResult

InstanceFailoverGroupReadOnlyEndpoint

InstanceFailoverGroupReadWriteEndpoint

InstanceFailoverGroupReplicationRole

ManagedInstancePairInfo

PartnerRegionInfo

ReadOnlyEndpointFailoverPolicy

ReadWriteEndpointFailoverPolicy

SecondaryInstanceType

systemData