Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. synapse
  5. PrivateLinkHub
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.synapse.PrivateLinkHub

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

A privateLinkHub Azure REST API version: 2021-06-01. Prior API version in Azure Native 1.x: 2021-03-01.

Other available API versions: 2021-06-01-preview.

Example Usage

Create or update a privateLinkHub

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

return await Deployment.RunAsync(() => 
{
    var privateLinkHub = new AzureNative.Synapse.PrivateLinkHub("privateLinkHub", new()
    {
        Location = "East US",
        PrivateLinkHubName = "privateLinkHub1",
        ResourceGroupName = "resourceGroup1",
        Tags = 
        {
            { "key", "value" },
        },
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := synapse.NewPrivateLinkHub(ctx, "privateLinkHub", &synapse.PrivateLinkHubArgs{
			Location:           pulumi.String("East US"),
			PrivateLinkHubName: pulumi.String("privateLinkHub1"),
			ResourceGroupName:  pulumi.String("resourceGroup1"),
			Tags: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
		})
		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.synapse.PrivateLinkHub;
import com.pulumi.azurenative.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 privateLinkHub = new PrivateLinkHub("privateLinkHub", PrivateLinkHubArgs.builder()
            .location("East US")
            .privateLinkHubName("privateLinkHub1")
            .resourceGroupName("resourceGroup1")
            .tags(Map.of("key", "value"))
            .build());

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

const privateLinkHub = new azure_native.synapse.PrivateLinkHub("privateLinkHub", {
    location: "East US",
    privateLinkHubName: "privateLinkHub1",
    resourceGroupName: "resourceGroup1",
    tags: {
        key: "value",
    },
});
Copy
import pulumi
import pulumi_azure_native as azure_native

private_link_hub = azure_native.synapse.PrivateLinkHub("privateLinkHub",
    location="East US",
    private_link_hub_name="privateLinkHub1",
    resource_group_name="resourceGroup1",
    tags={
        "key": "value",
    })
Copy
resources:
  privateLinkHub:
    type: azure-native:synapse:PrivateLinkHub
    properties:
      location: East US
      privateLinkHubName: privateLinkHub1
      resourceGroupName: resourceGroup1
      tags:
        key: value
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,
                   private_link_hub_name: Optional[str] = None,
                   provisioning_state: 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-native: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 AzureNative.Synapse.PrivateLinkHub("privateLinkHubResource", new()
{
    ResourceGroupName = "string",
    Location = "string",
    PrivateLinkHubName = "string",
    ProvisioningState = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := synapse.NewPrivateLinkHub(ctx, "privateLinkHubResource", &synapse.PrivateLinkHubArgs{
	ResourceGroupName:  "string",
	Location:           "string",
	PrivateLinkHubName: "string",
	ProvisioningState:  "string",
	Tags: map[string]interface{}{
		"string": "string",
	},
})
Copy
var privateLinkHubResource = new PrivateLinkHub("privateLinkHubResource", PrivateLinkHubArgs.builder()
    .resourceGroupName("string")
    .location("string")
    .privateLinkHubName("string")
    .provisioningState("string")
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());
Copy
private_link_hub_resource = azure_native.synapse.PrivateLinkHub("privateLinkHubResource",
    resource_group_name=string,
    location=string,
    private_link_hub_name=string,
    provisioning_state=string,
    tags={
        string: string,
    })
Copy
const privateLinkHubResource = new azure_native.synapse.PrivateLinkHub("privateLinkHubResource", {
    resourceGroupName: "string",
    location: "string",
    privateLinkHubName: "string",
    provisioningState: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure-native:synapse:PrivateLinkHub
properties:
    location: string
    privateLinkHubName: string
    provisioningState: 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. The name is case insensitive.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
PrivateLinkHubName Changes to this property will trigger replacement. string
Name of the privateLinkHub
ProvisioningState string
PrivateLinkHub provisioning state
Tags Dictionary<string, string>
Resource tags.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
PrivateLinkHubName Changes to this property will trigger replacement. string
Name of the privateLinkHub
ProvisioningState string
PrivateLinkHub provisioning state
Tags map[string]string
Resource tags.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
privateLinkHubName Changes to this property will trigger replacement. String
Name of the privateLinkHub
provisioningState String
PrivateLinkHub provisioning state
tags Map<String,String>
Resource tags.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
location Changes to this property will trigger replacement. string
The geo-location where the resource lives
privateLinkHubName Changes to this property will trigger replacement. string
Name of the privateLinkHub
provisioningState string
PrivateLinkHub provisioning state
tags {[key: string]: string}
Resource tags.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
location Changes to this property will trigger replacement. str
The geo-location where the resource lives
private_link_hub_name Changes to this property will trigger replacement. str
Name of the privateLinkHub
provisioning_state str
PrivateLinkHub provisioning state
tags Mapping[str, str]
Resource tags.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
privateLinkHubName Changes to this property will trigger replacement. String
Name of the privateLinkHub
provisioningState String
PrivateLinkHub provisioning state
tags Map<String>
Resource tags.

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.
Name string
The name of the resource
PrivateEndpointConnections List<Pulumi.AzureNative.Synapse.Outputs.PrivateEndpointConnectionForPrivateLinkHubBasicResponse>
List of private endpoint connections
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
PrivateEndpointConnections []PrivateEndpointConnectionForPrivateLinkHubBasicResponse
List of private endpoint connections
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
privateEndpointConnections List<PrivateEndpointConnectionForPrivateLinkHubBasicResponse>
List of private endpoint connections
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
privateEndpointConnections PrivateEndpointConnectionForPrivateLinkHubBasicResponse[]
List of private endpoint connections
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
private_endpoint_connections Sequence[PrivateEndpointConnectionForPrivateLinkHubBasicResponse]
List of private endpoint connections
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
privateEndpointConnections List<Property Map>
List of private endpoint connections
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

PrivateEndpointConnectionForPrivateLinkHubBasicResponse
, PrivateEndpointConnectionForPrivateLinkHubBasicResponseArgs

Id This property is required. string
identifier
ProvisioningState This property is required. string
Provisioning state of the private endpoint connection.
PrivateEndpoint Pulumi.AzureNative.Synapse.Inputs.PrivateEndpointResponse
The private endpoint which the connection belongs to.
PrivateLinkServiceConnectionState Pulumi.AzureNative.Synapse.Inputs.PrivateLinkServiceConnectionStateResponse
Connection state of the private endpoint connection.
Id This property is required. string
identifier
ProvisioningState This property is required. string
Provisioning state of the private endpoint connection.
PrivateEndpoint PrivateEndpointResponse
The private endpoint which the connection belongs to.
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
Connection state of the private endpoint connection.
id This property is required. String
identifier
provisioningState This property is required. String
Provisioning state of the private endpoint connection.
privateEndpoint PrivateEndpointResponse
The private endpoint which the connection belongs to.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
Connection state of the private endpoint connection.
id This property is required. string
identifier
provisioningState This property is required. string
Provisioning state of the private endpoint connection.
privateEndpoint PrivateEndpointResponse
The private endpoint which the connection belongs to.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
Connection state of the private endpoint connection.
id This property is required. str
identifier
provisioning_state This property is required. str
Provisioning state of the private endpoint connection.
private_endpoint PrivateEndpointResponse
The private endpoint which the connection belongs to.
private_link_service_connection_state PrivateLinkServiceConnectionStateResponse
Connection state of the private endpoint connection.
id This property is required. String
identifier
provisioningState This property is required. String
Provisioning state of the private endpoint connection.
privateEndpoint Property Map
The private endpoint which the connection belongs to.
privateLinkServiceConnectionState Property Map
Connection state of the private endpoint connection.

PrivateEndpointResponse
, PrivateEndpointResponseArgs

Id This property is required. string
Resource id of the private endpoint.
Id This property is required. string
Resource id of the private endpoint.
id This property is required. String
Resource id of the private endpoint.
id This property is required. string
Resource id of the private endpoint.
id This property is required. str
Resource id of the private endpoint.
id This property is required. String
Resource id of the private endpoint.

PrivateLinkServiceConnectionStateResponse
, PrivateLinkServiceConnectionStateResponseArgs

ActionsRequired This property is required. string
The actions required for private link service connection.
Description string
The private link service connection description.
Status string
The private link service connection status.
ActionsRequired This property is required. string
The actions required for private link service connection.
Description string
The private link service connection description.
Status string
The private link service connection status.
actionsRequired This property is required. String
The actions required for private link service connection.
description String
The private link service connection description.
status String
The private link service connection status.
actionsRequired This property is required. string
The actions required for private link service connection.
description string
The private link service connection description.
status string
The private link service connection status.
actions_required This property is required. str
The actions required for private link service connection.
description str
The private link service connection description.
status str
The private link service connection status.
actionsRequired This property is required. String
The actions required for private link service connection.
description String
The private link service connection description.
status String
The private link service connection status.

Import

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

$ pulumi import azure-native:synapse:PrivateLinkHub privateLinkHub1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/privateLinkHubs/{privateLinkHubName}
Copy

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

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native