Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. managednetworkfabric
  5. getRoutePolicy
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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.managednetworkfabric.getRoutePolicy

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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Implements Route Policy GET method.

Uses Azure REST API version 2023-06-15.

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

Using getRoutePolicy

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 getRoutePolicy(args: GetRoutePolicyArgs, opts?: InvokeOptions): Promise<GetRoutePolicyResult>
function getRoutePolicyOutput(args: GetRoutePolicyOutputArgs, opts?: InvokeOptions): Output<GetRoutePolicyResult>
Copy
def get_route_policy(resource_group_name: Optional[str] = None,
                     route_policy_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetRoutePolicyResult
def get_route_policy_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                     route_policy_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetRoutePolicyResult]
Copy
func LookupRoutePolicy(ctx *Context, args *LookupRoutePolicyArgs, opts ...InvokeOption) (*LookupRoutePolicyResult, error)
func LookupRoutePolicyOutput(ctx *Context, args *LookupRoutePolicyOutputArgs, opts ...InvokeOption) LookupRoutePolicyResultOutput
Copy

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

public static class GetRoutePolicy 
{
    public static Task<GetRoutePolicyResult> InvokeAsync(GetRoutePolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetRoutePolicyResult> Invoke(GetRoutePolicyInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRoutePolicyResult> getRoutePolicy(GetRoutePolicyArgs args, InvokeOptions options)
public static Output<GetRoutePolicyResult> getRoutePolicy(GetRoutePolicyArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:managednetworkfabric:getRoutePolicy
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
RoutePolicyName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Route Policy.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
RoutePolicyName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Route Policy.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
routePolicyName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Route Policy.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
routePolicyName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Route Policy.
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.
route_policy_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the Route Policy.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
routePolicyName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Route Policy.

getRoutePolicy Result

The following output properties are available:

AdministrativeState string
Administrative state of the resource.
AzureApiVersion string
The Azure API version of the resource.
ConfigurationState string
Configuration state of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
Name string
The name of the resource
NetworkFabricId string
Arm Resource ID of Network Fabric.
ProvisioningState string
Provisioning state of the resource.
Statements List<Pulumi.AzureNative.ManagedNetworkFabric.Outputs.RoutePolicyStatementPropertiesResponse>
Route Policy statements.
SystemData Pulumi.AzureNative.ManagedNetworkFabric.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AddressFamilyType string
AddressFamilyType. This parameter decides whether the given ipv4 or ipv6 route policy.
Annotation string
Switch configuration description.
DefaultAction string
Default action that needs to be applied when no condition is matched. Example: Permit | Deny.
Tags Dictionary<string, string>
Resource tags.
AdministrativeState string
Administrative state of the resource.
AzureApiVersion string
The Azure API version of the resource.
ConfigurationState string
Configuration state of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
Name string
The name of the resource
NetworkFabricId string
Arm Resource ID of Network Fabric.
ProvisioningState string
Provisioning state of the resource.
Statements []RoutePolicyStatementPropertiesResponse
Route Policy statements.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AddressFamilyType string
AddressFamilyType. This parameter decides whether the given ipv4 or ipv6 route policy.
Annotation string
Switch configuration description.
DefaultAction string
Default action that needs to be applied when no condition is matched. Example: Permit | Deny.
Tags map[string]string
Resource tags.
administrativeState String
Administrative state of the resource.
azureApiVersion String
The Azure API version of the resource.
configurationState String
Configuration state of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
name String
The name of the resource
networkFabricId String
Arm Resource ID of Network Fabric.
provisioningState String
Provisioning state of the resource.
statements List<RoutePolicyStatementPropertiesResponse>
Route Policy statements.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
addressFamilyType String
AddressFamilyType. This parameter decides whether the given ipv4 or ipv6 route policy.
annotation String
Switch configuration description.
defaultAction String
Default action that needs to be applied when no condition is matched. Example: Permit | Deny.
tags Map<String,String>
Resource tags.
administrativeState string
Administrative state of the resource.
azureApiVersion string
The Azure API version of the resource.
configurationState string
Configuration state of the resource.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location string
The geo-location where the resource lives
name string
The name of the resource
networkFabricId string
Arm Resource ID of Network Fabric.
provisioningState string
Provisioning state of the resource.
statements RoutePolicyStatementPropertiesResponse[]
Route Policy statements.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
addressFamilyType string
AddressFamilyType. This parameter decides whether the given ipv4 or ipv6 route policy.
annotation string
Switch configuration description.
defaultAction string
Default action that needs to be applied when no condition is matched. Example: Permit | Deny.
tags {[key: string]: string}
Resource tags.
administrative_state str
Administrative state of the resource.
azure_api_version str
The Azure API version of the resource.
configuration_state str
Configuration state of the resource.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location str
The geo-location where the resource lives
name str
The name of the resource
network_fabric_id str
Arm Resource ID of Network Fabric.
provisioning_state str
Provisioning state of the resource.
statements Sequence[RoutePolicyStatementPropertiesResponse]
Route Policy statements.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
address_family_type str
AddressFamilyType. This parameter decides whether the given ipv4 or ipv6 route policy.
annotation str
Switch configuration description.
default_action str
Default action that needs to be applied when no condition is matched. Example: Permit | Deny.
tags Mapping[str, str]
Resource tags.
administrativeState String
Administrative state of the resource.
azureApiVersion String
The Azure API version of the resource.
configurationState String
Configuration state of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
name String
The name of the resource
networkFabricId String
Arm Resource ID of Network Fabric.
provisioningState String
Provisioning state of the resource.
statements List<Property Map>
Route Policy statements.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
addressFamilyType String
AddressFamilyType. This parameter decides whether the given ipv4 or ipv6 route policy.
annotation String
Switch configuration description.
defaultAction String
Default action that needs to be applied when no condition is matched. Example: Permit | Deny.
tags Map<String>
Resource tags.

Supporting Types

ActionIpCommunityPropertiesResponse

Add IpCommunityIdListResponse
List of IP Community IDs.
Delete IpCommunityIdListResponse
List of IP Community IDs.
Set IpCommunityIdListResponse
List of IP Community IDs.
add IpCommunityIdListResponse
List of IP Community IDs.
delete IpCommunityIdListResponse
List of IP Community IDs.
set IpCommunityIdListResponse
List of IP Community IDs.
add IpCommunityIdListResponse
List of IP Community IDs.
delete IpCommunityIdListResponse
List of IP Community IDs.
set IpCommunityIdListResponse
List of IP Community IDs.
add IpCommunityIdListResponse
List of IP Community IDs.
delete IpCommunityIdListResponse
List of IP Community IDs.
set IpCommunityIdListResponse
List of IP Community IDs.
add Property Map
List of IP Community IDs.
delete Property Map
List of IP Community IDs.
set Property Map
List of IP Community IDs.

ActionIpExtendedCommunityPropertiesResponse

Add IpExtendedCommunityIdListResponse
List of IP Extended Community IDs.
Delete IpExtendedCommunityIdListResponse
List of IP Extended Community IDs.
Set IpExtendedCommunityIdListResponse
List of IP Extended Community IDs.
add IpExtendedCommunityIdListResponse
List of IP Extended Community IDs.
delete IpExtendedCommunityIdListResponse
List of IP Extended Community IDs.
set IpExtendedCommunityIdListResponse
List of IP Extended Community IDs.
add IpExtendedCommunityIdListResponse
List of IP Extended Community IDs.
delete IpExtendedCommunityIdListResponse
List of IP Extended Community IDs.
set IpExtendedCommunityIdListResponse
List of IP Extended Community IDs.
add IpExtendedCommunityIdListResponse
List of IP Extended Community IDs.
delete IpExtendedCommunityIdListResponse
List of IP Extended Community IDs.
set IpExtendedCommunityIdListResponse
List of IP Extended Community IDs.
add Property Map
List of IP Extended Community IDs.
delete Property Map
List of IP Extended Community IDs.
set Property Map
List of IP Extended Community IDs.

IpCommunityIdListResponse

IpCommunityIds List<string>
List of IP Community resource IDs.
IpCommunityIds []string
List of IP Community resource IDs.
ipCommunityIds List<String>
List of IP Community resource IDs.
ipCommunityIds string[]
List of IP Community resource IDs.
ip_community_ids Sequence[str]
List of IP Community resource IDs.
ipCommunityIds List<String>
List of IP Community resource IDs.

IpExtendedCommunityIdListResponse

IpExtendedCommunityIds List<string>
List of IP Extended Community resource IDs.
IpExtendedCommunityIds []string
List of IP Extended Community resource IDs.
ipExtendedCommunityIds List<String>
List of IP Extended Community resource IDs.
ipExtendedCommunityIds string[]
List of IP Extended Community resource IDs.
ip_extended_community_ids Sequence[str]
List of IP Extended Community resource IDs.
ipExtendedCommunityIds List<String>
List of IP Extended Community resource IDs.

RoutePolicyStatementPropertiesResponse

Action This property is required. Pulumi.AzureNative.ManagedNetworkFabric.Inputs.StatementActionPropertiesResponse
Route policy action properties.
Condition This property is required. Pulumi.AzureNative.ManagedNetworkFabric.Inputs.StatementConditionPropertiesResponse
Route policy condition properties.
SequenceNumber This property is required. double
Sequence to insert to/delete from existing route.
Annotation string
Switch configuration description.
Action This property is required. StatementActionPropertiesResponse
Route policy action properties.
Condition This property is required. StatementConditionPropertiesResponse
Route policy condition properties.
SequenceNumber This property is required. float64
Sequence to insert to/delete from existing route.
Annotation string
Switch configuration description.
action This property is required. StatementActionPropertiesResponse
Route policy action properties.
condition This property is required. StatementConditionPropertiesResponse
Route policy condition properties.
sequenceNumber This property is required. Double
Sequence to insert to/delete from existing route.
annotation String
Switch configuration description.
action This property is required. StatementActionPropertiesResponse
Route policy action properties.
condition This property is required. StatementConditionPropertiesResponse
Route policy condition properties.
sequenceNumber This property is required. number
Sequence to insert to/delete from existing route.
annotation string
Switch configuration description.
action This property is required. StatementActionPropertiesResponse
Route policy action properties.
condition This property is required. StatementConditionPropertiesResponse
Route policy condition properties.
sequence_number This property is required. float
Sequence to insert to/delete from existing route.
annotation str
Switch configuration description.
action This property is required. Property Map
Route policy action properties.
condition This property is required. Property Map
Route policy condition properties.
sequenceNumber This property is required. Number
Sequence to insert to/delete from existing route.
annotation String
Switch configuration description.

StatementActionPropertiesResponse

ActionType This property is required. string
Action type. Example: Permit | Deny | Continue.
IpCommunityProperties Pulumi.AzureNative.ManagedNetworkFabric.Inputs.ActionIpCommunityPropertiesResponse
IP Community Properties.
IpExtendedCommunityProperties Pulumi.AzureNative.ManagedNetworkFabric.Inputs.ActionIpExtendedCommunityPropertiesResponse
IP Extended Community Properties.
LocalPreference double
Local Preference of the route policy.
ActionType This property is required. string
Action type. Example: Permit | Deny | Continue.
IpCommunityProperties ActionIpCommunityPropertiesResponse
IP Community Properties.
IpExtendedCommunityProperties ActionIpExtendedCommunityPropertiesResponse
IP Extended Community Properties.
LocalPreference float64
Local Preference of the route policy.
actionType This property is required. String
Action type. Example: Permit | Deny | Continue.
ipCommunityProperties ActionIpCommunityPropertiesResponse
IP Community Properties.
ipExtendedCommunityProperties ActionIpExtendedCommunityPropertiesResponse
IP Extended Community Properties.
localPreference Double
Local Preference of the route policy.
actionType This property is required. string
Action type. Example: Permit | Deny | Continue.
ipCommunityProperties ActionIpCommunityPropertiesResponse
IP Community Properties.
ipExtendedCommunityProperties ActionIpExtendedCommunityPropertiesResponse
IP Extended Community Properties.
localPreference number
Local Preference of the route policy.
action_type This property is required. str
Action type. Example: Permit | Deny | Continue.
ip_community_properties ActionIpCommunityPropertiesResponse
IP Community Properties.
ip_extended_community_properties ActionIpExtendedCommunityPropertiesResponse
IP Extended Community Properties.
local_preference float
Local Preference of the route policy.
actionType This property is required. String
Action type. Example: Permit | Deny | Continue.
ipCommunityProperties Property Map
IP Community Properties.
ipExtendedCommunityProperties Property Map
IP Extended Community Properties.
localPreference Number
Local Preference of the route policy.

StatementConditionPropertiesResponse

IpCommunityIds List<string>
List of IP Community resource IDs.
IpExtendedCommunityIds List<string>
List of IP Extended Community resource IDs.
IpPrefixId string
Arm Resource Id of IpPrefix.
Type string
Type of the condition used.
IpCommunityIds []string
List of IP Community resource IDs.
IpExtendedCommunityIds []string
List of IP Extended Community resource IDs.
IpPrefixId string
Arm Resource Id of IpPrefix.
Type string
Type of the condition used.
ipCommunityIds List<String>
List of IP Community resource IDs.
ipExtendedCommunityIds List<String>
List of IP Extended Community resource IDs.
ipPrefixId String
Arm Resource Id of IpPrefix.
type String
Type of the condition used.
ipCommunityIds string[]
List of IP Community resource IDs.
ipExtendedCommunityIds string[]
List of IP Extended Community resource IDs.
ipPrefixId string
Arm Resource Id of IpPrefix.
type string
Type of the condition used.
ip_community_ids Sequence[str]
List of IP Community resource IDs.
ip_extended_community_ids Sequence[str]
List of IP Extended Community resource IDs.
ip_prefix_id str
Arm Resource Id of IpPrefix.
type str
Type of the condition used.
ipCommunityIds List<String>
List of IP Community resource IDs.
ipExtendedCommunityIds List<String>
List of IP Extended Community resource IDs.
ipPrefixId String
Arm Resource Id of IpPrefix.
type String
Type of the condition used.

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 timestamp of resource last modification (UTC)
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 timestamp of resource last modification (UTC)
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 timestamp of resource last modification (UTC)
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 timestamp of resource last modification (UTC)
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 timestamp of resource last modification (UTC)
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 timestamp of resource last modification (UTC)
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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native