Namespaces - Create Or Update Network Rule Set

Reference

Service:: Event Hubs

API Version:: 2024-01-01

Create or update NetworkRuleSet for a Namespace.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkRuleSets/default?api-version=2024-01-01

URI Parameters

Name	In	Required	Type	Description
namespaceName	path	True	string	The Namespace name Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	Name of the resource group within the azure subscription.
subscriptionId	path	True	string	Subscription credentials that uniquely identify a 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
properties.defaultAction	DefaultAction	Default Action for Network Rule Set
properties.ipRules	NWRuleSetIpRules[]	List of IpRules
properties.publicNetworkAccess	PublicNetworkAccessFlag	This determines if traffic is allowed over public network. By default it is enabled. If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile's access rules.
properties.trustedServiceAccessEnabled	boolean	Value that indicates whether Trusted Service Access is Enabled or not.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]	List VirtualNetwork Rules

Responses

Name	Type	Description
200 OK	NetworkRuleSet	Namespace NetworkRuleSet successfully returned.
Other Status Codes	ErrorResponse	ServiceBus 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

NameSpaceNetworkRuleSetCreate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-6019/networkRuleSets/default?api-version=2024-01-01

{
  "properties": {
    "defaultAction": "Deny",
    "virtualNetworkRules": [
      {
        "subnet": {
          "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2"
        },
        "ignoreMissingVnetServiceEndpoint": true
      },
      {
        "subnet": {
          "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3"
        },
        "ignoreMissingVnetServiceEndpoint": false
      },
      {
        "subnet": {
          "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6"
        },
        "ignoreMissingVnetServiceEndpoint": false
      }
    ],
    "ipRules": [
      {
        "ipMask": "1.1.1.1",
        "action": "Allow"
      },
      {
        "ipMask": "1.1.1.2",
        "action": "Allow"
      },
      {
        "ipMask": "1.1.1.3",
        "action": "Allow"
      },
      {
        "ipMask": "1.1.1.4",
        "action": "Allow"
      },
      {
        "ipMask": "1.1.1.5",
        "action": "Allow"
      }
    ]
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/resourcegroupid/providers/Microsoft.EventHub/namespaces/sdk-Namespace-9659/networkruleset/default",
  "name": "default",
  "type": "Microsoft.EventHub/Namespaces/NetworkRuleSet",
  "properties": {
    "defaultAction": "Deny",
    "virtualNetworkRules": [
      {
        "subnet": {
          "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2"
        },
        "ignoreMissingVnetServiceEndpoint": true
      },
      {
        "subnet": {
          "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3"
        },
        "ignoreMissingVnetServiceEndpoint": false
      },
      {
        "subnet": {
          "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6"
        },
        "ignoreMissingVnetServiceEndpoint": false
      }
    ],
    "ipRules": [
      {
        "ipMask": "1.1.1.1",
        "action": "Allow"
      },
      {
        "ipMask": "1.1.1.2",
        "action": "Allow"
      },
      {
        "ipMask": "1.1.1.3",
        "action": "Allow"
      },
      {
        "ipMask": "1.1.1.4",
        "action": "Allow"
      },
      {
        "ipMask": "1.1.1.5",
        "action": "Allow"
      }
    ]
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
DefaultAction	Default Action for Network Rule Set
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response indicates Event Hub service is not able to process the incoming request. The reason is provided in the error message.
NetworkRuleIPAction	The IP Filter Action
NetworkRuleSet	Description of topic resource.
NWRuleSetIpRules	The response from the List namespace operation.
NWRuleSetVirtualNetworkRules	The response from the List namespace operation.
PublicNetworkAccessFlag	This determines if traffic is allowed over public network. By default it is enabled. If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile's access rules.
Subnet	Properties supplied for Subnet
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultAction

Default Action for Network Rule Set

Name	Type	Description
Allow	string
Deny	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response indicates Event Hub service is not able to process the incoming request. The reason is provided in the error message.

Name	Type	Description
error	ErrorDetail	The error object.

NetworkRuleIPAction

The IP Filter Action

Name	Type	Description
Allow	string

NetworkRuleSet

Description of topic resource.

Name	Type	Default Value	Description
id	string		Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string		The geo-location where the resource lives
name	string		The name of the resource
properties.defaultAction	DefaultAction		Default Action for Network Rule Set
properties.ipRules	NWRuleSetIpRules[]		List of IpRules
properties.publicNetworkAccess	PublicNetworkAccessFlag	Enabled	This determines if traffic is allowed over public network. By default it is enabled. If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile's access rules.
properties.trustedServiceAccessEnabled	boolean		Value that indicates whether Trusted Service Access is Enabled or not.
properties.virtualNetworkRules	NWRuleSetVirtualNetworkRules[]		List VirtualNetwork Rules
systemData	systemData		The system meta data relating to this resource.
type	string		The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"

NWRuleSetIpRules

The response from the List namespace operation.

Name	Type	Description
action	NetworkRuleIPAction	The IP Filter Action
ipMask	string	IP Mask

NWRuleSetVirtualNetworkRules