Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. ObjectFirewallIdentitybasedroute
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

fortimanager.ObjectFirewallIdentitybasedroute

Explore with Pulumi AI

fortimanager logo
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
fortinetdev/terraform-provider-fortimanager

    Configure identity based routing.

    The following variables have sub resource. Avoid using them together, otherwise conflicts and overwrites may occur.

    • rule: fortimanager.ObjectFirewallIdentitybasedrouteRule

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as fortimanager from "@pulumi/fortimanager";

const trname = new fortimanager.ObjectFirewallIdentitybasedroute("trname", {comments: "terraform-comments"});

    import pulumi
import pulumi_fortimanager as fortimanager

trname = fortimanager.ObjectFirewallIdentitybasedroute("trname", comments="terraform-comments")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/fortimanager/fortimanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fortimanager.NewObjectFirewallIdentitybasedroute(ctx, "trname", &fortimanager.ObjectFirewallIdentitybasedrouteArgs{
			Comments: pulumi.String("terraform-comments"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortimanager = Pulumi.Fortimanager;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortimanager.ObjectFirewallIdentitybasedroute("trname", new()
    {
        Comments = "terraform-comments",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortimanager.ObjectFirewallIdentitybasedroute;
import com.pulumi.fortimanager.ObjectFirewallIdentitybasedrouteArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var trname = new ObjectFirewallIdentitybasedroute("trname", ObjectFirewallIdentitybasedrouteArgs.builder()
            .comments("terraform-comments")
            .build());

    }
}

    resources:
  trname:
    type: fortimanager:ObjectFirewallIdentitybasedroute
    properties:
      comments: terraform-comments

    Create ObjectFirewallIdentitybasedroute Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ObjectFirewallIdentitybasedroute(name: string, args?: ObjectFirewallIdentitybasedrouteArgs, opts?: CustomResourceOptions);
    @overload
def ObjectFirewallIdentitybasedroute(resource_name: str,
                                     args: Optional[ObjectFirewallIdentitybasedrouteArgs] = None,
                                     opts: Optional[ResourceOptions] = None)

@overload
def ObjectFirewallIdentitybasedroute(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     adom: Optional[str] = None,
                                     comments: Optional[str] = None,
                                     dynamic_sort_subtable: Optional[str] = None,
                                     name: Optional[str] = None,
                                     object_firewall_identitybasedroute_id: Optional[str] = None,
                                     rules: Optional[Sequence[ObjectFirewallIdentitybasedrouteRuleArgs]] = None,
                                     scopetype: Optional[str] = None)
    func NewObjectFirewallIdentitybasedroute(ctx *Context, name string, args *ObjectFirewallIdentitybasedrouteArgs, opts ...ResourceOption) (*ObjectFirewallIdentitybasedroute, error)
    public ObjectFirewallIdentitybasedroute(string name, ObjectFirewallIdentitybasedrouteArgs? args = null, CustomResourceOptions? opts = null)
    public ObjectFirewallIdentitybasedroute(String name, ObjectFirewallIdentitybasedrouteArgs args)
public ObjectFirewallIdentitybasedroute(String name, ObjectFirewallIdentitybasedrouteArgs args, CustomResourceOptions options)

    type: fortimanager:ObjectFirewallIdentitybasedroute
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ObjectFirewallIdentitybasedrouteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ObjectFirewallIdentitybasedrouteArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ObjectFirewallIdentitybasedrouteArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ObjectFirewallIdentitybasedrouteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ObjectFirewallIdentitybasedrouteArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var objectFirewallIdentitybasedrouteResource = new Fortimanager.ObjectFirewallIdentitybasedroute("objectFirewallIdentitybasedrouteResource", new()
{
    Adom = "string",
    Comments = "string",
    DynamicSortSubtable = "string",
    Name = "string",
    ObjectFirewallIdentitybasedrouteId = "string",
    Rules = new[]
    {
        new Fortimanager.Inputs.ObjectFirewallIdentitybasedrouteRuleArgs
        {
            Device = "string",
            Gateway = "string",
            Groups = "string",
            Id = 0,
        },
    },
    Scopetype = "string",
});

    example, err := fortimanager.NewObjectFirewallIdentitybasedroute(ctx, "objectFirewallIdentitybasedrouteResource", &fortimanager.ObjectFirewallIdentitybasedrouteArgs{
Adom: pulumi.String("string"),
Comments: pulumi.String("string"),
DynamicSortSubtable: pulumi.String("string"),
Name: pulumi.String("string"),
ObjectFirewallIdentitybasedrouteId: pulumi.String("string"),
Rules: .ObjectFirewallIdentitybasedrouteRuleTypeArray{
&.ObjectFirewallIdentitybasedrouteRuleTypeArgs{
Device: pulumi.String("string"),
Gateway: pulumi.String("string"),
Groups: pulumi.String("string"),
Id: pulumi.Float64(0),
},
},
Scopetype: pulumi.String("string"),
})

    var objectFirewallIdentitybasedrouteResource = new ObjectFirewallIdentitybasedroute("objectFirewallIdentitybasedrouteResource", ObjectFirewallIdentitybasedrouteArgs.builder()
    .adom("string")
    .comments("string")
    .dynamicSortSubtable("string")
    .name("string")
    .objectFirewallIdentitybasedrouteId("string")
    .rules(ObjectFirewallIdentitybasedrouteRuleArgs.builder()
        .device("string")
        .gateway("string")
        .groups("string")
        .id(0)
        .build())
    .scopetype("string")
    .build());

    object_firewall_identitybasedroute_resource = fortimanager.ObjectFirewallIdentitybasedroute("objectFirewallIdentitybasedrouteResource",
    adom="string",
    comments="string",
    dynamic_sort_subtable="string",
    name="string",
    object_firewall_identitybasedroute_id="string",
    rules=[{
        "device": "string",
        "gateway": "string",
        "groups": "string",
        "id": 0,
    }],
    scopetype="string")

    const objectFirewallIdentitybasedrouteResource = new fortimanager.ObjectFirewallIdentitybasedroute("objectFirewallIdentitybasedrouteResource", {
    adom: "string",
    comments: "string",
    dynamicSortSubtable: "string",
    name: "string",
    objectFirewallIdentitybasedrouteId: "string",
    rules: [{
        device: "string",
        gateway: "string",
        groups: "string",
        id: 0,
    }],
    scopetype: "string",
});

    type: fortimanager:ObjectFirewallIdentitybasedroute
properties:
    adom: string
    comments: string
    dynamicSortSubtable: string
    name: string
    objectFirewallIdentitybasedrouteId: string
    rules:
        - device: string
          gateway: string
          groups: string
          id: 0
    scopetype: string

    ObjectFirewallIdentitybasedroute Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ObjectFirewallIdentitybasedroute resource accepts the following input properties:

    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Comments string
    Comments.
    DynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    Name string
    Name.
    ObjectFirewallIdentitybasedrouteId string
    an identifier for the resource with format {{name}}.
    Rules List<ObjectFirewallIdentitybasedrouteRule>
    Rule. The structure of rule block is documented below.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Comments string
    Comments.
    DynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    Name string
    Name.
    ObjectFirewallIdentitybasedrouteId string
    an identifier for the resource with format {{name}}.
    Rules []ObjectFirewallIdentitybasedrouteRuleTypeArgs
    Rule. The structure of rule block is documented below.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comments String
    Comments.
    dynamicSortSubtable String
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    name String
    Name.
    objectFirewallIdentitybasedrouteId String
    an identifier for the resource with format {{name}}.
    rules List<ObjectFirewallIdentitybasedrouteRule>
    Rule. The structure of rule block is documented below.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comments string
    Comments.
    dynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    name string
    Name.
    objectFirewallIdentitybasedrouteId string
    an identifier for the resource with format {{name}}.
    rules ObjectFirewallIdentitybasedrouteRule[]
    Rule. The structure of rule block is documented below.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comments str
    Comments.
    dynamic_sort_subtable str
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    name str
    Name.
    object_firewall_identitybasedroute_id str
    an identifier for the resource with format {{name}}.
    rules Sequence[ObjectFirewallIdentitybasedrouteRuleArgs]
    Rule. The structure of rule block is documented below.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comments String
    Comments.
    dynamicSortSubtable String
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    name String
    Name.
    objectFirewallIdentitybasedrouteId String
    an identifier for the resource with format {{name}}.
    rules List<Property Map>
    Rule. The structure of rule block is documented below.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ObjectFirewallIdentitybasedroute resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ObjectFirewallIdentitybasedroute Resource

    Get an existing ObjectFirewallIdentitybasedroute resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ObjectFirewallIdentitybasedrouteState, opts?: CustomResourceOptions): ObjectFirewallIdentitybasedroute
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        adom: Optional[str] = None,
        comments: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        name: Optional[str] = None,
        object_firewall_identitybasedroute_id: Optional[str] = None,
        rules: Optional[Sequence[ObjectFirewallIdentitybasedrouteRuleArgs]] = None,
        scopetype: Optional[str] = None) -> ObjectFirewallIdentitybasedroute
    func GetObjectFirewallIdentitybasedroute(ctx *Context, name string, id IDInput, state *ObjectFirewallIdentitybasedrouteState, opts ...ResourceOption) (*ObjectFirewallIdentitybasedroute, error)
    public static ObjectFirewallIdentitybasedroute Get(string name, Input<string> id, ObjectFirewallIdentitybasedrouteState? state, CustomResourceOptions? opts = null)
    public static ObjectFirewallIdentitybasedroute get(String name, Output<String> id, ObjectFirewallIdentitybasedrouteState state, CustomResourceOptions options)
    resources:  _:    type: fortimanager:ObjectFirewallIdentitybasedroute    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Comments string
    Comments.
    DynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    Name string
    Name.
    ObjectFirewallIdentitybasedrouteId string
    an identifier for the resource with format {{name}}.
    Rules List<ObjectFirewallIdentitybasedrouteRule>
    Rule. The structure of rule block is documented below.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    Adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    Comments string
    Comments.
    DynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    Name string
    Name.
    ObjectFirewallIdentitybasedrouteId string
    an identifier for the resource with format {{name}}.
    Rules []ObjectFirewallIdentitybasedrouteRuleTypeArgs
    Rule. The structure of rule block is documented below.
    Scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comments String
    Comments.
    dynamicSortSubtable String
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    name String
    Name.
    objectFirewallIdentitybasedrouteId String
    an identifier for the resource with format {{name}}.
    rules List<ObjectFirewallIdentitybasedrouteRule>
    Rule. The structure of rule block is documented below.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    adom string
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comments string
    Comments.
    dynamicSortSubtable string
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    name string
    Name.
    objectFirewallIdentitybasedrouteId string
    an identifier for the resource with format {{name}}.
    rules ObjectFirewallIdentitybasedrouteRule[]
    Rule. The structure of rule block is documented below.
    scopetype string
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    adom str
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comments str
    Comments.
    dynamic_sort_subtable str
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    name str
    Name.
    object_firewall_identitybasedroute_id str
    an identifier for the resource with format {{name}}.
    rules Sequence[ObjectFirewallIdentitybasedrouteRuleArgs]
    Rule. The structure of rule block is documented below.
    scopetype str
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
    adom String
    Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
    comments String
    Comments.
    dynamicSortSubtable String
    true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
    name String
    Name.
    objectFirewallIdentitybasedrouteId String
    an identifier for the resource with format {{name}}.
    rules List<Property Map>
    Rule. The structure of rule block is documented below.
    scopetype String
    The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.

    Supporting Types

    ObjectFirewallIdentitybasedrouteRule, ObjectFirewallIdentitybasedrouteRuleArgs

    Device string
    Outgoing interface for the rule.
    Gateway string
    IPv4 address of the gateway (Format: xxx.xxx.xxx.xxx , Default: 0.0.0.0).
    Groups string
    Select one or more group(s) from available groups that are allowed to use this route. Separate group names with a space.
    Id double
    Rule ID.
    Device string
    Outgoing interface for the rule.
    Gateway string
    IPv4 address of the gateway (Format: xxx.xxx.xxx.xxx , Default: 0.0.0.0).
    Groups string
    Select one or more group(s) from available groups that are allowed to use this route. Separate group names with a space.
    Id float64
    Rule ID.
    device String
    Outgoing interface for the rule.
    gateway String
    IPv4 address of the gateway (Format: xxx.xxx.xxx.xxx , Default: 0.0.0.0).
    groups String
    Select one or more group(s) from available groups that are allowed to use this route. Separate group names with a space.
    id Double
    Rule ID.
    device string
    Outgoing interface for the rule.
    gateway string
    IPv4 address of the gateway (Format: xxx.xxx.xxx.xxx , Default: 0.0.0.0).
    groups string
    Select one or more group(s) from available groups that are allowed to use this route. Separate group names with a space.
    id number
    Rule ID.
    device str
    Outgoing interface for the rule.
    gateway str
    IPv4 address of the gateway (Format: xxx.xxx.xxx.xxx , Default: 0.0.0.0).
    groups str
    Select one or more group(s) from available groups that are allowed to use this route. Separate group names with a space.
    id float
    Rule ID.
    device String
    Outgoing interface for the rule.
    gateway String
    IPv4 address of the gateway (Format: xxx.xxx.xxx.xxx , Default: 0.0.0.0).
    groups String
    Select one or more group(s) from available groups that are allowed to use this route. Separate group names with a space.
    id Number
    Rule ID.

    Import

    ObjectFirewall IdentityBasedRoute can be imported using any of these accepted formats:

    $ export “FORTIMANAGER_IMPORT_TABLE”=“true”

    $ pulumi import fortimanager:index/objectFirewallIdentitybasedroute:ObjectFirewallIdentitybasedroute labelname {{name}}

    $ unset “FORTIMANAGER_IMPORT_TABLE”

    -> Hint: The scopetype and adom for import will directly inherit the scopetype and adom configuration of the provider.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    fortimanager fortinetdev/terraform-provider-fortimanager
    License
    Notes
    This Pulumi package is based on the fortimanager Terraform Provider.
    fortimanager logo
    fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev
    fortinetdev/terraform-provider-fortimanager