Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. network
  5. getNspLink
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.network.getNspLink

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the specified NSP link resource. Azure REST API version: 2021-02-01-preview.

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

Using getNspLink

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getNspLink(args: GetNspLinkArgs, opts?: InvokeOptions): Promise<GetNspLinkResult>
function getNspLinkOutput(args: GetNspLinkOutputArgs, opts?: InvokeOptions): Output<GetNspLinkResult>
Copy
def get_nsp_link(link_name: Optional[str] = None,
                 network_security_perimeter_name: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetNspLinkResult
def get_nsp_link_output(link_name: Optional[pulumi.Input[str]] = None,
                 network_security_perimeter_name: Optional[pulumi.Input[str]] = None,
                 resource_group_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetNspLinkResult]
Copy
func LookupNspLink(ctx *Context, args *LookupNspLinkArgs, opts ...InvokeOption) (*LookupNspLinkResult, error)
func LookupNspLinkOutput(ctx *Context, args *LookupNspLinkOutputArgs, opts ...InvokeOption) LookupNspLinkResultOutput
Copy

> Note: This function is named LookupNspLink in the Go SDK.

public static class GetNspLink 
{
    public static Task<GetNspLinkResult> InvokeAsync(GetNspLinkArgs args, InvokeOptions? opts = null)
    public static Output<GetNspLinkResult> Invoke(GetNspLinkInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNspLinkResult> getNspLink(GetNspLinkArgs args, InvokeOptions options)
public static Output<GetNspLinkResult> getNspLink(GetNspLinkArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getNspLink
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

LinkName
This property is required.
Changes to this property will trigger replacement.
string
The name of the NSP link.
NetworkSecurityPerimeterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network security perimeter.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
LinkName
This property is required.
Changes to this property will trigger replacement.
string
The name of the NSP link.
NetworkSecurityPerimeterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network security perimeter.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
linkName
This property is required.
Changes to this property will trigger replacement.
String
The name of the NSP link.
networkSecurityPerimeterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network security perimeter.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
linkName
This property is required.
Changes to this property will trigger replacement.
string
The name of the NSP link.
networkSecurityPerimeterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network security perimeter.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
link_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the NSP link.
network_security_perimeter_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the network security perimeter.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
linkName
This property is required.
Changes to this property will trigger replacement.
String
The name of the NSP link.
networkSecurityPerimeterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network security perimeter.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.

getNspLink Result

The following output properties are available:

Etag string
A unique read-only string that changes whenever the resource is updated.
Id string
Resource ID.
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.
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.
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 [''].
Etag string
A unique read-only string that changes whenever the resource is updated.
Id string
Resource ID.
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.
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.
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 [''].
etag String
A unique read-only string that changes whenever the resource is updated.
id String
Resource ID.
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.
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.
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 [''].
etag string
A unique read-only string that changes whenever the resource is updated.
id string
Resource ID.
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.
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.
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 [''].
etag str
A unique read-only string that changes whenever the resource is updated.
id str
Resource ID.
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.
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.
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 [''].
etag String
A unique read-only string that changes whenever the resource is updated.
id String
Resource ID.
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.
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.
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 [''].

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native