Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getRoutingRule
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.getRoutingRule

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a network manager routing configuration routing rule.

Uses Azure REST API version 2024-05-01.

Other available API versions: 2024-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native network [ApiVersion]. See the version guide for details.

Using getRoutingRule

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 getRoutingRule(args: GetRoutingRuleArgs, opts?: InvokeOptions): Promise<GetRoutingRuleResult>
function getRoutingRuleOutput(args: GetRoutingRuleOutputArgs, opts?: InvokeOptions): Output<GetRoutingRuleResult>
Copy
def get_routing_rule(configuration_name: Optional[str] = None,
                     network_manager_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     rule_collection_name: Optional[str] = None,
                     rule_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetRoutingRuleResult
def get_routing_rule_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,
                     rule_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetRoutingRuleResult]
Copy
func LookupRoutingRule(ctx *Context, args *LookupRoutingRuleArgs, opts ...InvokeOption) (*LookupRoutingRuleResult, error)
func LookupRoutingRuleOutput(ctx *Context, args *LookupRoutingRuleOutputArgs, opts ...InvokeOption) LookupRoutingRuleResultOutput
Copy

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

public static class GetRoutingRule 
{
    public static Task<GetRoutingRuleResult> InvokeAsync(GetRoutingRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetRoutingRuleResult> Invoke(GetRoutingRuleInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRoutingRuleResult> getRoutingRule(GetRoutingRuleArgs args, InvokeOptions options)
public static Output<GetRoutingRuleResult> getRoutingRule(GetRoutingRuleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getRoutingRule
  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.
RuleName
This property is required.
Changes to this property will trigger replacement.
string
The name of the rule.
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.
RuleName
This property is required.
Changes to this property will trigger replacement.
string
The name of the rule.
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.
ruleName
This property is required.
Changes to this property will trigger replacement.
String
The name of the rule.
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.
ruleName
This property is required.
Changes to this property will trigger replacement.
string
The name of the rule.
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.
rule_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the rule.
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.
ruleName
This property is required.
Changes to this property will trigger replacement.
String
The name of the rule.

getRoutingRule Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Destination Pulumi.AzureNative.Network.Outputs.RoutingRuleRouteDestinationResponse
Indicates the destination for this particular rule.
Etag string
A unique read-only string that changes whenever the resource is updated.
Id string
Resource ID.
Name string
Resource name.
NextHop Pulumi.AzureNative.Network.Outputs.RoutingRuleNextHopResponse
Indicates the next hop for this particular rule.
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 for this rule.
AzureApiVersion string
The Azure API version of the resource.
Destination RoutingRuleRouteDestinationResponse
Indicates the destination for this particular rule.
Etag string
A unique read-only string that changes whenever the resource is updated.
Id string
Resource ID.
Name string
Resource name.
NextHop RoutingRuleNextHopResponse
Indicates the next hop for this particular rule.
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 for this rule.
azureApiVersion String
The Azure API version of the resource.
destination RoutingRuleRouteDestinationResponse
Indicates the destination for this particular rule.
etag String
A unique read-only string that changes whenever the resource is updated.
id String
Resource ID.
name String
Resource name.
nextHop RoutingRuleNextHopResponse
Indicates the next hop for this particular rule.
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 for this rule.
azureApiVersion string
The Azure API version of the resource.
destination RoutingRuleRouteDestinationResponse
Indicates the destination for this particular rule.
etag string
A unique read-only string that changes whenever the resource is updated.
id string
Resource ID.
name string
Resource name.
nextHop RoutingRuleNextHopResponse
Indicates the next hop for this particular rule.
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 for this rule.
azure_api_version str
The Azure API version of the resource.
destination RoutingRuleRouteDestinationResponse
Indicates the destination for this particular rule.
etag str
A unique read-only string that changes whenever the resource is updated.
id str
Resource ID.
name str
Resource name.
next_hop RoutingRuleNextHopResponse
Indicates the next hop for this particular rule.
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 for this rule.
azureApiVersion String
The Azure API version of the resource.
destination Property Map
Indicates the destination for this particular rule.
etag String
A unique read-only string that changes whenever the resource is updated.
id String
Resource ID.
name String
Resource name.
nextHop Property Map
Indicates the next hop for this particular rule.
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 for this rule.

Supporting Types

RoutingRuleNextHopResponse

NextHopType This property is required. string
Next hop type.
NextHopAddress string
Next hop address. Only required if the next hop type is VirtualAppliance.
NextHopType This property is required. string
Next hop type.
NextHopAddress string
Next hop address. Only required if the next hop type is VirtualAppliance.
nextHopType This property is required. String
Next hop type.
nextHopAddress String
Next hop address. Only required if the next hop type is VirtualAppliance.
nextHopType This property is required. string
Next hop type.
nextHopAddress string
Next hop address. Only required if the next hop type is VirtualAppliance.
next_hop_type This property is required. str
Next hop type.
next_hop_address str
Next hop address. Only required if the next hop type is VirtualAppliance.
nextHopType This property is required. String
Next hop type.
nextHopAddress String
Next hop address. Only required if the next hop type is VirtualAppliance.

RoutingRuleRouteDestinationResponse

DestinationAddress This property is required. string
Destination address.
Type This property is required. string
Destination type.
DestinationAddress This property is required. string
Destination address.
Type This property is required. string
Destination type.
destinationAddress This property is required. String
Destination address.
type This property is required. String
Destination type.
destinationAddress This property is required. string
Destination address.
type This property is required. string
Destination type.
destination_address This property is required. str
Destination address.
type This property is required. str
Destination type.
destinationAddress This property is required. String
Destination address.
type This property is required. String
Destination type.

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 pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native