Top / Microsoft Azure / Azure Synapse / Private Link Hub

Azure Synapse Private Link Hub

This page shows how to write Terraform and Azure Resource Manager for Synapse Private Link Hub and write them securely.

terraform-logo

Review your .tf file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

azurerm_synapse_private_link_hub (Terraform)

The Private Link Hub in Synapse can be configured in Terraform with the resource name azurerm_synapse_private_link_hub. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Review your Terraform file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

The following arguments are supported:

  • name - (Required) 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 - (Required) 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 - (Required) Specifies the Azure location where the Synapse Private Link Hub exists. Changing this forces a new resource to be created.

  • tags - (Optional) A mapping of tags which should be assigned to the Synapse Private Link Hub.

In addition to the Arguments listed above - the following Attributes are exported:

  • id - The ID of the Synapse Private Link Hub.

>> from Terraform Registry

Explanation in Terraform Registry

Manages a Synapse Private Link Hub.

>> from Terraform Registry

Tips: Best Practices for The Other Azure Synapse Resources

In addition to the azurerm_synapse_workspace, Azure Synapse has the other resources that should be configured for security reasons. Please check some examples of those resources and precautions.

risk-label

azurerm_synapse_workspace

Ensure to enable the managed virtual network

It is better to enable the managed virtual network, which is disabled as the default.

Review your Azure Synapse settings

In addition to the above, there are other security points you should be aware of making sure that your .tf files are protected in Shisho Cloud.

Microsoft.Synapse/privateLinkHubs (Azure Resource Manager)

The privateLinkHubs in Microsoft.Synapse can be configured in Azure Resource Manager with the resource name Microsoft.Synapse/privateLinkHubs. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

ListPrivateLinkHubsInSubscription.json#L13
            "type": "Microsoft.Synapse/privateLinkHubs",
            "location": "East US",
            "properties": {
              "provisioningState": "Succeeded"
            },
            "tags": {
ListPrivateLinkHubsInResourceGroup.json#L14
            "type": "Microsoft.Synapse/privateLinkHubs",
            "location": "East US",
            "properties": {
              "provisioningState": "Succeeded"
            },
            "tags": {
ListPrivateLinkHubsInResourceGroup.json#L14
            "type": "Microsoft.Synapse/privateLinkHubs",
            "location": "East US",
            "properties": {
              "provisioningState": "Succeeded"
            },
            "tags": {
ListPrivateLinkHubsInSubscription.json#L13
            "type": "Microsoft.Synapse/privateLinkHubs",
            "location": "East US",
            "properties": {
              "provisioningState": "Succeeded"
            },
            "tags": {
ListPrivateLinkHubsInSubscription.json#L13
            "type": "Microsoft.Synapse/privateLinkHubs",
            "location": "East US",
            "properties": {
              "provisioningState": "Succeeded"
            },
            "tags": {
ListPrivateLinkHubsInResourceGroup.json#L14
            "type": "Microsoft.Synapse/privateLinkHubs",
            "location": "East US",
            "properties": {
              "provisioningState": "Succeeded"
            },
            "tags": {
ListPrivateLinkHubsInSubscription.json#L13
            "type": "Microsoft.Synapse/privateLinkHubs",
            "location": "East US",
            "properties": {
              "provisioningState": "Succeeded"
            },
            "tags": {
ListPrivateLinkHubsInResourceGroup.json#L14
            "type": "Microsoft.Synapse/privateLinkHubs",
            "location": "East US",
            "properties": {
              "provisioningState": "Succeeded"
            },
            "tags": {
ListPrivateLinkHubsInSubscription.json#L13
            "type": "Microsoft.Synapse/privateLinkHubs",
            "location": "East US",
            "properties": {
              "provisioningState": "Succeeded"
            },
            "tags": {
ListPrivateLinkHubsInResourceGroup.json#L14
            "type": "Microsoft.Synapse/privateLinkHubs",
            "location": "East US",
            "properties": {
              "provisioningState": "Succeeded"
            },
            "tags": {

Parameters

  • apiVersion required - string
  • location required - string

    The geo-location where the resource lives

  • name required - string

    Name of the privateLinkHub

  • properties required
      • provisioningState optional - string

        PrivateLinkHub provisioning state

  • tags optional - string

    Resource tags.

  • type required - string

>> from Azure Resource Manager Documentation

The Other Related Azure Synapse Resources

Frequently asked questions

Azure Synapse Private Link Hub is a resource for Synapse of Microsoft Azure. Settings can be wrote in Terraform.

security-icon

Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.

Table of Contents