Share via

ExpressRouteCircuit Class

ExpressRouteCircuit resource.

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

Constructor

ExpressRouteCircuit(*, id: str | None = None, location: str | None = None, tags: Dict[str, str] | None = None, sku: _models.ExpressRouteCircuitSku | None = None, allow_classic_operations: bool | None = None, circuit_provisioning_state: str | None = None, service_provider_provisioning_state: str | _models.ServiceProviderProvisioningState | None = None, authorizations: List[_models.ExpressRouteCircuitAuthorization] | None = None, peerings: List[_models.ExpressRouteCircuitPeering] | None = None, service_key: str | None = None, service_provider_notes: str | None = None, service_provider_properties: _models.ExpressRouteCircuitServiceProviderProperties | None = None, express_route_port: _models.SubResource | None = None, bandwidth_in_gbps: float | None = None, gateway_manager_etag: str | None = None, global_reach_enabled: bool | None = None, authorization_key: str | None = None, enable_direct_port_rate_limit: bool | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
id
str

Resource ID.

Default value: None
location
str

Resource location.

Default value: None
tags
dict[str, str]

Resource tags.

Default value: None
sku
ExpressRouteCircuitSku

The SKU.

Default value: None
allow_classic_operations
bool

Allow classic operations.

Default value: None
circuit_provisioning_state
str

The CircuitProvisioningState state of the resource.

Default value: None
service_provider_provisioning_state
str or ServiceProviderProvisioningState

The ServiceProviderProvisioningState state of the resource. Known values are: "NotProvisioned", "Provisioning", "Provisioned", and "Deprovisioning".

Default value: None
authorizations
list[ExpressRouteCircuitAuthorization]

The list of authorizations.

Default value: None
peerings
list[ExpressRouteCircuitPeering]

The list of peerings.

Default value: None
service_key
str

The ServiceKey.

Default value: None
service_provider_notes
str

The ServiceProviderNotes.

Default value: None
service_provider_properties
ExpressRouteCircuitServiceProviderProperties

The ServiceProviderProperties.

Default value: None
express_route_port
SubResource

The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.

Default value: None
bandwidth_in_gbps
float

The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.

Default value: None
gateway_manager_etag
str

The GatewayManager Etag.

Default value: None
global_reach_enabled
bool

Flag denoting global reach status.

Default value: None
authorization_key
str

The authorizationKey.

Default value: None
enable_direct_port_rate_limit
bool

Flag denoting rate-limiting status of the ExpressRoute direct-port circuit.

Default value: None

Variables

Name Description
id
str

Resource ID.
name
str

Resource name.
type
str

Resource type.
location
str

Resource location.
tags
dict[str, str]

Resource tags.
sku
ExpressRouteCircuitSku

The SKU.
etag
str

A unique read-only string that changes whenever the resource is updated.
allow_classic_operations
bool

Allow classic operations.
circuit_provisioning_state
str

The CircuitProvisioningState state of the resource.
service_provider_provisioning_state
str or ServiceProviderProvisioningState

The ServiceProviderProvisioningState state of the resource. Known values are: "NotProvisioned", "Provisioning", "Provisioned", and "Deprovisioning".
authorizations
list[ExpressRouteCircuitAuthorization]

The list of authorizations.
peerings
list[ExpressRouteCircuitPeering]

The list of peerings.
service_key
str

The ServiceKey.
service_provider_notes
str

The ServiceProviderNotes.
service_provider_properties
ExpressRouteCircuitServiceProviderProperties

The ServiceProviderProperties.
express_route_port
SubResource

The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource.
bandwidth_in_gbps
float

The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource.
stag
int

The identifier of the circuit traffic. Outer tag for QinQ encapsulation.
provisioning_state
str or ProvisioningState

The provisioning state of the express route circuit resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting".
gateway_manager_etag
str

The GatewayManager Etag.
global_reach_enabled
bool

Flag denoting global reach status.
authorization_key
str

The authorizationKey.
authorization_status
str

The authorization status of the Circuit.
enable_direct_port_rate_limit
bool

Flag denoting rate-limiting status of the ExpressRoute direct-port circuit.