Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. monitor
  5. PrivateLinkScopedResource
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.monitor.PrivateLinkScopedResource

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

A private link scoped resource

Uses Azure REST API version 2023-06-01-preview.

Other available API versions: 2021-07-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native monitor [ApiVersion]. See the version guide for details.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var privateLinkScopedResource = new AzureNative.Monitor.PrivateLinkScopedResource("privateLinkScopedResource", new()
    {
        Kind = "PlatformMetrics",
        LinkedResourceId = "/subscriptions/00000000-1111-2222-3333-444444444444",
        Name = "scoped-resource-name",
        ResourceGroupName = "MyResourceGroup",
        ScopeName = "MyPrivateLinkScope",
        SubscriptionLocation = "eastus",
    });

});
Copy
package main

import (
	monitor "github.com/pulumi/pulumi-azure-native-sdk/monitor/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := monitor.NewPrivateLinkScopedResource(ctx, "privateLinkScopedResource", &monitor.PrivateLinkScopedResourceArgs{
			Kind:                 pulumi.String("PlatformMetrics"),
			LinkedResourceId:     pulumi.String("/subscriptions/00000000-1111-2222-3333-444444444444"),
			Name:                 pulumi.String("scoped-resource-name"),
			ResourceGroupName:    pulumi.String("MyResourceGroup"),
			ScopeName:            pulumi.String("MyPrivateLinkScope"),
			SubscriptionLocation: pulumi.String("eastus"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.monitor.PrivateLinkScopedResource;
import com.pulumi.azurenative.monitor.PrivateLinkScopedResourceArgs;
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 privateLinkScopedResource = new PrivateLinkScopedResource("privateLinkScopedResource", PrivateLinkScopedResourceArgs.builder()
            .kind("PlatformMetrics")
            .linkedResourceId("/subscriptions/00000000-1111-2222-3333-444444444444")
            .name("scoped-resource-name")
            .resourceGroupName("MyResourceGroup")
            .scopeName("MyPrivateLinkScope")
            .subscriptionLocation("eastus")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const privateLinkScopedResource = new azure_native.monitor.PrivateLinkScopedResource("privateLinkScopedResource", {
    kind: "PlatformMetrics",
    linkedResourceId: "/subscriptions/00000000-1111-2222-3333-444444444444",
    name: "scoped-resource-name",
    resourceGroupName: "MyResourceGroup",
    scopeName: "MyPrivateLinkScope",
    subscriptionLocation: "eastus",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

private_link_scoped_resource = azure_native.monitor.PrivateLinkScopedResource("privateLinkScopedResource",
    kind="PlatformMetrics",
    linked_resource_id="/subscriptions/00000000-1111-2222-3333-444444444444",
    name="scoped-resource-name",
    resource_group_name="MyResourceGroup",
    scope_name="MyPrivateLinkScope",
    subscription_location="eastus")
Copy
resources:
  privateLinkScopedResource:
    type: azure-native:monitor:PrivateLinkScopedResource
    properties:
      kind: PlatformMetrics
      linkedResourceId: /subscriptions/00000000-1111-2222-3333-444444444444
      name: scoped-resource-name
      resourceGroupName: MyResourceGroup
      scopeName: MyPrivateLinkScope
      subscriptionLocation: eastus
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var privateLinkScopedResource = new AzureNative.Monitor.PrivateLinkScopedResource("privateLinkScopedResource", new()
    {
        Kind = AzureNative.Monitor.ScopedResourceKind.Resource,
        LinkedResourceId = "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/components/my-component",
        Name = "scoped-resource-name",
        ResourceGroupName = "MyResourceGroup",
        ScopeName = "MyPrivateLinkScope",
    });

});
Copy
package main

import (
	monitor "github.com/pulumi/pulumi-azure-native-sdk/monitor/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := monitor.NewPrivateLinkScopedResource(ctx, "privateLinkScopedResource", &monitor.PrivateLinkScopedResourceArgs{
			Kind:              pulumi.String(monitor.ScopedResourceKindResource),
			LinkedResourceId:  pulumi.String("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/components/my-component"),
			Name:              pulumi.String("scoped-resource-name"),
			ResourceGroupName: pulumi.String("MyResourceGroup"),
			ScopeName:         pulumi.String("MyPrivateLinkScope"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.monitor.PrivateLinkScopedResource;
import com.pulumi.azurenative.monitor.PrivateLinkScopedResourceArgs;
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 privateLinkScopedResource = new PrivateLinkScopedResource("privateLinkScopedResource", PrivateLinkScopedResourceArgs.builder()
            .kind("Resource")
            .linkedResourceId("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/components/my-component")
            .name("scoped-resource-name")
            .resourceGroupName("MyResourceGroup")
            .scopeName("MyPrivateLinkScope")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const privateLinkScopedResource = new azure_native.monitor.PrivateLinkScopedResource("privateLinkScopedResource", {
    kind: azure_native.monitor.ScopedResourceKind.Resource,
    linkedResourceId: "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/components/my-component",
    name: "scoped-resource-name",
    resourceGroupName: "MyResourceGroup",
    scopeName: "MyPrivateLinkScope",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

private_link_scoped_resource = azure_native.monitor.PrivateLinkScopedResource("privateLinkScopedResource",
    kind=azure_native.monitor.ScopedResourceKind.RESOURCE,
    linked_resource_id="/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/components/my-component",
    name="scoped-resource-name",
    resource_group_name="MyResourceGroup",
    scope_name="MyPrivateLinkScope")
Copy
resources:
  privateLinkScopedResource:
    type: azure-native:monitor:PrivateLinkScopedResource
    properties:
      kind: Resource
      linkedResourceId: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/components/my-component
      name: scoped-resource-name
      resourceGroupName: MyResourceGroup
      scopeName: MyPrivateLinkScope
Copy

Create PrivateLinkScopedResource Resource

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

Constructor syntax

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

@overload
def PrivateLinkScopedResource(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              resource_group_name: Optional[str] = None,
                              scope_name: Optional[str] = None,
                              kind: Optional[Union[str, ScopedResourceKind]] = None,
                              linked_resource_id: Optional[str] = None,
                              name: Optional[str] = None,
                              subscription_location: Optional[str] = None)
func NewPrivateLinkScopedResource(ctx *Context, name string, args PrivateLinkScopedResourceArgs, opts ...ResourceOption) (*PrivateLinkScopedResource, error)
public PrivateLinkScopedResource(string name, PrivateLinkScopedResourceArgs args, CustomResourceOptions? opts = null)
public PrivateLinkScopedResource(String name, PrivateLinkScopedResourceArgs args)
public PrivateLinkScopedResource(String name, PrivateLinkScopedResourceArgs args, CustomResourceOptions options)

type: azure-native:monitor:PrivateLinkScopedResource
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. PrivateLinkScopedResourceArgs
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. PrivateLinkScopedResourceArgs
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. PrivateLinkScopedResourceArgs
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. PrivateLinkScopedResourceArgs
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. PrivateLinkScopedResourceArgs
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 azure_nativePrivateLinkScopedResourceResource = new AzureNative.Monitor.PrivateLinkScopedResource("azure-nativePrivateLinkScopedResourceResource", new()
{
    ResourceGroupName = "string",
    ScopeName = "string",
    Kind = "string",
    LinkedResourceId = "string",
    Name = "string",
    SubscriptionLocation = "string",
});
Copy
example, err := monitor.NewPrivateLinkScopedResource(ctx, "azure-nativePrivateLinkScopedResourceResource", &monitor.PrivateLinkScopedResourceArgs{
	ResourceGroupName:    pulumi.String("string"),
	ScopeName:            pulumi.String("string"),
	Kind:                 pulumi.String("string"),
	LinkedResourceId:     pulumi.String("string"),
	Name:                 pulumi.String("string"),
	SubscriptionLocation: pulumi.String("string"),
})
Copy
var azure_nativePrivateLinkScopedResourceResource = new PrivateLinkScopedResource("azure-nativePrivateLinkScopedResourceResource", PrivateLinkScopedResourceArgs.builder()
    .resourceGroupName("string")
    .scopeName("string")
    .kind("string")
    .linkedResourceId("string")
    .name("string")
    .subscriptionLocation("string")
    .build());
Copy
azure_native_private_link_scoped_resource_resource = azure_native.monitor.PrivateLinkScopedResource("azure-nativePrivateLinkScopedResourceResource",
    resource_group_name="string",
    scope_name="string",
    kind="string",
    linked_resource_id="string",
    name="string",
    subscription_location="string")
Copy
const azure_nativePrivateLinkScopedResourceResource = new azure_native.monitor.PrivateLinkScopedResource("azure-nativePrivateLinkScopedResourceResource", {
    resourceGroupName: "string",
    scopeName: "string",
    kind: "string",
    linkedResourceId: "string",
    name: "string",
    subscriptionLocation: "string",
});
Copy
type: azure-native:monitor:PrivateLinkScopedResource
properties:
    kind: string
    linkedResourceId: string
    name: string
    resourceGroupName: string
    scopeName: string
    subscriptionLocation: string
Copy

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

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ScopeName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Azure Monitor PrivateLinkScope resource.
Kind string | Pulumi.AzureNative.Monitor.ScopedResourceKind
The kind of scoped Azure monitor resource.
LinkedResourceId string
The resource id of the scoped Azure monitor resource.
Name Changes to this property will trigger replacement. string
The name of the scoped resource object.
SubscriptionLocation string
The location of a scoped subscription. Only needs to be specified for metric dataplane subscriptions.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ScopeName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Azure Monitor PrivateLinkScope resource.
Kind string | ScopedResourceKind
The kind of scoped Azure monitor resource.
LinkedResourceId string
The resource id of the scoped Azure monitor resource.
Name Changes to this property will trigger replacement. string
The name of the scoped resource object.
SubscriptionLocation string
The location of a scoped subscription. Only needs to be specified for metric dataplane subscriptions.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
scopeName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Azure Monitor PrivateLinkScope resource.
kind String | ScopedResourceKind
The kind of scoped Azure monitor resource.
linkedResourceId String
The resource id of the scoped Azure monitor resource.
name Changes to this property will trigger replacement. String
The name of the scoped resource object.
subscriptionLocation String
The location of a scoped subscription. Only needs to be specified for metric dataplane subscriptions.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
scopeName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Azure Monitor PrivateLinkScope resource.
kind string | ScopedResourceKind
The kind of scoped Azure monitor resource.
linkedResourceId string
The resource id of the scoped Azure monitor resource.
name Changes to this property will trigger replacement. string
The name of the scoped resource object.
subscriptionLocation string
The location of a scoped subscription. Only needs to be specified for metric dataplane subscriptions.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
scope_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Azure Monitor PrivateLinkScope resource.
kind str | ScopedResourceKind
The kind of scoped Azure monitor resource.
linked_resource_id str
The resource id of the scoped Azure monitor resource.
name Changes to this property will trigger replacement. str
The name of the scoped resource object.
subscription_location str
The location of a scoped subscription. Only needs to be specified for metric dataplane subscriptions.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
scopeName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Azure Monitor PrivateLinkScope resource.
kind String | "Resource" | "Metrics"
The kind of scoped Azure monitor resource.
linkedResourceId String
The resource id of the scoped Azure monitor resource.
name Changes to this property will trigger replacement. String
The name of the scoped resource object.
subscriptionLocation String
The location of a scoped subscription. Only needs to be specified for metric dataplane subscriptions.

Outputs

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

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
ProvisioningState string
State of the Azure monitor resource.
SystemData Pulumi.AzureNative.Monitor.Outputs.SystemDataResponse
System data
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
ProvisioningState string
State of the Azure monitor resource.
SystemData SystemDataResponse
System data
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
provisioningState String
State of the Azure monitor resource.
systemData SystemDataResponse
System data
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
provisioningState string
State of the Azure monitor resource.
systemData SystemDataResponse
System data
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
provisioning_state str
State of the Azure monitor resource.
system_data SystemDataResponse
System data
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
provisioningState String
State of the Azure monitor resource.
systemData Property Map
System data
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

ScopedResourceKind
, ScopedResourceKindArgs

Resource
Resource
Metrics
Metrics
ScopedResourceKindResource
Resource
ScopedResourceKindMetrics
Metrics
Resource
Resource
Metrics
Metrics
Resource
Resource
Metrics
Metrics
RESOURCE
Resource
METRICS
Metrics
"Resource"
Resource
"Metrics"
Metrics

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:monitor:PrivateLinkScopedResource scoped-resource-name /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/scopedResources/{name}
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native