Share via

Microsoft.Network virtualHubs/routingIntent 2023-02-01

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.Network/virtualHubs/routingIntent@2023-02-01' = {
  name: 'string'
  properties: {
    routingPolicies: [
      {
        destinations: [
          'string'
        ]
        name: 'string'
        nextHop: 'string'
      }
    ]
  }
}

Property values

Microsoft.Network/virtualHubs/routingIntent

Name Description Value
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: virtualHubs
properties Properties of the RoutingIntent resource. RoutingIntentProperties

RoutingIntentProperties

Name Description Value
routingPolicies List of routing policies. RoutingPolicy[]

RoutingPolicy

Name Description Value
destinations List of all destinations which this routing policy is applicable to (for example: Internet, PrivateTraffic). string[] (required)
name The unique name for the routing policy. string (required)
nextHop The next hop resource id on which this routing policy is applicable to. string (required)

ARM template resource definition

The virtualHubs/routingIntent 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/virtualHubs/routingIntent resource, add the following JSON to your template.

{
  "type": "Microsoft.Network/virtualHubs/routingIntent",
  "apiVersion": "2023-02-01",
  "name": "string",
  "properties": {
    "routingPolicies": [
      {
        "destinations": [ "string" ],
        "name": "string",
        "nextHop": "string"
      }
    ]
  }
}

Property values

Microsoft.Network/virtualHubs/routingIntent

Name Description Value
apiVersion The api version '2023-02-01'
name The resource name string (required)
properties Properties of the RoutingIntent resource. RoutingIntentProperties
type The resource type 'Microsoft.Network/virtualHubs/routingIntent'

RoutingIntentProperties

Name Description Value
routingPolicies List of routing policies. RoutingPolicy[]

RoutingPolicy

Name Description Value
destinations List of all destinations which this routing policy is applicable to (for example: Internet, PrivateTraffic). string[] (required)
name The unique name for the routing policy. string (required)
nextHop The next hop resource id on which this routing policy is applicable to. string (required)

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/virtualHubs/routingIntent@2023-02-01"
  name = "string"
  body = jsonencode({
    properties = {
      routingPolicies = [
        {
          destinations = [
            "string"
          ]
          name = "string"
          nextHop = "string"
        }
      ]
    }
  })
}

Property values

Microsoft.Network/virtualHubs/routingIntent

Name Description Value
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: virtualHubs
properties Properties of the RoutingIntent resource. RoutingIntentProperties
type The resource type "Microsoft.Network/virtualHubs/routingIntent@2023-02-01"

RoutingIntentProperties

Name Description Value
routingPolicies List of routing policies. RoutingPolicy[]

RoutingPolicy

Name Description Value
destinations List of all destinations which this routing policy is applicable to (for example: Internet, PrivateTraffic). string[] (required)
name The unique name for the routing policy. string (required)
nextHop The next hop resource id on which this routing policy is applicable to. string (required)