Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. monitoring
  5. PrivateLinkScopedService

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.monitoring.PrivateLinkScopedService

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages an Azure Monitor Private Link Scoped Service.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleInsights = new azure.appinsights.Insights("example", {
    name: "example-appinsights",
    location: example.location,
    resourceGroupName: example.name,
    applicationType: "web",
});
const examplePrivateLinkScope = new azure.monitoring.PrivateLinkScope("example", {
    name: "example-ampls",
    resourceGroupName: example.name,
});
const examplePrivateLinkScopedService = new azure.monitoring.PrivateLinkScopedService("example", {
    name: "example-amplsservice",
    resourceGroupName: example.name,
    scopeName: examplePrivateLinkScope.name,
    linkedResourceId: exampleInsights.id,
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_insights = azure.appinsights.Insights("example",
    name="example-appinsights",
    location=example.location,
    resource_group_name=example.name,
    application_type="web")
example_private_link_scope = azure.monitoring.PrivateLinkScope("example",
    name="example-ampls",
    resource_group_name=example.name)
example_private_link_scoped_service = azure.monitoring.PrivateLinkScopedService("example",
    name="example-amplsservice",
    resource_group_name=example.name,
    scope_name=example_private_link_scope.name,
    linked_resource_id=example_insights.id)
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/appinsights"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/monitoring"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleInsights, err := appinsights.NewInsights(ctx, "example", &appinsights.InsightsArgs{
			Name:              pulumi.String("example-appinsights"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			ApplicationType:   pulumi.String("web"),
		})
		if err != nil {
			return err
		}
		examplePrivateLinkScope, err := monitoring.NewPrivateLinkScope(ctx, "example", &monitoring.PrivateLinkScopeArgs{
			Name:              pulumi.String("example-ampls"),
			ResourceGroupName: example.Name,
		})
		if err != nil {
			return err
		}
		_, err = monitoring.NewPrivateLinkScopedService(ctx, "example", &monitoring.PrivateLinkScopedServiceArgs{
			Name:              pulumi.String("example-amplsservice"),
			ResourceGroupName: example.Name,
			ScopeName:         examplePrivateLinkScope.Name,
			LinkedResourceId:  exampleInsights.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleInsights = new Azure.AppInsights.Insights("example", new()
    {
        Name = "example-appinsights",
        Location = example.Location,
        ResourceGroupName = example.Name,
        ApplicationType = "web",
    });

    var examplePrivateLinkScope = new Azure.Monitoring.PrivateLinkScope("example", new()
    {
        Name = "example-ampls",
        ResourceGroupName = example.Name,
    });

    var examplePrivateLinkScopedService = new Azure.Monitoring.PrivateLinkScopedService("example", new()
    {
        Name = "example-amplsservice",
        ResourceGroupName = example.Name,
        ScopeName = examplePrivateLinkScope.Name,
        LinkedResourceId = exampleInsights.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.appinsights.Insights;
import com.pulumi.azure.appinsights.InsightsArgs;
import com.pulumi.azure.monitoring.PrivateLinkScope;
import com.pulumi.azure.monitoring.PrivateLinkScopeArgs;
import com.pulumi.azure.monitoring.PrivateLinkScopedService;
import com.pulumi.azure.monitoring.PrivateLinkScopedServiceArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleInsights = new Insights("exampleInsights", InsightsArgs.builder()
            .name("example-appinsights")
            .location(example.location())
            .resourceGroupName(example.name())
            .applicationType("web")
            .build());

        var examplePrivateLinkScope = new PrivateLinkScope("examplePrivateLinkScope", PrivateLinkScopeArgs.builder()
            .name("example-ampls")
            .resourceGroupName(example.name())
            .build());

        var examplePrivateLinkScopedService = new PrivateLinkScopedService("examplePrivateLinkScopedService", PrivateLinkScopedServiceArgs.builder()
            .name("example-amplsservice")
            .resourceGroupName(example.name())
            .scopeName(examplePrivateLinkScope.name())
            .linkedResourceId(exampleInsights.id())
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleInsights:
    type: azure:appinsights:Insights
    name: example
    properties:
      name: example-appinsights
      location: ${example.location}
      resourceGroupName: ${example.name}
      applicationType: web
  examplePrivateLinkScope:
    type: azure:monitoring:PrivateLinkScope
    name: example
    properties:
      name: example-ampls
      resourceGroupName: ${example.name}
  examplePrivateLinkScopedService:
    type: azure:monitoring:PrivateLinkScopedService
    name: example
    properties:
      name: example-amplsservice
      resourceGroupName: ${example.name}
      scopeName: ${examplePrivateLinkScope.name}
      linkedResourceId: ${exampleInsights.id}
Copy

Create PrivateLinkScopedService Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new PrivateLinkScopedService(name: string, args: PrivateLinkScopedServiceArgs, opts?: CustomResourceOptions);
@overload
def PrivateLinkScopedService(resource_name: str,
                             args: PrivateLinkScopedServiceArgs,
                             opts: Optional[ResourceOptions] = None)

@overload
def PrivateLinkScopedService(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             linked_resource_id: Optional[str] = None,
                             resource_group_name: Optional[str] = None,
                             scope_name: Optional[str] = None,
                             name: Optional[str] = None)
func NewPrivateLinkScopedService(ctx *Context, name string, args PrivateLinkScopedServiceArgs, opts ...ResourceOption) (*PrivateLinkScopedService, error)
public PrivateLinkScopedService(string name, PrivateLinkScopedServiceArgs args, CustomResourceOptions? opts = null)
public PrivateLinkScopedService(String name, PrivateLinkScopedServiceArgs args)
public PrivateLinkScopedService(String name, PrivateLinkScopedServiceArgs args, CustomResourceOptions options)

type: azure:monitoring:PrivateLinkScopedService
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. PrivateLinkScopedServiceArgs
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. PrivateLinkScopedServiceArgs
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. PrivateLinkScopedServiceArgs
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. PrivateLinkScopedServiceArgs
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. PrivateLinkScopedServiceArgs
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 privateLinkScopedServiceResource = new Azure.Monitoring.PrivateLinkScopedService("privateLinkScopedServiceResource", new()
{
    LinkedResourceId = "string",
    ResourceGroupName = "string",
    ScopeName = "string",
    Name = "string",
});
Copy
example, err := monitoring.NewPrivateLinkScopedService(ctx, "privateLinkScopedServiceResource", &monitoring.PrivateLinkScopedServiceArgs{
	LinkedResourceId:  pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	ScopeName:         pulumi.String("string"),
	Name:              pulumi.String("string"),
})
Copy
var privateLinkScopedServiceResource = new PrivateLinkScopedService("privateLinkScopedServiceResource", PrivateLinkScopedServiceArgs.builder()
    .linkedResourceId("string")
    .resourceGroupName("string")
    .scopeName("string")
    .name("string")
    .build());
Copy
private_link_scoped_service_resource = azure.monitoring.PrivateLinkScopedService("privateLinkScopedServiceResource",
    linked_resource_id="string",
    resource_group_name="string",
    scope_name="string",
    name="string")
Copy
const privateLinkScopedServiceResource = new azure.monitoring.PrivateLinkScopedService("privateLinkScopedServiceResource", {
    linkedResourceId: "string",
    resourceGroupName: "string",
    scopeName: "string",
    name: "string",
});
Copy
type: azure:monitoring:PrivateLinkScopedService
properties:
    linkedResourceId: string
    name: string
    resourceGroupName: string
    scopeName: string
Copy

PrivateLinkScopedService 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 PrivateLinkScopedService resource accepts the following input properties:

LinkedResourceId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the linked resource. It must be the Log Analytics workspace or the Application Insights component or the Data Collection endpoint. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group where the Azure Monitor Private Link Scoped Service should exist. Changing this forces a new resource to be created.
ScopeName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Azure Monitor Private Link Scope. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of the Azure Monitor Private Link Scoped Service. Changing this forces a new resource to be created.
LinkedResourceId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the linked resource. It must be the Log Analytics workspace or the Application Insights component or the Data Collection endpoint. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group where the Azure Monitor Private Link Scoped Service should exist. Changing this forces a new resource to be created.
ScopeName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Azure Monitor Private Link Scope. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of the Azure Monitor Private Link Scoped Service. Changing this forces a new resource to be created.
linkedResourceId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the linked resource. It must be the Log Analytics workspace or the Application Insights component or the Data Collection endpoint. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group where the Azure Monitor Private Link Scoped Service should exist. Changing this forces a new resource to be created.
scopeName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Azure Monitor Private Link Scope. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of the Azure Monitor Private Link Scoped Service. Changing this forces a new resource to be created.
linkedResourceId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the linked resource. It must be the Log Analytics workspace or the Application Insights component or the Data Collection endpoint. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group where the Azure Monitor Private Link Scoped Service should exist. Changing this forces a new resource to be created.
scopeName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Azure Monitor Private Link Scope. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
The name of the Azure Monitor Private Link Scoped Service. Changing this forces a new resource to be created.
linked_resource_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the linked resource. It must be the Log Analytics workspace or the Application Insights component or the Data Collection endpoint. Changing this forces a new resource to be created.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Resource Group where the Azure Monitor Private Link Scoped Service should exist. Changing this forces a new resource to be created.
scope_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Azure Monitor Private Link Scope. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
The name of the Azure Monitor Private Link Scoped Service. Changing this forces a new resource to be created.
linkedResourceId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the linked resource. It must be the Log Analytics workspace or the Application Insights component or the Data Collection endpoint. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group where the Azure Monitor Private Link Scoped Service should exist. Changing this forces a new resource to be created.
scopeName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Azure Monitor Private Link Scope. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of the Azure Monitor Private Link Scoped Service. Changing this forces a new resource to be created.

Outputs

All input properties are implicitly available as output properties. Additionally, the PrivateLinkScopedService resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing PrivateLinkScopedService Resource

Get an existing PrivateLinkScopedService resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: PrivateLinkScopedServiceState, opts?: CustomResourceOptions): PrivateLinkScopedService
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        linked_resource_id: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        scope_name: Optional[str] = None) -> PrivateLinkScopedService
func GetPrivateLinkScopedService(ctx *Context, name string, id IDInput, state *PrivateLinkScopedServiceState, opts ...ResourceOption) (*PrivateLinkScopedService, error)
public static PrivateLinkScopedService Get(string name, Input<string> id, PrivateLinkScopedServiceState? state, CustomResourceOptions? opts = null)
public static PrivateLinkScopedService get(String name, Output<String> id, PrivateLinkScopedServiceState state, CustomResourceOptions options)
resources:  _:    type: azure:monitoring:PrivateLinkScopedService    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
LinkedResourceId Changes to this property will trigger replacement. string
The ID of the linked resource. It must be the Log Analytics workspace or the Application Insights component or the Data Collection endpoint. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of the Azure Monitor Private Link Scoped Service. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group where the Azure Monitor Private Link Scoped Service should exist. Changing this forces a new resource to be created.
ScopeName Changes to this property will trigger replacement. string
The name of the Azure Monitor Private Link Scope. Changing this forces a new resource to be created.
LinkedResourceId Changes to this property will trigger replacement. string
The ID of the linked resource. It must be the Log Analytics workspace or the Application Insights component or the Data Collection endpoint. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of the Azure Monitor Private Link Scoped Service. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group where the Azure Monitor Private Link Scoped Service should exist. Changing this forces a new resource to be created.
ScopeName Changes to this property will trigger replacement. string
The name of the Azure Monitor Private Link Scope. Changing this forces a new resource to be created.
linkedResourceId Changes to this property will trigger replacement. String
The ID of the linked resource. It must be the Log Analytics workspace or the Application Insights component or the Data Collection endpoint. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of the Azure Monitor Private Link Scoped Service. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the Resource Group where the Azure Monitor Private Link Scoped Service should exist. Changing this forces a new resource to be created.
scopeName Changes to this property will trigger replacement. String
The name of the Azure Monitor Private Link Scope. Changing this forces a new resource to be created.
linkedResourceId Changes to this property will trigger replacement. string
The ID of the linked resource. It must be the Log Analytics workspace or the Application Insights component or the Data Collection endpoint. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
The name of the Azure Monitor Private Link Scoped Service. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group where the Azure Monitor Private Link Scoped Service should exist. Changing this forces a new resource to be created.
scopeName Changes to this property will trigger replacement. string
The name of the Azure Monitor Private Link Scope. Changing this forces a new resource to be created.
linked_resource_id Changes to this property will trigger replacement. str
The ID of the linked resource. It must be the Log Analytics workspace or the Application Insights component or the Data Collection endpoint. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
The name of the Azure Monitor Private Link Scoped Service. Changing this forces a new resource to be created.
resource_group_name Changes to this property will trigger replacement. str
The name of the Resource Group where the Azure Monitor Private Link Scoped Service should exist. Changing this forces a new resource to be created.
scope_name Changes to this property will trigger replacement. str
The name of the Azure Monitor Private Link Scope. Changing this forces a new resource to be created.
linkedResourceId Changes to this property will trigger replacement. String
The ID of the linked resource. It must be the Log Analytics workspace or the Application Insights component or the Data Collection endpoint. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of the Azure Monitor Private Link Scoped Service. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the Resource Group where the Azure Monitor Private Link Scoped Service should exist. Changing this forces a new resource to be created.
scopeName Changes to this property will trigger replacement. String
The name of the Azure Monitor Private Link Scope. Changing this forces a new resource to be created.

Import

Azure Monitor Private Link Scoped Services can be imported using the resource id, e.g.

$ pulumi import azure:monitoring/privateLinkScopedService:PrivateLinkScopedService example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Insights/privateLinkScopes/pls1/scopedResources/sr1
Copy

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

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure