Failover Groups - Create Or Update

Service:: SQL Database

Version d'API:: 2025-01-01

Crée ou met à jour un groupe de basculement.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
failoverGroupName	path	True	string	Nom du groupe de basculement.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
serverName	path	True	string	Le nom du serveur
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
properties.partnerServers	True	PartnerInfo[]	Liste des informations sur le serveur partenaire pour le groupe de basculement.
properties.readWriteEndpoint	True	FailoverGroupReadWriteEndpoint	Point de terminaison en lecture-écriture de l’instance de groupe de basculement.
properties.databases		string[] (arm-id)	Liste des bases de données dans le groupe de basculement.
properties.readOnlyEndpoint		FailoverGroupReadOnlyEndpoint	Point de terminaison en lecture seule de l’instance de groupe de basculement.
properties.secondaryType		FailoverGroupDatabasesSecondaryType	Type secondaire de bases de données sur le serveur partenaire.
tags		object	Balises de ressource.

Réponses

Nom	Type	Description
200 OK	FailoverGroup	Opération de mise à jour de la ressource 'FailoverGroup' réussie
201 Created	FailoverGroup	Ressource 'FailoverGroup' créer l’opération réussie En-têtes Location: string Retry-After: integer
202 Accepted		Exploitation des ressources acceptée. En-têtes Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Create failover group

Create failover group with standby secondary database on partner server.

Create failover group

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
  }
}

Code d’état:: 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"
  }
}

Code d’état:: 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.

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
  }
}

Code d’état:: 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"
  }
}

Code d’état:: 202

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

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
FailoverGroup	Un groupe de basculement.
FailoverGroupDatabasesSecondaryType	Type secondaire de bases de données sur le serveur partenaire.
FailoverGroupReadOnlyEndpoint	Point de terminaison en lecture seule de l’instance de groupe de basculement.
FailoverGroupReadWriteEndpoint	Point de terminaison en lecture-écriture de l’instance de groupe de basculement.
FailoverGroupReplicationRole	Rôle de réplication local de l’instance de groupe de basculement.
PartnerInfo	Informations sur le serveur partenaire pour le groupe de basculement.
ReadOnlyEndpointFailoverPolicy	Stratégie de basculement du point de terminaison en lecture seule pour le groupe de basculement.
ReadWriteEndpointFailoverPolicy	Stratégie de basculement du point de terminaison en lecture-écriture pour le groupe de basculement. Si failoverPolicy est automatique, basculementWithDataLossGracePeriodMinutes est requis.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

FailoverGroup

Objet

Un groupe de basculement.

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
location	string	Emplacement des ressources.
name	string	Nom de la ressource
properties.databases	string[] (arm-id)	Liste des bases de données dans le groupe de basculement.
properties.partnerServers	PartnerInfo[]	Liste des informations sur le serveur partenaire pour le groupe de basculement.
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	Point de terminaison en lecture seule de l’instance de groupe de basculement.
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	Point de terminaison en lecture-écriture de l’instance de groupe de basculement.
properties.replicationRole	FailoverGroupReplicationRole	Rôle de réplication local de l’instance de groupe de basculement.
properties.replicationState	string	État de réplication de l’instance de groupe de basculement.
properties.secondaryType	FailoverGroupDatabasesSecondaryType	Type secondaire de bases de données sur le serveur partenaire.
systemData	systemData	Azure Resource Manager : métadonnées contenant des informations createdBy et modifiedBy.
tags	object	Balises de ressource.
type	string	Type de la ressource. Par exemple : « Microsoft. Calcul/virtualMachines » ou « Microsoft. StorageAccounts"

FailoverGroupDatabasesSecondaryType

Énumération

Type secondaire de bases de données sur le serveur partenaire.

Valeur	Description
Geo	Zone géographique
Standby	Standby (Réserve)

FailoverGroupReadOnlyEndpoint

Objet

Point de terminaison en lecture seule de l’instance de groupe de basculement.

Nom	Type	Description
failoverPolicy	ReadOnlyEndpointFailoverPolicy	Stratégie de basculement du point de terminaison en lecture seule pour le groupe de basculement.
targetServer	string (arm-id)	Serveur partenaire cible vers lequel le point de terminaison en lecture seule pointe.

FailoverGroupReadWriteEndpoint

Objet

Point de terminaison en lecture-écriture de l’instance de groupe de basculement.

Nom	Type	Description
failoverPolicy	ReadWriteEndpointFailoverPolicy	Stratégie de basculement du point de terminaison en lecture-écriture pour le groupe de basculement. Si failoverPolicy est automatique, basculementWithDataLossGracePeriodMinutes est requis.
failoverWithDataLossGracePeriodMinutes	integer (int32)	La période de grâce avant le basculement avec perte de données est tentée pour le point de terminaison en lecture-écriture. Si failoverPolicy est automatique, basculementWithDataLossGracePeriodMinutes est requis.

FailoverGroupReplicationRole

Énumération

Rôle de réplication local de l’instance de groupe de basculement.

Valeur	Description
Primary	Primaire
Secondary	Secondaire

PartnerInfo

Objet

Informations sur le serveur partenaire pour le groupe de basculement.

Nom	Type	Description
id	string (arm-id)	Identificateur de ressource du serveur partenaire.
location	string	Emplacement géographique du serveur partenaire.
replicationRole	FailoverGroupReplicationRole	Rôle de réplication du serveur partenaire.

ReadOnlyEndpointFailoverPolicy

Énumération

Stratégie de basculement du point de terminaison en lecture seule pour le groupe de basculement.

Valeur	Description
Disabled	Désactivé
Enabled	Activé

ReadWriteEndpointFailoverPolicy

Énumération

Stratégie de basculement du point de terminaison en lecture-écriture pour le groupe de basculement. Si failoverPolicy est automatique, basculementWithDataLossGracePeriodMinutes est requis.

Valeur	Description
Manual	Manuel
Automatic	Automatique

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

Partager via

Failover Groups - Create Or Update

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

Create failover group

Exemple de requête

Exemple de réponse

Create failover group with standby secondary database on partner server.

Exemple de requête

Exemple de réponse

Définitions

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FailoverGroup

FailoverGroupDatabasesSecondaryType

FailoverGroupReadOnlyEndpoint

FailoverGroupReadWriteEndpoint

FailoverGroupReplicationRole

PartnerInfo

ReadOnlyEndpointFailoverPolicy

ReadWriteEndpointFailoverPolicy

systemData