Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getRouteFilter
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.getRouteFilter

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the specified route filter.

Uses Azure REST API version 2024-05-01.

Other available API versions: 2018-06-01, 2018-07-01, 2018-08-01, 2018-10-01, 2018-11-01, 2018-12-01, 2019-02-01, 2019-04-01, 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 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 getRouteFilter

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 getRouteFilter(args: GetRouteFilterArgs, opts?: InvokeOptions): Promise<GetRouteFilterResult>
function getRouteFilterOutput(args: GetRouteFilterOutputArgs, opts?: InvokeOptions): Output<GetRouteFilterResult>
Copy
def get_route_filter(expand: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     route_filter_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetRouteFilterResult
def get_route_filter_output(expand: Optional[pulumi.Input[str]] = None,
                     resource_group_name: Optional[pulumi.Input[str]] = None,
                     route_filter_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetRouteFilterResult]
Copy
func LookupRouteFilter(ctx *Context, args *LookupRouteFilterArgs, opts ...InvokeOption) (*LookupRouteFilterResult, error)
func LookupRouteFilterOutput(ctx *Context, args *LookupRouteFilterOutputArgs, opts ...InvokeOption) LookupRouteFilterResultOutput
Copy

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

public static class GetRouteFilter 
{
    public static Task<GetRouteFilterResult> InvokeAsync(GetRouteFilterArgs args, InvokeOptions? opts = null)
    public static Output<GetRouteFilterResult> Invoke(GetRouteFilterInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRouteFilterResult> getRouteFilter(GetRouteFilterArgs args, InvokeOptions options)
public static Output<GetRouteFilterResult> getRouteFilter(GetRouteFilterArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getRouteFilter
  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.
RouteFilterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the route filter.
Expand string
Expands referenced express route bgp peering resources.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
RouteFilterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the route filter.
Expand string
Expands referenced express route bgp peering resources.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
routeFilterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the route filter.
expand String
Expands referenced express route bgp peering resources.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
routeFilterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the route filter.
expand string
Expands referenced express route bgp peering resources.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
route_filter_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the route filter.
expand str
Expands referenced express route bgp peering resources.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
routeFilterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the route filter.
expand String
Expands referenced express route bgp peering resources.

getRouteFilter Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
Ipv6Peerings List<Pulumi.AzureNative.Network.Outputs.ExpressRouteCircuitPeeringResponse>
A collection of references to express route circuit ipv6 peerings.
Location string
Resource location.
Name string
Resource name.
Peerings List<Pulumi.AzureNative.Network.Outputs.ExpressRouteCircuitPeeringResponse>
A collection of references to express route circuit peerings.
ProvisioningState string
The provisioning state of the route filter resource.
Type string
Resource type.
Id string
Resource ID.
Rules List<Pulumi.AzureNative.Network.Outputs.RouteFilterRuleResponse>
Collection of RouteFilterRules contained within a route filter.
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
Ipv6Peerings []ExpressRouteCircuitPeeringResponse
A collection of references to express route circuit ipv6 peerings.
Location string
Resource location.
Name string
Resource name.
Peerings []ExpressRouteCircuitPeeringResponse
A collection of references to express route circuit peerings.
ProvisioningState string
The provisioning state of the route filter resource.
Type string
Resource type.
Id string
Resource ID.
Rules []RouteFilterRuleResponse
Collection of RouteFilterRules contained within a route filter.
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
ipv6Peerings List<ExpressRouteCircuitPeeringResponse>
A collection of references to express route circuit ipv6 peerings.
location String
Resource location.
name String
Resource name.
peerings List<ExpressRouteCircuitPeeringResponse>
A collection of references to express route circuit peerings.
provisioningState String
The provisioning state of the route filter resource.
type String
Resource type.
id String
Resource ID.
rules List<RouteFilterRuleResponse>
Collection of RouteFilterRules contained within a route filter.
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
etag string
A unique read-only string that changes whenever the resource is updated.
ipv6Peerings ExpressRouteCircuitPeeringResponse[]
A collection of references to express route circuit ipv6 peerings.
location string
Resource location.
name string
Resource name.
peerings ExpressRouteCircuitPeeringResponse[]
A collection of references to express route circuit peerings.
provisioningState string
The provisioning state of the route filter resource.
type string
Resource type.
id string
Resource ID.
rules RouteFilterRuleResponse[]
Collection of RouteFilterRules contained within a route filter.
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
etag str
A unique read-only string that changes whenever the resource is updated.
ipv6_peerings Sequence[ExpressRouteCircuitPeeringResponse]
A collection of references to express route circuit ipv6 peerings.
location str
Resource location.
name str
Resource name.
peerings Sequence[ExpressRouteCircuitPeeringResponse]
A collection of references to express route circuit peerings.
provisioning_state str
The provisioning state of the route filter resource.
type str
Resource type.
id str
Resource ID.
rules Sequence[RouteFilterRuleResponse]
Collection of RouteFilterRules contained within a route filter.
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
ipv6Peerings List<Property Map>
A collection of references to express route circuit ipv6 peerings.
location String
Resource location.
name String
Resource name.
peerings List<Property Map>
A collection of references to express route circuit peerings.
provisioningState String
The provisioning state of the route filter resource.
type String
Resource type.
id String
Resource ID.
rules List<Property Map>
Collection of RouteFilterRules contained within a route filter.
tags Map<String>
Resource tags.

Supporting Types

ExpressRouteCircuitConnectionResponse

CircuitConnectionStatus This property is required. string
Express Route Circuit connection state.
Etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
ProvisioningState This property is required. string
The provisioning state of the express route circuit connection resource.
Type This property is required. string
Type of the resource.
AddressPrefix string
/29 IP address space to carve out Customer addresses for tunnels.
AuthorizationKey string
The authorization key.
ExpressRouteCircuitPeering Pulumi.AzureNative.Network.Inputs.SubResourceResponse
Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.
Id string
Resource ID.
Ipv6CircuitConnectionConfig Pulumi.AzureNative.Network.Inputs.Ipv6CircuitConnectionConfigResponse
IPv6 Address PrefixProperties of the express route circuit connection.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
PeerExpressRouteCircuitPeering Pulumi.AzureNative.Network.Inputs.SubResourceResponse
Reference to Express Route Circuit Private Peering Resource of the peered circuit.
CircuitConnectionStatus This property is required. string
Express Route Circuit connection state.
Etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
ProvisioningState This property is required. string
The provisioning state of the express route circuit connection resource.
Type This property is required. string
Type of the resource.
AddressPrefix string
/29 IP address space to carve out Customer addresses for tunnels.
AuthorizationKey string
The authorization key.
ExpressRouteCircuitPeering SubResourceResponse
Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.
Id string
Resource ID.
Ipv6CircuitConnectionConfig Ipv6CircuitConnectionConfigResponse
IPv6 Address PrefixProperties of the express route circuit connection.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
PeerExpressRouteCircuitPeering SubResourceResponse
Reference to Express Route Circuit Private Peering Resource of the peered circuit.
circuitConnectionStatus This property is required. String
Express Route Circuit connection state.
etag This property is required. String
A unique read-only string that changes whenever the resource is updated.
provisioningState This property is required. String
The provisioning state of the express route circuit connection resource.
type This property is required. String
Type of the resource.
addressPrefix String
/29 IP address space to carve out Customer addresses for tunnels.
authorizationKey String
The authorization key.
expressRouteCircuitPeering SubResourceResponse
Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.
id String
Resource ID.
ipv6CircuitConnectionConfig Ipv6CircuitConnectionConfigResponse
IPv6 Address PrefixProperties of the express route circuit connection.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.
peerExpressRouteCircuitPeering SubResourceResponse
Reference to Express Route Circuit Private Peering Resource of the peered circuit.
circuitConnectionStatus This property is required. string
Express Route Circuit connection state.
etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
provisioningState This property is required. string
The provisioning state of the express route circuit connection resource.
type This property is required. string
Type of the resource.
addressPrefix string
/29 IP address space to carve out Customer addresses for tunnels.
authorizationKey string
The authorization key.
expressRouteCircuitPeering SubResourceResponse
Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.
id string
Resource ID.
ipv6CircuitConnectionConfig Ipv6CircuitConnectionConfigResponse
IPv6 Address PrefixProperties of the express route circuit connection.
name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
peerExpressRouteCircuitPeering SubResourceResponse
Reference to Express Route Circuit Private Peering Resource of the peered circuit.
circuit_connection_status This property is required. str
Express Route Circuit connection state.
etag This property is required. str
A unique read-only string that changes whenever the resource is updated.
provisioning_state This property is required. str
The provisioning state of the express route circuit connection resource.
type This property is required. str
Type of the resource.
address_prefix str
/29 IP address space to carve out Customer addresses for tunnels.
authorization_key str
The authorization key.
express_route_circuit_peering SubResourceResponse
Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.
id str
Resource ID.
ipv6_circuit_connection_config Ipv6CircuitConnectionConfigResponse
IPv6 Address PrefixProperties of the express route circuit connection.
name str
The name of the resource that is unique within a resource group. This name can be used to access the resource.
peer_express_route_circuit_peering SubResourceResponse
Reference to Express Route Circuit Private Peering Resource of the peered circuit.
circuitConnectionStatus This property is required. String
Express Route Circuit connection state.
etag This property is required. String
A unique read-only string that changes whenever the resource is updated.
provisioningState This property is required. String
The provisioning state of the express route circuit connection resource.
type This property is required. String
Type of the resource.
addressPrefix String
/29 IP address space to carve out Customer addresses for tunnels.
authorizationKey String
The authorization key.
expressRouteCircuitPeering Property Map
Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.
id String
Resource ID.
ipv6CircuitConnectionConfig Property Map
IPv6 Address PrefixProperties of the express route circuit connection.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.
peerExpressRouteCircuitPeering Property Map
Reference to Express Route Circuit Private Peering Resource of the peered circuit.

ExpressRouteCircuitPeeringConfigResponse

AdvertisedPublicPrefixesState This property is required. string
The advertised public prefix state of the Peering resource.
AdvertisedCommunities List<string>
The communities of bgp peering. Specified for microsoft peering.
AdvertisedPublicPrefixes List<string>
The reference to AdvertisedPublicPrefixes.
CustomerASN int
The CustomerASN of the peering.
LegacyMode int
The legacy mode of the peering.
RoutingRegistryName string
The RoutingRegistryName of the configuration.
AdvertisedPublicPrefixesState This property is required. string
The advertised public prefix state of the Peering resource.
AdvertisedCommunities []string
The communities of bgp peering. Specified for microsoft peering.
AdvertisedPublicPrefixes []string
The reference to AdvertisedPublicPrefixes.
CustomerASN int
The CustomerASN of the peering.
LegacyMode int
The legacy mode of the peering.
RoutingRegistryName string
The RoutingRegistryName of the configuration.
advertisedPublicPrefixesState This property is required. String
The advertised public prefix state of the Peering resource.
advertisedCommunities List<String>
The communities of bgp peering. Specified for microsoft peering.
advertisedPublicPrefixes List<String>
The reference to AdvertisedPublicPrefixes.
customerASN Integer
The CustomerASN of the peering.
legacyMode Integer
The legacy mode of the peering.
routingRegistryName String
The RoutingRegistryName of the configuration.
advertisedPublicPrefixesState This property is required. string
The advertised public prefix state of the Peering resource.
advertisedCommunities string[]
The communities of bgp peering. Specified for microsoft peering.
advertisedPublicPrefixes string[]
The reference to AdvertisedPublicPrefixes.
customerASN number
The CustomerASN of the peering.
legacyMode number
The legacy mode of the peering.
routingRegistryName string
The RoutingRegistryName of the configuration.
advertised_public_prefixes_state This property is required. str
The advertised public prefix state of the Peering resource.
advertised_communities Sequence[str]
The communities of bgp peering. Specified for microsoft peering.
advertised_public_prefixes Sequence[str]
The reference to AdvertisedPublicPrefixes.
customer_asn int
The CustomerASN of the peering.
legacy_mode int
The legacy mode of the peering.
routing_registry_name str
The RoutingRegistryName of the configuration.
advertisedPublicPrefixesState This property is required. String
The advertised public prefix state of the Peering resource.
advertisedCommunities List<String>
The communities of bgp peering. Specified for microsoft peering.
advertisedPublicPrefixes List<String>
The reference to AdvertisedPublicPrefixes.
customerASN Number
The CustomerASN of the peering.
legacyMode Number
The legacy mode of the peering.
routingRegistryName String
The RoutingRegistryName of the configuration.

ExpressRouteCircuitPeeringResponse

Etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
LastModifiedBy This property is required. string
Who was the last to modify the peering.
PeeredConnections This property is required. List<Pulumi.AzureNative.Network.Inputs.PeerExpressRouteCircuitConnectionResponse>
The list of peered circuit connections associated with Azure Private Peering for this circuit.
ProvisioningState This property is required. string
The provisioning state of the express route circuit peering resource.
Type This property is required. string
Type of the resource.
AzureASN int
The Azure ASN.
Connections List<Pulumi.AzureNative.Network.Inputs.ExpressRouteCircuitConnectionResponse>
The list of circuit connections associated with Azure Private Peering for this circuit.
ExpressRouteConnection Pulumi.AzureNative.Network.Inputs.ExpressRouteConnectionIdResponse
The ExpressRoute connection.
GatewayManagerEtag string
The GatewayManager Etag.
Id string
Resource ID.
Ipv6PeeringConfig Pulumi.AzureNative.Network.Inputs.Ipv6ExpressRouteCircuitPeeringConfigResponse
The IPv6 peering configuration.
MicrosoftPeeringConfig Pulumi.AzureNative.Network.Inputs.ExpressRouteCircuitPeeringConfigResponse
The Microsoft peering configuration.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
PeerASN double
The peer ASN.
PeeringType string
The peering type.
PrimaryAzurePort string
The primary port.
PrimaryPeerAddressPrefix string
The primary address prefix.
RouteFilter Pulumi.AzureNative.Network.Inputs.SubResourceResponse
The reference to the RouteFilter resource.
SecondaryAzurePort string
The secondary port.
SecondaryPeerAddressPrefix string
The secondary address prefix.
SharedKey string
The shared key.
State string
The peering state.
Stats Pulumi.AzureNative.Network.Inputs.ExpressRouteCircuitStatsResponse
The peering stats of express route circuit.
VlanId int
The VLAN ID.
Etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
LastModifiedBy This property is required. string
Who was the last to modify the peering.
PeeredConnections This property is required. []PeerExpressRouteCircuitConnectionResponse
The list of peered circuit connections associated with Azure Private Peering for this circuit.
ProvisioningState This property is required. string
The provisioning state of the express route circuit peering resource.
Type This property is required. string
Type of the resource.
AzureASN int
The Azure ASN.
Connections []ExpressRouteCircuitConnectionResponse
The list of circuit connections associated with Azure Private Peering for this circuit.
ExpressRouteConnection ExpressRouteConnectionIdResponse
The ExpressRoute connection.
GatewayManagerEtag string
The GatewayManager Etag.
Id string
Resource ID.
Ipv6PeeringConfig Ipv6ExpressRouteCircuitPeeringConfigResponse
The IPv6 peering configuration.
MicrosoftPeeringConfig ExpressRouteCircuitPeeringConfigResponse
The Microsoft peering configuration.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
PeerASN float64
The peer ASN.
PeeringType string
The peering type.
PrimaryAzurePort string
The primary port.
PrimaryPeerAddressPrefix string
The primary address prefix.
RouteFilter SubResourceResponse
The reference to the RouteFilter resource.
SecondaryAzurePort string
The secondary port.
SecondaryPeerAddressPrefix string
The secondary address prefix.
SharedKey string
The shared key.
State string
The peering state.
Stats ExpressRouteCircuitStatsResponse
The peering stats of express route circuit.
VlanId int
The VLAN ID.
etag This property is required. String
A unique read-only string that changes whenever the resource is updated.
lastModifiedBy This property is required. String
Who was the last to modify the peering.
peeredConnections This property is required. List<PeerExpressRouteCircuitConnectionResponse>
The list of peered circuit connections associated with Azure Private Peering for this circuit.
provisioningState This property is required. String
The provisioning state of the express route circuit peering resource.
type This property is required. String
Type of the resource.
azureASN Integer
The Azure ASN.
connections List<ExpressRouteCircuitConnectionResponse>
The list of circuit connections associated with Azure Private Peering for this circuit.
expressRouteConnection ExpressRouteConnectionIdResponse
The ExpressRoute connection.
gatewayManagerEtag String
The GatewayManager Etag.
id String
Resource ID.
ipv6PeeringConfig Ipv6ExpressRouteCircuitPeeringConfigResponse
The IPv6 peering configuration.
microsoftPeeringConfig ExpressRouteCircuitPeeringConfigResponse
The Microsoft peering configuration.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.
peerASN Double
The peer ASN.
peeringType String
The peering type.
primaryAzurePort String
The primary port.
primaryPeerAddressPrefix String
The primary address prefix.
routeFilter SubResourceResponse
The reference to the RouteFilter resource.
secondaryAzurePort String
The secondary port.
secondaryPeerAddressPrefix String
The secondary address prefix.
sharedKey String
The shared key.
state String
The peering state.
stats ExpressRouteCircuitStatsResponse
The peering stats of express route circuit.
vlanId Integer
The VLAN ID.
etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
lastModifiedBy This property is required. string
Who was the last to modify the peering.
peeredConnections This property is required. PeerExpressRouteCircuitConnectionResponse[]
The list of peered circuit connections associated with Azure Private Peering for this circuit.
provisioningState This property is required. string
The provisioning state of the express route circuit peering resource.
type This property is required. string
Type of the resource.
azureASN number
The Azure ASN.
connections ExpressRouteCircuitConnectionResponse[]
The list of circuit connections associated with Azure Private Peering for this circuit.
expressRouteConnection ExpressRouteConnectionIdResponse
The ExpressRoute connection.
gatewayManagerEtag string
The GatewayManager Etag.
id string
Resource ID.
ipv6PeeringConfig Ipv6ExpressRouteCircuitPeeringConfigResponse
The IPv6 peering configuration.
microsoftPeeringConfig ExpressRouteCircuitPeeringConfigResponse
The Microsoft peering configuration.
name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
peerASN number
The peer ASN.
peeringType string
The peering type.
primaryAzurePort string
The primary port.
primaryPeerAddressPrefix string
The primary address prefix.
routeFilter SubResourceResponse
The reference to the RouteFilter resource.
secondaryAzurePort string
The secondary port.
secondaryPeerAddressPrefix string
The secondary address prefix.
sharedKey string
The shared key.
state string
The peering state.
stats ExpressRouteCircuitStatsResponse
The peering stats of express route circuit.
vlanId number
The VLAN ID.
etag This property is required. str
A unique read-only string that changes whenever the resource is updated.
last_modified_by This property is required. str
Who was the last to modify the peering.
peered_connections This property is required. Sequence[PeerExpressRouteCircuitConnectionResponse]
The list of peered circuit connections associated with Azure Private Peering for this circuit.
provisioning_state This property is required. str
The provisioning state of the express route circuit peering resource.
type This property is required. str
Type of the resource.
azure_asn int
The Azure ASN.
connections Sequence[ExpressRouteCircuitConnectionResponse]
The list of circuit connections associated with Azure Private Peering for this circuit.
express_route_connection ExpressRouteConnectionIdResponse
The ExpressRoute connection.
gateway_manager_etag str
The GatewayManager Etag.
id str
Resource ID.
ipv6_peering_config Ipv6ExpressRouteCircuitPeeringConfigResponse
The IPv6 peering configuration.
microsoft_peering_config ExpressRouteCircuitPeeringConfigResponse
The Microsoft peering configuration.
name str
The name of the resource that is unique within a resource group. This name can be used to access the resource.
peer_asn float
The peer ASN.
peering_type str
The peering type.
primary_azure_port str
The primary port.
primary_peer_address_prefix str
The primary address prefix.
route_filter SubResourceResponse
The reference to the RouteFilter resource.
secondary_azure_port str
The secondary port.
secondary_peer_address_prefix str
The secondary address prefix.
shared_key str
The shared key.
state str
The peering state.
stats ExpressRouteCircuitStatsResponse
The peering stats of express route circuit.
vlan_id int
The VLAN ID.
etag This property is required. String
A unique read-only string that changes whenever the resource is updated.
lastModifiedBy This property is required. String
Who was the last to modify the peering.
peeredConnections This property is required. List<Property Map>
The list of peered circuit connections associated with Azure Private Peering for this circuit.
provisioningState This property is required. String
The provisioning state of the express route circuit peering resource.
type This property is required. String
Type of the resource.
azureASN Number
The Azure ASN.
connections List<Property Map>
The list of circuit connections associated with Azure Private Peering for this circuit.
expressRouteConnection Property Map
The ExpressRoute connection.
gatewayManagerEtag String
The GatewayManager Etag.
id String
Resource ID.
ipv6PeeringConfig Property Map
The IPv6 peering configuration.
microsoftPeeringConfig Property Map
The Microsoft peering configuration.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.
peerASN Number
The peer ASN.
peeringType String
The peering type.
primaryAzurePort String
The primary port.
primaryPeerAddressPrefix String
The primary address prefix.
routeFilter Property Map
The reference to the RouteFilter resource.
secondaryAzurePort String
The secondary port.
secondaryPeerAddressPrefix String
The secondary address prefix.
sharedKey String
The shared key.
state String
The peering state.
stats Property Map
The peering stats of express route circuit.
vlanId Number
The VLAN ID.

ExpressRouteCircuitStatsResponse

PrimarybytesIn double
The Primary BytesIn of the peering.
PrimarybytesOut double
The primary BytesOut of the peering.
SecondarybytesIn double
The secondary BytesIn of the peering.
SecondarybytesOut double
The secondary BytesOut of the peering.
PrimarybytesIn float64
The Primary BytesIn of the peering.
PrimarybytesOut float64
The primary BytesOut of the peering.
SecondarybytesIn float64
The secondary BytesIn of the peering.
SecondarybytesOut float64
The secondary BytesOut of the peering.
primarybytesIn Double
The Primary BytesIn of the peering.
primarybytesOut Double
The primary BytesOut of the peering.
secondarybytesIn Double
The secondary BytesIn of the peering.
secondarybytesOut Double
The secondary BytesOut of the peering.
primarybytesIn number
The Primary BytesIn of the peering.
primarybytesOut number
The primary BytesOut of the peering.
secondarybytesIn number
The secondary BytesIn of the peering.
secondarybytesOut number
The secondary BytesOut of the peering.
primarybytes_in float
The Primary BytesIn of the peering.
primarybytes_out float
The primary BytesOut of the peering.
secondarybytes_in float
The secondary BytesIn of the peering.
secondarybytes_out float
The secondary BytesOut of the peering.
primarybytesIn Number
The Primary BytesIn of the peering.
primarybytesOut Number
The primary BytesOut of the peering.
secondarybytesIn Number
The secondary BytesIn of the peering.
secondarybytesOut Number
The secondary BytesOut of the peering.

ExpressRouteConnectionIdResponse

Id This property is required. string
The ID of the ExpressRouteConnection.
Id This property is required. string
The ID of the ExpressRouteConnection.
id This property is required. String
The ID of the ExpressRouteConnection.
id This property is required. string
The ID of the ExpressRouteConnection.
id This property is required. str
The ID of the ExpressRouteConnection.
id This property is required. String
The ID of the ExpressRouteConnection.

Ipv6CircuitConnectionConfigResponse

CircuitConnectionStatus This property is required. string
Express Route Circuit connection state.
AddressPrefix string
/125 IP address space to carve out customer addresses for global reach.
CircuitConnectionStatus This property is required. string
Express Route Circuit connection state.
AddressPrefix string
/125 IP address space to carve out customer addresses for global reach.
circuitConnectionStatus This property is required. String
Express Route Circuit connection state.
addressPrefix String
/125 IP address space to carve out customer addresses for global reach.
circuitConnectionStatus This property is required. string
Express Route Circuit connection state.
addressPrefix string
/125 IP address space to carve out customer addresses for global reach.
circuit_connection_status This property is required. str
Express Route Circuit connection state.
address_prefix str
/125 IP address space to carve out customer addresses for global reach.
circuitConnectionStatus This property is required. String
Express Route Circuit connection state.
addressPrefix String
/125 IP address space to carve out customer addresses for global reach.

Ipv6ExpressRouteCircuitPeeringConfigResponse

MicrosoftPeeringConfig Pulumi.AzureNative.Network.Inputs.ExpressRouteCircuitPeeringConfigResponse
The Microsoft peering configuration.
PrimaryPeerAddressPrefix string
The primary address prefix.
RouteFilter Pulumi.AzureNative.Network.Inputs.SubResourceResponse
The reference to the RouteFilter resource.
SecondaryPeerAddressPrefix string
The secondary address prefix.
State string
The state of peering.
MicrosoftPeeringConfig ExpressRouteCircuitPeeringConfigResponse
The Microsoft peering configuration.
PrimaryPeerAddressPrefix string
The primary address prefix.
RouteFilter SubResourceResponse
The reference to the RouteFilter resource.
SecondaryPeerAddressPrefix string
The secondary address prefix.
State string
The state of peering.
microsoftPeeringConfig ExpressRouteCircuitPeeringConfigResponse
The Microsoft peering configuration.
primaryPeerAddressPrefix String
The primary address prefix.
routeFilter SubResourceResponse
The reference to the RouteFilter resource.
secondaryPeerAddressPrefix String
The secondary address prefix.
state String
The state of peering.
microsoftPeeringConfig ExpressRouteCircuitPeeringConfigResponse
The Microsoft peering configuration.
primaryPeerAddressPrefix string
The primary address prefix.
routeFilter SubResourceResponse
The reference to the RouteFilter resource.
secondaryPeerAddressPrefix string
The secondary address prefix.
state string
The state of peering.
microsoft_peering_config ExpressRouteCircuitPeeringConfigResponse
The Microsoft peering configuration.
primary_peer_address_prefix str
The primary address prefix.
route_filter SubResourceResponse
The reference to the RouteFilter resource.
secondary_peer_address_prefix str
The secondary address prefix.
state str
The state of peering.
microsoftPeeringConfig Property Map
The Microsoft peering configuration.
primaryPeerAddressPrefix String
The primary address prefix.
routeFilter Property Map
The reference to the RouteFilter resource.
secondaryPeerAddressPrefix String
The secondary address prefix.
state String
The state of peering.

PeerExpressRouteCircuitConnectionResponse

CircuitConnectionStatus This property is required. string
Express Route Circuit connection state.
Etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
ProvisioningState This property is required. string
The provisioning state of the peer express route circuit connection resource.
Type This property is required. string
Type of the resource.
AddressPrefix string
/29 IP address space to carve out Customer addresses for tunnels.
AuthResourceGuid string
The resource guid of the authorization used for the express route circuit connection.
ConnectionName string
The name of the express route circuit connection resource.
ExpressRouteCircuitPeering Pulumi.AzureNative.Network.Inputs.SubResourceResponse
Reference to Express Route Circuit Private Peering Resource of the circuit.
Id string
Resource ID.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
PeerExpressRouteCircuitPeering Pulumi.AzureNative.Network.Inputs.SubResourceResponse
Reference to Express Route Circuit Private Peering Resource of the peered circuit.
CircuitConnectionStatus This property is required. string
Express Route Circuit connection state.
Etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
ProvisioningState This property is required. string
The provisioning state of the peer express route circuit connection resource.
Type This property is required. string
Type of the resource.
AddressPrefix string
/29 IP address space to carve out Customer addresses for tunnels.
AuthResourceGuid string
The resource guid of the authorization used for the express route circuit connection.
ConnectionName string
The name of the express route circuit connection resource.
ExpressRouteCircuitPeering SubResourceResponse
Reference to Express Route Circuit Private Peering Resource of the circuit.
Id string
Resource ID.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
PeerExpressRouteCircuitPeering SubResourceResponse
Reference to Express Route Circuit Private Peering Resource of the peered circuit.
circuitConnectionStatus This property is required. String
Express Route Circuit connection state.
etag This property is required. String
A unique read-only string that changes whenever the resource is updated.
provisioningState This property is required. String
The provisioning state of the peer express route circuit connection resource.
type This property is required. String
Type of the resource.
addressPrefix String
/29 IP address space to carve out Customer addresses for tunnels.
authResourceGuid String
The resource guid of the authorization used for the express route circuit connection.
connectionName String
The name of the express route circuit connection resource.
expressRouteCircuitPeering SubResourceResponse
Reference to Express Route Circuit Private Peering Resource of the circuit.
id String
Resource ID.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.
peerExpressRouteCircuitPeering SubResourceResponse
Reference to Express Route Circuit Private Peering Resource of the peered circuit.
circuitConnectionStatus This property is required. string
Express Route Circuit connection state.
etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
provisioningState This property is required. string
The provisioning state of the peer express route circuit connection resource.
type This property is required. string
Type of the resource.
addressPrefix string
/29 IP address space to carve out Customer addresses for tunnels.
authResourceGuid string
The resource guid of the authorization used for the express route circuit connection.
connectionName string
The name of the express route circuit connection resource.
expressRouteCircuitPeering SubResourceResponse
Reference to Express Route Circuit Private Peering Resource of the circuit.
id string
Resource ID.
name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
peerExpressRouteCircuitPeering SubResourceResponse
Reference to Express Route Circuit Private Peering Resource of the peered circuit.
circuit_connection_status This property is required. str
Express Route Circuit connection state.
etag This property is required. str
A unique read-only string that changes whenever the resource is updated.
provisioning_state This property is required. str
The provisioning state of the peer express route circuit connection resource.
type This property is required. str
Type of the resource.
address_prefix str
/29 IP address space to carve out Customer addresses for tunnels.
auth_resource_guid str
The resource guid of the authorization used for the express route circuit connection.
connection_name str
The name of the express route circuit connection resource.
express_route_circuit_peering SubResourceResponse
Reference to Express Route Circuit Private Peering Resource of the circuit.
id str
Resource ID.
name str
The name of the resource that is unique within a resource group. This name can be used to access the resource.
peer_express_route_circuit_peering SubResourceResponse
Reference to Express Route Circuit Private Peering Resource of the peered circuit.
circuitConnectionStatus This property is required. String
Express Route Circuit connection state.
etag This property is required. String
A unique read-only string that changes whenever the resource is updated.
provisioningState This property is required. String
The provisioning state of the peer express route circuit connection resource.
type This property is required. String
Type of the resource.
addressPrefix String
/29 IP address space to carve out Customer addresses for tunnels.
authResourceGuid String
The resource guid of the authorization used for the express route circuit connection.
connectionName String
The name of the express route circuit connection resource.
expressRouteCircuitPeering Property Map
Reference to Express Route Circuit Private Peering Resource of the circuit.
id String
Resource ID.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.
peerExpressRouteCircuitPeering Property Map
Reference to Express Route Circuit Private Peering Resource of the peered circuit.

RouteFilterRuleResponse

Access This property is required. string
The access type of the rule.
Communities This property is required. List<string>
The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].
Etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
ProvisioningState This property is required. string
The provisioning state of the route filter rule resource.
RouteFilterRuleType This property is required. string
The rule type of the rule.
Id string
Resource ID.
Location string
Resource location.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
Access This property is required. string
The access type of the rule.
Communities This property is required. []string
The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].
Etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
ProvisioningState This property is required. string
The provisioning state of the route filter rule resource.
RouteFilterRuleType This property is required. string
The rule type of the rule.
Id string
Resource ID.
Location string
Resource location.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
access This property is required. String
The access type of the rule.
communities This property is required. List<String>
The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].
etag This property is required. String
A unique read-only string that changes whenever the resource is updated.
provisioningState This property is required. String
The provisioning state of the route filter rule resource.
routeFilterRuleType This property is required. String
The rule type of the rule.
id String
Resource ID.
location String
Resource location.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.
access This property is required. string
The access type of the rule.
communities This property is required. string[]
The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].
etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
provisioningState This property is required. string
The provisioning state of the route filter rule resource.
routeFilterRuleType This property is required. string
The rule type of the rule.
id string
Resource ID.
location string
Resource location.
name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
access This property is required. str
The access type of the rule.
communities This property is required. Sequence[str]
The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].
etag This property is required. str
A unique read-only string that changes whenever the resource is updated.
provisioning_state This property is required. str
The provisioning state of the route filter rule resource.
route_filter_rule_type This property is required. str
The rule type of the rule.
id str
Resource ID.
location str
Resource location.
name str
The name of the resource that is unique within a resource group. This name can be used to access the resource.
access This property is required. String
The access type of the rule.
communities This property is required. List<String>
The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020'].
etag This property is required. String
A unique read-only string that changes whenever the resource is updated.
provisioningState This property is required. String
The provisioning state of the route filter rule resource.
routeFilterRuleType This property is required. String
The rule type of the rule.
id String
Resource ID.
location String
Resource location.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.

SubResourceResponse

Id string
Resource ID.
Id string
Resource ID.
id String
Resource ID.
id string
Resource ID.
id str
Resource ID.
id String
Resource ID.

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native