1. Packages
  2. Azure Classic
  3. API Docs
  4. monitoring
  5. PrivateLinkScope

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi

azure.monitoring.PrivateLinkScope

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Manages an Azure Monitor Private Link Scope.

    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 examplePrivateLinkScope = new azure.monitoring.PrivateLinkScope("example", {
        name: "example-ampls",
        resourceGroupName: example.name,
        ingestionAccessMode: "PrivateOnly",
        queryAccessMode: "Open",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_private_link_scope = azure.monitoring.PrivateLinkScope("example",
        name="example-ampls",
        resource_group_name=example.name,
        ingestion_access_mode="PrivateOnly",
        query_access_mode="Open")
    
    package main
    
    import (
    	"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
    		}
    		_, err = monitoring.NewPrivateLinkScope(ctx, "example", &monitoring.PrivateLinkScopeArgs{
    			Name:                pulumi.String("example-ampls"),
    			ResourceGroupName:   example.Name,
    			IngestionAccessMode: pulumi.String("PrivateOnly"),
    			QueryAccessMode:     pulumi.String("Open"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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 examplePrivateLinkScope = new Azure.Monitoring.PrivateLinkScope("example", new()
        {
            Name = "example-ampls",
            ResourceGroupName = example.Name,
            IngestionAccessMode = "PrivateOnly",
            QueryAccessMode = "Open",
        });
    
    });
    
    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.monitoring.PrivateLinkScope;
    import com.pulumi.azure.monitoring.PrivateLinkScopeArgs;
    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 examplePrivateLinkScope = new PrivateLinkScope("examplePrivateLinkScope", PrivateLinkScopeArgs.builder()
                .name("example-ampls")
                .resourceGroupName(example.name())
                .ingestionAccessMode("PrivateOnly")
                .queryAccessMode("Open")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      examplePrivateLinkScope:
        type: azure:monitoring:PrivateLinkScope
        name: example
        properties:
          name: example-ampls
          resourceGroupName: ${example.name}
          ingestionAccessMode: PrivateOnly
          queryAccessMode: Open
    

    Create PrivateLinkScope Resource

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

    Constructor syntax

    new PrivateLinkScope(name: string, args: PrivateLinkScopeArgs, opts?: CustomResourceOptions);
    @overload
    def PrivateLinkScope(resource_name: str,
                         args: PrivateLinkScopeArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def PrivateLinkScope(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         resource_group_name: Optional[str] = None,
                         ingestion_access_mode: Optional[str] = None,
                         name: Optional[str] = None,
                         query_access_mode: Optional[str] = None,
                         tags: Optional[Mapping[str, str]] = None)
    func NewPrivateLinkScope(ctx *Context, name string, args PrivateLinkScopeArgs, opts ...ResourceOption) (*PrivateLinkScope, error)
    public PrivateLinkScope(string name, PrivateLinkScopeArgs args, CustomResourceOptions? opts = null)
    public PrivateLinkScope(String name, PrivateLinkScopeArgs args)
    public PrivateLinkScope(String name, PrivateLinkScopeArgs args, CustomResourceOptions options)
    
    type: azure:monitoring:PrivateLinkScope
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args PrivateLinkScopeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PrivateLinkScopeArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PrivateLinkScopeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrivateLinkScopeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrivateLinkScopeArgs
    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 azurePrivateLinkScopeResource = new Azure.Monitoring.PrivateLinkScope("azurePrivateLinkScopeResource", new()
    {
        ResourceGroupName = "string",
        IngestionAccessMode = "string",
        Name = "string",
        QueryAccessMode = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := monitoring.NewPrivateLinkScope(ctx, "azurePrivateLinkScopeResource", &monitoring.PrivateLinkScopeArgs{
    	ResourceGroupName:   pulumi.String("string"),
    	IngestionAccessMode: pulumi.String("string"),
    	Name:                pulumi.String("string"),
    	QueryAccessMode:     pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var azurePrivateLinkScopeResource = new PrivateLinkScope("azurePrivateLinkScopeResource", PrivateLinkScopeArgs.builder()
        .resourceGroupName("string")
        .ingestionAccessMode("string")
        .name("string")
        .queryAccessMode("string")
        .tags(Map.of("string", "string"))
        .build());
    
    azure_private_link_scope_resource = azure.monitoring.PrivateLinkScope("azurePrivateLinkScopeResource",
        resource_group_name="string",
        ingestion_access_mode="string",
        name="string",
        query_access_mode="string",
        tags={
            "string": "string",
        })
    
    const azurePrivateLinkScopeResource = new azure.monitoring.PrivateLinkScope("azurePrivateLinkScopeResource", {
        resourceGroupName: "string",
        ingestionAccessMode: "string",
        name: "string",
        queryAccessMode: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure:monitoring:PrivateLinkScope
    properties:
        ingestionAccessMode: string
        name: string
        queryAccessMode: string
        resourceGroupName: string
        tags:
            string: string
    

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

    ResourceGroupName string
    The name of the Resource Group where the Azure Monitor Private Link Scope should exist. Changing this forces a new resource to be created.
    IngestionAccessMode string
    The default ingestion access mode for the associated private endpoints in scope. Possible values are Open and PrivateOnly. Defaults to Open.
    Name string
    The name of the Azure Monitor Private Link Scope. Changing this forces a new resource to be created.
    QueryAccessMode string
    The default query access mode for hte associated private endpoints in scope. Possible values are Open and PrivateOnly. Defaults to Open.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Azure Monitor Private Link Scope.
    ResourceGroupName string
    The name of the Resource Group where the Azure Monitor Private Link Scope should exist. Changing this forces a new resource to be created.
    IngestionAccessMode string
    The default ingestion access mode for the associated private endpoints in scope. Possible values are Open and PrivateOnly. Defaults to Open.
    Name string
    The name of the Azure Monitor Private Link Scope. Changing this forces a new resource to be created.
    QueryAccessMode string
    The default query access mode for hte associated private endpoints in scope. Possible values are Open and PrivateOnly. Defaults to Open.
    Tags map[string]string
    A mapping of tags which should be assigned to the Azure Monitor Private Link Scope.
    resourceGroupName String
    The name of the Resource Group where the Azure Monitor Private Link Scope should exist. Changing this forces a new resource to be created.
    ingestionAccessMode String
    The default ingestion access mode for the associated private endpoints in scope. Possible values are Open and PrivateOnly. Defaults to Open.
    name String
    The name of the Azure Monitor Private Link Scope. Changing this forces a new resource to be created.
    queryAccessMode String
    The default query access mode for hte associated private endpoints in scope. Possible values are Open and PrivateOnly. Defaults to Open.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Azure Monitor Private Link Scope.
    resourceGroupName string
    The name of the Resource Group where the Azure Monitor Private Link Scope should exist. Changing this forces a new resource to be created.
    ingestionAccessMode string
    The default ingestion access mode for the associated private endpoints in scope. Possible values are Open and PrivateOnly. Defaults to Open.
    name string
    The name of the Azure Monitor Private Link Scope. Changing this forces a new resource to be created.
    queryAccessMode string
    The default query access mode for hte associated private endpoints in scope. Possible values are Open and PrivateOnly. Defaults to Open.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Azure Monitor Private Link Scope.
    resource_group_name str
    The name of the Resource Group where the Azure Monitor Private Link Scope should exist. Changing this forces a new resource to be created.
    ingestion_access_mode str
    The default ingestion access mode for the associated private endpoints in scope. Possible values are Open and PrivateOnly. Defaults to Open.
    name str
    The name of the Azure Monitor Private Link Scope. Changing this forces a new resource to be created.
    query_access_mode str
    The default query access mode for hte associated private endpoints in scope. Possible values are Open and PrivateOnly. Defaults to Open.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Azure Monitor Private Link Scope.
    resourceGroupName String
    The name of the Resource Group where the Azure Monitor Private Link Scope should exist. Changing this forces a new resource to be created.
    ingestionAccessMode String
    The default ingestion access mode for the associated private endpoints in scope. Possible values are Open and PrivateOnly. Defaults to Open.
    name String
    The name of the Azure Monitor Private Link Scope. Changing this forces a new resource to be created.
    queryAccessMode String
    The default query access mode for hte associated private endpoints in scope. Possible values are Open and PrivateOnly. Defaults to Open.
    tags Map<String>
    A mapping of tags which should be assigned to the Azure Monitor Private Link Scope.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PrivateLinkScope 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 PrivateLinkScope Resource

    Get an existing PrivateLinkScope 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?: PrivateLinkScopeState, opts?: CustomResourceOptions): PrivateLinkScope
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            ingestion_access_mode: Optional[str] = None,
            name: Optional[str] = None,
            query_access_mode: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None) -> PrivateLinkScope
    func GetPrivateLinkScope(ctx *Context, name string, id IDInput, state *PrivateLinkScopeState, opts ...ResourceOption) (*PrivateLinkScope, error)
    public static PrivateLinkScope Get(string name, Input<string> id, PrivateLinkScopeState? state, CustomResourceOptions? opts = null)
    public static PrivateLinkScope get(String name, Output<String> id, PrivateLinkScopeState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    IngestionAccessMode string
    The default ingestion access mode for the associated private endpoints in scope. Possible values are Open and PrivateOnly. Defaults to Open.
    Name string
    The name of the Azure Monitor Private Link Scope. Changing this forces a new resource to be created.
    QueryAccessMode string
    The default query access mode for hte associated private endpoints in scope. Possible values are Open and PrivateOnly. Defaults to Open.
    ResourceGroupName string
    The name of the Resource Group where the Azure Monitor Private Link Scope should exist. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Azure Monitor Private Link Scope.
    IngestionAccessMode string
    The default ingestion access mode for the associated private endpoints in scope. Possible values are Open and PrivateOnly. Defaults to Open.
    Name string
    The name of the Azure Monitor Private Link Scope. Changing this forces a new resource to be created.
    QueryAccessMode string
    The default query access mode for hte associated private endpoints in scope. Possible values are Open and PrivateOnly. Defaults to Open.
    ResourceGroupName string
    The name of the Resource Group where the Azure Monitor Private Link Scope should exist. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Azure Monitor Private Link Scope.
    ingestionAccessMode String
    The default ingestion access mode for the associated private endpoints in scope. Possible values are Open and PrivateOnly. Defaults to Open.
    name String
    The name of the Azure Monitor Private Link Scope. Changing this forces a new resource to be created.
    queryAccessMode String
    The default query access mode for hte associated private endpoints in scope. Possible values are Open and PrivateOnly. Defaults to Open.
    resourceGroupName String
    The name of the Resource Group where the Azure Monitor Private Link Scope should exist. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Azure Monitor Private Link Scope.
    ingestionAccessMode string
    The default ingestion access mode for the associated private endpoints in scope. Possible values are Open and PrivateOnly. Defaults to Open.
    name string
    The name of the Azure Monitor Private Link Scope. Changing this forces a new resource to be created.
    queryAccessMode string
    The default query access mode for hte associated private endpoints in scope. Possible values are Open and PrivateOnly. Defaults to Open.
    resourceGroupName string
    The name of the Resource Group where the Azure Monitor Private Link Scope should exist. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Azure Monitor Private Link Scope.
    ingestion_access_mode str
    The default ingestion access mode for the associated private endpoints in scope. Possible values are Open and PrivateOnly. Defaults to Open.
    name str
    The name of the Azure Monitor Private Link Scope. Changing this forces a new resource to be created.
    query_access_mode str
    The default query access mode for hte associated private endpoints in scope. Possible values are Open and PrivateOnly. Defaults to Open.
    resource_group_name str
    The name of the Resource Group where the Azure Monitor Private Link Scope should exist. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Azure Monitor Private Link Scope.
    ingestionAccessMode String
    The default ingestion access mode for the associated private endpoints in scope. Possible values are Open and PrivateOnly. Defaults to Open.
    name String
    The name of the Azure Monitor Private Link Scope. Changing this forces a new resource to be created.
    queryAccessMode String
    The default query access mode for hte associated private endpoints in scope. Possible values are Open and PrivateOnly. Defaults to Open.
    resourceGroupName String
    The name of the Resource Group where the Azure Monitor Private Link Scope should exist. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Azure Monitor Private Link Scope.

    Import

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

    $ pulumi import azure:monitoring/privateLinkScope:PrivateLinkScope example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Insights/privateLinkScopes/pls1
    

    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.
    azure logo

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi