Failover Groups - List By Server

Enumera los grupos de conmutación por error de un servidor.

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

Parámetros de identificador URI

Name In Required Type Description
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.

serverName
path True
  • string

Nombre del servidor que contiene el grupo de conmutación por error.

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

Name Type Description
200 OK

Recuperó correctamente los grupos de conmutación por error.

Other Status Codes

Respuestas de error: ***

  • 400 FailoverGroupCreateOrUpdateRequestInvalidDatabases: los identificadores de bases de datos proporcionados no se construyen correctamente. Para ver el ejemplo de formato adecuado, consulte https://docs.microsoft.com/en-us/rest/api/sql/failovergroups/createorupdate

  • 400 FailoverGroupCreateOrUpdateRequestInvalidPartner: el campo de asociados especificado en el cuerpo de la solicitud del grupo de conmutación por error de creación o actualización está vacío o no es válido. Proporcione un valor válido de este campo. Para obtener ejemplos de solicitudes con formato correcto, consulte https://docs.microsoft.com/en-us/rest/api/sql/failovergroups/createorupdate

  • 400 FailoverGroupCreateOrUpdateRequestDuplicatePartner: uno o varios de los servidores asociados proporcionados ya forman parte del grupo de conmutación por error. Asegúrese de que el servidor principal y todos los servidores asociados especificados sean únicos.

  • 400 FailoverGroupCreateOrUpdateRequestInvalidDatabaseServer: una o varias de las bases de datos proporcionadas no existen en el servidor principal del grupo de conmutación por error. Asegúrese de que todas las bases de datos existen en el servidor principal.

  • 400 FailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount: solo se admite un servidor asociado para el grupo de conmutación por error. Modifique la solicitud en consecuencia. Para obtener ejemplos de solicitudes válidas, consulte https://docs.microsoft.com/en-us/rest/api/sql/failovergroups/createorupdate

  • 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint: el campo readWriteEndpoint es necesario para las solicitudes de creación o actualización.

  • 400 FailoverGroupCreateOrUpdateRequestInvalid: el cuerpo de la solicitud del grupo de conmutación por error de creación o actualización está vacío o no es válido.

  • 400 FailoverGroupUpdateOrDeleteRequestOnSecondary: no se permiten modificaciones en el grupo de conmutación por error en un servidor secundario. Ejecute la solicitud en el servidor principal.

  • 400 FailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues: el valor del período de gracia para el punto de conexión de lectura y escritura debe ser no negativo.

  • 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields: 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 FailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy: el campo failoverPolicy para el punto de conexión de lectura y escritura es necesario para crear o actualizar solicitudes.

  • 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy: el valor del período de gracia no se debe proporcionar cuando se selecciona manual de directiva de conmutación por error para el punto de conexión de lectura y escritura. Quítelo de la solicitud.

  • 400 FailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified: el cuerpo de la solicitud del grupo de conmutación por error de creación o actualización no debe modificar la propiedad de solo lectura '{0}'.

  • 400 FailoverGroupFailoverRequestOnPrimary: la solicitud de conmutación por error debe iniciarse en el servidor secundario del grupo de conmutación por error.

  • 400 FailoverGroupPartnerServerFromDifferentSubscription: el servidor principal y los servidores asociados 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 InvalidAddSecondaryPermission: el usuario no tiene permiso suficiente para agregar secundario en el servidor especificado.

  • 400 InvalidSku: el usuario especificó una SKU no válida.

  • 400 ServerNotFound: no se encontró el servidor solicitado.

  • 400 FeatureDisabledOnSelectedEdition: el usuario intentó usar una característica que está deshabilitada en la edición actual de la base de datos.

  • 400 TokenTooLong: el token proporcionado es demasiado largo.

  • 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 PartnerServerNotCompatible: el usuario está intentando copiar una base de datos de un servidor SAWA V1 en un servidor sterling o viceversa.

  • 400 IncorrectReplicationLinkState: la operación espera que la base de datos esté en un estado esperado en el vínculo de replicación.

  • 400 ResourcePoolNotFound: el grupo elástico especificado no existe en el servidor lógico especificado.

  • 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 AzureKeyVaultNoServerIdentity: la identidad del servidor no está configurada correctamente.

  • 400 AzureKeyVaultInvalidUri: 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 ha invocado la conmutación por error planeada, ha agotado el tiempo de espera y una base de datos específica parece ser culpada.

  • 400 PlannedFailoverTimedOut: el usuario ha invocado la conmutación por error planeada y ha agotado 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 AdalServicePrincipalNotFound: no se pudo completar la operación porque no se encontró un error de Azure Active Directory entidad de servicio de biblioteca.

  • 400 AzureKeyVaultMalformedVaultUri: el URI de Key Vault proporcionado no es válido.

  • 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 deben residir en regiones diferentes para proporcionar aislamiento.

  • 400 FailoverGroupDoesNotExist: el grupo de conmutación por error no existe en un servidor.

  • 400 FailoverGroupNotSecondary: no se puede iniciar la conmutación por error desde el servidor principal de un grupo de conmutación por error.

  • 400 InvalidServerName: nombre de servidor no válido especificado.

  • 400 DatabaseInFailoverGroupNotPrimary: el vínculo GeoDR para la base de datos ya existe, pero su rol no es "Principal" o no es un vínculo de copia continua.

  • 400 SecurityAdalPrincipalCertExpiredError: no se pudo completar la operación porque el certificado de entidad de seguridad de Azure Key Vault ha expirado.

  • 400 UnableToCreateFailoverGroupDueToTableAuditing: no se puede crear un grupo de conmutación por error para el servidor que tenga activada la auditoría de tablas.

  • 400 InvalidIdentifier: el identificador contiene NULL o un carácter unicode no válido.

  • 400 UnableToAddDbWithTableAuditingToFailoverGroup: la base de datos con auditoría de tablas habilitada no será accesible a través del punto de conexión del grupo de conmutación por error.

  • 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 TDE.

  • 400 LimitOfFailoverGroupsPerServerExceeded: la creación de un nuevo grupo de conmutación por error superará el número permitido de grupos de conmutación por error por servidor.

  • 400 AzureKeyVaultMismatchError: región de Key Vault inesperada que se encuentra en la respuesta http.

  • 400 AzureKeyVaultRsaKeyNotSupported: el almacén de claves proporcionado usa el tamaño o el tipo de clave RSA no admitidos. El tamaño de clave RSA admitido es 2048 o 3072 y el tipo de clave es RSA o RSA-HSM.

  • 400 GeoReplicationDatabaseNotSecondary: la operación espera que la base de datos sea un destino de replicación.

  • 400 GeoReplicaLimitReached: se alcanzó el límite de replicación por réplica.

  • 400 FailoverGroupWithVirtualNetworkRulesNotSupported: los grupos de conmutación por error configurados con una directiva de conmutación automática por error no se admiten actualmente en los servidores configurados con reglas de firewall de red virtual. Configure el grupo de conmutación por error con la directiva de conmutación por error manual.

  • 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 RemoteDatabaseCopyPermission: el usuario no tiene permiso suficiente para crear una copia de base de datos en el servidor especificado.

  • 400 SecurityAzureKeyVaultGeoChainError: no se admite la creación de una base de datos secundaria (un proceso conocido como encadenamiento) al habilitar Cifrado de datos transparente mediante Azure Key Vault (BYOK).

  • 404 ResourceNotFound: no se encontró el recurso solicitado.

  • 404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados.

  • 404 ServerNotInSubscription: el servidor especificado no existe en la suscripción especificada.

  • 404 SourceDatabaseNotFound: la base de datos de origen no existe.

  • 405 UnsupportedReplicationOperation: se inició una operación de replicación no admitida en la base de datos.

  • 409 ConflictingServerOperation: una operación está actualmente en curso para el servidor.

  • 409 SubscriptionDisabled: la suscripción está deshabilitada.

  • 409 ConflictingSystemOperationInProgress: una operación de mantenimiento del sistema está en curso en la base de datos y es necesario esperar a que se completen otras operaciones.

  • 409 GeoReplicationCannotBecomePrimaryDuringUndo: el usuario intentó conmutar por error o forzar la finalización de un vínculo geográfico mientras la base de datos secundaria está en un estado en el que puede no ser físicamente coherente y, por tanto, no puede entrar en el rol principal.

  • 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 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: la clave está siendo utilizada actualmente por el servidor.

  • 409 FailoverGroupAlreadyExists: el grupo de conmutación por error ya existe en un servidor determinado. Use otro nombre de grupo de conmutación por error.

  • 409 FailoverGroupBusy: el grupo de conmutación por error está ocupado con otra operación.

  • 409 DatabaseBelongsToOtherFailoverGroup: la base de datos pertenece a otro grupo de conmutación por error y no puede considerarse parte de esta.

  • 409 DatabaseBeingAddedToFailoverGroup: la base de datos se está agregando actualmente al grupo de conmutación por error, el cliente debe esperar a que esta operación termine de emitir la eliminación.

  • 409 DatabaseBeingRemovedFromFailoverGroup: la base de datos se está quitando del grupo de conmutación por error, el cliente debe esperar a que esta operación termine de emitirse.

  • 409 FailoverGroupDnsRecordInUse: existe un registro DNS duplicado para el punto de conexión solicitado.

  • 409 InvalidFailoverGroupName: se proporcionó un nombre de grupo de conmutación por error no válido.

  • 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: la operación no se permite 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.

  • 409 RemoteDatabaseExists: el nombre de la base de datos de destino ya existe en el servidor de destino.

  • 429 SuscripciónTooManyCreateUpdateRequests: solicitudes más allá del número máximo de solicitudes que pueden procesar los recursos disponibles.

  • 429 SubscriptionTooManyRequests: solicitudes más allá del número máximo de solicitudes que pueden procesar los recursos disponibles.

  • 503 TooManyRequests: solicitudes más allá del número máximo de solicitudes que se pueden procesar mediante recursos disponibles.

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

  • 503 DatabaseUnavailable: error en la operación porque la base de datos no está disponible.

  • 504 RequestTimeout: la solicitud de servicio superó el tiempo de espera permitido.

Ejemplos

List failover group

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups?api-version=2021-02-01-preview

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test",
      "name": "failover-group-test",
      "type": "Microsoft.Sql/servers/failoverGroups",
      "location": "Japan East",
      "properties": {
        "readWriteEndpoint": {
          "failoverPolicy": "Automatic",
          "failoverWithDataLossGracePeriodMinutes": 480
        },
        "readOnlyEndpoint": {
          "failoverPolicy": "Disabled"
        },
        "replicationRole": "Primary",
        "replicationState": "CATCH_UP",
        "partnerServers": [
          {
            "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server",
            "location": "Japan West",
            "replicationRole": "Secondary"
          }
        ],
        "databases": []
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-2",
      "name": "failover-group-test-2",
      "type": "Microsoft.Sql/servers/failoverGroups",
      "location": "Japan East",
      "properties": {
        "readWriteEndpoint": {
          "failoverPolicy": "Automatic",
          "failoverWithDataLossGracePeriodMinutes": 480
        },
        "readOnlyEndpoint": {
          "failoverPolicy": "Disabled"
        },
        "replicationRole": "Primary",
        "replicationState": "CATCH_UP",
        "partnerServers": [
          {
            "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server",
            "location": "Japan West",
            "replicationRole": "Secondary"
          }
        ],
        "databases": []
      }
    }
  ]
}

Definiciones

FailoverGroup

Un grupo de conmutación por error.

FailoverGroupListResult

Lista de grupos de conmutación por error.

FailoverGroupReadOnlyEndpoint

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

FailoverGroupReadWriteEndpoint

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

FailoverGroupReplicationRole

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

PartnerInfo

Información del servidor 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 Automatic, se requiere failoverWithDataLossGracePeriodMinutes.

FailoverGroup

Un grupo de conmutación por error.

Name Type Description
id
  • string

Identificador del recurso.

location
  • string

Ubicación del recurso

name
  • string

Nombre del recurso.

properties.databases
  • string[]

Lista de bases de datos del grupo de conmutación por error.

properties.partnerServers

Lista de información del servidor asociado para el grupo de conmutación por error.

properties.readOnlyEndpoint

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

properties.readWriteEndpoint

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

properties.replicationRole

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.

tags
  • object

Etiquetas del recurso.

type
  • string

Tipo de recurso.

FailoverGroupListResult

Lista de grupos de conmutación por error.

Name Type Description
nextLink
  • string

Vínculo para recuperar la página siguiente de resultados.

value

Matriz de resultados.

FailoverGroupReadOnlyEndpoint

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

Name Type Description
failoverPolicy

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

FailoverGroupReadWriteEndpoint

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

Name Type Description
failoverPolicy

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 Automatic, se requiere failoverWithDataLossGracePeriodMinutes.

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 Automatic, se requiere failoverWithDataLossGracePeriodMinutes.

FailoverGroupReplicationRole

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

Name Type Description
Primary
  • string
Secondary
  • string

PartnerInfo

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

Name Type Description
id
  • string

Identificador de recurso del servidor asociado.

location
  • string

Ubicación geográfica del servidor asociado.

replicationRole

Rol de replicación del servidor asociado.

ReadOnlyEndpointFailoverPolicy

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

Name Type 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 Automatic, se requiere failoverWithDataLossGracePeriodMinutes.

Name Type Description
Automatic
  • string
Manual
  • string