1. Packages
  2. Azure Native v2
  3. API Docs
  4. network
  5. getExpressRoutePort
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.network.getExpressRoutePort

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Retrieves the requested ExpressRoutePort resource. Azure REST API version: 2023-02-01.

Other available API versions: 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

Using getExpressRoutePort

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 getExpressRoutePort(args: GetExpressRoutePortArgs, opts?: InvokeOptions): Promise<GetExpressRoutePortResult>
function getExpressRoutePortOutput(args: GetExpressRoutePortOutputArgs, opts?: InvokeOptions): Output<GetExpressRoutePortResult>
Copy
def get_express_route_port(express_route_port_name: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetExpressRoutePortResult
def get_express_route_port_output(express_route_port_name: Optional[pulumi.Input[str]] = None,
                           resource_group_name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetExpressRoutePortResult]
Copy
func LookupExpressRoutePort(ctx *Context, args *LookupExpressRoutePortArgs, opts ...InvokeOption) (*LookupExpressRoutePortResult, error)
func LookupExpressRoutePortOutput(ctx *Context, args *LookupExpressRoutePortOutputArgs, opts ...InvokeOption) LookupExpressRoutePortResultOutput
Copy

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

public static class GetExpressRoutePort 
{
    public static Task<GetExpressRoutePortResult> InvokeAsync(GetExpressRoutePortArgs args, InvokeOptions? opts = null)
    public static Output<GetExpressRoutePortResult> Invoke(GetExpressRoutePortInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetExpressRoutePortResult> getExpressRoutePort(GetExpressRoutePortArgs args, InvokeOptions options)
public static Output<GetExpressRoutePortResult> getExpressRoutePort(GetExpressRoutePortArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getExpressRoutePort
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ExpressRoutePortName
This property is required.
Changes to this property will trigger replacement.
string
The name of ExpressRoutePort.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
ExpressRoutePortName
This property is required.
Changes to this property will trigger replacement.
string
The name of ExpressRoutePort.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
expressRoutePortName
This property is required.
Changes to this property will trigger replacement.
String
The name of ExpressRoutePort.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
expressRoutePortName
This property is required.
Changes to this property will trigger replacement.
string
The name of ExpressRoutePort.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
express_route_port_name
This property is required.
Changes to this property will trigger replacement.
str
The name of ExpressRoutePort.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
expressRoutePortName
This property is required.
Changes to this property will trigger replacement.
String
The name of ExpressRoutePort.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.

getExpressRoutePort Result

The following output properties are available:

AllocationDate string
Date of the physical port allocation to be used in Letter of Authorization.
Circuits List<Pulumi.AzureNative.Network.Outputs.SubResourceResponse>
Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
EtherType string
Ether type of the physical port.
Mtu string
Maximum transmission unit of the physical port pair(s).
Name string
Resource name.
ProvisionedBandwidthInGbps double
Aggregate Gbps of associated circuit bandwidths.
ProvisioningState string
The provisioning state of the express route port resource.
ResourceGuid string
The resource GUID property of the express route port resource.
Type string
Resource type.
BandwidthInGbps int
Bandwidth of procured ports in Gbps.
BillingType string
The billing type of the ExpressRoutePort resource.
Encapsulation string
Encapsulation method on physical ports.
Id string
Resource ID.
Identity Pulumi.AzureNative.Network.Outputs.ManagedServiceIdentityResponse
The identity of ExpressRoutePort, if configured.
Links List<Pulumi.AzureNative.Network.Outputs.ExpressRouteLinkResponse>
The set of physical links of the ExpressRoutePort resource.
Location string
Resource location.
PeeringLocation string
The name of the peering location that the ExpressRoutePort is mapped to physically.
Tags Dictionary<string, string>
Resource tags.
AllocationDate string
Date of the physical port allocation to be used in Letter of Authorization.
Circuits []SubResourceResponse
Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
EtherType string
Ether type of the physical port.
Mtu string
Maximum transmission unit of the physical port pair(s).
Name string
Resource name.
ProvisionedBandwidthInGbps float64
Aggregate Gbps of associated circuit bandwidths.
ProvisioningState string
The provisioning state of the express route port resource.
ResourceGuid string
The resource GUID property of the express route port resource.
Type string
Resource type.
BandwidthInGbps int
Bandwidth of procured ports in Gbps.
BillingType string
The billing type of the ExpressRoutePort resource.
Encapsulation string
Encapsulation method on physical ports.
Id string
Resource ID.
Identity ManagedServiceIdentityResponse
The identity of ExpressRoutePort, if configured.
Links []ExpressRouteLinkResponse
The set of physical links of the ExpressRoutePort resource.
Location string
Resource location.
PeeringLocation string
The name of the peering location that the ExpressRoutePort is mapped to physically.
Tags map[string]string
Resource tags.
allocationDate String
Date of the physical port allocation to be used in Letter of Authorization.
circuits List<SubResourceResponse>
Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource.
etag String
A unique read-only string that changes whenever the resource is updated.
etherType String
Ether type of the physical port.
mtu String
Maximum transmission unit of the physical port pair(s).
name String
Resource name.
provisionedBandwidthInGbps Double
Aggregate Gbps of associated circuit bandwidths.
provisioningState String
The provisioning state of the express route port resource.
resourceGuid String
The resource GUID property of the express route port resource.
type String
Resource type.
bandwidthInGbps Integer
Bandwidth of procured ports in Gbps.
billingType String
The billing type of the ExpressRoutePort resource.
encapsulation String
Encapsulation method on physical ports.
id String
Resource ID.
identity ManagedServiceIdentityResponse
The identity of ExpressRoutePort, if configured.
links List<ExpressRouteLinkResponse>
The set of physical links of the ExpressRoutePort resource.
location String
Resource location.
peeringLocation String
The name of the peering location that the ExpressRoutePort is mapped to physically.
tags Map<String,String>
Resource tags.
allocationDate string
Date of the physical port allocation to be used in Letter of Authorization.
circuits SubResourceResponse[]
Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource.
etag string
A unique read-only string that changes whenever the resource is updated.
etherType string
Ether type of the physical port.
mtu string
Maximum transmission unit of the physical port pair(s).
name string
Resource name.
provisionedBandwidthInGbps number
Aggregate Gbps of associated circuit bandwidths.
provisioningState string
The provisioning state of the express route port resource.
resourceGuid string
The resource GUID property of the express route port resource.
type string
Resource type.
bandwidthInGbps number
Bandwidth of procured ports in Gbps.
billingType string
The billing type of the ExpressRoutePort resource.
encapsulation string
Encapsulation method on physical ports.
id string
Resource ID.
identity ManagedServiceIdentityResponse
The identity of ExpressRoutePort, if configured.
links ExpressRouteLinkResponse[]
The set of physical links of the ExpressRoutePort resource.
location string
Resource location.
peeringLocation string
The name of the peering location that the ExpressRoutePort is mapped to physically.
tags {[key: string]: string}
Resource tags.
allocation_date str
Date of the physical port allocation to be used in Letter of Authorization.
circuits Sequence[SubResourceResponse]
Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource.
etag str
A unique read-only string that changes whenever the resource is updated.
ether_type str
Ether type of the physical port.
mtu str
Maximum transmission unit of the physical port pair(s).
name str
Resource name.
provisioned_bandwidth_in_gbps float
Aggregate Gbps of associated circuit bandwidths.
provisioning_state str
The provisioning state of the express route port resource.
resource_guid str
The resource GUID property of the express route port resource.
type str
Resource type.
bandwidth_in_gbps int
Bandwidth of procured ports in Gbps.
billing_type str
The billing type of the ExpressRoutePort resource.
encapsulation str
Encapsulation method on physical ports.
id str
Resource ID.
identity ManagedServiceIdentityResponse
The identity of ExpressRoutePort, if configured.
links Sequence[ExpressRouteLinkResponse]
The set of physical links of the ExpressRoutePort resource.
location str
Resource location.
peering_location str
The name of the peering location that the ExpressRoutePort is mapped to physically.
tags Mapping[str, str]
Resource tags.
allocationDate String
Date of the physical port allocation to be used in Letter of Authorization.
circuits List<Property Map>
Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource.
etag String
A unique read-only string that changes whenever the resource is updated.
etherType String
Ether type of the physical port.
mtu String
Maximum transmission unit of the physical port pair(s).
name String
Resource name.
provisionedBandwidthInGbps Number
Aggregate Gbps of associated circuit bandwidths.
provisioningState String
The provisioning state of the express route port resource.
resourceGuid String
The resource GUID property of the express route port resource.
type String
Resource type.
bandwidthInGbps Number
Bandwidth of procured ports in Gbps.
billingType String
The billing type of the ExpressRoutePort resource.
encapsulation String
Encapsulation method on physical ports.
id String
Resource ID.
identity Property Map
The identity of ExpressRoutePort, if configured.
links List<Property Map>
The set of physical links of the ExpressRoutePort resource.
location String
Resource location.
peeringLocation String
The name of the peering location that the ExpressRoutePort is mapped to physically.
tags Map<String>
Resource tags.

Supporting Types

ExpressRouteLinkMacSecConfigResponse

CakSecretIdentifier string
Keyvault Secret Identifier URL containing Mac security CAK key.
Cipher string
Mac security cipher.
CknSecretIdentifier string
Keyvault Secret Identifier URL containing Mac security CKN key.
SciState string
Sci mode enabled/disabled.
CakSecretIdentifier string
Keyvault Secret Identifier URL containing Mac security CAK key.
Cipher string
Mac security cipher.
CknSecretIdentifier string
Keyvault Secret Identifier URL containing Mac security CKN key.
SciState string
Sci mode enabled/disabled.
cakSecretIdentifier String
Keyvault Secret Identifier URL containing Mac security CAK key.
cipher String
Mac security cipher.
cknSecretIdentifier String
Keyvault Secret Identifier URL containing Mac security CKN key.
sciState String
Sci mode enabled/disabled.
cakSecretIdentifier string
Keyvault Secret Identifier URL containing Mac security CAK key.
cipher string
Mac security cipher.
cknSecretIdentifier string
Keyvault Secret Identifier URL containing Mac security CKN key.
sciState string
Sci mode enabled/disabled.
cak_secret_identifier str
Keyvault Secret Identifier URL containing Mac security CAK key.
cipher str
Mac security cipher.
ckn_secret_identifier str
Keyvault Secret Identifier URL containing Mac security CKN key.
sci_state str
Sci mode enabled/disabled.
cakSecretIdentifier String
Keyvault Secret Identifier URL containing Mac security CAK key.
cipher String
Mac security cipher.
cknSecretIdentifier String
Keyvault Secret Identifier URL containing Mac security CKN key.
sciState String
Sci mode enabled/disabled.

ExpressRouteLinkResponse

ColoLocation This property is required. string
Cololocation for ExpressRoute Hybrid Direct.
ConnectorType This property is required. string
Physical fiber port type.
Etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
InterfaceName This property is required. string
Name of Azure router interface.
PatchPanelId This property is required. string
Mapping between physical port to patch panel port.
ProvisioningState This property is required. string
The provisioning state of the express route link resource.
RackId This property is required. string
Mapping of physical patch panel to rack.
RouterName This property is required. string
Name of Azure router associated with physical port.
AdminState string
Administrative state of the physical port.
Id string
Resource ID.
MacSecConfig Pulumi.AzureNative.Network.Inputs.ExpressRouteLinkMacSecConfigResponse
MacSec configuration.
Name string
Name of child port resource that is unique among child port resources of the parent.
ColoLocation This property is required. string
Cololocation for ExpressRoute Hybrid Direct.
ConnectorType This property is required. string
Physical fiber port type.
Etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
InterfaceName This property is required. string
Name of Azure router interface.
PatchPanelId This property is required. string
Mapping between physical port to patch panel port.
ProvisioningState This property is required. string
The provisioning state of the express route link resource.
RackId This property is required. string
Mapping of physical patch panel to rack.
RouterName This property is required. string
Name of Azure router associated with physical port.
AdminState string
Administrative state of the physical port.
Id string
Resource ID.
MacSecConfig ExpressRouteLinkMacSecConfigResponse
MacSec configuration.
Name string
Name of child port resource that is unique among child port resources of the parent.
coloLocation This property is required. String
Cololocation for ExpressRoute Hybrid Direct.
connectorType This property is required. String
Physical fiber port type.
etag This property is required. String
A unique read-only string that changes whenever the resource is updated.
interfaceName This property is required. String
Name of Azure router interface.
patchPanelId This property is required. String
Mapping between physical port to patch panel port.
provisioningState This property is required. String
The provisioning state of the express route link resource.
rackId This property is required. String
Mapping of physical patch panel to rack.
routerName This property is required. String
Name of Azure router associated with physical port.
adminState String
Administrative state of the physical port.
id String
Resource ID.
macSecConfig ExpressRouteLinkMacSecConfigResponse
MacSec configuration.
name String
Name of child port resource that is unique among child port resources of the parent.
coloLocation This property is required. string
Cololocation for ExpressRoute Hybrid Direct.
connectorType This property is required. string
Physical fiber port type.
etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
interfaceName This property is required. string
Name of Azure router interface.
patchPanelId This property is required. string
Mapping between physical port to patch panel port.
provisioningState This property is required. string
The provisioning state of the express route link resource.
rackId This property is required. string
Mapping of physical patch panel to rack.
routerName This property is required. string
Name of Azure router associated with physical port.
adminState string
Administrative state of the physical port.
id string
Resource ID.
macSecConfig ExpressRouteLinkMacSecConfigResponse
MacSec configuration.
name string
Name of child port resource that is unique among child port resources of the parent.
colo_location This property is required. str
Cololocation for ExpressRoute Hybrid Direct.
connector_type This property is required. str
Physical fiber port type.
etag This property is required. str
A unique read-only string that changes whenever the resource is updated.
interface_name This property is required. str
Name of Azure router interface.
patch_panel_id This property is required. str
Mapping between physical port to patch panel port.
provisioning_state This property is required. str
The provisioning state of the express route link resource.
rack_id This property is required. str
Mapping of physical patch panel to rack.
router_name This property is required. str
Name of Azure router associated with physical port.
admin_state str
Administrative state of the physical port.
id str
Resource ID.
mac_sec_config ExpressRouteLinkMacSecConfigResponse
MacSec configuration.
name str
Name of child port resource that is unique among child port resources of the parent.
coloLocation This property is required. String
Cololocation for ExpressRoute Hybrid Direct.
connectorType This property is required. String
Physical fiber port type.
etag This property is required. String
A unique read-only string that changes whenever the resource is updated.
interfaceName This property is required. String
Name of Azure router interface.
patchPanelId This property is required. String
Mapping between physical port to patch panel port.
provisioningState This property is required. String
The provisioning state of the express route link resource.
rackId This property is required. String
Mapping of physical patch panel to rack.
routerName This property is required. String
Name of Azure router associated with physical port.
adminState String
Administrative state of the physical port.
id String
Resource ID.
macSecConfig Property Map
MacSec configuration.
name String
Name of child port resource that is unique among child port resources of the parent.

ManagedServiceIdentityResponse

PrincipalId This property is required. string
The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
Type string
The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.Network.Inputs.ManagedServiceIdentityResponseUserAssignedIdentities>
The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
PrincipalId This property is required. string
The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
Type string
The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.
UserAssignedIdentities map[string]ManagedServiceIdentityResponseUserAssignedIdentities
The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
principalId This property is required. String
The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
type String
The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.
userAssignedIdentities Map<String,ManagedServiceIdentityResponseUserAssignedIdentities>
The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
principalId This property is required. string
The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. string
The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
type string
The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.
userAssignedIdentities {[key: string]: ManagedServiceIdentityResponseUserAssignedIdentities}
The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
principal_id This property is required. str
The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
tenant_id This property is required. str
The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
type str
The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.
user_assigned_identities Mapping[str, ManagedServiceIdentityResponseUserAssignedIdentities]
The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
principalId This property is required. String
The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
type String
The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.
userAssignedIdentities Map<Property Map>
The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ManagedServiceIdentityResponseUserAssignedIdentities

ClientId This property is required. string
The client id of user assigned identity.
PrincipalId This property is required. string
The principal id of user assigned identity.
ClientId This property is required. string
The client id of user assigned identity.
PrincipalId This property is required. string
The principal id of user assigned identity.
clientId This property is required. String
The client id of user assigned identity.
principalId This property is required. String
The principal id of user assigned identity.
clientId This property is required. string
The client id of user assigned identity.
principalId This property is required. string
The principal id of user assigned identity.
client_id This property is required. str
The client id of user assigned identity.
principal_id This property is required. str
The principal id of user assigned identity.
clientId This property is required. String
The client id of user assigned identity.
principalId This property is required. String
The principal id of user assigned identity.

SubResourceResponse

Id This property is required. string
Resource ID.
Id This property is required. string
Resource ID.
id This property is required. String
Resource ID.
id This property is required. string
Resource ID.
id This property is required. str
Resource ID.
id This property is required. String
Resource ID.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi