Replication Links - List By Database

Servicio:: SQL Database

Versión de la API:: 2023-08-01

Obtiene una lista de vínculos de replicación en la base de datos.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
databaseName	path	True	string	Nombre de la base de datos.
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
serverName	path	True	string	Nombre del servidor.
subscriptionId	path	True	string	Identificador de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	Versión de la API que se va a usar para la solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	ReplicationLinkListResult	Se recuperó correctamente la lista de vínculos de replicación.
Other Status Codes	ErrorResponse	Respuestas de error: *** 400 ReplicationLinksReplicationLinkNameIsInvalid: el nombre del vínculo de replicación debe ser un guid válido. 400 GeoReplicationDatabaseNotSecondary: la operación espera que la base de datos sea un destino de replicación. 400 ReplicationLinksReplicationLinkTypeIsInvalid: LinkType no es válido. Los valores válidos son STANDBY y GEO. 400 ReplicationLinksCreateIsNotSupported: no se admite la creación de un vínculo de replicación. 400 LedgerNoDropLink: no se puede detener la replicación geográfica porque la base de datos tiene habilitadas cargas implícitas de libro de contabilidad. Deshabilite las cargas implícitas del libro de contabilidad y vuelva a intentar la operación. 400 ManagedInstanceStoppingOrStopped: operación en conflicto enviada mientras la instancia está en estado de detención o detención 400 ManagedInstanceStarting: operación en conflicto enviada mientras la instancia está en estado de inicio 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 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado.

Nombre

Tipo

Description

200 OK

ReplicationLinkListResult

Se recuperó correctamente la lista de vínculos de replicación.

Other Status Codes

ErrorResponse

Respuestas de error: ***

400 ReplicationLinksReplicationLinkNameIsInvalid: el nombre del vínculo de replicación debe ser un guid válido.
400 GeoReplicationDatabaseNotSecondary: la operación espera que la base de datos sea un destino de replicación.
400 ReplicationLinksReplicationLinkTypeIsInvalid: LinkType no es válido. Los valores válidos son STANDBY y GEO.
400 ReplicationLinksCreateIsNotSupported: no se admite la creación de un vínculo de replicación.
400 LedgerNoDropLink: no se puede detener la replicación geográfica porque la base de datos tiene habilitadas cargas implícitas de libro de contabilidad. Deshabilite las cargas implícitas del libro de contabilidad y vuelva a intentar la operación.
400 ManagedInstanceStoppingOrStopped: operación en conflicto enviada mientras la instancia está en estado de detención o detención
400 ManagedInstanceStarting: operación en conflicto enviada mientras la instancia está en estado de inicio
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 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado.

Ejemplos

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

Respuesta de muestra

status code:: 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"
    }
  ]
}

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ReplicationLink	Vínculo de replicación.
ReplicationLinkListResult	Lista de vínculos de replicación.
ReplicationLinkType	Tipo de vínculo (GEO, NAMED, STANDBY). La operación de actualización no admite NAMED.
ReplicationRole	Rol de replicación local.
ReplicationState	Estado de replicación (PENDIENTE, SEEDING, CATCHUP, SUSPENDED).

ErrorAdditionalInfo

Object

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

Object

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	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ReplicationLink

Object

Vínculo de replicación.

Nombre	Tipo	Description
id	string	Identificador de recurso.
name	string	Nombre del recurso.
properties.isTerminationAllowed	boolean	Si el usuario puede finalizar el vínculo actualmente.
properties.linkType	ReplicationLinkType	Tipo de vínculo (GEO, NAMED, STANDBY). La operación de actualización no admite NAMED.
properties.partnerDatabase	string	Base de datos del asociado de recursos.
properties.partnerDatabaseId	string	Identificador de base de datos del asociado de recursos.
properties.partnerLocation	string	Ubicación del asociado de recursos.
properties.partnerRole	ReplicationRole	Rol de replicación de asociados.
properties.partnerServer	string	Servidor asociado de recursos.
properties.percentComplete	integer (int32)	Porcentaje de finalización de propagación del vínculo.
properties.replicationMode	string	Modo de replicación.
properties.replicationState	ReplicationState	Estado de replicación (PENDIENTE, SEEDING, CATCHUP, SUSPENDED).
properties.role	ReplicationRole	Rol de replicación local.
properties.startTime	string (date-time)	Hora en la que se creó el vínculo.
type	string	Tipo de recurso.

ReplicationLinkListResult

Object

Lista de vínculos de replicación.

Nombre	Tipo	Description
nextLink	string	Vínculo para recuperar la siguiente página de resultados.
value	ReplicationLink[]	Matriz de resultados.

ReplicationLinkType

Enumeración

Tipo de vínculo (GEO, NAMED, STANDBY). La operación de actualización no admite NAMED.

Valor	Description
GEO
NAMED
STANDBY

ReplicationRole

Enumeración

Rol de replicación local.

Valor	Description
Primary
Secondary
NonReadableSecondary
Source
Copy

ReplicationState

Enumeración

Estado de replicación (PENDIENTE, SEEDING, CATCHUP, SUSPENDED).

Valor	Description
PENDING
SEEDING
CATCH_UP
SUSPENDED

Compartir a través de

Replication Links - List By Database

Parámetros de identificador URI

Respuestas

Ejemplos

List replication links on server on database.

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ReplicationLink

ReplicationLinkListResult

ReplicationLinkType

ReplicationRole

ReplicationState