Microsoft.Network networkManagers/securityAdminConfigurations/ruleCollections/rules 2022-11-01

Bicep resource definition

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

resource symbolicname 'Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules@2022-11-01' = {
  name: 'string'
  kind: 'string'
  // For remaining properties, see Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules objects
}

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

Set the kind property to specify the type of object.

For Custom, use:

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

For Default, use:

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

Property Values

Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules

AddressPrefixItem

AdminPropertiesFormat

AdminRule

DefaultAdminPropertiesFormat

DefaultAdminRule

Usage Examples

Bicep Samples

A basic example of deploying Network Manager Admin Rule.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource networkManager 'Microsoft.Network/networkManagers@2022-09-01' = {
  name: resourceName
  location: location
  properties: {
    description: ''
    networkManagerScopeAccesses: [
      'SecurityAdmin'
    ]
    networkManagerScopes: {
      managementGroups: []
      subscriptions: [
        subscription().id
      ]
    }
  }
}

resource networkGroup 'Microsoft.Network/networkManagers/networkGroups@2022-09-01' = {
  parent: networkManager
  name: resourceName
  properties: {}
}

resource securityAdminConfiguration 'Microsoft.Network/networkManagers/securityAdminConfigurations@2022-09-01' = {
  parent: networkManager
  name: resourceName
  properties: {
    applyOnNetworkIntentPolicyBasedServices: []
  }
}

resource ruleCollection 'Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections@2022-09-01' = {
  parent: securityAdminConfiguration
  name: resourceName
  properties: {
    appliesToGroups: [
      {
        networkGroupId: networkGroup.id
      }
    ]
  }
}

resource rule 'Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules@2022-09-01' = {
  parent: ruleCollection
  name: resourceName
  kind: 'Custom'
  properties: {
    access: 'Deny'
    destinationPortRanges: []
    destinations: []
    direction: 'Outbound'
    priority: 1
    protocol: 'Tcp'
    sourcePortRanges: []
    sources: []
  }
}

ARM template resource definition

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

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

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

Set the kind property to specify the type of object.

For Custom, use:

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

For Default, use:

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

Property Values

Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules

AddressPrefixItem

AdminPropertiesFormat

AdminRule

DefaultAdminPropertiesFormat

DefaultAdminRule

Usage Examples

Terraform (AzAPI provider) resource definition

The networkManagers/securityAdminConfigurations/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/securityAdminConfigurations/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/securityAdminConfigurations/ruleCollections/rules objects
}

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

Set the kind property to specify the type of object.

For Custom, use:

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

For Default, use:

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

Property Values

Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules

AddressPrefixItem

AdminPropertiesFormat

AdminRule

DefaultAdminPropertiesFormat

DefaultAdminRule

Usage Examples

Terraform Samples

A basic example of deploying Network Manager Admin Rule.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
    azurerm = {
      source = "hashicorp/azurerm"
    }
  }
}

provider "azurerm" {
  features {
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

data "azurerm_client_config" "current" {
}

data "azapi_resource" "subscription" {
  type                   = "Microsoft.Resources/subscriptions@2021-01-01"
  resource_id            = "/subscriptions/${data.azurerm_client_config.current.subscription_id}"
  response_export_values = ["*"]
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "networkManager" {
  type      = "Microsoft.Network/networkManagers@2022-09-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      description = ""
      networkManagerScopeAccesses = [
        "SecurityAdmin",
      ]
      networkManagerScopes = {
        managementGroups = [
        ]
        subscriptions = [
          data.azapi_resource.subscription.id,
        ]
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "securityAdminConfiguration" {
  type      = "Microsoft.Network/networkManagers/securityAdminConfigurations@2022-09-01"
  parent_id = azapi_resource.networkManager.id
  name      = var.resource_name
  body = {
    properties = {
      applyOnNetworkIntentPolicyBasedServices = []
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "networkGroup" {
  type      = "Microsoft.Network/networkManagers/networkGroups@2022-09-01"
  parent_id = azapi_resource.networkManager.id
  name      = var.resource_name
  body = {
    properties = {
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "ruleCollection" {
  type      = "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections@2022-09-01"
  parent_id = azapi_resource.securityAdminConfiguration.id
  name      = var.resource_name
  body = {
    properties = {
      appliesToGroups = [
        {
          networkGroupId = azapi_resource.networkGroup.id
        },
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "rule" {
  type      = "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules@2022-09-01"
  parent_id = azapi_resource.ruleCollection.id
  name      = var.resource_name
  body = {
    kind = "Custom"
    properties = {
      access                = "Deny"
      destinationPortRanges = []
      destinations          = []
      direction             = "Outbound"
      priority              = 1
      protocol              = "Tcp"
      sourcePortRanges      = []
      sources               = []
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}