Instance Failover Groups - List By Location

Servicio:

SQL Database

Versión de la API:

2021-11-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=2021-11-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	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.
subscriptionId	path	True	string	El id. de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	La versión de API que se usará para la solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	InstanceFailoverGroupListResult	Recuperó correctamente los grupos de conmutación por error.
Other Status Codes		Respuestas de error: *** 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary: el campo principal especificado en el cuerpo de la solicitud del grupo de conmutación por error de la instancia de creación o actualización está vacío o no es válido. 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner: el campo asociados especificados en el cuerpo de la solicitud del grupo de conmutación por error de la instancia de creación o actualización está vacío o no es válido. 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner: uno o varios de los servidores asociados proporcionados ya forman parte del grupo de conmutación por error de instancia. Asegúrese de que el servidor principal y todos los servidores asociados especificados son únicos. 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion: la región de instancia administrada del asociado proporcionada en el cuerpo de la solicitud del grupo de conmutación por error de instancia está vacía o no es válida. 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount: solo se admite una región de asociado. 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount: solo se admite un par de instancias administradas. 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint: el campo readWriteEndpoint es necesario para crear o actualizar solicitudes. 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid: el cuerpo de la solicitud del grupo de conmutación por error de la instancia de creación o actualización está vacío o no es válido. 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary: no se permiten modificaciones en el grupo de conmutación por error de instancia en un servidor secundario. Ejecute la solicitud en el servidor principal. 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues: el valor del período de gracia para el punto de conexión de lectura y escritura debe ser no negativo. 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues: el valor del período de gracia para el grupo de conmutación por error de instancia debe ser mayor o igual que el período de gracia mínimo de "{0}" minutos. 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields: la propiedad failoverWithDataLossGracePeriodMinutes debe proporcionarse cuando la directiva de conmutación por error Automática está seleccionada para el punto de conexión de lectura y escritura. 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy: el campo failoverPolicy para el punto de conexión de lectura y escritura es necesario para crear o actualizar solicitudes. 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy: el valor del período de gracia no debe proporcionarse cuando se selecciona manual de directiva de conmutación por error para el punto de conexión de lectura y escritura. 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified: el cuerpo de la solicitud del grupo de conmutación por error de la instancia de creación o actualización no debe modificar la propiedad de solo lectura '{0}'. 400 InstanceFailoverGroupFailoverRequestOnPrimary: la solicitud de conmutación por error se debe iniciar en el servidor secundario del grupo de conmutación por error de instancia. 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription: el servidor principal y el servidor asociado del grupo de conmutación por error proceden de suscripciones diferentes. No se permite la suscripción cruzada para servidores del grupo de conmutación por error. 400 FailoverGroupRegionMismatch: la región del asociado especificada en el grupo de conmutación por error debe coincidir con la región de la instancia administrada del asociado indicada. 400 ServerEditionMismatch: Edition debe ser el mismo que el servidor principal al crear un servidor de réplica. 400 DnsZoneMismatch: dnsZone en el servidor asociado es diferente de DNSZone en el servidor de origen. Esto interrumpe la funcionalidad InstanceFailoverGroup. 400 InvalidTargetSubregion: el servidor de destino de una base de datos secundaria no legible no está en una región de Azure emparejada con recuperación ante desastres. 400 GeoDrInstanceSizeMismatch: la instancia administrada principal y la instancia administrada del asociado no tienen el mismo tamaño de almacenamiento. 400 SecurityAdalPrincipalCertExpiredError: no se pudo completar la operación porque el certificado de entidad de seguridad de Azure Key Vault ha expirado. 400 GeoDrSecondaryInstanceNotEmpty: la instancia administrada secundaria tiene bases de datos de usuario. Para crear un grupo de conmutación por error de instancia, la instancia administrada secundaria debe estar vacía. 400 InstanceFailoverGroupIncorrectNetworkingConfiguration: la configuración de redes es incorrecta. El tráfico de replicación del servidor principal no puede acceder al servidor secundario. 400 IncorrectReplicationLinkState: la operación espera que la base de datos esté en un estado esperado en el vínculo de replicación. 400 SecurityInvalidAzureKeyVaultRecoveryLevel: el URI de Key Vault proporcionado no es válido. 400 KeyMaterialNotFoundOnRemoteServer: el servidor remoto no tiene acceso al material de clave utilizado como protector de TDE. 400 AzureKeyVaultRsaKeyNotSupported: el almacén de claves proporcionado usa el tamaño de clave RSA o el tipo de clave no admitidos. El tamaño de clave RSA admitido es 2048 o 3072 y el tipo de clave es RSA o RSA-HSM. 400 UnableToResolveRemoteServer: no se pudo resolver el nombre del servidor asociado remoto debido a un nombre de servidor no válido o problemas de conectividad DNS. 400 SameKeyUriNotFoundOnRemoteServer: el servidor secundario no tiene el material de clave del mismo almacén de claves que el protector de cifrado del servidor principal con la rotación automática de claves habilitada. 400 RemoteDatabaseCopyPermission: el usuario no tiene permiso suficiente para crear una copia de base de datos en el servidor especificado. 400 SameKeyMaterialNotFoundOnRemoteServer: el servidor secundario no tiene el material clave del protector de cifrado del servidor principal. 400 CannotUseReservedDatabaseName: no se puede usar el nombre reservado de la base de datos en esta operación. 400 InvalidFailoverGroupRegion: los servidores especificados en un grupo de conmutación por error de instancia deben residir en regiones diferentes para proporcionar aislamiento. 400 InstanceFailoverGroupDoesNotExist: el grupo de conmutación por error no existe en un servidor. 400 InstanceFailoverGroupNotSecondary: no se puede iniciar la conmutación por error desde el servidor principal en un grupo de conmutación por error de instancia. 400 InvalidServerName: nombre de servidor no válido especificado. 400 InvalidIdentifier: el identificador contiene NULL o un carácter unicode no válido. 400 TokenTooLong: el token proporcionado es demasiado largo. 400 AzureKeyVaultKeyDisabled: no se pudo completar la operación en el servidor porque la clave de Azure Key Vault está deshabilitada. 400 AzureKeyVaultInvalidExpirationDate: no se pudo completar la operación porque la fecha de expiración de la clave de Azure Key Vault no es válida. 400 SecurityAzureKeyVaultUrlNullOrEmpty: no se pudo completar la operación porque el URI de Azure Key Vault es nulo o está vacío. 400 InvalidSku: el usuario especificó una SKU no válida. 400 InvalidAddSecondaryPermission: el usuario no tiene permiso suficiente para agregar secundario en el servidor especificado. 400 ServerNotFound: no se encontró el servidor solicitado. 400 AzureKeyVaultNoServerIdentity: la identidad del servidor no está configurada correctamente. 400 AzureKeyVaultInvalidUri: una respuesta no válida de Azure Key Vault. Use un URI de Azure Key Vault válido. 400 AzureKeyVaultMissingPermissions: faltan permisos necesarios en azure Key Vault el servidor. 400 SecurityAzureKeyVaultInvalidKeyName: no se pudo completar la operación debido a un nombre de clave de servidor no válido. 400 PlannedFailoverTimedOutForDatabase: el usuario invocó conmutación por error planeada, se agota el tiempo de espera y parece que una base de datos específica es la culpa. 400 PlannedFailoverTimedOut: el usuario invocó conmutación por error planeada y agota el tiempo de espera al intentar ponerse en contacto con el servicio de administración de partners. 400 AdalGenericError: no se pudo completar la operación porque se encontró un error de Azure Active Directory. 400 GeoReplicationDatabaseNotSecondary: la operación espera que la base de datos sea un destino de replicación. 400 AdalServicePrincipalNotFound: no se pudo completar la operación porque no se encontró un error en la entidad de servicio de la biblioteca de Azure Active Directory. 400 AzureKeyVaultMalformedVaultUri: el URI de Key Vault proporcionado no es válido. 400 FeatureDisabledOnSelectedEdition: el usuario intentó usar una característica que está deshabilitada en la edición actual de la base de datos. 404 ResourceNotFound: no se encontró el recurso solicitado. 404 SourceDatabaseNotFound: la base de datos de origen no existe. 404 ServerNotInSubscription: el servidor especificado no existe en la suscripción especificada. 404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados. 405 UnsupportedReplicationOperation: se inició una operación de replicación no admitida en la base de datos. 409 ManagedInstanceHasHybridLink: el usuario intentó iniciar la operación que no se admite cuando la instancia administrada tiene configurado un vínculo híbrido. 409 RemoteDatabaseExists: el nombre de la base de datos de destino ya existe en el servidor de destino. 409 ConflictingServerOperation: una operación está actualmente en curso para el servidor. 409 SubscriptionDisabled: la suscripción está deshabilitada. 409 InstanceFailoverGroupAlreadyExists: el grupo de conmutación por error ya existe en un servidor determinado. 409 InstanceFailoverGroupBusy: el grupo de conmutación por error de instancia está ocupado con otra operación. 409 GeoReplicationCannotBecomePrimaryDuringUndo: el usuario intentó conmutar por error o forzar la finalización de un vínculo geográfico mientras el secundario está en un estado en el que puede no ser físicamente coherente y, por tanto, no puede entrar en el rol principal. 409 InstanceFailoverGroupDnsRecordInUse: existe un registro DNS duplicado para el punto de conexión solicitado. 409 ServerKeyNameAlreadyExists: la clave de servidor ya existe en el servidor. 409 ServerKeyUriAlreadyExists: el URI de la clave de servidor ya existe en el servidor. 409 ServerKeyDoesNotExists: la clave del servidor no existe. 409 InvalidFailoverGroupName: se proporcionó el nombre del grupo de conmutación por error de instancia no válido. 409 UpdateSloInProgress: el usuario intentó iniciar una operación incompatible mientras estaba en curso una actualización de SLO. 409 AzureKeyVaultKeyNameNotFound: no se pudo completar la operación porque el nombre de clave de Azure Key Vault no existe. 409 AzureKeyVaultKeyInUse: el servidor usa la clave. 409 ConflictingSystemOperationInProgress: una operación de mantenimiento del sistema está en curso en la base de datos y es necesario esperar hasta que se complete. 409 InvalidOperationForDatabaseNotInReplicationRelationship: se realizó una operación de propagación de replicación en una base de datos que ya está en una relación de replicación. 409 InvalidDatabaseStateForOperation: no se permite la operación en la base de datos en su estado de replicación actual. 409 DuplicateGeoDrRelation: las bases de datos ya están en una relación de replicación. Se trata de una solicitud duplicada. 429 SubscriptionTooManyCreateUpdateRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar. 429 SubscriptionTooManyRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar. 503 TooManyRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar. 503 AzureKeyVaultConnectionFailed: no se pudo completar la operación en el servidor porque se ha producido un error al intentar conectarse a Azure Key Vault 503 AzureKeyVaultGenericConnectionError: no se pudo completar la operación porque se encontró un error al intentar recuperar Key Vault información . 504 RequestTimeout: la solicitud de servicio superó el tiempo de espera permitido.

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=2021-11-01

Java

/**
 * Samples for InstanceFailoverGroups ListByLocation.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/InstanceFailoverGroupList.json
     */
    /**
     * Sample code: List failover group.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listFailoverGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getInstanceFailoverGroups().listByLocation("Default", "Japan East",
            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

Respuesta de muestra

status code:

200

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

Definiciones

Nombre	Description
InstanceFailoverGroup	Un grupo de conmutación por error de instancia.
InstanceFailoverGroupListResult	Lista de grupos de conmutación por error de instancia.
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.

InstanceFailoverGroup

Un grupo de conmutación por error de instancia.

Nombre	Tipo	Description
id	string	Identificador del recurso.
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.
type	string	Tipo de recurso.

InstanceFailoverGroupListResult

Lista de grupos de conmutación por error de instancia.

Nombre	Tipo	Description
nextLink	string	Vínculo para recuperar la página siguiente de resultados.
value	InstanceFailoverGroup[]	Matriz de resultados.

InstanceFailoverGroupReadOnlyEndpoint

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

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

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

Nombre	Tipo	Description
Primary	string
Secondary	string

ManagedInstancePairInfo

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

Nombre	Tipo	Description
partnerManagedInstanceId	string	Id. de partner Instancia administrada en par.
primaryManagedInstanceId	string	Id. del Instancia administrada principal en par.

PartnerRegionInfo

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

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

Nombre	Tipo	Description
Disabled	string
Enabled	string

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.

Nombre	Tipo	Description
Automatic	string
Manual	string