Sql Pool Replication Links - List

Service:

Synapse

API Version:

2021-06-01

Get SQL pool replication links
Lists a Sql pool's replication links.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/replicationLinks?api-version=2021-06-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
sqlPoolName	path	True	string	SQL pool name
subscriptionId	path	True	string	The ID of the target subscription.
workspaceName	path	True	string	The name of the workspace.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ReplicationLinkListResult	OK
Other Status Codes	ErrorResponse

Examples

Lists a Sql Analytic pool's replication links

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Synapse/workspaces/sqlcrudtest-6440/sqlPools/testdb/replicationLinks?api-version=2021-06-01

Java

/** Samples for SqlPoolReplicationLinks List. */
public final class Main {
    /*
     * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolReplicationLinks.json
     */
    /**
     * Sample code: Lists a Sql Analytic pool's replication links.
     *
     * @param manager Entry point to SynapseManager.
     */
    public static void listsASqlAnalyticPoolSReplicationLinks(
        com.azure.resourcemanager.synapse.SynapseManager manager) {
        manager
            .sqlPoolReplicationLinks()
            .list("sqlcrudtest-4799", "sqlcrudtest-6440", "testdb", com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.synapse import SynapseManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-synapse
# USAGE
    python list_sql_pool_replication_links.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 = SynapseManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-1111-2222-3333-444444444444",
    )

    response = client.sql_pool_replication_links.list(
        resource_group_name="sqlcrudtest-4799",
        workspace_name="sqlcrudtest-6440",
        sql_pool_name="testdb",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolReplicationLinks.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 armsynapse_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolReplicationLinks.json
func ExampleSQLPoolReplicationLinksClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSQLPoolReplicationLinksClient().NewListPager("sqlcrudtest-4799", "sqlcrudtest-6440", "testdb", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ReplicationLinkListResult = armsynapse.ReplicationLinkListResult{
		// 	Value: []*armsynapse.ReplicationLink{
		// 		{
		// 			Name: to.Ptr("5b301b68-03f6-4b26-b0f4-73ebb8634238"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/replicationLinks"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Synapse/workspaces/sqlcrudtest-6440/sqlPools/testdb/replicationLinks/5b301b68-03f6-4b26-b0f4-73ebb8634238"),
		// 			Location: to.Ptr("Japan East"),
		// 			Properties: &armsynapse.ReplicationLinkProperties{
		// 				IsTerminationAllowed: to.Ptr(true),
		// 				PartnerDatabase: to.Ptr("testdb"),
		// 				PartnerLocation: to.Ptr("Japan East"),
		// 				PartnerRole: to.Ptr(armsynapse.ReplicationRolePrimary),
		// 				PartnerServer: to.Ptr("sqlcrudtest-5961"),
		// 				PercentComplete: to.Ptr[int32](100),
		// 				ReplicationMode: to.Ptr("ASYNC"),
		// 				ReplicationState: to.Ptr(armsynapse.ReplicationStateCATCHUP),
		// 				Role: to.Ptr(armsynapse.ReplicationRoleSecondary),
		// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-02-10T01:44:27.117Z"); 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 { SynapseManagementClient } = require("@azure/arm-synapse");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists a Sql pool's replication links.
 *
 * @summary Lists a Sql pool's replication links.
 * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolReplicationLinks.json
 */
async function listsASqlAnalyticPoolReplicationLinks() {
  const subscriptionId =
    process.env["SYNAPSE_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const resourceGroupName = process.env["SYNAPSE_RESOURCE_GROUP"] || "sqlcrudtest-4799";
  const workspaceName = "sqlcrudtest-6440";
  const sqlPoolName = "testdb";
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.sqlPoolReplicationLinks.list(
    resourceGroupName,
    workspaceName,
    sqlPoolName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Synapse;

// Generated from example definition: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolReplicationLinks.json
// this example is just showing the usage of "SqlPoolReplicationLinks_List" 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 SynapseSqlPoolResource created on azure
// for more information of creating SynapseSqlPoolResource, please refer to the document of SynapseSqlPoolResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-4799";
string workspaceName = "sqlcrudtest-6440";
string sqlPoolName = "testdb";
ResourceIdentifier synapseSqlPoolResourceId = SynapseSqlPoolResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName, sqlPoolName);
SynapseSqlPoolResource synapseSqlPool = client.GetSynapseSqlPoolResource(synapseSqlPoolResourceId);

// get the collection of this SynapseReplicationLinkResource
SynapseReplicationLinkCollection collection = synapseSqlPool.GetSynapseReplicationLinks();

// invoke the operation and iterate over the result
await foreach (SynapseReplicationLinkResource 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
    SynapseReplicationLinkData 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

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Synapse/workspaces/sqlcrudtest-6440/sqlPools/testdb/replicationLinks/5b301b68-03f6-4b26-b0f4-73ebb8634238",
      "name": "5b301b68-03f6-4b26-b0f4-73ebb8634238",
      "type": "Microsoft.Synapse/workspaces/sqlPools/replicationLinks",
      "location": "Japan East",
      "properties": {
        "partnerServer": "sqlcrudtest-5961",
        "partnerDatabase": "testdb",
        "partnerLocation": "Japan East",
        "role": "Secondary",
        "partnerRole": "Primary",
        "replicationMode": "ASYNC",
        "startTime": "2017-02-10T01:44:27.117Z",
        "percentComplete": 100,
        "replicationState": "CATCH_UP",
        "isTerminationAllowed": true
      }
    }
  ]
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ReplicationLink	Represents a Sql pool replication link.
ReplicationLinkListResult	Represents the response to a List Sql pool replication link request.
ReplicationRole	The role of the Sql pool in the replication link.
ReplicationState	The replication state for the replication link.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ReplicationLink

Represents a Sql pool replication link.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Location of the workspace that contains this firewall rule.
name	string	The name of the resource
properties.isTerminationAllowed	boolean	Legacy value indicating whether termination is allowed. Currently always returns true.
properties.partnerDatabase	string	The name of the partner Sql pool.
properties.partnerLocation	string	The Azure Region of the partner Sql pool.
properties.partnerRole	ReplicationRole	The role of the partner Sql pool in the replication link.
properties.partnerServer	string	The name of the workspace hosting the partner Sql pool.
properties.percentComplete	integer	The percentage of seeding complete for the replication link.
properties.replicationMode	string	Replication mode of this replication link.
properties.replicationState	ReplicationState	The replication state for the replication link.
properties.role	ReplicationRole	The role of the Sql pool in the replication link.
properties.startTime	string	The start time for the replication link.
type	string	Type of resource this is.

ReplicationLinkListResult

Represents the response to a List Sql pool replication link request.

Name	Type	Description
nextLink	string	Link to retrieve next page of results.
value	ReplicationLink[]	The list of Sql pool replication links housed in the Sql pool.

ReplicationRole

The role of the Sql pool in the replication link.

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

ReplicationState

The replication state for the replication link.

Name	Type	Description
CATCH_UP	string
PENDING	string
SEEDING	string
SUSPENDED	string