Microsoft.EventHub namespaces/networkRuleSets 2023-01-01-preview

• Latest
• 2024-01-01
• 2023-01-01-preview
• 2022-10-01-preview
• 2022-01-01-preview
• 2021-11-01
• 2021-06-01-preview
• 2021-01-01-preview
• 2018-01-01-preview
• 2017-04-01

Bicep resource definition

The namespaces/networkRuleSets resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.EventHub/namespaces/networkRuleSets resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.EventHub/namespaces/networkRuleSets@2023-01-01-preview' = {
  name: 'default'
  parent: resourceSymbolicName
  properties: {
    defaultAction: 'string'
    ipRules: [
      {
        action: 'Allow'
        ipMask: 'string'
      }
    ]
    publicNetworkAccess: 'string'
    trustedServiceAccessEnabled: bool
    virtualNetworkRules: [
      {
        ignoreMissingVnetServiceEndpoint: bool
        subnet: {
          id: 'string'
        }
      }
    ]
  }
}

Property values

namespaces/networkRuleSets

Name	Description	Value
name	The resource name See how to set names and types for child resources in Bicep.	'default'
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: namespaces
properties	NetworkRuleSet properties	NetworkRuleSetProperties

NetworkRuleSetProperties

Name	Description	Value
defaultAction	Default Action for Network Rule Set	'Allow' 'Deny'
ipRules	List of IpRules	NWRuleSetIpRules[]
publicNetworkAccess	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.	'Disabled' 'Enabled' 'SecuredByPerimeter'
trustedServiceAccessEnabled	Value that indicates whether Trusted Service Access is Enabled or not.	bool
virtualNetworkRules	List VirtualNetwork Rules	NWRuleSetVirtualNetworkRules[]

NWRuleSetIpRules

Name	Description	Value
action	The IP Filter Action	'Allow'
ipMask	IP Mask	string

NWRuleSetVirtualNetworkRules

Name	Description	Value
ignoreMissingVnetServiceEndpoint	Value that indicates whether to ignore missing Vnet Service Endpoint	bool
subnet	Subnet properties	Subnet

Subnet

Name	Description	Value
id	Resource ID of Virtual Network Subnet	string

ARM template resource definition

The namespaces/networkRuleSets resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.EventHub/namespaces/networkRuleSets resource, add the following JSON to your template.

{
  "type": "Microsoft.EventHub/namespaces/networkRuleSets",
  "apiVersion": "2023-01-01-preview",
  "name": "default",
  "properties": {
    "defaultAction": "string",
    "ipRules": [
      {
        "action": "Allow",
        "ipMask": "string"
      }
    ],
    "publicNetworkAccess": "string",
    "trustedServiceAccessEnabled": "bool",
    "virtualNetworkRules": [
      {
        "ignoreMissingVnetServiceEndpoint": "bool",
        "subnet": {
          "id": "string"
        }
      }
    ]
  }
}

Property values

namespaces/networkRuleSets

Name	Description	Value
type	The resource type	'Microsoft.EventHub/namespaces/networkRuleSets'
apiVersion	The resource api version	'2023-01-01-preview'
name	The resource name See how to set names and types for child resources in JSON ARM templates.	'default'
properties	NetworkRuleSet properties	NetworkRuleSetProperties

NetworkRuleSetProperties

Name	Description	Value
defaultAction	Default Action for Network Rule Set	'Allow' 'Deny'
ipRules	List of IpRules	NWRuleSetIpRules[]
publicNetworkAccess	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.	'Disabled' 'Enabled' 'SecuredByPerimeter'
trustedServiceAccessEnabled	Value that indicates whether Trusted Service Access is Enabled or not.	bool
virtualNetworkRules	List VirtualNetwork Rules	NWRuleSetVirtualNetworkRules[]

NWRuleSetIpRules

Name	Description	Value
action	The IP Filter Action	'Allow'
ipMask	IP Mask	string

NWRuleSetVirtualNetworkRules

Name	Description	Value
ignoreMissingVnetServiceEndpoint	Value that indicates whether to ignore missing Vnet Service Endpoint	bool
subnet	Subnet properties	Subnet

Subnet

Name	Description	Value
id	Resource ID of Virtual Network Subnet	string

Terraform (AzAPI provider) resource definition

The namespaces/networkRuleSets resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.EventHub/namespaces/networkRuleSets resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventHub/namespaces/networkRuleSets@2023-01-01-preview"
  name = "default"
  parent_id = "string"
  body = jsonencode({
    properties = {
      defaultAction = "string"
      ipRules = [
        {
          action = "Allow"
          ipMask = "string"
        }
      ]
      publicNetworkAccess = "string"
      trustedServiceAccessEnabled = bool
      virtualNetworkRules = [
        {
          ignoreMissingVnetServiceEndpoint = bool
          subnet = {
            id = "string"
          }
        }
      ]
    }
  })
}

Property values

namespaces/networkRuleSets

Name	Description	Value
type	The resource type	"Microsoft.EventHub/namespaces/networkRuleSets@2023-01-01-preview"
name	The resource name	"default"
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: namespaces
properties	NetworkRuleSet properties	NetworkRuleSetProperties

NetworkRuleSetProperties

Name	Description	Value
defaultAction	Default Action for Network Rule Set	"Allow" "Deny"
ipRules	List of IpRules	NWRuleSetIpRules[]
publicNetworkAccess	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.	"Disabled" "Enabled" "SecuredByPerimeter"
trustedServiceAccessEnabled	Value that indicates whether Trusted Service Access is Enabled or not.	bool
virtualNetworkRules	List VirtualNetwork Rules	NWRuleSetVirtualNetworkRules[]

NWRuleSetIpRules

Name	Description	Value
action	The IP Filter Action	"Allow"
ipMask	IP Mask	string

NWRuleSetVirtualNetworkRules

Name	Description	Value
ignoreMissingVnetServiceEndpoint	Value that indicates whether to ignore missing Vnet Service Endpoint	bool
subnet	Subnet properties	Subnet

Subnet

Name	Description	Value
id	Resource ID of Virtual Network Subnet	string