Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. synapse
  5. PrivateLinkHub

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.synapse.PrivateLinkHub

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages a Synapse Private Link Hub.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.synapse.PrivateLinkHub("example", {
    name: "example",
    resourceGroupName: "example-rg",
    location: "West Europe",
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.synapse.PrivateLinkHub("example",
    name="example",
    resource_group_name="example-rg",
    location="West Europe")
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/synapse"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := synapse.NewPrivateLinkHub(ctx, "example", &synapse.PrivateLinkHubArgs{
			Name:              pulumi.String("example"),
			ResourceGroupName: pulumi.String("example-rg"),
			Location:          pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Synapse.PrivateLinkHub("example", new()
    {
        Name = "example",
        ResourceGroupName = "example-rg",
        Location = "West Europe",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.synapse.PrivateLinkHub;
import com.pulumi.azure.synapse.PrivateLinkHubArgs;
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 example = new PrivateLinkHub("example", PrivateLinkHubArgs.builder()
            .name("example")
            .resourceGroupName("example-rg")
            .location("West Europe")
            .build());

    }
}
Copy
resources:
  example:
    type: azure:synapse:PrivateLinkHub
    properties:
      name: example
      resourceGroupName: example-rg
      location: West Europe
Copy

Create PrivateLinkHub Resource

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

Constructor syntax

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

@overload
def PrivateLinkHub(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   resource_group_name: Optional[str] = None,
                   location: Optional[str] = None,
                   name: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None)
func NewPrivateLinkHub(ctx *Context, name string, args PrivateLinkHubArgs, opts ...ResourceOption) (*PrivateLinkHub, error)
public PrivateLinkHub(string name, PrivateLinkHubArgs args, CustomResourceOptions? opts = null)
public PrivateLinkHub(String name, PrivateLinkHubArgs args)
public PrivateLinkHub(String name, PrivateLinkHubArgs args, CustomResourceOptions options)

type: azure:synapse:PrivateLinkHub
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. PrivateLinkHubArgs
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. PrivateLinkHubArgs
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. PrivateLinkHubArgs
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. PrivateLinkHubArgs
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. PrivateLinkHubArgs
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 privateLinkHubResource = new Azure.Synapse.PrivateLinkHub("privateLinkHubResource", new()
{
    ResourceGroupName = "string",
    Location = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := synapse.NewPrivateLinkHub(ctx, "privateLinkHubResource", &synapse.PrivateLinkHubArgs{
	ResourceGroupName: pulumi.String("string"),
	Location:          pulumi.String("string"),
	Name:              pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var privateLinkHubResource = new PrivateLinkHub("privateLinkHubResource", PrivateLinkHubArgs.builder()
    .resourceGroupName("string")
    .location("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
private_link_hub_resource = azure.synapse.PrivateLinkHub("privateLinkHubResource",
    resource_group_name="string",
    location="string",
    name="string",
    tags={
        "string": "string",
    })
Copy
const privateLinkHubResource = new azure.synapse.PrivateLinkHub("privateLinkHubResource", {
    resourceGroupName: "string",
    location: "string",
    name: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure:synapse:PrivateLinkHub
properties:
    location: string
    name: string
    resourceGroupName: string
    tags:
        string: string
Copy

PrivateLinkHub 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 PrivateLinkHub resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the Synapse Private Link Hub. Changing this forces a new resource to be created.
Location Changes to this property will trigger replacement. string
Specifies the Azure location where the Synapse Private Link Hub exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Synapse Private Link Hub. Changing this forces a new Synapse Private Link Hub to be created.
Tags Dictionary<string, string>
A mapping of tags which should be assigned to the Synapse Private Link Hub.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the Synapse Private Link Hub. Changing this forces a new resource to be created.
Location Changes to this property will trigger replacement. string
Specifies the Azure location where the Synapse Private Link Hub exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Synapse Private Link Hub. Changing this forces a new Synapse Private Link Hub to be created.
Tags map[string]string
A mapping of tags which should be assigned to the Synapse Private Link Hub.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group in which to create the Synapse Private Link Hub. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. String
Specifies the Azure location where the Synapse Private Link Hub exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Synapse Private Link Hub. Changing this forces a new Synapse Private Link Hub to be created.
tags Map<String,String>
A mapping of tags which should be assigned to the Synapse Private Link Hub.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the Synapse Private Link Hub. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. string
Specifies the Azure location where the Synapse Private Link Hub exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
The name which should be used for this Synapse Private Link Hub. Changing this forces a new Synapse Private Link Hub to be created.
tags {[key: string]: string}
A mapping of tags which should be assigned to the Synapse Private Link Hub.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group in which to create the Synapse Private Link Hub. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. str
Specifies the Azure location where the Synapse Private Link Hub exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
The name which should be used for this Synapse Private Link Hub. Changing this forces a new Synapse Private Link Hub to be created.
tags Mapping[str, str]
A mapping of tags which should be assigned to the Synapse Private Link Hub.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group in which to create the Synapse Private Link Hub. Changing this forces a new resource to be created.
location Changes to this property will trigger replacement. String
Specifies the Azure location where the Synapse Private Link Hub exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Synapse Private Link Hub. Changing this forces a new Synapse Private Link Hub to be created.
tags Map<String>
A mapping of tags which should be assigned to the Synapse Private Link Hub.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing PrivateLinkHub Resource

Get an existing PrivateLinkHub resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: PrivateLinkHubState, opts?: CustomResourceOptions): PrivateLinkHub
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> PrivateLinkHub
func GetPrivateLinkHub(ctx *Context, name string, id IDInput, state *PrivateLinkHubState, opts ...ResourceOption) (*PrivateLinkHub, error)
public static PrivateLinkHub Get(string name, Input<string> id, PrivateLinkHubState? state, CustomResourceOptions? opts = null)
public static PrivateLinkHub get(String name, Output<String> id, PrivateLinkHubState state, CustomResourceOptions options)
resources:  _:    type: azure:synapse:PrivateLinkHub    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Location Changes to this property will trigger replacement. string
Specifies the Azure location where the Synapse Private Link Hub exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Synapse Private Link Hub. Changing this forces a new Synapse Private Link Hub to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the Synapse Private Link Hub. Changing this forces a new resource to be created.
Tags Dictionary<string, string>
A mapping of tags which should be assigned to the Synapse Private Link Hub.
Location Changes to this property will trigger replacement. string
Specifies the Azure location where the Synapse Private Link Hub exists. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Synapse Private Link Hub. Changing this forces a new Synapse Private Link Hub to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the Synapse Private Link Hub. Changing this forces a new resource to be created.
Tags map[string]string
A mapping of tags which should be assigned to the Synapse Private Link Hub.
location Changes to this property will trigger replacement. String
Specifies the Azure location where the Synapse Private Link Hub exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Synapse Private Link Hub. Changing this forces a new Synapse Private Link Hub to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group in which to create the Synapse Private Link Hub. Changing this forces a new resource to be created.
tags Map<String,String>
A mapping of tags which should be assigned to the Synapse Private Link Hub.
location Changes to this property will trigger replacement. string
Specifies the Azure location where the Synapse Private Link Hub exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
The name which should be used for this Synapse Private Link Hub. Changing this forces a new Synapse Private Link Hub to be created.
resourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the Synapse Private Link Hub. Changing this forces a new resource to be created.
tags {[key: string]: string}
A mapping of tags which should be assigned to the Synapse Private Link Hub.
location Changes to this property will trigger replacement. str
Specifies the Azure location where the Synapse Private Link Hub exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
The name which should be used for this Synapse Private Link Hub. Changing this forces a new Synapse Private Link Hub to be created.
resource_group_name Changes to this property will trigger replacement. str
The name of the resource group in which to create the Synapse Private Link Hub. Changing this forces a new resource to be created.
tags Mapping[str, str]
A mapping of tags which should be assigned to the Synapse Private Link Hub.
location Changes to this property will trigger replacement. String
Specifies the Azure location where the Synapse Private Link Hub exists. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Synapse Private Link Hub. Changing this forces a new Synapse Private Link Hub to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group in which to create the Synapse Private Link Hub. Changing this forces a new resource to be created.
tags Map<String>
A mapping of tags which should be assigned to the Synapse Private Link Hub.

Import

Synapse Private Link Hub can be imported using the resource id, e.g.

$ pulumi import azure:synapse/privateLinkHub:PrivateLinkHub example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub1
Copy

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

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure