Network Security Perimeter Configurations - List By Private Link Scope

Service:: Hybrid Compute

API Version:: 2025-01-13

Lists the network security perimeter configurations for a private link scope.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/networkSecurityPerimeterConfigurations?api-version=2025-01-13

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
scopeName	path	True	string pattern: [a-zA-Z0-9-_\.]+	The name of the Azure Arc PrivateLinkScope resource.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	NetworkSecurityPerimeterConfigurationListResult	Successfully retrieved network security perimeter configuration details.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Gets the list of network security perimeter configurations of the private link scope.

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/my-resource-group/providers/Microsoft.HybridCompute/privateLinkScopes/my-privatelinkscope/networkSecurityPerimeterConfigurations?api-version=2025-01-13

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/my-resource-group/providers/Microsoft.HybridCompute/privateLinkScopes/my-privatelinkscope/networkSecurityPerimeterConfigurations/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee.myAssociation",
      "name": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee.myAssociation",
      "type": "Microsoft.HybridCompute/privateLinkScopes/networkSecurityPerimeterConfigurations",
      "properties": {
        "provisioningState": "Accepted",
        "provisioningIssues": [],
        "networkSecurityPerimeter": {
          "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/networkSecurityPerimeters/myPerimeter",
          "perimeterGuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
          "location": "westus"
        },
        "resourceAssociation": {
          "name": "myAssociation",
          "accessMode": "enforced"
        },
        "profile": {
          "name": "myProfile",
          "accessRulesVersion": 1,
          "accessRules": [
            {
              "name": "myAccessRule",
              "properties": {
                "direction": "Inbound",
                "addressPrefixes": [
                  "148.0.0.0/8",
                  "152.4.6.0/24",
                  "..."
                ]
              }
            }
          ],
          "diagnosticSettingsVersion": 1,
          "enabledLogCategories": []
        }
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/my-resource-group/providers/Microsoft.HybridCompute/privateLinkScopes/my-privatelinkscope/networkSecurityPerimeterConfigurations/37364608-77ea-4c2a-bdc3-4b0b1cdfab15.myAssociation2",
      "name": "aaaaaaaa-0000-cccc-1111-eeeeeeeeeeee.myAssociation2",
      "type": "Microsoft.HybridCompute/privateLinkScopes/networkSecurityPerimeterConfigurations",
      "properties": {
        "provisioningState": "Accepted",
        "provisioningIssues": [],
        "networkSecurityPerimeter": {
          "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/networkSecurityPerimeters/myOtherPerimeter",
          "perimeterGuid": "aaaaaaaa-0000-cccc-1111-eeeeeeeeeeee",
          "location": "westus"
        },
        "resourceAssociation": {
          "name": "myAssociation",
          "accessMode": "learning"
        },
        "profile": {
          "name": "myProfile",
          "accessRulesVersion": 1,
          "accessRules": [
            {
              "name": "myAccessRule",
              "properties": {
                "direction": "Inbound",
                "addressPrefixes": [
                  "122.0.0.0/8",
                  "144.4.6.0/24",
                  "..."
                ]
              }
            }
          ],
          "diagnosticSettingsVersion": 1,
          "enabledLogCategories": []
        }
      }
    }
  ]
}

Definitions

Name	Description
AccessMode	Property that impacts a resource's logging behavior and its connectivity with other resources and public networks.
AccessRule	Access rule.
AccessRuleDirection	Indicates direction of an access rule.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
NetworkSecurityPerimeter	Properties that define a Network Security Perimeter resource.
NetworkSecurityPerimeterConfiguration	Properties that define a Network Security Perimeter resource.
NetworkSecurityPerimeterConfigurationListResult	A list of network security perimeter configurations.
NetworkSecurityPerimeterProfile	Network Security Perimeter profile
ProvisioningIssue	Details on issues that occurred during provisioning.
ProvisioningIssueSeverity	Severity of the provisioning issue.
ProvisioningIssueType	Type of provisioning issue.
ResourceAssociation	Properties that define a Resource Association.

AccessMode

Enumeration

Property that impacts a resource's logging behavior and its connectivity with other resources and public networks.

Value	Description
enforced	Indicates that resource access is controlled by the NSP definition.
audit	Dry run mode, where traffic is evaluated against NSP Rules, logged but not enforced.
learning	Enables traffic evaluation to fall back to resource-specific firewall configurations.

AccessRule

Object

Access rule.

Name	Type	Description
name	string	Name of the access rule.
properties.addressPrefixes	string[]	Address prefixes that are allowed access.
properties.direction	AccessRuleDirection	Direction of the access rule.

AccessRuleDirection

Enumeration

Indicates direction of an access rule.

Value	Description
Inbound	Traffic originates outside of network.
Outbound	Traffic originates inside the network

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.