Network Security Perimeter Configurations - List

Service:

Event Grid

API Version:

2025-04-01-preview

Get all network security perimeter configurations for resource.
Get all network security perimeter configurations associated with a topic or domain.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{resourceType}/{resourceName}/networkSecurityPerimeterConfigurations?api-version=2025-04-01-preview

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group within the user's subscription.
resourceName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-zA-Z0-9-]*$	The name of the resource (namely, either, the topic name or domain name).
resourceType	path	True	NetworkSecurityPerimeterResourceType	The type of the resource. This can be either 'topics' or 'domains'.
subscriptionId	path	True	string	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Version of the API to be used with the client request.

Responses

Name	Type	Description
200 OK	NetworkSecurityPerimeterConfigurationList	OK
Other Status Codes	ErrorResponse	Error response returned if request was unsuccessful.

Examples

NetworkSecurityPerimeterConfigurations_List

Sample request

HTTP

GET https://management.azure.com/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampleResourceName/networkSecurityPerimeterConfigurations?api-version=2025-04-01-preview

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.EventGrid;

// Generated from example definition: specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2025-04-01-preview/examples/NetworkSecurityPerimeterConfigurations_List.json
// this example is just showing the usage of "NetworkSecurityPerimeterConfigurations_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this EventGridTopicResource created on azure
// for more information of creating EventGridTopicResource, please refer to the document of EventGridTopicResource
string subscriptionId = "8f6b6269-84f2-4d09-9e31-1127efcd1e40";
string resourceGroupName = "examplerg";
string resourceName = "exampleResourceName";
ResourceIdentifier eventGridTopicResourceId = EventGridTopicResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, resourceName);
EventGridTopicResource eventGridTopic = client.GetEventGridTopicResource(eventGridTopicResourceId);

// get the collection of this TopicNetworkSecurityPerimeterConfigurationResource
TopicNetworkSecurityPerimeterConfigurationCollection collection = eventGridTopic.GetTopicNetworkSecurityPerimeterConfigurations();

// invoke the operation and iterate over the result
await foreach (NetworkSecurityPerimeterConfigurationData item in collection.GetAllAsync())
{
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {item.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "properties": {
        "provisioningState": "Succeeded",
        "networkSecurityPerimeter": {
          "id": "/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/perimeterrg/providers/Microsoft.Network/networkSecurityPerimeters/somePerimeter",
          "perimeterGuid": "8f6b6269-84f2-4d09-9e31-1127efcd1e40perimeter",
          "location": "West US"
        },
        "resourceAssociation": {
          "name": "someAssociation",
          "accessMode": "Enforced"
        },
        "profile": {
          "name": "someProfile",
          "accessRulesVersion": "1",
          "accessRules": [
            {
              "name": "ipRule",
              "properties": {
                "direction": "Inbound",
                "addressPrefixes": [
                  "148.0.0.0/8"
                ]
              }
            }
          ],
          "diagnosticSettingsVersion": "1",
          "enabledLogCategories": [
            "NspOutbound"
          ]
        }
      },
      "id": "/subscriptions//resourceGroups/paasrg/providers/Microsoft.EventGrid/topics/egtopic/networkSecurityPerimeterConfigurations/8f6b6269-84f2-4d09-9e31-1127efcd1e40perimeter.someAssociation",
      "name": "8f6b6269-84f2-4d09-9e31-1127efcd1e40perimeter.someAssociation",
      "type": "Microsoft.EventGrid/topics/networkSecurityPerimeterConfigurations"
    }
  ]
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
NetworkSecurityPerimeterAssociationAccessMode	Network security perimeter access mode.
NetworkSecurityPerimeterConfigProvisioningState	Provisioning state to reflect configuration state and indicate status of nsp profile configuration retrieval.
NetworkSecurityPerimeterConfiguration	Network security perimeter configuration.
NetworkSecurityPerimeterConfigurationIssues	Network security perimeter configuration issues.
NetworkSecurityPerimeterConfigurationIssueSeverity	Provisioning issue severity.
NetworkSecurityPerimeterConfigurationIssueType	Provisioning issue type.
NetworkSecurityPerimeterConfigurationList	Network security perimeter configuration List.
NetworkSecurityPerimeterConfigurationProfile	Nsp configuration with profile information.
NetworkSecurityPerimeterInfo	Network security perimeter info.
NetworkSecurityPerimeterProfileAccessRule	Network security perimeter profile access rule.
NetworkSecurityPerimeterProfileAccessRuleDirection	NSP access rule direction.
NetworkSecurityPerimeterResourceType	The type of the resource. This can be either 'topics' or 'domains'.
NetworkSecurityPerimeterSubscription	Network security perimeter subscription inbound access rule.
ResourceAssociation	Nsp resource association

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

NetworkSecurityPerimeterAssociationAccessMode

Enumeration

Network security perimeter access mode.

Value	Description
Learning
Enforced
Audit

NetworkSecurityPerimeterConfigProvisioningState

Enumeration

Provisioning state to reflect configuration state and indicate status of nsp profile configuration retrieval.

Value	Description
Creating
Updating
Deleting
Succeeded
Canceled
Failed
Deleted
Accepted

NetworkSecurityPerimeterConfiguration

Object

Network security perimeter configuration.

Name	Type	Description
id	string	Fully qualified identifier of the resource.
name	string	Name of the resource.
properties.networkSecurityPerimeter	NetworkSecurityPerimeterInfo	Perimeter info for nsp association.
properties.profile	NetworkSecurityPerimeterConfigurationProfile	Nsp profile configuration, access rules and diagnostic settings.
properties.provisioningIssues	NetworkSecurityPerimeterConfigurationIssues[]	Provisioning issues to reflect status when attempting to retrieve nsp profile configuration.
properties.provisioningState	NetworkSecurityPerimeterConfigProvisioningState	Provisioning state to reflect configuration state and indicate status of nsp profile configuration retrieval.
properties.resourceAssociation	ResourceAssociation	Nsp association name and access mode of association.
type	string	Type of the resource.

NetworkSecurityPerimeterConfigurationIssues

Object

Network security perimeter configuration issues.

Name	Type	Description
name	string	Provisioning issue name.
properties.description	string	Provisioning issue description.
properties.issueType	NetworkSecurityPerimeterConfigurationIssueType	Provisioning issue type.
properties.severity	NetworkSecurityPerimeterConfigurationIssueSeverity	Provisioning issue severity.
properties.suggestedAccessRules	string[]	Access rules that can be added to the same profile to remediate the issue.
properties.suggestedResourceIds	string[]	ARM IDs of resources that can be associated to the same perimeter to remediate the issue.

NetworkSecurityPerimeterConfigurationIssueSeverity

Enumeration

Provisioning issue severity.

Value	Description
Warning
Error

NetworkSecurityPerimeterConfigurationIssueType

Enumeration

Provisioning issue type.

Value	Description
MissingPerimeterConfiguration
MissingIdentityConfiguration
ConfigurationPropagationFailure
Other

NetworkSecurityPerimeterConfigurationList

Object

Network security perimeter configuration List.

Name	Type	Description
nextLink	string	A link for the next page of Network Security Perimeter Configuration.
value	NetworkSecurityPerimeterConfiguration[]	List of all network security parameter configurations.

NetworkSecurityPerimeterConfigurationProfile

Object

Nsp configuration with profile information.

Name	Type	Description
accessRules	NetworkSecurityPerimeterProfileAccessRule[]	List of inbound or outbound access rule setup on the nsp profile.
accessRulesVersion	string	Access rules version number for nsp profile.
diagnosticSettingsVersion	string	Diagnostic settings version number for nsp profile.
enabledLogCategories	string[]	Enabled log categories for nsp profile.
name	string	Nsp configuration profile name.

NetworkSecurityPerimeterInfo

Object

Network security perimeter info.

Name	Type	Description
id	string	Arm id for network security perimeter.
location	string	Network security perimeter location.
perimeterGuid	string	Network security perimeter guid.

NetworkSecurityPerimeterProfileAccessRule

Object

Network security perimeter profile access rule.

Name	Type	Description
fullyQualifiedArmId	string	Fully Qualified Arm id for network security perimeter profile access rule.
name	string	Name for nsp access rule.
properties.addressPrefixes	string[]	Address prefixes.
properties.direction	NetworkSecurityPerimeterProfileAccessRuleDirection	NSP access rule direction.
properties.emailAddresses	string[]	List of email addresses.
properties.fullyQualifiedDomainNames	string[]	Fully qualified domain names.
properties.networkSecurityPerimeters	NetworkSecurityPerimeterInfo[]	Network security perimeters.
properties.phoneNumbers	string[]	List of phone numbers.
properties.subscriptions	NetworkSecurityPerimeterSubscription[]	List of subscriptions.
type	string	nsp access rule type.

NetworkSecurityPerimeterProfileAccessRuleDirection

Enumeration

NSP access rule direction.

Value	Description
Inbound
Outbound

NetworkSecurityPerimeterResourceType

Enumeration

The type of the resource. This can be either 'topics' or 'domains'.

Value	Description
topics
domains

NetworkSecurityPerimeterSubscription

Object

Network security perimeter subscription inbound access rule.

Name	Type	Description
id	string	Subscription id.

ResourceAssociation

Object

Nsp resource association

Name	Type	Description
accessMode	NetworkSecurityPerimeterAssociationAccessMode	Network security perimeter access mode.
name	string	Association name