1. Packages
  2. Azure Native v2
  3. API Docs
  4. network
  5. getNspAccessRule
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

azure-native-v2.network.getNspAccessRule

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

Gets the specified NSP access rule by name. Azure REST API version: 2021-02-01-preview.

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

Using getNspAccessRule

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 getNspAccessRule(args: GetNspAccessRuleArgs, opts?: InvokeOptions): Promise<GetNspAccessRuleResult>
function getNspAccessRuleOutput(args: GetNspAccessRuleOutputArgs, opts?: InvokeOptions): Output<GetNspAccessRuleResult>
Copy
def get_nsp_access_rule(access_rule_name: Optional[str] = None,
                        network_security_perimeter_name: Optional[str] = None,
                        profile_name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetNspAccessRuleResult
def get_nsp_access_rule_output(access_rule_name: Optional[pulumi.Input[str]] = None,
                        network_security_perimeter_name: Optional[pulumi.Input[str]] = None,
                        profile_name: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetNspAccessRuleResult]
Copy
func LookupNspAccessRule(ctx *Context, args *LookupNspAccessRuleArgs, opts ...InvokeOption) (*LookupNspAccessRuleResult, error)
func LookupNspAccessRuleOutput(ctx *Context, args *LookupNspAccessRuleOutputArgs, opts ...InvokeOption) LookupNspAccessRuleResultOutput
Copy

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

public static class GetNspAccessRule 
{
    public static Task<GetNspAccessRuleResult> InvokeAsync(GetNspAccessRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetNspAccessRuleResult> Invoke(GetNspAccessRuleInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNspAccessRuleResult> getNspAccessRule(GetNspAccessRuleArgs args, InvokeOptions options)
public static Output<GetNspAccessRuleResult> getNspAccessRule(GetNspAccessRuleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getNspAccessRule
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccessRuleName
This property is required.
Changes to this property will trigger replacement.
string
The name of the NSP access rule.
NetworkSecurityPerimeterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network security perimeter.
ProfileName
This property is required.
Changes to this property will trigger replacement.
string
The name of the NSP profile.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
AccessRuleName
This property is required.
Changes to this property will trigger replacement.
string
The name of the NSP access rule.
NetworkSecurityPerimeterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network security perimeter.
ProfileName
This property is required.
Changes to this property will trigger replacement.
string
The name of the NSP profile.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
accessRuleName
This property is required.
Changes to this property will trigger replacement.
String
The name of the NSP access rule.
networkSecurityPerimeterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network security perimeter.
profileName
This property is required.
Changes to this property will trigger replacement.
String
The name of the NSP profile.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
accessRuleName
This property is required.
Changes to this property will trigger replacement.
string
The name of the NSP access rule.
networkSecurityPerimeterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network security perimeter.
profileName
This property is required.
Changes to this property will trigger replacement.
string
The name of the NSP profile.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
access_rule_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the NSP access rule.
network_security_perimeter_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the network security perimeter.
profile_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the NSP profile.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
accessRuleName
This property is required.
Changes to this property will trigger replacement.
String
The name of the NSP access rule.
networkSecurityPerimeterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network security perimeter.
profileName
This property is required.
Changes to this property will trigger replacement.
String
The name of the NSP profile.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.

getNspAccessRule Result

The following output properties are available:

Id string
Resource ID.
Name string
Resource name.
NetworkSecurityPerimeters List<Pulumi.AzureNative.Network.Outputs.PerimeterBasedAccessRuleResponse>
Rule specified by the perimeter id.
ProvisioningState string
The provisioning state of the scope assignment resource.
Type string
Resource type.
AddressPrefixes List<string>
Inbound address prefixes (IPv4/IPv6)
Direction string
Direction that specifies whether the access rules is inbound/outbound.
EmailAddresses List<string>
Outbound rules email address format.
FullyQualifiedDomainNames List<string>
Outbound rules fully qualified domain name format.
Location string
Resource location.
PhoneNumbers List<string>
Outbound rules phone number format.
Subscriptions List<Pulumi.AzureNative.Network.Outputs.SubscriptionIdResponse>
List of subscription ids
Tags Dictionary<string, string>
Resource tags.
Id string
Resource ID.
Name string
Resource name.
NetworkSecurityPerimeters []PerimeterBasedAccessRuleResponse
Rule specified by the perimeter id.
ProvisioningState string
The provisioning state of the scope assignment resource.
Type string
Resource type.
AddressPrefixes []string
Inbound address prefixes (IPv4/IPv6)
Direction string
Direction that specifies whether the access rules is inbound/outbound.
EmailAddresses []string
Outbound rules email address format.
FullyQualifiedDomainNames []string
Outbound rules fully qualified domain name format.
Location string
Resource location.
PhoneNumbers []string
Outbound rules phone number format.
Subscriptions []SubscriptionIdResponse
List of subscription ids
Tags map[string]string
Resource tags.
id String
Resource ID.
name String
Resource name.
networkSecurityPerimeters List<PerimeterBasedAccessRuleResponse>
Rule specified by the perimeter id.
provisioningState String
The provisioning state of the scope assignment resource.
type String
Resource type.
addressPrefixes List<String>
Inbound address prefixes (IPv4/IPv6)
direction String
Direction that specifies whether the access rules is inbound/outbound.
emailAddresses List<String>
Outbound rules email address format.
fullyQualifiedDomainNames List<String>
Outbound rules fully qualified domain name format.
location String
Resource location.
phoneNumbers List<String>
Outbound rules phone number format.
subscriptions List<SubscriptionIdResponse>
List of subscription ids
tags Map<String,String>
Resource tags.
id string
Resource ID.
name string
Resource name.
networkSecurityPerimeters PerimeterBasedAccessRuleResponse[]
Rule specified by the perimeter id.
provisioningState string
The provisioning state of the scope assignment resource.
type string
Resource type.
addressPrefixes string[]
Inbound address prefixes (IPv4/IPv6)
direction string
Direction that specifies whether the access rules is inbound/outbound.
emailAddresses string[]
Outbound rules email address format.
fullyQualifiedDomainNames string[]
Outbound rules fully qualified domain name format.
location string
Resource location.
phoneNumbers string[]
Outbound rules phone number format.
subscriptions SubscriptionIdResponse[]
List of subscription ids
tags {[key: string]: string}
Resource tags.
id str
Resource ID.
name str
Resource name.
network_security_perimeters Sequence[PerimeterBasedAccessRuleResponse]
Rule specified by the perimeter id.
provisioning_state str
The provisioning state of the scope assignment resource.
type str
Resource type.
address_prefixes Sequence[str]
Inbound address prefixes (IPv4/IPv6)
direction str
Direction that specifies whether the access rules is inbound/outbound.
email_addresses Sequence[str]
Outbound rules email address format.
fully_qualified_domain_names Sequence[str]
Outbound rules fully qualified domain name format.
location str
Resource location.
phone_numbers Sequence[str]
Outbound rules phone number format.
subscriptions Sequence[SubscriptionIdResponse]
List of subscription ids
tags Mapping[str, str]
Resource tags.
id String
Resource ID.
name String
Resource name.
networkSecurityPerimeters List<Property Map>
Rule specified by the perimeter id.
provisioningState String
The provisioning state of the scope assignment resource.
type String
Resource type.
addressPrefixes List<String>
Inbound address prefixes (IPv4/IPv6)
direction String
Direction that specifies whether the access rules is inbound/outbound.
emailAddresses List<String>
Outbound rules email address format.
fullyQualifiedDomainNames List<String>
Outbound rules fully qualified domain name format.
location String
Resource location.
phoneNumbers List<String>
Outbound rules phone number format.
subscriptions List<Property Map>
List of subscription ids
tags Map<String>
Resource tags.

Supporting Types

PerimeterBasedAccessRuleResponse

Id This property is required. string
NSP id in the ARM id format.
Location This property is required. string
Location of the NSP supplied.
PerimeterGuid This property is required. string
Resource guid of the NSP supplied.
Id This property is required. string
NSP id in the ARM id format.
Location This property is required. string
Location of the NSP supplied.
PerimeterGuid This property is required. string
Resource guid of the NSP supplied.
id This property is required. String
NSP id in the ARM id format.
location This property is required. String
Location of the NSP supplied.
perimeterGuid This property is required. String
Resource guid of the NSP supplied.
id This property is required. string
NSP id in the ARM id format.
location This property is required. string
Location of the NSP supplied.
perimeterGuid This property is required. string
Resource guid of the NSP supplied.
id This property is required. str
NSP id in the ARM id format.
location This property is required. str
Location of the NSP supplied.
perimeter_guid This property is required. str
Resource guid of the NSP supplied.
id This property is required. String
NSP id in the ARM id format.
location This property is required. String
Location of the NSP supplied.
perimeterGuid This property is required. String
Resource guid of the NSP supplied.

SubscriptionIdResponse

Id string
Subscription id in the ARM id format.
Id string
Subscription id in the ARM id format.
id String
Subscription id in the ARM id format.
id string
Subscription id in the ARM id format.
id str
Subscription id in the ARM id format.
id String
Subscription id in the ARM id format.

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