1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. NspLink
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi

azure-native.network.NspLink

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi

    The network security perimeter link resource Azure REST API version: 2021-02-01-preview.

    Other available API versions: 2023-07-01-preview, 2023-08-01-preview.

    Example Usage

    NspLinksPut

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var nspLink = new AzureNative.Network.NspLink("nspLink", new()
        {
            AutoApprovedRemotePerimeterResourceId = "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2",
            LinkName = "link1",
            NetworkSecurityPerimeterName = "nsp1",
            ResourceGroupName = "rg1",
        });
    
    });
    
    package main
    
    import (
    	network "github.com/pulumi/pulumi-azure-native-sdk/network/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := network.NewNspLink(ctx, "nspLink", &network.NspLinkArgs{
    			AutoApprovedRemotePerimeterResourceId: pulumi.String("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2"),
    			LinkName:                              pulumi.String("link1"),
    			NetworkSecurityPerimeterName:          pulumi.String("nsp1"),
    			ResourceGroupName:                     pulumi.String("rg1"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.network.NspLink;
    import com.pulumi.azurenative.network.NspLinkArgs;
    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 nspLink = new NspLink("nspLink", NspLinkArgs.builder()
                .autoApprovedRemotePerimeterResourceId("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2")
                .linkName("link1")
                .networkSecurityPerimeterName("nsp1")
                .resourceGroupName("rg1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    nsp_link = azure_native.network.NspLink("nspLink",
        auto_approved_remote_perimeter_resource_id="/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2",
        link_name="link1",
        network_security_perimeter_name="nsp1",
        resource_group_name="rg1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const nspLink = new azure_native.network.NspLink("nspLink", {
        autoApprovedRemotePerimeterResourceId: "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2",
        linkName: "link1",
        networkSecurityPerimeterName: "nsp1",
        resourceGroupName: "rg1",
    });
    
    resources:
      nspLink:
        type: azure-native:network:NspLink
        properties:
          autoApprovedRemotePerimeterResourceId: /subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2
          linkName: link1
          networkSecurityPerimeterName: nsp1
          resourceGroupName: rg1
    

    Create NspLink Resource

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

    Constructor syntax

    new NspLink(name: string, args: NspLinkArgs, opts?: CustomResourceOptions);
    @overload
    def NspLink(resource_name: str,
                args: NspLinkArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def NspLink(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                network_security_perimeter_name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                auto_approved_remote_perimeter_resource_id: Optional[str] = None,
                description: Optional[str] = None,
                link_name: Optional[str] = None,
                local_inbound_profiles: Optional[Sequence[str]] = None,
                remote_inbound_profiles: Optional[Sequence[str]] = None)
    func NewNspLink(ctx *Context, name string, args NspLinkArgs, opts ...ResourceOption) (*NspLink, error)
    public NspLink(string name, NspLinkArgs args, CustomResourceOptions? opts = null)
    public NspLink(String name, NspLinkArgs args)
    public NspLink(String name, NspLinkArgs args, CustomResourceOptions options)
    
    type: azure-native:network:NspLink
    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 NspLinkArgs
    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 NspLinkArgs
    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 NspLinkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NspLinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NspLinkArgs
    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 nspLinkResource = new AzureNative.Network.NspLink("nspLinkResource", new()
    {
        NetworkSecurityPerimeterName = "string",
        ResourceGroupName = "string",
        AutoApprovedRemotePerimeterResourceId = "string",
        Description = "string",
        LinkName = "string",
        LocalInboundProfiles = new[]
        {
            "string",
        },
        RemoteInboundProfiles = new[]
        {
            "string",
        },
    });
    
    example, err := network.NewNspLink(ctx, "nspLinkResource", &network.NspLinkArgs{
    	NetworkSecurityPerimeterName:          pulumi.String("string"),
    	ResourceGroupName:                     pulumi.String("string"),
    	AutoApprovedRemotePerimeterResourceId: pulumi.String("string"),
    	Description:                           pulumi.String("string"),
    	LinkName:                              pulumi.String("string"),
    	LocalInboundProfiles: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	RemoteInboundProfiles: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var nspLinkResource = new NspLink("nspLinkResource", NspLinkArgs.builder()
        .networkSecurityPerimeterName("string")
        .resourceGroupName("string")
        .autoApprovedRemotePerimeterResourceId("string")
        .description("string")
        .linkName("string")
        .localInboundProfiles("string")
        .remoteInboundProfiles("string")
        .build());
    
    nsp_link_resource = azure_native.network.NspLink("nspLinkResource",
        network_security_perimeter_name="string",
        resource_group_name="string",
        auto_approved_remote_perimeter_resource_id="string",
        description="string",
        link_name="string",
        local_inbound_profiles=["string"],
        remote_inbound_profiles=["string"])
    
    const nspLinkResource = new azure_native.network.NspLink("nspLinkResource", {
        networkSecurityPerimeterName: "string",
        resourceGroupName: "string",
        autoApprovedRemotePerimeterResourceId: "string",
        description: "string",
        linkName: "string",
        localInboundProfiles: ["string"],
        remoteInboundProfiles: ["string"],
    });
    
    type: azure-native:network:NspLink
    properties:
        autoApprovedRemotePerimeterResourceId: string
        description: string
        linkName: string
        localInboundProfiles:
            - string
        networkSecurityPerimeterName: string
        remoteInboundProfiles:
            - string
        resourceGroupName: string
    

    NspLink Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The NspLink resource accepts the following input properties:

    NetworkSecurityPerimeterName string
    The name of the network security perimeter.
    ResourceGroupName string
    The name of the resource group.
    AutoApprovedRemotePerimeterResourceId string
    Perimeter ARM Id for the remote NSP with which the link gets created in Auto-approval mode. It should be used when the NSP admin have Microsoft.Network/networkSecurityPerimeters/linkPerimeter/action permission on the remote NSP resource.
    Description string
    A message passed to the owner of the remote NSP link resource with this connection request. In case of Auto-approved flow, it is default to 'Auto Approved'. Restricted to 140 chars.
    LinkName string
    The name of the NSP link.
    LocalInboundProfiles List<string>
    Local Inbound profile names to which Inbound is allowed. Use [''] to allow inbound to all profiles. It's default value is [''].
    RemoteInboundProfiles List<string>
    Remote Inbound profile names to which Inbound is allowed. Use [''] to allow inbound to all profiles. This property can only be updated in auto-approval mode. It's default value is [''].
    NetworkSecurityPerimeterName string
    The name of the network security perimeter.
    ResourceGroupName string
    The name of the resource group.
    AutoApprovedRemotePerimeterResourceId string
    Perimeter ARM Id for the remote NSP with which the link gets created in Auto-approval mode. It should be used when the NSP admin have Microsoft.Network/networkSecurityPerimeters/linkPerimeter/action permission on the remote NSP resource.
    Description string
    A message passed to the owner of the remote NSP link resource with this connection request. In case of Auto-approved flow, it is default to 'Auto Approved'. Restricted to 140 chars.
    LinkName string
    The name of the NSP link.
    LocalInboundProfiles []string
    Local Inbound profile names to which Inbound is allowed. Use [''] to allow inbound to all profiles. It's default value is [''].
    RemoteInboundProfiles []string
    Remote Inbound profile names to which Inbound is allowed. Use [''] to allow inbound to all profiles. This property can only be updated in auto-approval mode. It's default value is [''].
    networkSecurityPerimeterName String
    The name of the network security perimeter.
    resourceGroupName String
    The name of the resource group.
    autoApprovedRemotePerimeterResourceId String
    Perimeter ARM Id for the remote NSP with which the link gets created in Auto-approval mode. It should be used when the NSP admin have Microsoft.Network/networkSecurityPerimeters/linkPerimeter/action permission on the remote NSP resource.
    description String
    A message passed to the owner of the remote NSP link resource with this connection request. In case of Auto-approved flow, it is default to 'Auto Approved'. Restricted to 140 chars.
    linkName String
    The name of the NSP link.
    localInboundProfiles List<String>
    Local Inbound profile names to which Inbound is allowed. Use [''] to allow inbound to all profiles. It's default value is [''].
    remoteInboundProfiles List<String>
    Remote Inbound profile names to which Inbound is allowed. Use [''] to allow inbound to all profiles. This property can only be updated in auto-approval mode. It's default value is [''].
    networkSecurityPerimeterName string
    The name of the network security perimeter.
    resourceGroupName string
    The name of the resource group.
    autoApprovedRemotePerimeterResourceId string
    Perimeter ARM Id for the remote NSP with which the link gets created in Auto-approval mode. It should be used when the NSP admin have Microsoft.Network/networkSecurityPerimeters/linkPerimeter/action permission on the remote NSP resource.
    description string
    A message passed to the owner of the remote NSP link resource with this connection request. In case of Auto-approved flow, it is default to 'Auto Approved'. Restricted to 140 chars.
    linkName string
    The name of the NSP link.
    localInboundProfiles string[]
    Local Inbound profile names to which Inbound is allowed. Use [''] to allow inbound to all profiles. It's default value is [''].
    remoteInboundProfiles string[]
    Remote Inbound profile names to which Inbound is allowed. Use [''] to allow inbound to all profiles. This property can only be updated in auto-approval mode. It's default value is [''].
    network_security_perimeter_name str
    The name of the network security perimeter.
    resource_group_name str
    The name of the resource group.
    auto_approved_remote_perimeter_resource_id str
    Perimeter ARM Id for the remote NSP with which the link gets created in Auto-approval mode. It should be used when the NSP admin have Microsoft.Network/networkSecurityPerimeters/linkPerimeter/action permission on the remote NSP resource.
    description str
    A message passed to the owner of the remote NSP link resource with this connection request. In case of Auto-approved flow, it is default to 'Auto Approved'. Restricted to 140 chars.
    link_name str
    The name of the NSP link.
    local_inbound_profiles Sequence[str]
    Local Inbound profile names to which Inbound is allowed. Use [''] to allow inbound to all profiles. It's default value is [''].
    remote_inbound_profiles Sequence[str]
    Remote Inbound profile names to which Inbound is allowed. Use [''] to allow inbound to all profiles. This property can only be updated in auto-approval mode. It's default value is [''].
    networkSecurityPerimeterName String
    The name of the network security perimeter.
    resourceGroupName String
    The name of the resource group.
    autoApprovedRemotePerimeterResourceId String
    Perimeter ARM Id for the remote NSP with which the link gets created in Auto-approval mode. It should be used when the NSP admin have Microsoft.Network/networkSecurityPerimeters/linkPerimeter/action permission on the remote NSP resource.
    description String
    A message passed to the owner of the remote NSP link resource with this connection request. In case of Auto-approved flow, it is default to 'Auto Approved'. Restricted to 140 chars.
    linkName String
    The name of the NSP link.
    localInboundProfiles List<String>
    Local Inbound profile names to which Inbound is allowed. Use [''] to allow inbound to all profiles. It's default value is [''].
    remoteInboundProfiles List<String>
    Remote Inbound profile names to which Inbound is allowed. Use [''] to allow inbound to all profiles. This property can only be updated in auto-approval mode. It's default value is [''].

    Outputs

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

    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    LocalOutboundProfiles List<string>
    Local Outbound profile names from which Outbound is allowed. In current version, it is readonly property and it's value is set to ['*'] to allow outbound from all profiles. In later version, user will be able to modify it.
    Name string
    Resource name.
    ProvisioningState string
    The provisioning state of the NSP Link resource.
    RemoteOutboundProfiles List<string>
    Remote Outbound profile names from which Outbound is allowed. In current version, it is readonly property and it's value is set to ['*'] to allow outbound from all profiles. In later version, user will be able to modify it.
    RemotePerimeterGuid string
    Remote NSP Guid with which the link gets created.
    RemotePerimeterLocation string
    Remote NSP location with which the link gets created.
    Status string
    The NSP link state.
    Type string
    Resource type.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    LocalOutboundProfiles []string
    Local Outbound profile names from which Outbound is allowed. In current version, it is readonly property and it's value is set to ['*'] to allow outbound from all profiles. In later version, user will be able to modify it.
    Name string
    Resource name.
    ProvisioningState string
    The provisioning state of the NSP Link resource.
    RemoteOutboundProfiles []string
    Remote Outbound profile names from which Outbound is allowed. In current version, it is readonly property and it's value is set to ['*'] to allow outbound from all profiles. In later version, user will be able to modify it.
    RemotePerimeterGuid string
    Remote NSP Guid with which the link gets created.
    RemotePerimeterLocation string
    Remote NSP location with which the link gets created.
    Status string
    The NSP link state.
    Type string
    Resource type.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    The provider-assigned unique ID for this managed resource.
    localOutboundProfiles List<String>
    Local Outbound profile names from which Outbound is allowed. In current version, it is readonly property and it's value is set to ['*'] to allow outbound from all profiles. In later version, user will be able to modify it.
    name String
    Resource name.
    provisioningState String
    The provisioning state of the NSP Link resource.
    remoteOutboundProfiles List<String>
    Remote Outbound profile names from which Outbound is allowed. In current version, it is readonly property and it's value is set to ['*'] to allow outbound from all profiles. In later version, user will be able to modify it.
    remotePerimeterGuid String
    Remote NSP Guid with which the link gets created.
    remotePerimeterLocation String
    Remote NSP location with which the link gets created.
    status String
    The NSP link state.
    type String
    Resource type.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    id string
    The provider-assigned unique ID for this managed resource.
    localOutboundProfiles string[]
    Local Outbound profile names from which Outbound is allowed. In current version, it is readonly property and it's value is set to ['*'] to allow outbound from all profiles. In later version, user will be able to modify it.
    name string
    Resource name.
    provisioningState string
    The provisioning state of the NSP Link resource.
    remoteOutboundProfiles string[]
    Remote Outbound profile names from which Outbound is allowed. In current version, it is readonly property and it's value is set to ['*'] to allow outbound from all profiles. In later version, user will be able to modify it.
    remotePerimeterGuid string
    Remote NSP Guid with which the link gets created.
    remotePerimeterLocation string
    Remote NSP location with which the link gets created.
    status string
    The NSP link state.
    type string
    Resource type.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    id str
    The provider-assigned unique ID for this managed resource.
    local_outbound_profiles Sequence[str]
    Local Outbound profile names from which Outbound is allowed. In current version, it is readonly property and it's value is set to ['*'] to allow outbound from all profiles. In later version, user will be able to modify it.
    name str
    Resource name.
    provisioning_state str
    The provisioning state of the NSP Link resource.
    remote_outbound_profiles Sequence[str]
    Remote Outbound profile names from which Outbound is allowed. In current version, it is readonly property and it's value is set to ['*'] to allow outbound from all profiles. In later version, user will be able to modify it.
    remote_perimeter_guid str
    Remote NSP Guid with which the link gets created.
    remote_perimeter_location str
    Remote NSP location with which the link gets created.
    status str
    The NSP link state.
    type str
    Resource type.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    The provider-assigned unique ID for this managed resource.
    localOutboundProfiles List<String>
    Local Outbound profile names from which Outbound is allowed. In current version, it is readonly property and it's value is set to ['*'] to allow outbound from all profiles. In later version, user will be able to modify it.
    name String
    Resource name.
    provisioningState String
    The provisioning state of the NSP Link resource.
    remoteOutboundProfiles List<String>
    Remote Outbound profile names from which Outbound is allowed. In current version, it is readonly property and it's value is set to ['*'] to allow outbound from all profiles. In later version, user will be able to modify it.
    remotePerimeterGuid String
    Remote NSP Guid with which the link gets created.
    remotePerimeterLocation String
    Remote NSP location with which the link gets created.
    status String
    The NSP link state.
    type String
    Resource type.

    Import

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

    $ pulumi import azure-native:network:NspLink link1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/links/{linkName} 
    

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi