Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. network
  5. getRoutingRuleCollection
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.network.getRoutingRuleCollection

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a network manager routing configuration rule collection. Azure REST API version: 2024-03-01.

Other available API versions: 2024-05-01.

Using getRoutingRuleCollection

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRoutingRuleCollection(args: GetRoutingRuleCollectionArgs, opts?: InvokeOptions): Promise<GetRoutingRuleCollectionResult>
function getRoutingRuleCollectionOutput(args: GetRoutingRuleCollectionOutputArgs, opts?: InvokeOptions): Output<GetRoutingRuleCollectionResult>
Copy
def get_routing_rule_collection(configuration_name: Optional[str] = None,
                                network_manager_name: Optional[str] = None,
                                resource_group_name: Optional[str] = None,
                                rule_collection_name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetRoutingRuleCollectionResult
def get_routing_rule_collection_output(configuration_name: Optional[pulumi.Input[str]] = None,
                                network_manager_name: Optional[pulumi.Input[str]] = None,
                                resource_group_name: Optional[pulumi.Input[str]] = None,
                                rule_collection_name: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetRoutingRuleCollectionResult]
Copy
func LookupRoutingRuleCollection(ctx *Context, args *LookupRoutingRuleCollectionArgs, opts ...InvokeOption) (*LookupRoutingRuleCollectionResult, error)
func LookupRoutingRuleCollectionOutput(ctx *Context, args *LookupRoutingRuleCollectionOutputArgs, opts ...InvokeOption) LookupRoutingRuleCollectionResultOutput
Copy

> Note: This function is named LookupRoutingRuleCollection in the Go SDK.

public static class GetRoutingRuleCollection 
{
    public static Task<GetRoutingRuleCollectionResult> InvokeAsync(GetRoutingRuleCollectionArgs args, InvokeOptions? opts = null)
    public static Output<GetRoutingRuleCollectionResult> Invoke(GetRoutingRuleCollectionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRoutingRuleCollectionResult> getRoutingRuleCollection(GetRoutingRuleCollectionArgs args, InvokeOptions options)
public static Output<GetRoutingRuleCollectionResult> getRoutingRuleCollection(GetRoutingRuleCollectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getRoutingRuleCollection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ConfigurationName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager Routing Configuration.
NetworkManagerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
RuleCollectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager routing Configuration rule collection.
ConfigurationName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager Routing Configuration.
NetworkManagerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
RuleCollectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager routing Configuration rule collection.
configurationName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network manager Routing Configuration.
networkManagerName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network manager.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
ruleCollectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network manager routing Configuration rule collection.
configurationName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager Routing Configuration.
networkManagerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ruleCollectionName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager routing Configuration rule collection.
configuration_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the network manager Routing Configuration.
network_manager_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the network manager.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
rule_collection_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the network manager routing Configuration rule collection.
configurationName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network manager Routing Configuration.
networkManagerName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network manager.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
ruleCollectionName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network manager routing Configuration rule collection.

getRoutingRuleCollection Result

The following output properties are available:

AppliesTo List<Pulumi.AzureNative.Network.Outputs.NetworkManagerRoutingGroupItemResponse>
Groups for configuration
Etag string
A unique read-only string that changes whenever the resource is updated.
Id string
Resource ID.
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.
Description string
A description of the routing rule collection.
DisableBgpRoutePropagation string
Determines whether BGP route propagation is enabled. Defaults to true.
AppliesTo []NetworkManagerRoutingGroupItemResponse
Groups for configuration
Etag string
A unique read-only string that changes whenever the resource is updated.
Id string
Resource ID.
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.
Description string
A description of the routing rule collection.
DisableBgpRoutePropagation string
Determines whether BGP route propagation is enabled. Defaults to true.
appliesTo List<NetworkManagerRoutingGroupItemResponse>
Groups for configuration
etag String
A unique read-only string that changes whenever the resource is updated.
id String
Resource ID.
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.
description String
A description of the routing rule collection.
disableBgpRoutePropagation String
Determines whether BGP route propagation is enabled. Defaults to true.
appliesTo NetworkManagerRoutingGroupItemResponse[]
Groups for configuration
etag string
A unique read-only string that changes whenever the resource is updated.
id string
Resource ID.
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.
description string
A description of the routing rule collection.
disableBgpRoutePropagation string
Determines whether BGP route propagation is enabled. Defaults to true.
applies_to Sequence[NetworkManagerRoutingGroupItemResponse]
Groups for configuration
etag str
A unique read-only string that changes whenever the resource is updated.
id str
Resource ID.
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.
description str
A description of the routing rule collection.
disable_bgp_route_propagation str
Determines whether BGP route propagation is enabled. Defaults to true.
appliesTo List<Property Map>
Groups for configuration
etag String
A unique read-only string that changes whenever the resource is updated.
id String
Resource ID.
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.
description String
A description of the routing rule collection.
disableBgpRoutePropagation String
Determines whether BGP route propagation is enabled. Defaults to true.

Supporting Types

NetworkManagerRoutingGroupItemResponse

NetworkGroupId This property is required. string
Network manager group Id.
NetworkGroupId This property is required. string
Network manager group Id.
networkGroupId This property is required. String
Network manager group Id.
networkGroupId This property is required. string
Network manager group Id.
network_group_id This property is required. str
Network manager group Id.
networkGroupId This property is required. String
Network manager group Id.

SystemDataResponse

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.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native