1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. ServerCommunicationLink
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.sql.ServerCommunicationLink

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Server communication link.

Uses Azure REST API version 2014-04-01. In version 2.x of the Azure Native provider, it used API version 2014-04-01.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var serverCommunicationLink = new AzureNative.Sql.ServerCommunicationLink("serverCommunicationLink", new()
    {
        CommunicationLinkName = "link1",
        PartnerServer = "sqldcrudtest-test",
        ResourceGroupName = "sqlcrudtest-7398",
        ServerName = "sqlcrudtest-4645",
    });

});
Copy
package main

import (
	sql "github.com/pulumi/pulumi-azure-native-sdk/sql/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sql.NewServerCommunicationLink(ctx, "serverCommunicationLink", &sql.ServerCommunicationLinkArgs{
			CommunicationLinkName: pulumi.String("link1"),
			PartnerServer:         pulumi.String("sqldcrudtest-test"),
			ResourceGroupName:     pulumi.String("sqlcrudtest-7398"),
			ServerName:            pulumi.String("sqlcrudtest-4645"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.sql.ServerCommunicationLink;
import com.pulumi.azurenative.sql.ServerCommunicationLinkArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var serverCommunicationLink = new ServerCommunicationLink("serverCommunicationLink", ServerCommunicationLinkArgs.builder()
            .communicationLinkName("link1")
            .partnerServer("sqldcrudtest-test")
            .resourceGroupName("sqlcrudtest-7398")
            .serverName("sqlcrudtest-4645")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const serverCommunicationLink = new azure_native.sql.ServerCommunicationLink("serverCommunicationLink", {
    communicationLinkName: "link1",
    partnerServer: "sqldcrudtest-test",
    resourceGroupName: "sqlcrudtest-7398",
    serverName: "sqlcrudtest-4645",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

server_communication_link = azure_native.sql.ServerCommunicationLink("serverCommunicationLink",
    communication_link_name="link1",
    partner_server="sqldcrudtest-test",
    resource_group_name="sqlcrudtest-7398",
    server_name="sqlcrudtest-4645")
Copy
resources:
  serverCommunicationLink:
    type: azure-native:sql:ServerCommunicationLink
    properties:
      communicationLinkName: link1
      partnerServer: sqldcrudtest-test
      resourceGroupName: sqlcrudtest-7398
      serverName: sqlcrudtest-4645
Copy

Create ServerCommunicationLink Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ServerCommunicationLink(name: string, args: ServerCommunicationLinkArgs, opts?: CustomResourceOptions);
@overload
def ServerCommunicationLink(resource_name: str,
                            args: ServerCommunicationLinkArgs,
                            opts: Optional[ResourceOptions] = None)

@overload
def ServerCommunicationLink(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            partner_server: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            server_name: Optional[str] = None,
                            communication_link_name: Optional[str] = None)
func NewServerCommunicationLink(ctx *Context, name string, args ServerCommunicationLinkArgs, opts ...ResourceOption) (*ServerCommunicationLink, error)
public ServerCommunicationLink(string name, ServerCommunicationLinkArgs args, CustomResourceOptions? opts = null)
public ServerCommunicationLink(String name, ServerCommunicationLinkArgs args)
public ServerCommunicationLink(String name, ServerCommunicationLinkArgs args, CustomResourceOptions options)
type: azure-native:sql:ServerCommunicationLink
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ServerCommunicationLinkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ServerCommunicationLinkArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ServerCommunicationLinkArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ServerCommunicationLinkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ServerCommunicationLinkArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var serverCommunicationLinkResource = new AzureNative.Sql.ServerCommunicationLink("serverCommunicationLinkResource", new()
{
    PartnerServer = "string",
    ResourceGroupName = "string",
    ServerName = "string",
    CommunicationLinkName = "string",
});
Copy
example, err := sql.NewServerCommunicationLink(ctx, "serverCommunicationLinkResource", &sql.ServerCommunicationLinkArgs{
	PartnerServer:         pulumi.String("string"),
	ResourceGroupName:     pulumi.String("string"),
	ServerName:            pulumi.String("string"),
	CommunicationLinkName: pulumi.String("string"),
})
Copy
var serverCommunicationLinkResource = new ServerCommunicationLink("serverCommunicationLinkResource", ServerCommunicationLinkArgs.builder()
    .partnerServer("string")
    .resourceGroupName("string")
    .serverName("string")
    .communicationLinkName("string")
    .build());
Copy
server_communication_link_resource = azure_native.sql.ServerCommunicationLink("serverCommunicationLinkResource",
    partner_server="string",
    resource_group_name="string",
    server_name="string",
    communication_link_name="string")
Copy
const serverCommunicationLinkResource = new azure_native.sql.ServerCommunicationLink("serverCommunicationLinkResource", {
    partnerServer: "string",
    resourceGroupName: "string",
    serverName: "string",
    communicationLinkName: "string",
});
Copy
type: azure-native:sql:ServerCommunicationLink
properties:
    communicationLinkName: string
    partnerServer: string
    resourceGroupName: string
    serverName: string
Copy

ServerCommunicationLink Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ServerCommunicationLink resource accepts the following input properties:

PartnerServer
This property is required.
Changes to this property will trigger replacement.
string
The name of the partner server.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
CommunicationLinkName Changes to this property will trigger replacement. string
The name of the server communication link.
PartnerServer
This property is required.
Changes to this property will trigger replacement.
string
The name of the partner server.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
CommunicationLinkName Changes to this property will trigger replacement. string
The name of the server communication link.
partnerServer
This property is required.
Changes to this property will trigger replacement.
String
The name of the partner server.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.
communicationLinkName Changes to this property will trigger replacement. String
The name of the server communication link.
partnerServer
This property is required.
Changes to this property will trigger replacement.
string
The name of the partner server.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
communicationLinkName Changes to this property will trigger replacement. string
The name of the server communication link.
partner_server
This property is required.
Changes to this property will trigger replacement.
str
The name of the partner server.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the server.
communication_link_name Changes to this property will trigger replacement. str
The name of the server communication link.
partnerServer
This property is required.
Changes to this property will trigger replacement.
String
The name of the partner server.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.
communicationLinkName Changes to this property will trigger replacement. String
The name of the server communication link.

Outputs

All input properties are implicitly available as output properties. Additionally, the ServerCommunicationLink resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Kind string
Communication link kind. This property is used for Azure Portal metadata.
Location string
Communication link location.
Name string
Resource name.
State string
The state.
Type string
Resource type.
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Kind string
Communication link kind. This property is used for Azure Portal metadata.
Location string
Communication link location.
Name string
Resource name.
State string
The state.
Type string
Resource type.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
kind String
Communication link kind. This property is used for Azure Portal metadata.
location String
Communication link location.
name String
Resource name.
state String
The state.
type String
Resource type.
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
kind string
Communication link kind. This property is used for Azure Portal metadata.
location string
Communication link location.
name string
Resource name.
state string
The state.
type string
Resource type.
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
kind str
Communication link kind. This property is used for Azure Portal metadata.
location str
Communication link location.
name str
Resource name.
state str
The state.
type str
Resource type.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
kind String
Communication link kind. This property is used for Azure Portal metadata.
location String
Communication link location.
name String
Resource name.
state String
The state.
type String
Resource type.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:sql:ServerCommunicationLink link1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/communicationLinks/{communicationLinkName} 
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi