Microsoft.Network topologyMaps 2026-10-01-preview

Bicep resource definition

The topologyMaps 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/topologyMaps resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/topologyMaps@2026-10-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    catchAllSiteName: 'string'
    sites: [
      {
        name: 'string'
        properties: {
          probingGatewayIds: [
            'string'
          ]
          virtualNetworkIds: [
            'string'
          ]
        }
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.Network/topologyMaps

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9-]{3,24}$ (required)
properties The properties of the Topology Map. TopologyMapProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

SiteProperties

Name Description Value
probingGatewayIds The ARM resource ID of the probing gateway that can be used to monitor health as surrogate to the networks in the Site. string[]
virtualNetworkIds The list of Network IDs that forms the Site. string[]

TopologyMapInlineSite

Name Description Value
name The name of the Site. string (required)
properties The properties of the Site. SiteProperties

TopologyMapProperties

Name Description Value
catchAllSiteName The Name of the CatchAll site. There is only one CatchAll site in a TopologyMap string
sites The list of Sites in the Topology Map. TopologyMapInlineSite[]

TrackedResourceTags

Name Description Value

ARM template resource definition

The topologyMaps resource type can be deployed with operations that target:

Usage Examples

Resource format

To create a Microsoft.Network/topologyMaps resource, add the following JSON to your template.

{
  "type": "Microsoft.Network/topologyMaps",
  "apiVersion": "2026-10-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "catchAllSiteName": "string",
    "sites": [
      {
        "name": "string",
        "properties": {
          "probingGatewayIds": [ "string" ],
          "virtualNetworkIds": [ "string" ]
        }
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Network/topologyMaps

Name Description Value
apiVersion The api version '2026-10-01-preview'
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9-]{3,24}$ (required)
properties The properties of the Topology Map. TopologyMapProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Network/topologyMaps'

SiteProperties

Name Description Value
probingGatewayIds The ARM resource ID of the probing gateway that can be used to monitor health as surrogate to the networks in the Site. string[]
virtualNetworkIds The list of Network IDs that forms the Site. string[]

TopologyMapInlineSite

Name Description Value
name The name of the Site. string (required)
properties The properties of the Site. SiteProperties

TopologyMapProperties

Name Description Value
catchAllSiteName The Name of the CatchAll site. There is only one CatchAll site in a TopologyMap string
sites The list of Sites in the Topology Map. TopologyMapInlineSite[]

TrackedResourceTags

Name Description Value

Terraform (AzAPI provider) resource definition

The topologyMaps 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/topologyMaps resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/topologyMaps@2026-10-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      catchAllSiteName = "string"
      sites = [
        {
          name = "string"
          properties = {
            probingGatewayIds = [
              "string"
            ]
            virtualNetworkIds = [
              "string"
            ]
          }
        }
      ]
    }
  }
}

Property Values

Microsoft.Network/topologyMaps

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9-]{3,24}$ (required)
properties The properties of the Topology Map. TopologyMapProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Network/topologyMaps@2026-10-01-preview"

SiteProperties

Name Description Value
probingGatewayIds The ARM resource ID of the probing gateway that can be used to monitor health as surrogate to the networks in the Site. string[]
virtualNetworkIds The list of Network IDs that forms the Site. string[]

TopologyMapInlineSite

Name Description Value
name The name of the Site. string (required)
properties The properties of the Site. SiteProperties

TopologyMapProperties

Name Description Value
catchAllSiteName The Name of the CatchAll site. There is only one CatchAll site in a TopologyMap string
sites The list of Sites in the Topology Map. TopologyMapInlineSite[]

TrackedResourceTags

Name Description Value
  • Last updated on