Azure Native v1.98.0, Mar 23 23

azure-native.network.getExpressRoutePort

Retrieves the requested ExpressRoutePort resource. API Version: 2020-11-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>

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]

func LookupExpressRoutePort(ctx *Context, args *LookupExpressRoutePortArgs, opts ...InvokeOption) (*LookupExpressRoutePortResult, error)
func LookupExpressRoutePortOutput(ctx *Context, args *LookupExpressRoutePortOutputArgs, opts ...InvokeOption) LookupExpressRoutePortResultOutput

> 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)
}

public static CompletableFuture<GetExpressRoutePortResult> getExpressRoutePort(GetExpressRoutePortArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

ExpressRoutePortName string: The name of ExpressRoutePort.
ResourceGroupName string: The name of the resource group.

ExpressRoutePortName string: The name of ExpressRoutePort.
ResourceGroupName string: The name of the resource group.

expressRoutePortName String: The name of ExpressRoutePort.
resourceGroupName String: The name of the resource group.

expressRoutePortName string: The name of ExpressRoutePort.
resourceGroupName string: The name of the resource group.

express_route_port_name str: The name of ExpressRoutePort.
resource_group_name str: The name of the resource group.

expressRoutePortName String: The name of ExpressRoutePort.
resourceGroupName 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.
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.
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.
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.
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.
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.
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

ConnectorType string: Physical fiber port type.
Etag string: A unique read-only string that changes whenever the resource is updated.
InterfaceName string: Name of Azure router interface.
PatchPanelId string: Mapping between physical port to patch panel port.
ProvisioningState string: The provisioning state of the express route link resource.
RackId string: Mapping of physical patch panel to rack.
RouterName 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.

ConnectorType string: Physical fiber port type.
Etag string: A unique read-only string that changes whenever the resource is updated.
InterfaceName string: Name of Azure router interface.
PatchPanelId string: Mapping between physical port to patch panel port.
ProvisioningState string: The provisioning state of the express route link resource.
RackId string: Mapping of physical patch panel to rack.
RouterName 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.

connectorType String: Physical fiber port type.
etag String: A unique read-only string that changes whenever the resource is updated.
interfaceName String: Name of Azure router interface.
patchPanelId String: Mapping between physical port to patch panel port.
provisioningState String: The provisioning state of the express route link resource.
rackId String: Mapping of physical patch panel to rack.
routerName 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.

connectorType string: Physical fiber port type.
etag string: A unique read-only string that changes whenever the resource is updated.
interfaceName string: Name of Azure router interface.
patchPanelId string: Mapping between physical port to patch panel port.
provisioningState string: The provisioning state of the express route link resource.
rackId string: Mapping of physical patch panel to rack.
routerName 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.

connector_type str: Physical fiber port type.
etag str: A unique read-only string that changes whenever the resource is updated.
interface_name str: Name of Azure router interface.
patch_panel_id str: Mapping between physical port to patch panel port.
provisioning_state str: The provisioning state of the express route link resource.
rack_id str: Mapping of physical patch panel to rack.
router_name 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.

connectorType String: Physical fiber port type.
etag String: A unique read-only string that changes whenever the resource is updated.
interfaceName String: Name of Azure router interface.
patchPanelId String: Mapping between physical port to patch panel port.
provisioningState String: The provisioning state of the express route link resource.
rackId String: Mapping of physical patch panel to rack.
routerName 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 string: The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId 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 string: The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId 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 String: The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId 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 string: The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId 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 str: The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
tenant_id 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 String: The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId 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 string: The client id of user assigned identity.
PrincipalId string: The principal id of user assigned identity.

ClientId string: The client id of user assigned identity.
PrincipalId string: The principal id of user assigned identity.

clientId String: The client id of user assigned identity.
principalId String: The principal id of user assigned identity.

clientId string: The client id of user assigned identity.
principalId string: The principal id of user assigned identity.

client_id str: The client id of user assigned identity.
principal_id str: The principal id of user assigned identity.

clientId String: The client id of user assigned identity.
principalId String: The principal id of user assigned identity.

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