Network Security Perimeters - Create Or Update

Service:

Network Manager

API Version:

2021-02-01-preview

Creates or updates a Network Security Perimeter.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}?api-version=2021-02-01-preview

URI Parameters

Name	In	Required	Type	Description
networkSecurityPerimeterName	path	True	string	The name of the network security perimeter.
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.

Request Body

Name	Type	Description
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.
tags	object	Resource tags.

Responses

Name	Type	Description
200 OK	NetworkSecurityPerimeter	Resource Updated. Returns the network security perimeter.
201 Created	NetworkSecurityPerimeter	Resource Created. Returns the network security perimeter.
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

Put Network Security Perimeter

Sample Request

HTTP

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

{
  "properties": {}
}

Sample Response

Status code:

200

{
  "name": "TestNetworkSecurityPerimeter",
  "id": "/subscriptions/subId/resourceGroup/rg1/providers/Microsoft.Network/networkSecurityPerimeters/TestNetworkSecurityPerimeter",
  "type": "Microsoft.Network/networkSecurityPerimeters",
  "tags": {},
  "location": "East US 2 EUAP",
  "properties": {
    "perimeterGuid": "guid",
    "provisioningState": "Succeeded"
  }
}

Status code:

201

{
  "name": "TestNetworkSecurityPerimeter",
  "id": "/subscriptions/subId/resourceGroup/rg1/providers/Microsoft.Network/networkSecurityPerimeters/TestNetworkSecurityPerimeter",
  "type": "Microsoft.Network/networkSecurityPerimeters",
  "tags": {},
  "location": "East US 2 EUAP",
  "properties": {
    "perimeterGuid": "guid",
    "provisioningState": "Succeeded"
  }
}

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
NetworkSecurityPerimeter	The Network Security Perimeter resource
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.

nspProvisioningState

The provisioning state of the scope assignment resource.

Name	Type	Description
Accepted	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string