Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. RoutingRuleCollection
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.RoutingRuleCollection

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-azure-native

    Defines the routing rule collection. Azure REST API version: 2024-03-01.

    Example Usage

    Create or Update a routing rule collection

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

return await Deployment.RunAsync(() => 
{
    var routingRuleCollection = new AzureNative.Network.RoutingRuleCollection("routingRuleCollection", new()
    {
        AppliesTo = new[]
        {
            new AzureNative.Network.Inputs.NetworkManagerRoutingGroupItemArgs
            {
                NetworkGroupId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup",
            },
        },
        ConfigurationName = "myTestRoutingConfig",
        Description = "A sample policy",
        NetworkManagerName = "testNetworkManager",
        ResourceGroupName = "rg1",
        RuleCollectionName = "testRuleCollection",
    });

});

    package main

import (
	network "github.com/pulumi/pulumi-azure-native-sdk/network/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewRoutingRuleCollection(ctx, "routingRuleCollection", &network.RoutingRuleCollectionArgs{
			AppliesTo: network.NetworkManagerRoutingGroupItemArray{
				&network.NetworkManagerRoutingGroupItemArgs{
					NetworkGroupId: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup"),
				},
			},
			ConfigurationName:  pulumi.String("myTestRoutingConfig"),
			Description:        pulumi.String("A sample policy"),
			NetworkManagerName: pulumi.String("testNetworkManager"),
			ResourceGroupName:  pulumi.String("rg1"),
			RuleCollectionName: pulumi.String("testRuleCollection"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.network.RoutingRuleCollection;
import com.pulumi.azurenative.network.RoutingRuleCollectionArgs;
import com.pulumi.azurenative.network.inputs.NetworkManagerRoutingGroupItemArgs;
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 routingRuleCollection = new RoutingRuleCollection("routingRuleCollection", RoutingRuleCollectionArgs.builder()
            .appliesTo(NetworkManagerRoutingGroupItemArgs.builder()
                .networkGroupId("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup")
                .build())
            .configurationName("myTestRoutingConfig")
            .description("A sample policy")
            .networkManagerName("testNetworkManager")
            .resourceGroupName("rg1")
            .ruleCollectionName("testRuleCollection")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

routing_rule_collection = azure_native.network.RoutingRuleCollection("routingRuleCollection",
    applies_to=[{
        "network_group_id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup",
    }],
    configuration_name="myTestRoutingConfig",
    description="A sample policy",
    network_manager_name="testNetworkManager",
    resource_group_name="rg1",
    rule_collection_name="testRuleCollection")

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const routingRuleCollection = new azure_native.network.RoutingRuleCollection("routingRuleCollection", {
    appliesTo: [{
        networkGroupId: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup",
    }],
    configurationName: "myTestRoutingConfig",
    description: "A sample policy",
    networkManagerName: "testNetworkManager",
    resourceGroupName: "rg1",
    ruleCollectionName: "testRuleCollection",
});

    resources:
  routingRuleCollection:
    type: azure-native:network:RoutingRuleCollection
    properties:
      appliesTo:
        - networkGroupId: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup
      configurationName: myTestRoutingConfig
      description: A sample policy
      networkManagerName: testNetworkManager
      resourceGroupName: rg1
      ruleCollectionName: testRuleCollection

    Create RoutingRuleCollection Resource

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

    Constructor syntax

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

@overload
def RoutingRuleCollection(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          applies_to: Optional[Sequence[NetworkManagerRoutingGroupItemArgs]] = None,
                          configuration_name: Optional[str] = None,
                          network_manager_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          description: Optional[str] = None,
                          disable_bgp_route_propagation: Optional[Union[str, DisableBgpRoutePropagation]] = None,
                          rule_collection_name: Optional[str] = None)
    func NewRoutingRuleCollection(ctx *Context, name string, args RoutingRuleCollectionArgs, opts ...ResourceOption) (*RoutingRuleCollection, error)
    public RoutingRuleCollection(string name, RoutingRuleCollectionArgs args, CustomResourceOptions? opts = null)
    public RoutingRuleCollection(String name, RoutingRuleCollectionArgs args)
public RoutingRuleCollection(String name, RoutingRuleCollectionArgs args, CustomResourceOptions options)

    type: azure-native:network:RoutingRuleCollection
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 RoutingRuleCollectionArgs
    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 RoutingRuleCollectionArgs
    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 RoutingRuleCollectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RoutingRuleCollectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RoutingRuleCollectionArgs
    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 routingRuleCollectionResource = new AzureNative.Network.RoutingRuleCollection("routingRuleCollectionResource", new()
{
    AppliesTo = new[]
    {
        new AzureNative.Network.Inputs.NetworkManagerRoutingGroupItemArgs
        {
            NetworkGroupId = "string",
        },
    },
    ConfigurationName = "string",
    NetworkManagerName = "string",
    ResourceGroupName = "string",
    Description = "string",
    DisableBgpRoutePropagation = "string",
    RuleCollectionName = "string",
});

    example, err := network.NewRoutingRuleCollection(ctx, "routingRuleCollectionResource", &network.RoutingRuleCollectionArgs{
	AppliesTo: network.NetworkManagerRoutingGroupItemArray{
		&network.NetworkManagerRoutingGroupItemArgs{
			NetworkGroupId: pulumi.String("string"),
		},
	},
	ConfigurationName:          pulumi.String("string"),
	NetworkManagerName:         pulumi.String("string"),
	ResourceGroupName:          pulumi.String("string"),
	Description:                pulumi.String("string"),
	DisableBgpRoutePropagation: pulumi.String("string"),
	RuleCollectionName:         pulumi.String("string"),
})

    var routingRuleCollectionResource = new RoutingRuleCollection("routingRuleCollectionResource", RoutingRuleCollectionArgs.builder()
    .appliesTo(NetworkManagerRoutingGroupItemArgs.builder()
        .networkGroupId("string")
        .build())
    .configurationName("string")
    .networkManagerName("string")
    .resourceGroupName("string")
    .description("string")
    .disableBgpRoutePropagation("string")
    .ruleCollectionName("string")
    .build());

    routing_rule_collection_resource = azure_native.network.RoutingRuleCollection("routingRuleCollectionResource",
    applies_to=[{
        "networkGroupId": "string",
    }],
    configuration_name="string",
    network_manager_name="string",
    resource_group_name="string",
    description="string",
    disable_bgp_route_propagation="string",
    rule_collection_name="string")

    const routingRuleCollectionResource = new azure_native.network.RoutingRuleCollection("routingRuleCollectionResource", {
    appliesTo: [{
        networkGroupId: "string",
    }],
    configurationName: "string",
    networkManagerName: "string",
    resourceGroupName: "string",
    description: "string",
    disableBgpRoutePropagation: "string",
    ruleCollectionName: "string",
});

    type: azure-native:network:RoutingRuleCollection
properties:
    appliesTo:
        - networkGroupId: string
    configurationName: string
    description: string
    disableBgpRoutePropagation: string
    networkManagerName: string
    resourceGroupName: string
    ruleCollectionName: string

    RoutingRuleCollection Resource Properties

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

    Inputs

    The RoutingRuleCollection resource accepts the following input properties:

    AppliesTo List<Pulumi.AzureNative.Network.Inputs.NetworkManagerRoutingGroupItem>
    Groups for configuration
    ConfigurationName string
    The name of the network manager Routing Configuration.
    NetworkManagerName string
    The name of the network manager.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    Description string
    A description of the routing rule collection.
    DisableBgpRoutePropagation string | Pulumi.AzureNative.Network.DisableBgpRoutePropagation
    Determines whether BGP route propagation is enabled. Defaults to true.
    RuleCollectionName string
    The name of the network manager routing Configuration rule collection.
    AppliesTo []NetworkManagerRoutingGroupItemArgs
    Groups for configuration
    ConfigurationName string
    The name of the network manager Routing Configuration.
    NetworkManagerName string
    The name of the network manager.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    Description string
    A description of the routing rule collection.
    DisableBgpRoutePropagation string | DisableBgpRoutePropagation
    Determines whether BGP route propagation is enabled. Defaults to true.
    RuleCollectionName string
    The name of the network manager routing Configuration rule collection.
    appliesTo List<NetworkManagerRoutingGroupItem>
    Groups for configuration
    configurationName String
    The name of the network manager Routing Configuration.
    networkManagerName String
    The name of the network manager.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    description String
    A description of the routing rule collection.
    disableBgpRoutePropagation String | DisableBgpRoutePropagation
    Determines whether BGP route propagation is enabled. Defaults to true.
    ruleCollectionName String
    The name of the network manager routing Configuration rule collection.
    appliesTo NetworkManagerRoutingGroupItem[]
    Groups for configuration
    configurationName string
    The name of the network manager Routing Configuration.
    networkManagerName string
    The name of the network manager.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    description string
    A description of the routing rule collection.
    disableBgpRoutePropagation string | DisableBgpRoutePropagation
    Determines whether BGP route propagation is enabled. Defaults to true.
    ruleCollectionName string
    The name of the network manager routing Configuration rule collection.
    applies_to Sequence[NetworkManagerRoutingGroupItemArgs]
    Groups for configuration
    configuration_name str
    The name of the network manager Routing Configuration.
    network_manager_name str
    The name of the network manager.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    description str
    A description of the routing rule collection.
    disable_bgp_route_propagation str | DisableBgpRoutePropagation
    Determines whether BGP route propagation is enabled. Defaults to true.
    rule_collection_name str
    The name of the network manager routing Configuration rule collection.
    appliesTo List<Property Map>
    Groups for configuration
    configurationName String
    The name of the network manager Routing Configuration.
    networkManagerName String
    The name of the network manager.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    description String
    A description of the routing rule collection.
    disableBgpRoutePropagation String | "False" | "True"
    Determines whether BGP route propagation is enabled. Defaults to true.
    ruleCollectionName String
    The name of the network manager routing Configuration rule collection.

    Outputs

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

    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name.
    ProvisioningState string
    The provisioning state of the resource.
    ResourceGuid string
    Unique identifier for this resource.
    SystemData Pulumi.AzureNative.Network.Outputs.SystemDataResponse
    The system metadata related to this resource.
    Type string
    Resource type.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name.
    ProvisioningState string
    The provisioning state of the resource.
    ResourceGuid string
    Unique identifier for this resource.
    SystemData SystemDataResponse
    The system metadata related to this resource.
    Type string
    Resource type.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    provisioningState String
    The provisioning state of the resource.
    resourceGuid String
    Unique identifier for this resource.
    systemData SystemDataResponse
    The system metadata related to this resource.
    type String
    Resource type.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Resource name.
    provisioningState string
    The provisioning state of the resource.
    resourceGuid string
    Unique identifier for this resource.
    systemData SystemDataResponse
    The system metadata related to this resource.
    type string
    Resource type.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Resource name.
    provisioning_state str
    The provisioning state of the resource.
    resource_guid str
    Unique identifier for this resource.
    system_data SystemDataResponse
    The system metadata related to this resource.
    type str
    Resource type.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    provisioningState String
    The provisioning state of the resource.
    resourceGuid String
    Unique identifier for this resource.
    systemData Property Map
    The system metadata related to this resource.
    type String
    Resource type.

    Supporting Types

    DisableBgpRoutePropagation, DisableBgpRoutePropagationArgs

    False
    False
    True
    True
    DisableBgpRoutePropagationFalse
    False
    DisableBgpRoutePropagationTrue
    True
    False
    False
    True
    True
    False
    False
    True
    True
    FALSE
    False
    TRUE
    True
    "False"
    False
    "True"
    True

    NetworkManagerRoutingGroupItem, NetworkManagerRoutingGroupItemArgs

    NetworkGroupId string
    Network manager group Id.
    NetworkGroupId string
    Network manager group Id.
    networkGroupId String
    Network manager group Id.
    networkGroupId string
    Network manager group Id.
    network_group_id str
    Network manager group Id.
    networkGroupId String
    Network manager group Id.

    NetworkManagerRoutingGroupItemResponse, NetworkManagerRoutingGroupItemResponseArgs

    NetworkGroupId string
    Network manager group Id.
    NetworkGroupId string
    Network manager group Id.
    networkGroupId String
    Network manager group Id.
    networkGroupId string
    Network manager group Id.
    network_group_id str
    Network manager group Id.
    networkGroupId String
    Network manager group Id.

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The type of identity that last modified the resource.
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The type of identity that last modified the resource.
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The type of identity that last modified the resource.
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The type of identity that last modified the resource.
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The type of identity that last modified the resource.
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The type of identity that last modified the resource.
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:network:RoutingRuleCollection myTestRoutingConfig /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
    pulumi/pulumi-azure-native