Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP 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.7.1 published on Wednesday, Aug 13, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.getRoutingRule

Explore with Pulumi AI

azure-native logo
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.7.1 published on Wednesday, Aug 13, 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, 2024-07-01, 2024-09-01-preview. 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>
    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]
    func LookupRoutingRule(ctx *Context, args *LookupRoutingRuleArgs, opts ...InvokeOption) (*LookupRoutingRuleResult, error)
func LookupRoutingRuleOutput(ctx *Context, args *LookupRoutingRuleOutputArgs, opts ...InvokeOption) LookupRoutingRuleResultOutput

    > 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)
}
    public static CompletableFuture<GetRoutingRuleResult> getRoutingRule(GetRoutingRuleArgs args, InvokeOptions options)
public static Output<GetRoutingRuleResult> getRoutingRule(GetRoutingRuleArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:network:getRoutingRule
  arguments:
    # arguments dictionary

    The following arguments are supported:

    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.
    RuleCollectionName string
    The name of the network manager routing Configuration rule collection.
    RuleName string
    The name of the rule.
    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.
    RuleCollectionName string
    The name of the network manager routing Configuration rule collection.
    RuleName string
    The name of the rule.
    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.
    ruleCollectionName String
    The name of the network manager routing Configuration rule collection.
    ruleName String
    The name of the rule.
    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.
    ruleCollectionName string
    The name of the network manager routing Configuration rule collection.
    ruleName string
    The name of the rule.
    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.
    rule_collection_name str
    The name of the network manager routing Configuration rule collection.
    rule_name str
    The name of the rule.
    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.
    ruleCollectionName String
    The name of the network manager routing Configuration rule collection.
    ruleName 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 string
    Next hop type.
    NextHopAddress string
    Next hop address. Only required if the next hop type is VirtualAppliance.
    NextHopType string
    Next hop type.
    NextHopAddress string
    Next hop address. Only required if the next hop type is VirtualAppliance.
    nextHopType String
    Next hop type.
    nextHopAddress String
    Next hop address. Only required if the next hop type is VirtualAppliance.
    nextHopType string
    Next hop type.
    nextHopAddress string
    Next hop address. Only required if the next hop type is VirtualAppliance.
    next_hop_type str
    Next hop type.
    next_hop_address str
    Next hop address. Only required if the next hop type is VirtualAppliance.
    nextHopType String
    Next hop type.
    nextHopAddress String
    Next hop address. Only required if the next hop type is VirtualAppliance.

    RoutingRuleRouteDestinationResponse

    DestinationAddress string
    Destination address.
    Type string
    Destination type.
    DestinationAddress string
    Destination address.
    Type string
    Destination type.
    destinationAddress String
    Destination address.
    type String
    Destination type.
    destinationAddress string
    Destination address.
    type string
    Destination type.
    destination_address str
    Destination address.
    type str
    Destination type.
    destinationAddress String
    Destination address.
    type 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
    azure-native logo
    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.7.1 published on Wednesday, Aug 13, 2025 by Pulumi
    pulumi/pulumi-azure-native