Share via

Microsoft.Network networkManagers/securityUserConfigurations/ruleCollections/rules 2021-05-01-preview

Bicep resource definition

The networkManagers/securityUserConfigurations/ruleCollections/rules resource type can be deployed with operations that target:

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

Resource format

To create a Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections/rules resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections/rules@2021-05-01-preview' = {
  name: 'string'
  kind: 'string'
  // For remaining properties, see Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections/rules objects
}

Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections/rules objects

Set the kind property to specify the type of object.

For Custom, use:

{
  kind: 'Custom'
  properties: {
    description: 'string'
    destinationPortRanges: [
      'string'
    ]
    destinations: [
      {
        addressPrefix: 'string'
        addressPrefixType: 'string'
      }
    ]
    direction: 'string'
    displayName: 'string'
    protocol: 'string'
    sourcePortRanges: [
      'string'
    ]
    sources: [
      {
        addressPrefix: 'string'
        addressPrefixType: 'string'
      }
    ]
  }
}

For Default, use:

{
  kind: 'Default'
  properties: {
    flag: 'string'
  }
}

Property Values

Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections/rules

Name Description Value
kind Set to 'Custom' for type UserRule. Set to 'Default' for type DefaultUserRule. 'Custom'
'Default' (required)
name The resource name string (required)
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: networkManagers/securityUserConfigurations/ruleCollections

AddressPrefixItem

Name Description Value
addressPrefix Address prefix. string
addressPrefixType Address prefix type. 'IPPrefix'
'ServiceTag'

DefaultUserRule

Name Description Value
kind Whether the rule is custom or default. 'Default' (required)
properties Indicates the properties of the security default user rule DefaultUserRulePropertiesFormat

DefaultUserRulePropertiesFormat

Name Description Value
flag Default rule flag. string

UserRule

Name Description Value
kind Whether the rule is custom or default. 'Custom' (required)
properties Indicates the properties of the security user rule UserRulePropertiesFormat

UserRulePropertiesFormat

Name Description Value
description A description for this rule. string
destinationPortRanges The destination port ranges. string[]
destinations The destination address prefixes. CIDR or destination IP ranges. AddressPrefixItem[]
direction Indicates if the traffic matched against the rule in inbound or outbound. 'Inbound'
'Outbound' (required)
displayName A friendly name for the rule. string
protocol Network protocol this rule applies to. 'Ah'
'Any'
'Esp'
'Icmp'
'Tcp'
'Udp' (required)
sourcePortRanges The source port ranges. string[]
sources The CIDR or source IP ranges. AddressPrefixItem[]

ARM template resource definition

The networkManagers/securityUserConfigurations/ruleCollections/rules resource type can be deployed with operations that target:

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

Resource format

To create a Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections/rules resource, add the following JSON to your template.

{
  "name": "string",
  "kind": "string"
  // For remaining properties, see Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections/rules objects
}

Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections/rules objects

Set the kind property to specify the type of object.

For Custom, use:

{
  "kind": "Custom",
  "properties": {
    "description": "string",
    "destinationPortRanges": [ "string" ],
    "destinations": [
      {
        "addressPrefix": "string",
        "addressPrefixType": "string"
      }
    ],
    "direction": "string",
    "displayName": "string",
    "protocol": "string",
    "sourcePortRanges": [ "string" ],
    "sources": [
      {
        "addressPrefix": "string",
        "addressPrefixType": "string"
      }
    ]
  }
}

For Default, use:

{
  "kind": "Default",
  "properties": {
    "flag": "string"
  }
}

Property Values

Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections/rules

Name Description Value
apiVersion The api version '2021-05-01-preview'
kind Set to 'Custom' for type UserRule. Set to 'Default' for type DefaultUserRule. 'Custom'
'Default' (required)
name The resource name string (required)
type The resource type 'Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections/rules'

AddressPrefixItem

Name Description Value
addressPrefix Address prefix. string
addressPrefixType Address prefix type. 'IPPrefix'
'ServiceTag'

DefaultUserRule

Name Description Value
kind Whether the rule is custom or default. 'Default' (required)
properties Indicates the properties of the security default user rule DefaultUserRulePropertiesFormat

DefaultUserRulePropertiesFormat

Name Description Value
flag Default rule flag. string

UserRule

Name Description Value
kind Whether the rule is custom or default. 'Custom' (required)
properties Indicates the properties of the security user rule UserRulePropertiesFormat

UserRulePropertiesFormat

Name Description Value
description A description for this rule. string
destinationPortRanges The destination port ranges. string[]
destinations The destination address prefixes. CIDR or destination IP ranges. AddressPrefixItem[]
direction Indicates if the traffic matched against the rule in inbound or outbound. 'Inbound'
'Outbound' (required)
displayName A friendly name for the rule. string
protocol Network protocol this rule applies to. 'Ah'
'Any'
'Esp'
'Icmp'
'Tcp'
'Udp' (required)
sourcePortRanges The source port ranges. string[]
sources The CIDR or source IP ranges. AddressPrefixItem[]

Usage Examples

Terraform (AzAPI provider) resource definition

The networkManagers/securityUserConfigurations/ruleCollections/rules 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.Network/networkManagers/securityUserConfigurations/ruleCollections/rules resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  name = "string"
  kind = "string"
  // For remaining properties, see Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections/rules objects
}

Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections/rules objects

Set the kind property to specify the type of object.

For Custom, use:

{
  kind = "Custom"
  properties = {
    description = "string"
    destinationPortRanges = [
      "string"
    ]
    destinations = [
      {
        addressPrefix = "string"
        addressPrefixType = "string"
      }
    ]
    direction = "string"
    displayName = "string"
    protocol = "string"
    sourcePortRanges = [
      "string"
    ]
    sources = [
      {
        addressPrefix = "string"
        addressPrefixType = "string"
      }
    ]
  }
}

For Default, use:

{
  kind = "Default"
  properties = {
    flag = "string"
  }
}

Property Values

Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections/rules

Name Description Value
kind Set to 'Custom' for type UserRule. Set to 'Default' for type DefaultUserRule. 'Custom'
'Default' (required)
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: networkManagers/securityUserConfigurations/ruleCollections
type The resource type "Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections/rules@2021-05-01-preview"

AddressPrefixItem

Name Description Value
addressPrefix Address prefix. string
addressPrefixType Address prefix type. 'IPPrefix'
'ServiceTag'

DefaultUserRule

Name Description Value
kind Whether the rule is custom or default. 'Default' (required)
properties Indicates the properties of the security default user rule DefaultUserRulePropertiesFormat

DefaultUserRulePropertiesFormat

Name Description Value
flag Default rule flag. string

UserRule

Name Description Value
kind Whether the rule is custom or default. 'Custom' (required)
properties Indicates the properties of the security user rule UserRulePropertiesFormat

UserRulePropertiesFormat

Name Description Value
description A description for this rule. string
destinationPortRanges The destination port ranges. string[]
destinations The destination address prefixes. CIDR or destination IP ranges. AddressPrefixItem[]
direction Indicates if the traffic matched against the rule in inbound or outbound. 'Inbound'
'Outbound' (required)
displayName A friendly name for the rule. string
protocol Network protocol this rule applies to. 'Ah'
'Any'
'Esp'
'Icmp'
'Tcp'
'Udp' (required)
sourcePortRanges The source port ranges. string[]
sources The CIDR or source IP ranges. AddressPrefixItem[]