Nsp Access Rules - List

Service:: Network Manager

API Version:: 2023-07-01-preview

Lists the NSP access rules in the specified NSP profile.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/profiles/{profileName}/accessRules?api-version=2023-07-01-preview

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/profiles/{profileName}/accessRules?api-version=2023-07-01-preview&$top={$top}&$skipToken={$skipToken}

URI Parameters

Name	In	Required	Type	Description
networkSecurityPerimeterName	path	True	string	The name of the network security perimeter.
profileName	path	True	string	The name of the NSP profile.
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client API version.
$skipToken	query		string	SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.
$top	query		integer (int32) minimum: 1 maximum: 20	An optional query parameter which specifies the maximum number of records to be returned by the server.

Responses

Name	Type	Description
200 OK	NspAccessRuleListResult	OK - Returns the list of NSP access rules.
Other Status Codes	CloudError	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

NspAccessRulesList

Sample request

HTTP

GET https://management.azure.com/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/profile1/accessRules?api-version=2023-07-01-preview

Sample response

Status code:: 200

{
  "value": [
    {
      "name": "accessRule1",
      "id": "/subscriptions/rg1/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/profile1/accessRules/accessRule1",
      "type": "Microsoft.Network/networkSecurityPerimeters/profiles/accessRules",
      "properties": {
        "provisioningState": "Succeeded",
        "direction": "Inbound",
        "addressPrefixes": [
          "10.11.0.0/16",
          "10.10.1.0/24"
        ],
        "fullyQualifiedDomainNames": [],
        "subscriptions": [],
        "networkSecurityPerimeters": [],
        "emailAddresses": [],
        "phoneNumbers": []
      }
    },
    {
      "name": "accessRule2",
      "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/profile1/accessRules/accessRule2",
      "type": "Microsoft.Network/networkSecurityPerimeters/profiles/accessRules",
      "properties": {
        "provisioningState": "Succeeded",
        "direction": "Outbound",
        "addressPrefixes": [],
        "fullyQualifiedDomainNames": [
          "paasrp1.contoso.org",
          "paasrp2.contoso.org"
        ],
        "subscriptions": [],
        "networkSecurityPerimeters": [],
        "emailAddresses": [],
        "phoneNumbers": []
      }
    }
  ],
  "nextLink": "{baseurl}/subscriptions/subId/resourceGroup/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/profile1/accessRules?api-version=2023-07-01-preview&$skipToken=10"
}

Definitions

Name	Description
AccessRuleDirection	Direction that specifies whether the access rules is inbound/outbound.
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
NspAccessRule	The NSP access rule resource
NspAccessRuleListResult	Result of the request to list NSP access rules. Contains a list of NSP access rules and a URL link to get the next set of results.
nspProvisioningState	The provisioning state of the scope assignment resource.
PerimeterBasedAccessRule
SubscriptionId

AccessRuleDirection

Enumeration

Direction that specifies whether the access rules is inbound/outbound.

Value	Description
Inbound
Outbound

CloudError

Object

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

Object

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

NspAccessRule

Object

The NSP access rule resource

Name	Type	Description
id	string	NSP access rule identifier.
location	string	Resource location.
name	string	The name of the access rule that is unique within a profile. This name can be used to access the resource.
properties.addressPrefixes	string[]	Inbound address prefixes (IPv4/IPv6)
properties.direction	AccessRuleDirection	Direction that specifies whether the access rules is inbound/outbound.
properties.emailAddresses	string[]	Outbound rules email address format.
properties.fullyQualifiedDomainNames	string[]	Outbound rules fully qualified domain name format.
properties.networkSecurityPerimeters	PerimeterBasedAccessRule[]	Rule specified by the perimeter id.
properties.phoneNumbers	string[]	Outbound rules phone number format.
properties.provisioningState	nspProvisioningState	The provisioning state of the scope assignment resource.
properties.subscriptions	SubscriptionId[]	List of subscription ids
tags	object	Resource tags.
type	string	Resource type.

NspAccessRuleListResult

Object

Result of the request to list NSP access rules. Contains a list of NSP access rules and a URL link to get the next set of results.

Name	Type	Description
nextLink	string	Gets the URL to get the next page of results.
value	NspAccessRule[]	Gets a page of NSP access rule

nspProvisioningState

Enumeration

The provisioning state of the scope assignment resource.

Value	Description
Succeeded
Creating
Updating
Deleting
Accepted
Failed

PerimeterBasedAccessRule

Object

Name	Type	Description
id	string	NSP id in the ARM id format.
location	string	Location of the NSP supplied.
perimeterGuid	string	Resource guid of the NSP supplied.

SubscriptionId

Object

Name	Type	Description
id	string	Subscription id in the ARM id format.

Share via

Nsp Access Rules - List

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

NspAccessRulesList

Sample request

Sample response

Definitions

AccessRuleDirection

CloudError

CloudErrorBody

NspAccessRule

NspAccessRuleListResult

nspProvisioningState

PerimeterBasedAccessRule

SubscriptionId