Network Security Perimeter Configurations - Get

Service:

Storage Resource Provider

API Version:

2025-08-01

Gets effective NetworkSecurityPerimeterConfiguration for association

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}?api-version=2025-08-01

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-z0-9]+$	The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
networkSecurityPerimeterConfigurationName	path	True	string pattern: ^.*$	The name for Network Security Perimeter configuration
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	NetworkSecurityPerimeterConfiguration	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

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

NetworkSecurityPerimeterConfigurationGet

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/networkSecurityPerimeterConfigurations/dbedb4e0-40e6-4145-81f3-f1314c150774.resourceAssociation1?api-version=2025-08-01

Sample response

Status code:

200

{
  "name": "dbedb4e0-40e6-4145-81f3-f1314c150774.resourceAssociation1",
  "type": "Microsoft.Storage/storageAccounts/networkSecurityPerimeterConfigurations",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/networkSecurityPerimeterConfigurations/dbedb4e0-40e6-4145-81f3-f1314c150774.resourceAssociation1",
  "properties": {
    "networkSecurityPerimeter": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/res4794/providers/Microsoft.Network/networkSecurityPerimeters/nsp1",
      "location": "East US",
      "perimeterGuid": "ce2d5953-5c15-40ca-9d51-cc3f4a63b0f5"
    },
    "profile": {
      "name": "profile1",
      "accessRules": [
        {
          "name": "allowedSubscriptions",
          "properties": {
            "direction": "Inbound",
            "subscriptions": [
              {
                "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774"
              }
            ]
          }
        }
      ],
      "accessRulesVersion": 10,
      "diagnosticSettingsVersion": 5,
      "enabledLogCategories": [
        "NspPublicInboundPerimeterRulesAllowed",
        "NspPublicInboundPerimeterRulesDenied"
      ]
    },
    "provisioningIssues": [
      {
        "name": "ConfigurationPropagationFailure",
        "properties": {
          "description": "Failed to update Network Security Perimeter association.",
          "issueType": "ConfigurationPropagationFailure",
          "severity": "Error"
        }
      }
    ],
    "provisioningState": "Succeeded",
    "resourceAssociation": {
      "name": "resourceAssociation1",
      "accessMode": "Enforced"
    }
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorResponse	An error response from the storage resource provider.
ErrorResponseBody	Error response body contract.
IssueType	Type of issue
NetworkSecurityPerimeter	NetworkSecurityPerimeter related information
NetworkSecurityPerimeterConfiguration	The Network Security Perimeter configuration resource.
NetworkSecurityPerimeterConfigurationPropertiesProfile	Network Security Perimeter profile
NetworkSecurityPerimeterConfigurationPropertiesResourceAssociation	Information about resource association
NetworkSecurityPerimeterConfigurationProvisioningState	Provisioning state of Network Security Perimeter configuration propagation
NspAccessRule	Information of Access Rule in Network Security Perimeter profile
NspAccessRuleDirection	Direction of Access Rule
NspAccessRuleProperties	Properties of Access Rule
NspAccessRulePropertiesSubscriptionsItem	Subscription for inbound rule
ProvisioningIssue	Describes provisioning issue for given NetworkSecurityPerimeterConfiguration
ProvisioningIssueProperties	Properties of provisioning issue
ResourceAssociationAccessMode	Access Mode of the resource association
Severity	Severity of the issue.
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorResponse

Object

An error response from the storage resource provider.

Name	Type	Description
error	ErrorResponseBody	Azure Storage Resource Provider error response body.

ErrorResponseBody

Object

Error response body contract.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
message	string	A message describing the error, intended to be suitable for display in a user interface.

IssueType

Enumeration

Type of issue

Value	Description
Unknown
ConfigurationPropagationFailure

NetworkSecurityPerimeter

Object

NetworkSecurityPerimeter related information

Name	Type	Description
id	string	The ARM identifier of the resource
location	string	Location of the resource
perimeterGuid	string	Guid of the resource

NetworkSecurityPerimeterConfiguration

Object

The Network Security Perimeter configuration resource.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.networkSecurityPerimeter	NetworkSecurityPerimeter	NetworkSecurityPerimeter related information
properties.profile	NetworkSecurityPerimeterConfigurationPropertiesProfile	Network Security Perimeter profile
properties.provisioningIssues	ProvisioningIssue[]	List of Provisioning Issues if any
properties.provisioningState	NetworkSecurityPerimeterConfigurationProvisioningState	Provisioning state of Network Security Perimeter configuration propagation
properties.resourceAssociation	NetworkSecurityPerimeterConfigurationPropertiesResourceAssociation	Information about resource association
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

NetworkSecurityPerimeterConfigurationPropertiesProfile

Object

Network Security Perimeter profile

Name	Type	Description
accessRules	NspAccessRule[]	List of Access Rules
accessRulesVersion	number (float)	Current access rules version
diagnosticSettingsVersion	number (float)	Diagnostic settings version
enabledLogCategories	string[]	Enabled logging categories
name	string	Name of the resource

NetworkSecurityPerimeterConfigurationPropertiesResourceAssociation

Object

Information about resource association

Name	Type	Description
accessMode	ResourceAssociationAccessMode	Access Mode of the resource association
name	string	Name of the resource association

NetworkSecurityPerimeterConfigurationProvisioningState

Enumeration

Provisioning state of Network Security Perimeter configuration propagation

Value	Description
Accepted
Succeeded
Failed
Deleting
Canceled

NspAccessRule

Object

Information of Access Rule in Network Security Perimeter profile

Name	Type	Description
name	string	Name of the resource
properties	NspAccessRuleProperties	Properties of Access Rule

NspAccessRuleDirection

Enumeration

Direction of Access Rule

Value	Description
Inbound
Outbound

NspAccessRuleProperties

Object

Properties of Access Rule

Name	Type	Description
addressPrefixes	string[]	Address prefixes in the CIDR format for inbound rules
direction	NspAccessRuleDirection	Direction of Access Rule
fullyQualifiedDomainNames	string[]	FQDN for outbound rules
networkSecurityPerimeters	NetworkSecurityPerimeter[]	NetworkSecurityPerimeters for inbound rules
subscriptions	NspAccessRulePropertiesSubscriptionsItem[]	Subscriptions for inbound rules

NspAccessRulePropertiesSubscriptionsItem

Object

Subscription for inbound rule

Name	Type	Description
id	string	The ARM identifier of subscription

ProvisioningIssue

Object

Describes provisioning issue for given NetworkSecurityPerimeterConfiguration

Name	Type	Description
name	string	Name of the issue
properties	ProvisioningIssueProperties	Properties of provisioning issue

ProvisioningIssueProperties

Object

Properties of provisioning issue

Name	Type	Description
description	string	Description of the issue
issueType	IssueType	Type of issue
severity	Severity	Severity of the issue.

ResourceAssociationAccessMode

Enumeration

Access Mode of the resource association

Value	Description
Enforced
Learning
Audit

Severity

Enumeration

Severity of the issue.

Value	Description
Warning
Error

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.