API Reference
Command
New-ImageTopologyEdge
Creates a topology edge definition.
Remarks
Use this cmdlet inside New-ImageTopology to describe a relationship between topology nodes.
Examples
Create a dependency edge
PS>
New-ImageTopologyEdge -SourceNodeId api -TargetNodeId database -Label '32 ms' -Kind Dependency -Status Warning -Direction Forward
Creates a ChartForgeX topology edge that can be rendered by New-ImageTopology.
Common Parameters
This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
For more information, see about_CommonParameters.
Syntax
New-ImageTopologyEdge [-Color <String>] [-Direction <Forward|Backward|Bidirectional>] [-Emphasis <Normal|Subtle|Strong>] [-Href <String>] [-Id <String>] [-Kind <Generic>] [-Label <String>] [-LabelOffsetX <Double>] [-LabelOffsetY <Double>] [-LineStyle <Auto|Solid|Dashed|Dotted>] [-Muted] [-RouteLane <Double>] [-Routing <Straight|Curved|Orthogonal|ObstacleAvoidingOrthogonal>] [-SecondaryLabel <String>] -SourceNodeId <String> [-SourcePort <Auto|Top|Right|Bottom|Left>] [-Status <Healthy|Warning|Critical|Unknown|Disabled>] -TargetNodeId <String> [-TargetPort <Auto|Top|Right|Bottom|Left>] [-TertiaryLabel <String>] [-Tooltip <String>] [<CommonParameters>]#Parameter set:
All Parameter SetsParameters
- Color String
- Optional edge color as a CSS hex color.
- Direction VisualLinkDirection
- Direction marker behavior.
- Possible values:
Forward,Backward,Bidirectional - Emphasis TopologyEdgeEmphasis
- Edge visual emphasis.
- Possible values:
Normal,Subtle,Strong - Href String
- Optional drill-down link for SVG and HTML outputs.
- Id String
- Stable edge identifier. When omitted, a unique identifier is derived from source and target node ids.
- Kind TopologyEdgeKind
- Relationship kind.
- Possible values:
Generic,Link,Replication,Connectivity,Dependency,Trust,Mapping,AuthenticationPath,CertificateChain,DataFlow,Ownership,Membership - Label String
- Primary edge label.
- LabelOffsetX Double
- Optional horizontal edge-label offset in pixels.
- LabelOffsetY Double
- Optional vertical edge-label offset in pixels.
- LineStyle TopologyEdgeLineStyle
- Edge line style.
- Possible values:
Auto,Solid,Dashed,Dotted - Muted SwitchParameter
- Render the edge as a quiet structural relationship.
- RouteLane Double
- Optional route lane offset in pixels.
- Routing TopologyEdgeRouting
- Edge routing mode.
- Possible values:
Straight,Curved,Orthogonal,ObstacleAvoidingOrthogonal - SecondaryLabel String
- Secondary edge label.
- SourceNodeId String
- Source node identifier.
- SourcePort TopologyEdgePort
- Preferred source attachment side.
- Possible values:
Auto,Top,Right,Bottom,Left - Status TopologyHealthStatus
- Relationship health or state.
- Possible values:
Healthy,Warning,Critical,Unknown,Disabled - TargetNodeId String
- Target node identifier.
- TargetPort TopologyEdgePort
- Preferred target attachment side.
- Possible values:
Auto,Top,Right,Bottom,Left - TertiaryLabel String
- Tertiary edge label.
- Tooltip String
- Optional tooltip for SVG and HTML outputs.
Outputs
ChartForgeX.Topology.TopologyEdge