Network Security Perimeters - List By Subscription

List all network security perimeters in a subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkSecurityPerimeters?api-version=2021-02-01-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkSecurityPerimeters?api-version=2021-02-01-preview&$top={$top}&$skipToken={$skipToken}

URI Parameters

Name In Required Type Description
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

An optional query parameter which specifies the maximum number of records to be returned by the server.

Responses

Name Type Description
200 OK

NetworkSecurityPerimeterListResult

Request is successful. Returns the list of the network security perimeters.

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

NetworkSecurityPerimetersList

Sample Request

GET https://management.azure.com/subscriptions/subId/providers/Microsoft.Network/networkSecurityPerimeters?api-version=2021-02-01-preview

Sample Response

{
  "value": [
    {
      "name": "testNSP1",
      "id": "/subscriptions/subId/resourceGroup/rg1/providers/Microsoft.Network/networkSecurityPerimeters/testNSP1",
      "type": "Microsoft.Network/networkSecurityPerimeters",
      "tags": {},
      "location": "East US 2 EUAP",
      "properties": {
        "perimeterGuid": "guid",
        "provisioningState": "Succeeded"
      }
    },
    {
      "name": "testNSP2",
      "id": "/subscriptions/subId/resourceGroup/rg1/providers/Microsoft.Network/networkSecurityPerimeters/testNSP2",
      "type": "Microsoft.Network/networkSecurityPerimeters",
      "tags": {},
      "location": "East US 2 EUAP",
      "properties": {
        "perimeterGuid": "guid",
        "provisioningState": "Succeeded"
      }
    }
  ],
  "nextLink": "{baseurl}/subscriptions/subId/providers/Microsoft.Network/networkSecurityPerimeters?api-version=2021-02-01-preview&$skipToken=10"
}

Definitions

Name Description
CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

NetworkSecurityPerimeter

The Network Security Perimeter resource

NetworkSecurityPerimeterListResult

Result of the request to list NetworkSecurityPerimeter. It contains a list of network security perimeters and a URL link to get the next set of results.

nspProvisioningState

The provisioning state of the scope assignment resource.

CloudError

An error response from the service.

Name Type Description
error

CloudErrorBody

Cloud error body.

CloudErrorBody

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.

NetworkSecurityPerimeter

The Network Security Perimeter resource

Name Type Description
id

string

Network security perimeter identifier.

location

string

The location in which NSP is created.

name

string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.perimeterGuid

string

perimeter guid of the network security perimeter.

properties.provisioningState

nspProvisioningState

The provisioning state of the scope assignment resource.

tags

object

Resource tags.

type

string

Resource type.

NetworkSecurityPerimeterListResult

Result of the request to list NetworkSecurityPerimeter. It contains a list of network security perimeters 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

NetworkSecurityPerimeter[]

Gets a page of NetworkSecurityPerimeter

nspProvisioningState

The provisioning state of the scope assignment resource.

Name Type Description
Accepted

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string