Failover Groups - Create Or Update

Servicio:: SQL Database

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

Crea o actualiza un grupo de conmutación por error.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
failoverGroupName	path	True	string	Nombre del grupo de conmutación por error.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
serverName	path	True	string	El nombre del servidor.
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.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
properties.partnerServers	True	PartnerInfo[]	Lista de información del servidor asociado para el grupo de conmutación por error.
properties.readWriteEndpoint	True	FailoverGroupReadWriteEndpoint	Punto de conexión de lectura y escritura de la instancia del grupo de conmutación por error.
properties.databases		string[] (arm-id)	Lista de bases de datos del grupo de conmutación por error.
properties.readOnlyEndpoint		FailoverGroupReadOnlyEndpoint	Punto de conexión de solo lectura de la instancia del grupo de conmutación por error.
properties.secondaryType		FailoverGroupDatabasesSecondaryType	Tipo secundario de bases de datos en el servidor asociado.
tags		object	Etiquetas de recursos.

Respuestas

Nombre	Tipo	Description
200 OK	FailoverGroup	Operación de actualización del recurso 'FailoverGroup' exitosa
201 Created	FailoverGroup	Recurso 'FailoverGroup' crear operación exitosa Encabezados Location: string Retry-After: integer
202 Accepted		Operación de recursos aceptada. Encabezados Location: string Retry-After: integer
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

Create failover group

Create failover group with standby secondary database on partner server.

Create failover group

Solicitud de ejemplo

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-3?api-version=2025-01-01

{
  "properties": {
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1",
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2"
    ],
    "partnerServers": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 480
    }
  }
}

Respuesta de muestra

status code:: 200

{
  "name": "failover-group-test-3",
  "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-3",
  "location": "Japan East",
  "properties": {
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1",
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2"
    ],
    "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"
  }
}

status code:: 201

{
  "name": "failover-group-test-3",
  "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-3",
  "location": "Japan East",
  "properties": {
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1",
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2"
    ],
    "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"
  }
}

status code:: 202

Location: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/japaneast/failoverGroupOperationResults/11111111-1111-1111-1111-111111111111

Create failover group with standby secondary database on partner server.

Solicitud de ejemplo

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-3?api-version=2025-01-01

{
  "properties": {
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1",
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2"
    ],
    "partnerServers": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server"
      }
    ],
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled"
    },
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 480
    },
    "secondaryType": "Standby"
  }
}

Respuesta de muestra

status code:: 200

{
  "name": "failover-group-test-3",
  "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-3",
  "location": "Japan East",
  "properties": {
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1",
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2"
    ],
    "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"
  }
}

status code:: 201

{
  "name": "failover-group-test-3",
  "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-3",
  "location": "Japan East",
  "properties": {
    "databases": [
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-1",
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/databases/testdb-2"
    ],
    "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"
  }
}

status code:: 202

Location: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/japaneast/failoverGroupOperationResults/11111111-1111-1111-1111-111111111111

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
FailoverGroup	Un grupo de conmutación por error.
FailoverGroupDatabasesSecondaryType	Tipo secundario de bases de datos en el servidor asociado.
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 Automático, se requiere conmutación por errorWithDataLossGracePeriodMinutes.
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.

FailoverGroup

Objeto

Un grupo de conmutación por error.

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Ubicación del recurso.
name	string	Nombre del recurso
properties.databases	string[] (arm-id)	Lista de bases de datos del grupo de conmutación por error.
properties.partnerServers	PartnerInfo[]	Lista de información del servidor asociado para el grupo de conmutación por error.
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	Punto de conexión de solo lectura de la instancia del grupo de conmutación por error.
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	Punto de conexión de lectura y escritura de la instancia del grupo de conmutación por error.
properties.replicationRole	FailoverGroupReplicationRole	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	FailoverGroupDatabasesSecondaryType	Tipo secundario de bases de datos en el servidor asociado.
systemData	systemData	Azure Resource Manager metadatos que contienen información createdBy y modifiedBy.
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso. Por ejemplo, "Microsoft. Compute/virtualMachines" o "Microsoft. CuentasAlmacenamiento/Almacenamiento"

FailoverGroupDatabasesSecondaryType

Enumeración

Tipo secundario de bases de datos en el servidor asociado.

Valor	Description
Geo	Geo
Standby	En espera

FailoverGroupReadOnlyEndpoint

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.
targetServer	string (arm-id)	Servidor asociado de destino al que apunta el punto de conexión de solo lectura.

FailoverGroupReadWriteEndpoint

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.

FailoverGroupReplicationRole

Enumeración

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

Valor	Description
Primary	Primary
Secondary	Secundario

PartnerInfo

Objeto

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

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recursos del servidor asociado.
location	string	Ubicación geográfica del servidor asociado.
replicationRole	FailoverGroupReplicationRole	Rol de replicación del servidor 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

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

Failover Groups - Create Or Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Create failover group

Solicitud de ejemplo

Respuesta de muestra

Create failover group with standby secondary database on partner server.

Solicitud de ejemplo

Respuesta de muestra

Definiciones

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FailoverGroup

FailoverGroupDatabasesSecondaryType

FailoverGroupReadOnlyEndpoint

FailoverGroupReadWriteEndpoint

FailoverGroupReplicationRole

PartnerInfo

ReadOnlyEndpointFailoverPolicy

ReadWriteEndpointFailoverPolicy

systemData