ExpressRouteCircuitPeering Class

Peering in an ExpressRouteCircuit resource.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

ExpressRouteCircuitPeering(*, id: str | None = None, name: str | None = None, peering_type: str | _models.ExpressRoutePeeringType | None = None, state: str | _models.ExpressRoutePeeringState | None = None, azure_asn: int | None = None, peer_asn: int | None = None, primary_peer_address_prefix: str | None = None, secondary_peer_address_prefix: str | None = None, primary_azure_port: str | None = None, secondary_azure_port: str | None = None, shared_key: str | None = None, vlan_id: int | None = None, microsoft_peering_config: _models.ExpressRouteCircuitPeeringConfig | None = None, stats: _models.ExpressRouteCircuitStats | None = None, gateway_manager_etag: str | None = None, route_filter: _models.SubResource | None = None, ipv6_peering_config: _models.Ipv6ExpressRouteCircuitPeeringConfig | None = None, express_route_connection: _models.ExpressRouteConnectionId | None = None, connections: List[_models.ExpressRouteCircuitConnection] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
id	str Resource ID. Default value: None
name	str The name of the resource that is unique within a resource group. This name can be used to access the resource. Default value: None
peering_type	str or ExpressRoutePeeringType The peering type. Known values are: "AzurePublicPeering", "AzurePrivatePeering", and "MicrosoftPeering". Default value: None
state	str or ExpressRoutePeeringState The peering state. Known values are: "Disabled" and "Enabled". Default value: None
azure_asn	int The Azure ASN. Default value: None
peer_asn	int The peer ASN. Default value: None
primary_peer_address_prefix	str The primary address prefix. Default value: None
secondary_peer_address_prefix	str The secondary address prefix. Default value: None
primary_azure_port	str The primary port. Default value: None
secondary_azure_port	str The secondary port. Default value: None
shared_key	str The shared key. Default value: None
vlan_id	int The VLAN ID. Default value: None
microsoft_peering_config	ExpressRouteCircuitPeeringConfig The Microsoft peering configuration. Default value: None
stats	ExpressRouteCircuitStats The peering stats of express route circuit. Default value: None
gateway_manager_etag	str The GatewayManager Etag. Default value: None
route_filter	SubResource The reference to the RouteFilter resource. Default value: None
ipv6_peering_config	Ipv6ExpressRouteCircuitPeeringConfig The IPv6 peering configuration. Default value: None
express_route_connection	ExpressRouteConnectionId The ExpressRoute connection. Default value: None
connections	list[ExpressRouteCircuitConnection] The list of circuit connections associated with Azure Private Peering for this circuit. Default value: None

Variables

Name	Description
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.
etag	str A unique read-only string that changes whenever the resource is updated.
type	str Type of the resource.
peering_type	str or ExpressRoutePeeringType The peering type. Known values are: "AzurePublicPeering", "AzurePrivatePeering", and "MicrosoftPeering".
state	str or ExpressRoutePeeringState The peering state. Known values are: "Disabled" and "Enabled".
azure_asn	int The Azure ASN.
peer_asn	int The peer ASN.
primary_peer_address_prefix	str The primary address prefix.
secondary_peer_address_prefix	str The secondary address prefix.
primary_azure_port	str The primary port.
secondary_azure_port	str The secondary port.
shared_key	str The shared key.
vlan_id	int The VLAN ID.
microsoft_peering_config	ExpressRouteCircuitPeeringConfig The Microsoft peering configuration.
stats	ExpressRouteCircuitStats The peering stats of express route circuit.
provisioning_state	str or ProvisioningState The provisioning state of the express route circuit peering resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting".
gateway_manager_etag	str The GatewayManager Etag.
last_modified_by	str Who was the last to modify the peering.
route_filter	SubResource The reference to the RouteFilter resource.
ipv6_peering_config	Ipv6ExpressRouteCircuitPeeringConfig The IPv6 peering configuration.
express_route_connection	ExpressRouteConnectionId The ExpressRoute connection.
connections	list[ExpressRouteCircuitConnection] The list of circuit connections associated with Azure Private Peering for this circuit.
peered_connections	list[PeerExpressRouteCircuitConnection] The list of peered circuit connections associated with Azure Private Peering for this circuit.