Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. arc
  5. PrivateLinkScope

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.arc.PrivateLinkScope

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages an Azure Arc 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: "rg-example",
    location: "west europe",
});
const examplePrivateLinkScope = new azure.arc.PrivateLinkScope("example", {
    name: "plsexample",
    resourceGroupName: example.name,
    location: example.location,
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="rg-example",
    location="west europe")
example_private_link_scope = azure.arc.PrivateLinkScope("example",
    name="plsexample",
    resource_group_name=example.name,
    location=example.location)

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/arc"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"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("rg-example"),
			Location: pulumi.String("west europe"),
		})
		if err != nil {
			return err
		}
		_, err = arc.NewPrivateLinkScope(ctx, "example", &arc.PrivateLinkScopeArgs{
			Name:              pulumi.String("plsexample"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
		})
		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 = "rg-example",
        Location = "west europe",
    });

    var examplePrivateLinkScope = new Azure.Arc.PrivateLinkScope("example", new()
    {
        Name = "plsexample",
        ResourceGroupName = example.Name,
        Location = example.Location,
    });

});

    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.arc.PrivateLinkScope;
import com.pulumi.azure.arc.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("rg-example")
            .location("west europe")
            .build());

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

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: rg-example
      location: west europe
  examplePrivateLinkScope:
    type: azure:arc:PrivateLinkScope
    name: example
    properties:
      name: plsexample
      resourceGroupName: ${example.name}
      location: ${example.location}

    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,
                     location: Optional[str] = None,
                     name: Optional[str] = None,
                     public_network_access_enabled: Optional[bool] = 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:arc: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 privateLinkScopeResource = new Azure.Arc.PrivateLinkScope("privateLinkScopeResource", new()
{
    ResourceGroupName = "string",
    Location = "string",
    Name = "string",
    PublicNetworkAccessEnabled = false,
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := arc.NewPrivateLinkScope(ctx, "privateLinkScopeResource", &arc.PrivateLinkScopeArgs{
	ResourceGroupName:          pulumi.String("string"),
	Location:                   pulumi.String("string"),
	Name:                       pulumi.String("string"),
	PublicNetworkAccessEnabled: pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var privateLinkScopeResource = new PrivateLinkScope("privateLinkScopeResource", PrivateLinkScopeArgs.builder()
    .resourceGroupName("string")
    .location("string")
    .name("string")
    .publicNetworkAccessEnabled(false)
    .tags(Map.of("string", "string"))
    .build());

    private_link_scope_resource = azure.arc.PrivateLinkScope("privateLinkScopeResource",
    resource_group_name="string",
    location="string",
    name="string",
    public_network_access_enabled=False,
    tags={
        "string": "string",
    })

    const privateLinkScopeResource = new azure.arc.PrivateLinkScope("privateLinkScopeResource", {
    resourceGroupName: "string",
    location: "string",
    name: "string",
    publicNetworkAccessEnabled: false,
    tags: {
        string: "string",
    },
});

    type: azure:arc:PrivateLinkScope
properties:
    location: string
    name: string
    publicNetworkAccessEnabled: false
    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 Arc Private Link Scope should exist. Changing this forces a new Azure Arc Private Link Scope to be created.
    Location string
    The Azure Region where the Arc Private Link Scope should exist. Changing this forces a new Azure Arc Private Link Scope to be created.
    Name string
    The name which should be used for the Azure Arc Private Link Scope. Changing this forces a new Azure Arc Private Link Scope to be created.
    PublicNetworkAccessEnabled bool
    Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. Defaults to false. Possible values are true and false.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Azure Arc Private Link Scope.
    ResourceGroupName string
    The name of the Resource Group where the Azure Arc Private Link Scope should exist. Changing this forces a new Azure Arc Private Link Scope to be created.
    Location string
    The Azure Region where the Arc Private Link Scope should exist. Changing this forces a new Azure Arc Private Link Scope to be created.
    Name string
    The name which should be used for the Azure Arc Private Link Scope. Changing this forces a new Azure Arc Private Link Scope to be created.
    PublicNetworkAccessEnabled bool
    Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. Defaults to false. Possible values are true and false.
    Tags map[string]string
    A mapping of tags which should be assigned to the Azure Arc Private Link Scope.
    resourceGroupName String
    The name of the Resource Group where the Azure Arc Private Link Scope should exist. Changing this forces a new Azure Arc Private Link Scope to be created.
    location String
    The Azure Region where the Arc Private Link Scope should exist. Changing this forces a new Azure Arc Private Link Scope to be created.
    name String
    The name which should be used for the Azure Arc Private Link Scope. Changing this forces a new Azure Arc Private Link Scope to be created.
    publicNetworkAccessEnabled Boolean
    Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. Defaults to false. Possible values are true and false.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Azure Arc Private Link Scope.
    resourceGroupName string
    The name of the Resource Group where the Azure Arc Private Link Scope should exist. Changing this forces a new Azure Arc Private Link Scope to be created.
    location string
    The Azure Region where the Arc Private Link Scope should exist. Changing this forces a new Azure Arc Private Link Scope to be created.
    name string
    The name which should be used for the Azure Arc Private Link Scope. Changing this forces a new Azure Arc Private Link Scope to be created.
    publicNetworkAccessEnabled boolean
    Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. Defaults to false. Possible values are true and false.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Azure Arc Private Link Scope.
    resource_group_name str
    The name of the Resource Group where the Azure Arc Private Link Scope should exist. Changing this forces a new Azure Arc Private Link Scope to be created.
    location str
    The Azure Region where the Arc Private Link Scope should exist. Changing this forces a new Azure Arc Private Link Scope to be created.
    name str
    The name which should be used for the Azure Arc Private Link Scope. Changing this forces a new Azure Arc Private Link Scope to be created.
    public_network_access_enabled bool
    Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. Defaults to false. Possible values are true and false.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Azure Arc Private Link Scope.
    resourceGroupName String
    The name of the Resource Group where the Azure Arc Private Link Scope should exist. Changing this forces a new Azure Arc Private Link Scope to be created.
    location String
    The Azure Region where the Arc Private Link Scope should exist. Changing this forces a new Azure Arc Private Link Scope to be created.
    name String
    The name which should be used for the Azure Arc Private Link Scope. Changing this forces a new Azure Arc Private Link Scope to be created.
    publicNetworkAccessEnabled Boolean
    Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. Defaults to false. Possible values are true and false.
    tags Map<String>
    A mapping of tags which should be assigned to the Azure Arc 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,
        location: Optional[str] = None,
        name: Optional[str] = None,
        public_network_access_enabled: Optional[bool] = 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:
    Location string
    The Azure Region where the Arc Private Link Scope should exist. Changing this forces a new Azure Arc Private Link Scope to be created.
    Name string
    The name which should be used for the Azure Arc Private Link Scope. Changing this forces a new Azure Arc Private Link Scope to be created.
    PublicNetworkAccessEnabled bool
    Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. Defaults to false. Possible values are true and false.
    ResourceGroupName string
    The name of the Resource Group where the Azure Arc Private Link Scope should exist. Changing this forces a new Azure Arc Private Link Scope to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Azure Arc Private Link Scope.
    Location string
    The Azure Region where the Arc Private Link Scope should exist. Changing this forces a new Azure Arc Private Link Scope to be created.
    Name string
    The name which should be used for the Azure Arc Private Link Scope. Changing this forces a new Azure Arc Private Link Scope to be created.
    PublicNetworkAccessEnabled bool
    Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. Defaults to false. Possible values are true and false.
    ResourceGroupName string
    The name of the Resource Group where the Azure Arc Private Link Scope should exist. Changing this forces a new Azure Arc Private Link Scope to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Azure Arc Private Link Scope.
    location String
    The Azure Region where the Arc Private Link Scope should exist. Changing this forces a new Azure Arc Private Link Scope to be created.
    name String
    The name which should be used for the Azure Arc Private Link Scope. Changing this forces a new Azure Arc Private Link Scope to be created.
    publicNetworkAccessEnabled Boolean
    Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. Defaults to false. Possible values are true and false.
    resourceGroupName String
    The name of the Resource Group where the Azure Arc Private Link Scope should exist. Changing this forces a new Azure Arc Private Link Scope to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Azure Arc Private Link Scope.
    location string
    The Azure Region where the Arc Private Link Scope should exist. Changing this forces a new Azure Arc Private Link Scope to be created.
    name string
    The name which should be used for the Azure Arc Private Link Scope. Changing this forces a new Azure Arc Private Link Scope to be created.
    publicNetworkAccessEnabled boolean
    Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. Defaults to false. Possible values are true and false.
    resourceGroupName string
    The name of the Resource Group where the Azure Arc Private Link Scope should exist. Changing this forces a new Azure Arc Private Link Scope to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Azure Arc Private Link Scope.
    location str
    The Azure Region where the Arc Private Link Scope should exist. Changing this forces a new Azure Arc Private Link Scope to be created.
    name str
    The name which should be used for the Azure Arc Private Link Scope. Changing this forces a new Azure Arc Private Link Scope to be created.
    public_network_access_enabled bool
    Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. Defaults to false. Possible values are true and false.
    resource_group_name str
    The name of the Resource Group where the Azure Arc Private Link Scope should exist. Changing this forces a new Azure Arc Private Link Scope to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Azure Arc Private Link Scope.
    location String
    The Azure Region where the Arc Private Link Scope should exist. Changing this forces a new Azure Arc Private Link Scope to be created.
    name String
    The name which should be used for the Azure Arc Private Link Scope. Changing this forces a new Azure Arc Private Link Scope to be created.
    publicNetworkAccessEnabled Boolean
    Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. Defaults to false. Possible values are true and false.
    resourceGroupName String
    The name of the Resource Group where the Azure Arc Private Link Scope should exist. Changing this forces a new Azure Arc Private Link Scope to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Azure Arc Private Link Scope.

    Import

    Azure Arc Private Link Scope can be imported using the resource id, e.g.

    $ pulumi import azure:arc/privateLinkScope:PrivateLinkScope example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScope1

    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
    pulumi/pulumi-azure