Instance Failover Groups - List By Location

Servicio:: SQL Database

Versión de la API:: 2025-01-01

Enumera los grupos de conmutación por error de una ubicación.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
locationName	path	True	string	Nombre de la región donde se encuentra el recurso.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de API que se usará para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	InstanceFailoverGroupListResult	Operación de Azure completada con éxito.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

List failover group

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
      }
    }
  ]
}

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
InstanceFailoverGroup	Un grupo de conmutación por error de instancia.
InstanceFailoverGroupListResult	La respuesta de una operación de lista InstanceFailoverGroup.
InstanceFailoverGroupReadOnlyEndpoint	Punto de conexión de solo lectura de la instancia del grupo de conmutación por error.
InstanceFailoverGroupReadWriteEndpoint	Punto de conexión de lectura y escritura de la instancia del grupo de conmutación por error.
InstanceFailoverGroupReplicationRole	Rol de replicación local de la instancia del grupo de conmutación por error.
ManagedInstancePairInfo	Pares de instancias administradas en el grupo de conmutación por error.
PartnerRegionInfo	Información de la región del asociado para el grupo de conmutación por error.
ReadOnlyEndpointFailoverPolicy	Directiva de conmutación por error del punto de conexión de solo lectura para el grupo de conmutación por error.
ReadWriteEndpointFailoverPolicy	Directiva de conmutación por error del punto de conexión de lectura y escritura para el grupo de conmutación por error. Si failoverPolicy es Automático, se requiere conmutación por errorWithDataLossGracePeriodMinutes.
SecondaryInstanceType	Tipo de la instancia secundaria geográfica. Establezca "En espera" si la instancia solo se usa como opción de recuperación ante desastres.
systemData	Metadatos relativos a la creación y última modificación del recurso.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

InstanceFailoverGroup

Objeto

Un grupo de conmutación por error de instancia.

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nombre del recurso
properties.managedInstancePairs	ManagedInstancePairInfo[]	Lista de pares de instancias administradas en el grupo de conmutación por error.
properties.partnerRegions	PartnerRegionInfo[]	Información de la región del asociado para el grupo de conmutación por error.
properties.readOnlyEndpoint	InstanceFailoverGroupReadOnlyEndpoint	Punto de conexión de solo lectura de la instancia del grupo de conmutación por error.
properties.readWriteEndpoint	InstanceFailoverGroupReadWriteEndpoint	Punto de conexión de lectura y escritura de la instancia del grupo de conmutación por error.
properties.replicationRole	InstanceFailoverGroupReplicationRole	Rol de replicación local de la instancia del grupo de conmutación por error.
properties.replicationState	string	Estado de replicación de la instancia del grupo de conmutación por error.
properties.secondaryType	SecondaryInstanceType	Tipo de la instancia secundaria geográfica. Establezca "En espera" si la instancia solo se usa como opción de recuperación ante desastres.
systemData	systemData	Azure Resource Manager metadatos que contienen información createdBy y modifiedBy.
type	string	Tipo de recurso. Por ejemplo, "Microsoft. Compute/virtualMachines" o "Microsoft. CuentasAlmacenamiento/Almacenamiento"

InstanceFailoverGroupListResult

Objeto

La respuesta de una operación de lista InstanceFailoverGroup.

Nombre	Tipo	Description
nextLink	string (uri)	El enlace a la siguiente página de artículos
value	InstanceFailoverGroup[]	Los elementos de InstanceFailoverGroup en esta página

InstanceFailoverGroupReadOnlyEndpoint

Objeto

Punto de conexión de solo lectura de la instancia del grupo de conmutación por error.

Nombre	Tipo	Description
failoverPolicy	ReadOnlyEndpointFailoverPolicy	Directiva de conmutación por error del punto de conexión de solo lectura para el grupo de conmutación por error.

InstanceFailoverGroupReadWriteEndpoint

Objeto

Punto de conexión de lectura y escritura de la instancia del grupo de conmutación por error.

Nombre	Tipo	Description
failoverPolicy	ReadWriteEndpointFailoverPolicy	Directiva de conmutación por error del punto de conexión de lectura y escritura para el grupo de conmutación por error. Si failoverPolicy es Automático, se requiere conmutación por errorWithDataLossGracePeriodMinutes.
failoverWithDataLossGracePeriodMinutes	integer (int32)	Período de gracia antes de la conmutación por error con pérdida de datos se intenta para el punto de conexión de lectura y escritura. Si failoverPolicy es Automático, se requiere conmutación por errorWithDataLossGracePeriodMinutes.

InstanceFailoverGroupReplicationRole

Enumeración

Rol de replicación local de la instancia del grupo de conmutación por error.

Valor	Description
Primary	Primary
Secondary	Secundario

ManagedInstancePairInfo

Objeto

Pares de instancias administradas en el grupo de conmutación por error.

Nombre	Tipo	Description
partnerManagedInstanceId	string	Id de Partner Instancia administrada en pareja.
primaryManagedInstanceId	string	Id de Primary Instancia administrada en pareja.

PartnerRegionInfo

Objeto

Información de la región del asociado para el grupo de conmutación por error.

Nombre	Tipo	Description
location	string	Ubicación geográfica de las instancias administradas del asociado.
replicationRole	InstanceFailoverGroupReplicationRole	Rol de replicación de las instancias administradas del asociado.

ReadOnlyEndpointFailoverPolicy

Enumeración

Directiva de conmutación por error del punto de conexión de solo lectura para el grupo de conmutación por error.

Valor	Description
Disabled	Deshabilitado
Enabled	Habilitado

ReadWriteEndpointFailoverPolicy

Enumeración

Directiva de conmutación por error del punto de conexión de lectura y escritura para el grupo de conmutación por error. Si failoverPolicy es Automático, se requiere conmutación por errorWithDataLossGracePeriodMinutes.

Valor	Description
Manual	Manual
Automatic	Automático

SecondaryInstanceType

Enumeración

Tipo de la instancia secundaria geográfica. Establezca "En espera" si la instancia solo se usa como opción de recuperación ante desastres.

Valor	Description
Geo	Geo
Standby	En espera

systemData

Objeto

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	La marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Compartir a través de

Instance Failover Groups - List By Location

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

List failover group

Solicitud de ejemplo

Respuesta de muestra

Definiciones

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InstanceFailoverGroup

InstanceFailoverGroupListResult

InstanceFailoverGroupReadOnlyEndpoint

InstanceFailoverGroupReadWriteEndpoint

InstanceFailoverGroupReplicationRole

ManagedInstancePairInfo

PartnerRegionInfo

ReadOnlyEndpointFailoverPolicy

ReadWriteEndpointFailoverPolicy

SecondaryInstanceType

systemData