Replication Links - List By Database

Service:: SQL Database

Version d'API:: 2023-08-01

Obtient la liste des liens de réplication sur la base de données.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
databaseName	path	True	string	Nom de la base de données.
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	Nom du serveur.
subscriptionId	path	True	string	ID d’abonnement qui identifie un abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser pour la requête.

Réponses

Nom	Type	Description
200 OK	ReplicationLinkListResult	Récupération réussie de la liste des liens de réplication.
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 : 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 la base de données a activé les chargements de digest de registre. Désactivez les chargements de digest du registre et réessayez l’opération. 400 ManagedInstanceStoppingOrStopped : opération en conflit envoyée pendant l’arrêt/l’état arrêté de l’instance 400 ManagedInstanceStarting - Opération en conflit envoyée pendant que l’instance est à l’état de démarrage 404 ResourceNotFound : la ressource demandée est introuvable. 404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés. 404 SubscriptionDoesNotHaveServer - Le serveur demandé est introuvable

Nom

Type

Description

200 OK

ReplicationLinkListResult

Récupération réussie de la liste des liens de réplication.

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 : 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 la base de données a activé les chargements de digest de registre. Désactivez les chargements de digest du registre et réessayez l’opération.
400 ManagedInstanceStoppingOrStopped : opération en conflit envoyée pendant l’arrêt/l’état arrêté de l’instance
400 ManagedInstanceStarting - Opération en conflit envoyée pendant que l’instance est à l’état de démarrage
404 ResourceNotFound : la ressource demandée est introuvable.
404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés.
404 SubscriptionDoesNotHaveServer - Le serveur demandé est introuvable

Exemples

List replication links on server on database.

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/sourcesvr/databases/tetha-db/replicationLinks?api-version=2023-08-01

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/stable/2023-08-01/examples/ReplicationLinkListByDatabase.json
// this example is just showing the usage of "ReplicationLinks_ListByDatabase" 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 SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default";
string serverName = "sourcesvr";
string databaseName = "tetha-db";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// get the collection of this SqlServerDatabaseReplicationLinkResource
SqlServerDatabaseReplicationLinkCollection collection = sqlDatabase.GetSqlServerDatabaseReplicationLinks();

// invoke the operation and iterate over the result
await foreach (SqlServerDatabaseReplicationLinkResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

{
  "value": [
    {
      "properties": {
        "partnerServer": "testsvr",
        "partnerDatabase": "tetha-db",
        "partnerDatabaseId": "/subscriptions/00000000-1111-2222-3333-555555555555/resourceGroups/Second-Default/providers/Microsoft.Sql/servers/testsvr/databases/tetha-db",
        "partnerLocation": "Japan East",
        "role": "Primary",
        "partnerRole": "Secondary",
        "replicationMode": "ASYNC",
        "startTime": "2018-06-21T08:11:46.907Z",
        "percentComplete": 100,
        "replicationState": "CATCH_UP",
        "isTerminationAllowed": true,
        "linkType": "GEO"
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/sourcesvr/databases/tetha-db/replicationLinks/fb92de60-eb87-4a58-b250-3362d0cfdf26",
      "name": "fb92de60-eb87-4a58-b250-3362d0cfdf26"
    },
    {
      "properties": {
        "partnerServer": "targetsvr",
        "partnerDatabase": "tetha-db",
        "partnerDatabaseId": "/subscriptions/00000000-1111-2222-3333-555555555555/resourceGroups/Second-Default/providers/Microsoft.Sql/servers/targetsvr/databases/tetha-db",
        "partnerLocation": "Japan East",
        "role": "Primary",
        "partnerRole": "Secondary",
        "replicationMode": "ASYNC",
        "startTime": "2018-06-21T08:11:34.423Z",
        "percentComplete": 100,
        "replicationState": "CATCH_UP",
        "isTerminationAllowed": true,
        "linkType": "GEO"
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/sourcesvr/databases/tetha-db/replicationLinks/6ad1eefc-18a2-4fcb-94f3-4b654ba788d7",
      "name": "6ad1eefc-18a2-4fcb-94f3-4b654ba788d7"
    }
  ]
}

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.
ReplicationLinkListResult	Liste des liens de réplication.
ReplicationLinkType	Type de lien (GEO, NAMED, STANDBY). L’opération de mise à jour ne prend pas en charge NAMED.
ReplicationRole	Rôle de réplication local.
ReplicationState	État de réplication (PENDING, SEEDING, CATCHUP, SUSPENDED).

ErrorAdditionalInfo

Object

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

Object

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

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

ReplicationLink

Object

Lien de réplication.

Nom	Type	Description
id	string	ID de ressource.
name	string	Nom de la ressource.
properties.isTerminationAllowed	boolean	Indique si l’utilisateur est actuellement autorisé à terminer le lien.
properties.linkType	ReplicationLinkType	Type de lien (GEO, NAMED, STANDBY). L’opération de mise à jour ne prend pas en charge NAMED.
properties.partnerDatabase	string	Base de données du partenaire de ressources.
properties.partnerDatabaseId	string	ID de base de données du partenaire de ressources.
properties.partnerLocation	string	Emplacement du partenaire de ressource.
properties.partnerRole	ReplicationRole	Rôle de réplication de partenaire.
properties.partnerServer	string	Serveur partenaire de ressources.
properties.percentComplete	integer (int32)	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 (date-time)	Heure à laquelle le lien a été créé.
type	string	Type de ressource.

ReplicationLinkListResult

Object

Liste des liens de réplication.

Nom	Type	Description
nextLink	string	Lien pour récupérer la page suivante des résultats.
value	ReplicationLink[]	Tableau de résultats.

ReplicationLinkType

Énumération

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

Valeur	Description
GEO
NAMED
STANDBY

ReplicationRole

Énumération

Rôle de réplication local.

Valeur	Description
Primary
Secondary
NonReadableSecondary
Source
Copy

ReplicationState

Énumération

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

Valeur	Description
PENDING
SEEDING
CATCH_UP
SUSPENDED

Partager via

Replication Links - List By Database

Paramètres URI

Réponses

Exemples

List replication links on server on database.

Exemple de requête

Exemple de réponse

Définitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ReplicationLink

ReplicationLinkListResult

ReplicationLinkType

ReplicationRole

ReplicationState