Replication Links - Update

Service:

SQL Database

Version d'API:

2023-05-01-preview

Mises à jour le type de lien de réplication.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}?api-version=2023-05-01-preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
databaseName	path	True	string	Nom de la base de données.
linkId	path	True	string
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
serverName	path	True	string	Le nom du serveur
subscriptionId	path	True	string	L’ID d’abonnement d’un abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser pour la requête.

Corps de la demande

Nom	Type	Description
properties.linkType	ReplicationLinkType	Type de lien (GEO, NOMMÉ, VEILLE). L’opération de mise à jour ne prend pas en charge NAMED.

Réponses

Nom	Type	Description
200 OK	ReplicationLink	Mise à jour réussie du lien de réplication.
202 Accepted		L’opération de mise à jour est en cours.
Other Status Codes	ErrorResponse	Réponses d’erreur : *** 400 ReplicationLinksReplicationLinkNameIsInvalid : le nom du lien de réplication doit être un guid valide. 400 GeoReplicationDatabaseNotSecondary : l’opération s’attend à ce que la base de données soit une cible de réplication. 400 ReplicationLinksReplicationLinkTypeIsInvalid : le LinkType n’est pas valide. Les valeurs valides sont STANDBY et GEO. 400 ReplicationLinksCreateIsNotSupported : la création d’un lien de réplication n’est pas prise en charge. 400 LedgerNoDropLink : la géoréplication ne peut pas être arrêtée, car les chargements de digestes de la base de données sont activés. Désactivez les téléchargements de digest du registre et réessayez l’opération. 400 CannotUseTrailingWhitespacesInDatabaseName : la validation du nom de la base de données a échoué. 400 GeoReplicationDatabaseNotSecondary : l’opération s’attend à ce que la base de données soit une cible de réplication. 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave : la configuration de la géoréplication n’est pas prise en charge pour les bases de données utilisant des valeurs différentes de la propriété preferredEnclaveType. La base de données principale {0} sur le {1} serveur utilise le {2} preferredEnclaveType, tandis que le preferredEnclaveType spécifié pour la base de données secondaire {3} sur le {4} serveur est {5}. 400 VBSEnclaveNotSupportedFor PlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveTypes : le basculement planifié entre une base de données primaire et une base de données secondaire avec des bases de données preferredEnclaveType différentes n’est pas pris en charge pour les enclaves de sécurité basées sur la virtualisation (VBS). 400 CannotUseReservedDatabaseName : impossible d’utiliser le nom de la base de données réservée dans cette opération. 400 InvalidServerName : nom de serveur non valide spécifié. 400 PlannedFailoverTimedOut : l’utilisateur a appelé basculement planifié et il a expiré lors de la tentative de contact avec le service de gestion des partenaires. 400 InvalidIdentifier : l’identificateur contient NULL ou un caractère Unicode non valide. 400 IncorrectReplicationLinkState : l’opération s’attend à ce que la base de données soit dans un état attendu sur le lien de réplication. 404 OperationIdNotFound : l’opération avec ID n’existe pas. 404 ResourceNotFound : la ressource demandée est introuvable. 404 OperationIdNotFound : l’opération avec ID n’existe pas. 404 DatabaseDoesNotExist : l’utilisateur a spécifié un nom de base de données qui n’existe pas sur ce serveur instance. 409 CannotCancelOperation : l’opération de gestion est dans un état qui ne peut pas être annulé. 409 OperationCancelled : l’opération a été annulée par l’utilisateur. 409 Opération interrompue : l’opération sur la ressource n’a pas pu être terminée, car elle a été interrompue par une autre opération sur la même ressource. 409 InvalidOperationForDatabaseNotInReplicationRelationship : une opération de réplication a été effectuée sur une base de données qui n’est pas dans une relation de réplication. 409 GeoReplicationCannotBecomePrimaryDuringUndo : l’utilisateur a tenté de basculer ou de forcer l’arrêt d’un lien géographique alors que le secondaire est dans un état où il n’est peut-être pas physiquement cohérent et ne peut donc pas entrer le rôle principal. 409 DuplicateGeoDrRelation : les bases de données sont déjà dans une relation de réplication. Il s’agit d’une demande en double. 409 UpdateSloInProgress : l’utilisateur a tenté de lancer une opération incompatible alors qu’une mise à jour SLO était en cours. 409 ManagementServiceDatabaseBusy - La base de données '{0}' est occupée par une autre opération. Essayez votre opération ultérieurement. 409 ConflictingSystemOperationInProgress : une opération de maintenance du système est en cours sur la base de données et d’autres opérations doivent attendre qu’elle soit terminée. 409 FailoverGroupAlreadySetup : l’opération ne peut pas être effectuée, car le lien de géoréplication fait partie d’un groupe de basculement. Vous devez supprimer la base de données du groupe afin d’arrêter ou de basculer individuellement. 429 SubscriptionTooManyCreateUpdateRequests : demandes au-delà du nombre maximal de requêtes pouvant être traitées par les ressources disponibles. 429 SubscriptionTooManyRequests : demandes au-delà du nombre maximal de requêtes pouvant être traitées par les ressources disponibles. 500 OperationTimedOut : l’opération a expiré et a été restaurée automatiquement. Réessayez l’opération. 503 TooManyRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles.

Exemples

Update Replication Link

Exemple de requête

HTTP

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/sourcesvr/databases/gamma-db/replicationLinks/00000000-1111-2222-3333-666666666666?api-version=2023-05-01-preview

{
  "properties": {
    "linkType": "STANDBY"
  }
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python replication_link_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-1111-2222-3333-444444444444",
    )

    response = client.replication_links.begin_update(
        resource_group_name="Default",
        server_name="sourcesvr",
        database_name="gamma-db",
        link_id="00000000-1111-2222-3333-666666666666",
        parameters={"properties": {"linkType": "STANDBY"}},
    ).result()
    print(response)


# x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/preview/2023-05-01-preview/examples/ReplicationLinkUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armsql_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/sql/armsql/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/a3913f4b26467aed413cdc907116e99894f08994/specification/sql/resource-manager/Microsoft.Sql/preview/2023-05-01-preview/examples/ReplicationLinkUpdate.json
func ExampleReplicationLinksClient_BeginUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsql.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewReplicationLinksClient().BeginUpdate(ctx, "Default", "sourcesvr", "gamma-db", "00000000-1111-2222-3333-666666666666", armsql.ReplicationLinkUpdate{
		Properties: &armsql.ReplicationLinkUpdateProperties{
			LinkType: to.Ptr(armsql.ReplicationLinkTypeSTANDBY),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ReplicationLink = armsql.ReplicationLink{
	// 	Name: to.Ptr("00000000-1111-2222-3333-666666666666"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/sourcesvr/databases/gamma-db/replicationLinks/4891ca10-ebd0-47d7-9182-c722651780fb"),
	// 	Properties: &armsql.ReplicationLinkProperties{
	// 		IsTerminationAllowed: to.Ptr(true),
	// 		LinkType: to.Ptr(armsql.ReplicationLinkTypeSTANDBY),
	// 		PartnerDatabase: to.Ptr("gamma-db"),
	// 		PartnerDatabaseID: to.Ptr("/subscriptions/00000000-1111-2222-3333-555555555555/resourceGroups/Second-Default/providers/Microsoft.Sql/servers/testsvr/databases/gamma-db"),
	// 		PartnerLocation: to.Ptr("Japan East"),
	// 		PartnerRole: to.Ptr(armsql.ReplicationRoleSecondary),
	// 		PartnerServer: to.Ptr("testsvr"),
	// 		PercentComplete: to.Ptr[int32](100),
	// 		ReplicationMode: to.Ptr("ASYNC"),
	// 		ReplicationState: to.Ptr(armsql.ReplicationStateCATCHUP),
	// 		Role: to.Ptr(armsql.ReplicationRolePrimary),
	// 		StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-21T08:12:43.783Z"); return t}()),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates the replication link type.
 *
 * @summary Updates the replication link type.
 * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/preview/2023-05-01-preview/examples/ReplicationLinkUpdate.json
 */
async function updateReplicationLink() {
  const subscriptionId =
    process.env["SQL_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const resourceGroupName = process.env["SQL_RESOURCE_GROUP"] || "Default";
  const serverName = "sourcesvr";
  const databaseName = "gamma-db";
  const linkId = "00000000-1111-2222-3333-666666666666";
  const parameters = { linkType: "STANDBY" };
  const credential = new DefaultAzureCredential();
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.replicationLinks.beginUpdateAndWait(
    resourceGroupName,
    serverName,
    databaseName,
    linkId,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/preview/2023-05-01-preview/examples/ReplicationLinkUpdate.json
// this example is just showing the usage of "ReplicationLinks_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerDatabaseReplicationLinkResource created on azure
// for more information of creating SqlServerDatabaseReplicationLinkResource, please refer to the document of SqlServerDatabaseReplicationLinkResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default";
string serverName = "sourcesvr";
string databaseName = "gamma-db";
string linkId = "00000000-1111-2222-3333-666666666666";
ResourceIdentifier sqlServerDatabaseReplicationLinkResourceId = SqlServerDatabaseReplicationLinkResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, linkId);
SqlServerDatabaseReplicationLinkResource sqlServerDatabaseReplicationLink = client.GetSqlServerDatabaseReplicationLinkResource(sqlServerDatabaseReplicationLinkResourceId);

// invoke the operation
SqlServerDatabaseReplicationLinkPatch patch = new SqlServerDatabaseReplicationLinkPatch()
{
    LinkType = ReplicationLinkType.Standby,
};
ArmOperation<SqlServerDatabaseReplicationLinkResource> lro = await sqlServerDatabaseReplicationLink.UpdateAsync(WaitUntil.Completed, patch);
SqlServerDatabaseReplicationLinkResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlServerDatabaseReplicationLinkData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:

200

{
  "properties": {
    "partnerServer": "testsvr",
    "partnerDatabase": "gamma-db",
    "partnerDatabaseId": "/subscriptions/00000000-1111-2222-3333-555555555555/resourceGroups/Second-Default/providers/Microsoft.Sql/servers/testsvr/databases/gamma-db",
    "partnerLocation": "Japan East",
    "role": "Primary",
    "partnerRole": "Secondary",
    "replicationMode": "ASYNC",
    "startTime": "2018-06-21T08:12:43.783Z",
    "percentComplete": 100,
    "replicationState": "CATCH_UP",
    "isTerminationAllowed": true,
    "linkType": "STANDBY"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/sourcesvr/databases/gamma-db/replicationLinks/4891ca10-ebd0-47d7-9182-c722651780fb",
  "name": "00000000-1111-2222-3333-666666666666"
}

Code d’état:

202

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

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
ReplicationLink	Lien de réplication.
ReplicationLinkType	Type de lien (GEO, NOMMÉ, VEILLE). L’opération de mise à jour ne prend pas en charge NAMED.
ReplicationLinkUpdate	Demande de mise à jour de lien de réplication.
ReplicationRole	Rôle de réplication local.
ReplicationState	État de réplication (PENDING, SEEDING, CATCHUP, SUSPENDED).

ErrorAdditionalInfo

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

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

ErrorDetail

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

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

ReplicationLink

Lien de réplication.

Nom	Type	Description
id	string	ID de la ressource
name	string	Nom de la ressource.
properties.isTerminationAllowed	boolean	Indique si l’utilisateur est actuellement autorisé à mettre fin au lien.
properties.linkType	ReplicationLinkType	Type de lien (GEO, NOMMÉ, VEILLE). L’opération de mise à jour ne prend pas en charge NAMED.
properties.partnerDatabase	string	Base de données partenaire de ressources.
properties.partnerDatabaseId	string	ID de base de données partenaire de ressources.
properties.partnerLocation	string	Emplacement du partenaire de ressources.
properties.partnerRole	ReplicationRole	Rôle de réplication partenaire.
properties.partnerServer	string	Serveur partenaire de ressources.
properties.percentComplete	integer	Pourcentage d’achèvement d’amorçage pour le lien.
properties.replicationMode	string	Mode de réplication.
properties.replicationState	ReplicationState	État de réplication (PENDING, SEEDING, CATCHUP, SUSPENDED).
properties.role	ReplicationRole	Rôle de réplication local.
properties.startTime	string	Heure à laquelle le lien a été créé.
type	string	Type de ressource.

ReplicationLinkType

Type de lien (GEO, NOMMÉ, VEILLE). L’opération de mise à jour ne prend pas en charge NAMED.

Nom	Type	Description
GEO	string
NAMED	string
STANDBY	string

ReplicationLinkUpdate

Demande de mise à jour de lien de réplication.

Nom	Type	Description
id	string	ID de la ressource
name	string	Nom de la ressource.
properties.linkType	ReplicationLinkType	Type de lien (GEO, NOMMÉ, VEILLE). L’opération de mise à jour ne prend pas en charge NAMED.
type	string	Type de ressource.

ReplicationRole

Rôle de réplication local.

Nom	Type	Description
Copy	string
NonReadableSecondary	string
Primary	string
Secondary	string
Source	string

ReplicationState

État de réplication (PENDING, SEEDING, CATCHUP, SUSPENDED).

Nom	Type	Description
CATCH_UP	string
PENDING	string
SEEDING	string
SUSPENDED	string