Share via


Microsoft.Security privateLinks

Bicep resource definition

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

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

Resource format

To create a Microsoft.Security/privateLinks resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Security/privateLinks@2026-01-01' = {
  location: 'string'
  name: 'string'
  properties: {
    publicNetworkAccess: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$ (required)
properties Properties specific to the private link resource PrivateLinkProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates

PrivateLinkProperties

Name Description Value
publicNetworkAccess This determines if traffic is allowed over public network. By default it is disabled. 'Disabled'
'Enabled'

TrackedResourceTags

Name Description Value

Usage Examples

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File Description
Microsoft Security Private Link This template creates a Microsoft Security Private Link.

ARM template resource definition

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

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

Resource format

To create a Microsoft.Security/privateLinks resource, add the following JSON to your template.

{
  "type": "Microsoft.Security/privateLinks",
  "apiVersion": "2026-01-01",
  "name": "string",
  "location": "string",
  "properties": {
    "publicNetworkAccess": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Name Description Value
apiVersion The api version '2026-01-01'
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$ (required)
properties Properties specific to the private link resource PrivateLinkProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Security/privateLinks'

PrivateLinkProperties

Name Description Value
publicNetworkAccess This determines if traffic is allowed over public network. By default it is disabled. 'Disabled'
'Enabled'

TrackedResourceTags

Name Description Value

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Microsoft Security Private Link

Deploy to Azure
This template creates a Microsoft Security Private Link.

Terraform (AzAPI provider) resource definition

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

  • Resource groups

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

Resource format

To create a Microsoft.Security/privateLinks resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Security/privateLinks@2026-01-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      publicNetworkAccess = "string"
    }
  }
}

Property Values

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$ (required)
properties Properties specific to the private link resource PrivateLinkProperties (required)
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Security/privateLinks@2026-01-01"

PrivateLinkProperties

Name Description Value
publicNetworkAccess This determines if traffic is allowed over public network. By default it is disabled. 'Disabled'
'Enabled'

TrackedResourceTags

Name Description Value