Share via


Microsoft.HybridCompute privateLinkScopes

Bicep resource definition

The privateLinkScopes 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.HybridCompute/privateLinkScopes resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.HybridCompute/privateLinkScopes@2025-09-16-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    publicNetworkAccess: 'string'
    serviceExtensions: [
      {
        serviceExtensionPublicNetworkAccess: 'string'
        serviceExtensionType: 'string'
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.HybridCompute/privateLinkScopes

Name Description Value
location Resource location string (required)
name The resource name string

Constraints:
Pattern = [a-zA-Z0-9-_\.]+ (required)
properties Properties that define a Azure Arc PrivateLinkScope resource. HybridComputePrivateLinkScopeProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

HybridComputePrivateLinkScopeProperties

Name Description Value
publicNetworkAccess Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. 'Disabled'
'Enabled'
'SecuredByPerimeter'
serviceExtensions Enable private link validation for an Azure Arc Extension. ServiceExtension[]

PrivateLinkScopesResourceTags

Name Description Value

ServiceExtension

Name Description Value
serviceExtensionPublicNetworkAccess The network access policy to determine if the specified Azure Arc Extension can use public Azure Arc Extension service endpoints. 'disabled'
'enabled'
serviceExtensionType The name of the Azure Arc Extension. string

Usage Examples

Bicep Samples

A basic example of deploying Azure Arc Private Link Scope.

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

resource privateLinkScope 'Microsoft.HybridCompute/privateLinkScopes@2022-11-10' = {
  name: resourceName
  location: location
  properties: {
    publicNetworkAccess: 'Disabled'
  }
}

ARM template resource definition

The privateLinkScopes 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.HybridCompute/privateLinkScopes resource, add the following JSON to your template.

{
  "type": "Microsoft.HybridCompute/privateLinkScopes",
  "apiVersion": "2025-09-16-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "publicNetworkAccess": "string",
    "serviceExtensions": [
      {
        "serviceExtensionPublicNetworkAccess": "string",
        "serviceExtensionType": "string"
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.HybridCompute/privateLinkScopes

Name Description Value
apiVersion The api version '2025-09-16-preview'
location Resource location string (required)
name The resource name string

Constraints:
Pattern = [a-zA-Z0-9-_\.]+ (required)
properties Properties that define a Azure Arc PrivateLinkScope resource. HybridComputePrivateLinkScopeProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.HybridCompute/privateLinkScopes'

HybridComputePrivateLinkScopeProperties

Name Description Value
publicNetworkAccess Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. 'Disabled'
'Enabled'
'SecuredByPerimeter'
serviceExtensions Enable private link validation for an Azure Arc Extension. ServiceExtension[]

PrivateLinkScopesResourceTags

Name Description Value

ServiceExtension

Name Description Value
serviceExtensionPublicNetworkAccess The network access policy to determine if the specified Azure Arc Extension can use public Azure Arc Extension service endpoints. 'disabled'
'enabled'
serviceExtensionType The name of the Azure Arc Extension. string

Usage Examples

Terraform (AzAPI provider) resource definition

The privateLinkScopes 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.HybridCompute/privateLinkScopes resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.HybridCompute/privateLinkScopes@2025-09-16-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      publicNetworkAccess = "string"
      serviceExtensions = [
        {
          serviceExtensionPublicNetworkAccess = "string"
          serviceExtensionType = "string"
        }
      ]
    }
  }
}

Property Values

Microsoft.HybridCompute/privateLinkScopes

Name Description Value
location Resource location string (required)
name The resource name string

Constraints:
Pattern = [a-zA-Z0-9-_\.]+ (required)
properties Properties that define a Azure Arc PrivateLinkScope resource. HybridComputePrivateLinkScopeProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.HybridCompute/privateLinkScopes@2025-09-16-preview"

HybridComputePrivateLinkScopeProperties

Name Description Value
publicNetworkAccess Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. 'Disabled'
'Enabled'
'SecuredByPerimeter'
serviceExtensions Enable private link validation for an Azure Arc Extension. ServiceExtension[]

PrivateLinkScopesResourceTags

Name Description Value

ServiceExtension

Name Description Value
serviceExtensionPublicNetworkAccess The network access policy to determine if the specified Azure Arc Extension can use public Azure Arc Extension service endpoints. 'disabled'
'enabled'
serviceExtensionType The name of the Azure Arc Extension. string

Usage Examples

Terraform Samples

A basic example of deploying Azure Arc Private Link Scope.

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" "privateLinkScope" {
  type      = "Microsoft.HybridCompute/privateLinkScopes@2022-11-10"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      publicNetworkAccess = "Disabled"
    }

  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}