Nsp Access Rules - Create Or Update

Reference

Service:: Network Manager

API Version:: 2023-07-01-preview

Creates or updates a network access rule.

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

URI Parameters

Name	In	Required	Type	Description
accessRuleName	path	True	string	The name of the NSP access rule.
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.

Request Body

Name	Type	Description
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.phoneNumbers	string[]	Outbound rules phone number format.
properties.subscriptions	SubscriptionId[]	List of subscription ids
tags	object	Resource tags.

Responses

Name	Type	Description
200 OK	NspAccessRule	Updated - Existing access rule is updated. Returns the resource.
201 Created	NspAccessRule	Create - Returns the NspAccessRule resource created.
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

NspAccessRulePut

Sample request

HTTP

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

{
  "properties": {
    "direction": "Inbound",
    "addressPrefixes": [
      "10.11.0.0/16",
      "10.10.1.0/24"
    ]
  }
}

Sample response

Status code:: 200

{
  "name": "accessRule1",
  "id": "/subscriptions/subId/resourceGroup/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": []
  }
}

Status code:: 201

{
  "name": "accessRule1",
  "id": "/subscriptions/subId/resourceGroup/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": []
  }
}

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
nspProvisioningState	The provisioning state of the scope assignment resource.
PerimeterBasedAccessRule
SubscriptionId

AccessRuleDirection

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

Name	Type	Description
Inbound	string
Outbound	string

CloudError

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody