Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getExpressRouteCircuit
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.network.getExpressRouteCircuit

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

    Gets information about the specified express route circuit.

    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 getExpressRouteCircuit

    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 getExpressRouteCircuit(args: GetExpressRouteCircuitArgs, opts?: InvokeOptions): Promise<GetExpressRouteCircuitResult>
function getExpressRouteCircuitOutput(args: GetExpressRouteCircuitOutputArgs, opts?: InvokeOptions): Output<GetExpressRouteCircuitResult>
    def get_express_route_circuit(circuit_name: Optional[str] = None,
                              resource_group_name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetExpressRouteCircuitResult
def get_express_route_circuit_output(circuit_name: Optional[pulumi.Input[str]] = None,
                              resource_group_name: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetExpressRouteCircuitResult]
    func LookupExpressRouteCircuit(ctx *Context, args *LookupExpressRouteCircuitArgs, opts ...InvokeOption) (*LookupExpressRouteCircuitResult, error)
func LookupExpressRouteCircuitOutput(ctx *Context, args *LookupExpressRouteCircuitOutputArgs, opts ...InvokeOption) LookupExpressRouteCircuitResultOutput

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

    public static class GetExpressRouteCircuit 
{
    public static Task<GetExpressRouteCircuitResult> InvokeAsync(GetExpressRouteCircuitArgs args, InvokeOptions? opts = null)
    public static Output<GetExpressRouteCircuitResult> Invoke(GetExpressRouteCircuitInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetExpressRouteCircuitResult> getExpressRouteCircuit(GetExpressRouteCircuitArgs args, InvokeOptions options)
public static Output<GetExpressRouteCircuitResult> getExpressRouteCircuit(GetExpressRouteCircuitArgs args, InvokeOptions options)

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

    The following arguments are supported:

    CircuitName string
    The name of express route circuit.
    ResourceGroupName string
    The name of the resource group.
    CircuitName string
    The name of express route circuit.
    ResourceGroupName string
    The name of the resource group.
    circuitName String
    The name of express route circuit.
    resourceGroupName String
    The name of the resource group.
    circuitName string
    The name of express route circuit.
    resourceGroupName string
    The name of the resource group.
    circuit_name str
    The name of express route circuit.
    resource_group_name str
    The name of the resource group.
    circuitName String
    The name of express route circuit.
    resourceGroupName String
    The name of the resource group.

    getExpressRouteCircuit Result

    The following output properties are available:

    AuthorizationStatus string
    The authorization status of the Circuit.
    AzureApiVersion string
    The Azure API version of the resource.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Name string
    Resource name.
    ProvisioningState string
    The provisioning state of the express route circuit resource.
    Stag int
    The identifier of the circuit traffic. Outer tag for QinQ encapsulation.
    Type string
    Resource type.
    AllowClassicOperations bool
    Allow classic operations.
    AuthorizationKey string
    The authorizationKey.
    Authorizations List<Pulumi.AzureNative.Network.Outputs.ExpressRouteCircuitAuthorizationResponse>
    The list of authorizations.
    BandwidthInGbps double
    The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.
    CircuitProvisioningState string
    The CircuitProvisioningState state of the resource.
    EnableDirectPortRateLimit bool
    Flag denoting rate-limiting status of the ExpressRoute direct-port circuit.
    ExpressRoutePort Pulumi.AzureNative.Network.Outputs.SubResourceResponse
    The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.
    GatewayManagerEtag string
    The GatewayManager Etag.
    GlobalReachEnabled bool
    Flag denoting global reach status.
    Id string
    Resource ID.
    Location string
    Resource location.
    Peerings List<Pulumi.AzureNative.Network.Outputs.ExpressRouteCircuitPeeringResponse>
    The list of peerings.
    ServiceKey string
    The ServiceKey.
    ServiceProviderNotes string
    The ServiceProviderNotes.
    ServiceProviderProperties Pulumi.AzureNative.Network.Outputs.ExpressRouteCircuitServiceProviderPropertiesResponse
    The ServiceProviderProperties.
    ServiceProviderProvisioningState string
    The ServiceProviderProvisioningState state of the resource.
    Sku Pulumi.AzureNative.Network.Outputs.ExpressRouteCircuitSkuResponse
    The SKU.
    Tags Dictionary<string, string>
    Resource tags.
    AuthorizationStatus string
    The authorization status of the Circuit.
    AzureApiVersion string
    The Azure API version of the resource.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    Name string
    Resource name.
    ProvisioningState string
    The provisioning state of the express route circuit resource.
    Stag int
    The identifier of the circuit traffic. Outer tag for QinQ encapsulation.
    Type string
    Resource type.
    AllowClassicOperations bool
    Allow classic operations.
    AuthorizationKey string
    The authorizationKey.
    Authorizations []ExpressRouteCircuitAuthorizationResponse
    The list of authorizations.
    BandwidthInGbps float64
    The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.
    CircuitProvisioningState string
    The CircuitProvisioningState state of the resource.
    EnableDirectPortRateLimit bool
    Flag denoting rate-limiting status of the ExpressRoute direct-port circuit.
    ExpressRoutePort SubResourceResponse
    The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.
    GatewayManagerEtag string
    The GatewayManager Etag.
    GlobalReachEnabled bool
    Flag denoting global reach status.
    Id string
    Resource ID.
    Location string
    Resource location.
    Peerings []ExpressRouteCircuitPeeringResponse
    The list of peerings.
    ServiceKey string
    The ServiceKey.
    ServiceProviderNotes string
    The ServiceProviderNotes.
    ServiceProviderProperties ExpressRouteCircuitServiceProviderPropertiesResponse
    The ServiceProviderProperties.
    ServiceProviderProvisioningState string
    The ServiceProviderProvisioningState state of the resource.
    Sku ExpressRouteCircuitSkuResponse
    The SKU.
    Tags map[string]string
    Resource tags.
    authorizationStatus String
    The authorization status of the Circuit.
    azureApiVersion String
    The Azure API version of the resource.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    name String
    Resource name.
    provisioningState String
    The provisioning state of the express route circuit resource.
    stag Integer
    The identifier of the circuit traffic. Outer tag for QinQ encapsulation.
    type String
    Resource type.
    allowClassicOperations Boolean
    Allow classic operations.
    authorizationKey String
    The authorizationKey.
    authorizations List<ExpressRouteCircuitAuthorizationResponse>
    The list of authorizations.
    bandwidthInGbps Double
    The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.
    circuitProvisioningState String
    The CircuitProvisioningState state of the resource.
    enableDirectPortRateLimit Boolean
    Flag denoting rate-limiting status of the ExpressRoute direct-port circuit.
    expressRoutePort SubResourceResponse
    The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.
    gatewayManagerEtag String
    The GatewayManager Etag.
    globalReachEnabled Boolean
    Flag denoting global reach status.
    id String
    Resource ID.
    location String
    Resource location.
    peerings List<ExpressRouteCircuitPeeringResponse>
    The list of peerings.
    serviceKey String
    The ServiceKey.
    serviceProviderNotes String
    The ServiceProviderNotes.
    serviceProviderProperties ExpressRouteCircuitServiceProviderPropertiesResponse
    The ServiceProviderProperties.
    serviceProviderProvisioningState String
    The ServiceProviderProvisioningState state of the resource.
    sku ExpressRouteCircuitSkuResponse
    The SKU.
    tags Map<String,String>
    Resource tags.
    authorizationStatus string
    The authorization status of the Circuit.
    azureApiVersion string
    The Azure API version of the resource.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    name string
    Resource name.
    provisioningState string
    The provisioning state of the express route circuit resource.
    stag number
    The identifier of the circuit traffic. Outer tag for QinQ encapsulation.
    type string
    Resource type.
    allowClassicOperations boolean
    Allow classic operations.
    authorizationKey string
    The authorizationKey.
    authorizations ExpressRouteCircuitAuthorizationResponse[]
    The list of authorizations.
    bandwidthInGbps number
    The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.
    circuitProvisioningState string
    The CircuitProvisioningState state of the resource.
    enableDirectPortRateLimit boolean
    Flag denoting rate-limiting status of the ExpressRoute direct-port circuit.
    expressRoutePort SubResourceResponse
    The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.
    gatewayManagerEtag string
    The GatewayManager Etag.
    globalReachEnabled boolean
    Flag denoting global reach status.
    id string
    Resource ID.
    location string
    Resource location.
    peerings ExpressRouteCircuitPeeringResponse[]
    The list of peerings.
    serviceKey string
    The ServiceKey.
    serviceProviderNotes string
    The ServiceProviderNotes.
    serviceProviderProperties ExpressRouteCircuitServiceProviderPropertiesResponse
    The ServiceProviderProperties.
    serviceProviderProvisioningState string
    The ServiceProviderProvisioningState state of the resource.
    sku ExpressRouteCircuitSkuResponse
    The SKU.
    tags {[key: string]: string}
    Resource tags.
    authorization_status str
    The authorization status of the Circuit.
    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.
    name str
    Resource name.
    provisioning_state str
    The provisioning state of the express route circuit resource.
    stag int
    The identifier of the circuit traffic. Outer tag for QinQ encapsulation.
    type str
    Resource type.
    allow_classic_operations bool
    Allow classic operations.
    authorization_key str
    The authorizationKey.
    authorizations Sequence[ExpressRouteCircuitAuthorizationResponse]
    The list of authorizations.
    bandwidth_in_gbps float
    The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.
    circuit_provisioning_state str
    The CircuitProvisioningState state of the resource.
    enable_direct_port_rate_limit bool
    Flag denoting rate-limiting status of the ExpressRoute direct-port circuit.
    express_route_port SubResourceResponse
    The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.
    gateway_manager_etag str
    The GatewayManager Etag.
    global_reach_enabled bool
    Flag denoting global reach status.
    id str
    Resource ID.
    location str
    Resource location.
    peerings Sequence[ExpressRouteCircuitPeeringResponse]
    The list of peerings.
    service_key str
    The ServiceKey.
    service_provider_notes str
    The ServiceProviderNotes.
    service_provider_properties ExpressRouteCircuitServiceProviderPropertiesResponse
    The ServiceProviderProperties.
    service_provider_provisioning_state str
    The ServiceProviderProvisioningState state of the resource.
    sku ExpressRouteCircuitSkuResponse
    The SKU.
    tags Mapping[str, str]
    Resource tags.
    authorizationStatus String
    The authorization status of the Circuit.
    azureApiVersion String
    The Azure API version of the resource.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    name String
    Resource name.
    provisioningState String
    The provisioning state of the express route circuit resource.
    stag Number
    The identifier of the circuit traffic. Outer tag for QinQ encapsulation.
    type String
    Resource type.
    allowClassicOperations Boolean
    Allow classic operations.
    authorizationKey String
    The authorizationKey.
    authorizations List<Property Map>
    The list of authorizations.
    bandwidthInGbps Number
    The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.
    circuitProvisioningState String
    The CircuitProvisioningState state of the resource.
    enableDirectPortRateLimit Boolean
    Flag denoting rate-limiting status of the ExpressRoute direct-port circuit.
    expressRoutePort Property Map
    The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.
    gatewayManagerEtag String
    The GatewayManager Etag.
    globalReachEnabled Boolean
    Flag denoting global reach status.
    id String
    Resource ID.
    location String
    Resource location.
    peerings List<Property Map>
    The list of peerings.
    serviceKey String
    The ServiceKey.
    serviceProviderNotes String
    The ServiceProviderNotes.
    serviceProviderProperties Property Map
    The ServiceProviderProperties.
    serviceProviderProvisioningState String
    The ServiceProviderProvisioningState state of the resource.
    sku Property Map
    The SKU.
    tags Map<String>
    Resource tags.

    Supporting Types

    ExpressRouteCircuitAuthorizationResponse

    ConnectionResourceUri string
    The reference to the ExpressRoute connection resource using the authorization.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    ProvisioningState string
    The provisioning state of the authorization resource.
    Type string
    Type of the resource.
    AuthorizationKey string
    The authorization key.
    AuthorizationUseStatus string
    The authorization use status.
    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.
    ConnectionResourceUri string
    The reference to the ExpressRoute connection resource using the authorization.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    ProvisioningState string
    The provisioning state of the authorization resource.
    Type string
    Type of the resource.
    AuthorizationKey string
    The authorization key.
    AuthorizationUseStatus string
    The authorization use status.
    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.
    connectionResourceUri String
    The reference to the ExpressRoute connection resource using the authorization.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    provisioningState String
    The provisioning state of the authorization resource.
    type String
    Type of the resource.
    authorizationKey String
    The authorization key.
    authorizationUseStatus String
    The authorization use status.
    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.
    connectionResourceUri string
    The reference to the ExpressRoute connection resource using the authorization.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    provisioningState string
    The provisioning state of the authorization resource.
    type string
    Type of the resource.
    authorizationKey string
    The authorization key.
    authorizationUseStatus string
    The authorization use status.
    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.
    connection_resource_uri str
    The reference to the ExpressRoute connection resource using the authorization.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    provisioning_state str
    The provisioning state of the authorization resource.
    type str
    Type of the resource.
    authorization_key str
    The authorization key.
    authorization_use_status str
    The authorization use status.
    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.
    connectionResourceUri String
    The reference to the ExpressRoute connection resource using the authorization.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    provisioningState String
    The provisioning state of the authorization resource.
    type String
    Type of the resource.
    authorizationKey String
    The authorization key.
    authorizationUseStatus String
    The authorization use status.
    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.

    ExpressRouteCircuitConnectionResponse

    CircuitConnectionStatus string
    Express Route Circuit connection state.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    ProvisioningState string
    The provisioning state of the express route circuit connection resource.
    Type 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 string
    Express Route Circuit connection state.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    ProvisioningState string
    The provisioning state of the express route circuit connection resource.
    Type 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 String
    Express Route Circuit connection state.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    provisioningState String
    The provisioning state of the express route circuit connection resource.
    type 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 string
    Express Route Circuit connection state.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    provisioningState string
    The provisioning state of the express route circuit connection resource.
    type 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 str
    Express Route Circuit connection state.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    provisioning_state str
    The provisioning state of the express route circuit connection resource.
    type 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 String
    Express Route Circuit connection state.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    provisioningState String
    The provisioning state of the express route circuit connection resource.
    type 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 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 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 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 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 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 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 string
    A unique read-only string that changes whenever the resource is updated.
    LastModifiedBy string
    Who was the last to modify the peering.
    PeeredConnections List<Pulumi.AzureNative.Network.Inputs.PeerExpressRouteCircuitConnectionResponse>
    The list of peered circuit connections associated with Azure Private Peering for this circuit.
    ProvisioningState string
    The provisioning state of the express route circuit peering resource.
    Type 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 string
    A unique read-only string that changes whenever the resource is updated.
    LastModifiedBy string
    Who was the last to modify the peering.
    PeeredConnections []PeerExpressRouteCircuitConnectionResponse
    The list of peered circuit connections associated with Azure Private Peering for this circuit.
    ProvisioningState string
    The provisioning state of the express route circuit peering resource.
    Type 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 String
    A unique read-only string that changes whenever the resource is updated.
    lastModifiedBy String
    Who was the last to modify the peering.
    peeredConnections List<PeerExpressRouteCircuitConnectionResponse>
    The list of peered circuit connections associated with Azure Private Peering for this circuit.
    provisioningState String
    The provisioning state of the express route circuit peering resource.
    type 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 string
    A unique read-only string that changes whenever the resource is updated.
    lastModifiedBy string
    Who was the last to modify the peering.
    peeredConnections PeerExpressRouteCircuitConnectionResponse[]
    The list of peered circuit connections associated with Azure Private Peering for this circuit.
    provisioningState string
    The provisioning state of the express route circuit peering resource.
    type 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 str
    A unique read-only string that changes whenever the resource is updated.
    last_modified_by str
    Who was the last to modify the peering.
    peered_connections Sequence[PeerExpressRouteCircuitConnectionResponse]
    The list of peered circuit connections associated with Azure Private Peering for this circuit.
    provisioning_state str
    The provisioning state of the express route circuit peering resource.
    type 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 String
    A unique read-only string that changes whenever the resource is updated.
    lastModifiedBy String
    Who was the last to modify the peering.
    peeredConnections List<Property Map>
    The list of peered circuit connections associated with Azure Private Peering for this circuit.
    provisioningState String
    The provisioning state of the express route circuit peering resource.
    type 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.

    ExpressRouteCircuitServiceProviderPropertiesResponse

    BandwidthInMbps int
    The BandwidthInMbps.
    PeeringLocation string
    The peering location.
    ServiceProviderName string
    The serviceProviderName.
    BandwidthInMbps int
    The BandwidthInMbps.
    PeeringLocation string
    The peering location.
    ServiceProviderName string
    The serviceProviderName.
    bandwidthInMbps Integer
    The BandwidthInMbps.
    peeringLocation String
    The peering location.
    serviceProviderName String
    The serviceProviderName.
    bandwidthInMbps number
    The BandwidthInMbps.
    peeringLocation string
    The peering location.
    serviceProviderName string
    The serviceProviderName.
    bandwidth_in_mbps int
    The BandwidthInMbps.
    peering_location str
    The peering location.
    service_provider_name str
    The serviceProviderName.
    bandwidthInMbps Number
    The BandwidthInMbps.
    peeringLocation String
    The peering location.
    serviceProviderName String
    The serviceProviderName.

    ExpressRouteCircuitSkuResponse

    Family string
    The family of the SKU.
    Name string
    The name of the SKU.
    Tier string
    The tier of the SKU.
    Family string
    The family of the SKU.
    Name string
    The name of the SKU.
    Tier string
    The tier of the SKU.
    family String
    The family of the SKU.
    name String
    The name of the SKU.
    tier String
    The tier of the SKU.
    family string
    The family of the SKU.
    name string
    The name of the SKU.
    tier string
    The tier of the SKU.
    family str
    The family of the SKU.
    name str
    The name of the SKU.
    tier str
    The tier of the SKU.
    family String
    The family of the SKU.
    name String
    The name of the SKU.
    tier String
    The tier of the SKU.

    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 string
    The ID of the ExpressRouteConnection.
    Id string
    The ID of the ExpressRouteConnection.
    id String
    The ID of the ExpressRouteConnection.
    id string
    The ID of the ExpressRouteConnection.
    id str
    The ID of the ExpressRouteConnection.
    id String
    The ID of the ExpressRouteConnection.

    Ipv6CircuitConnectionConfigResponse

    CircuitConnectionStatus string
    Express Route Circuit connection state.
    AddressPrefix string
    /125 IP address space to carve out customer addresses for global reach.
    CircuitConnectionStatus string
    Express Route Circuit connection state.
    AddressPrefix string
    /125 IP address space to carve out customer addresses for global reach.
    circuitConnectionStatus String
    Express Route Circuit connection state.
    addressPrefix String
    /125 IP address space to carve out customer addresses for global reach.
    circuitConnectionStatus string
    Express Route Circuit connection state.
    addressPrefix string
    /125 IP address space to carve out customer addresses for global reach.
    circuit_connection_status str
    Express Route Circuit connection state.
    address_prefix str
    /125 IP address space to carve out customer addresses for global reach.
    circuitConnectionStatus 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 string
    Express Route Circuit connection state.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    ProvisioningState string
    The provisioning state of the peer express route circuit connection resource.
    Type 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 string
    Express Route Circuit connection state.
    Etag string
    A unique read-only string that changes whenever the resource is updated.
    ProvisioningState string
    The provisioning state of the peer express route circuit connection resource.
    Type 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 String
    Express Route Circuit connection state.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    provisioningState String
    The provisioning state of the peer express route circuit connection resource.
    type 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 string
    Express Route Circuit connection state.
    etag string
    A unique read-only string that changes whenever the resource is updated.
    provisioningState string
    The provisioning state of the peer express route circuit connection resource.
    type 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 str
    Express Route Circuit connection state.
    etag str
    A unique read-only string that changes whenever the resource is updated.
    provisioning_state str
    The provisioning state of the peer express route circuit connection resource.
    type 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 String
    Express Route Circuit connection state.
    etag String
    A unique read-only string that changes whenever the resource is updated.
    provisioningState String
    The provisioning state of the peer express route circuit connection resource.
    type 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.

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