Microsoft.Synapse privateLinkHubs 2021-03-01

Bicep resource definition

The privateLinkHubs resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Usage Examples

Bicep Samples

A basic example of deploying Synapse Private Link Hub.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource privateLinkHub 'Microsoft.Synapse/privateLinkHubs@2021-06-01' = {
  name: resourceName
  location: location
}

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
Azure Synapse Analytics Private Link Hub AVM Resource Module for Azure Synapse Analytics Private Link Hub

Resource format

To create a Microsoft.Synapse/privateLinkHubs resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Synapse/privateLinkHubs@2021-03-01' = {
  location: 'string'
  name: 'string'
  properties: {
    provisioningState: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.Synapse/privateLinkHubs

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string (required)
properties PrivateLinkHub resource properties PrivateLinkHubProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

PrivateLinkHubProperties

Name Description Value
provisioningState PrivateLinkHub provisioning state string

TrackedResourceTags

Name Description Value

ARM template resource definition

The privateLinkHubs resource type can be deployed with operations that target:

Usage Examples

Resource format

To create a Microsoft.Synapse/privateLinkHubs resource, add the following JSON to your template.

{
  "type": "Microsoft.Synapse/privateLinkHubs",
  "apiVersion": "2021-03-01",
  "name": "string",
  "location": "string",
  "properties": {
    "provisioningState": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Synapse/privateLinkHubs

Name Description Value
apiVersion The api version '2021-03-01'
location The geo-location where the resource lives string (required)
name The resource name string (required)
properties PrivateLinkHub resource properties PrivateLinkHubProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Synapse/privateLinkHubs'

PrivateLinkHubProperties

Name Description Value
provisioningState PrivateLinkHub provisioning state string

TrackedResourceTags

Name Description Value

Terraform (AzAPI provider) resource definition

The privateLinkHubs resource type can be deployed with operations that target:

  • Resource groups For a list of changed properties in each API version, see change log.

Usage Examples

Terraform Samples

A basic example of deploying Synapse Private Link Hub.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "privateLinkHub" {
  type                      = "Microsoft.Synapse/privateLinkHubs@2021-06-01"
  parent_id                 = azapi_resource.resourceGroup.id
  name                      = var.resource_name
  location                  = var.location
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Resource format

To create a Microsoft.Synapse/privateLinkHubs resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/privateLinkHubs@2021-03-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      provisioningState = "string"
    }
  }
}

Property Values

Microsoft.Synapse/privateLinkHubs

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string (required)
properties PrivateLinkHub resource properties PrivateLinkHubProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Synapse/privateLinkHubs@2021-03-01"

PrivateLinkHubProperties

Name Description Value
provisioningState PrivateLinkHub provisioning state string

TrackedResourceTags

Name Description Value
  • Last updated on