Skip to content

Latest commit

 

History

History
284 lines (223 loc) · 5.26 KB

Send-AppInsightsDependency.md

File metadata and controls

284 lines (223 loc) · 5.26 KB
external help file Module Name online version schema
AppInsights.dll-Help.xml
AppInsights
2.0.0

Send-AppInsightsDependency

SYNOPSIS

PowerShell command used to track dependencies with application insights.

SYNTAX

Send-AppInsightsDependency [-Type] <String> [-Name] <String> [-Target] <String> [-Duration] <TimeSpan>
 [-ResultCode] <String> [[-Data] <String>] [[-Metrics] <Hashtable>] [[-Timestamp] <DateTimeOffset>]
 [[-Success] <Boolean>] [[-InstrumentationKey] <Guid>] [[-Properties] <Hashtable>] [[-RoleName] <String>]
 [[-RoleInstance] <String>] [[-CaptureLevel] <Int32>] [-CaptureCommand] [-DeveloperMode] [<CommonParameters>]

DESCRIPTION

PowerShell command used to track dependencies with application insights.

EXAMPLES

Example 1

Send-AppInsightsDependency -Type "<Type>" -Name "<Nam>" -Target "<Target>" -Data "<Data>" -StartTime (Get-Date) -Duration (New-TimeSpan -Seconds 30) -ResultCode OK

PARAMETERS

-CaptureCommand

Disables the capturing for the PowerShell command context. For instance, if sensitive data would be captured.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Benannt
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CaptureLevel

Defines which level in the call stack is taken into account for the command context.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Benannt
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Data

Command initiated by this dependency call. Examples are SQL statement and HTTP URL with all query parameters.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Benannt
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Duration

The dependency processing time.

Type: TimeSpan
Parameter Sets: (All)
Aliases:

Required: True
Position: Benannt
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-InstrumentationKey

The Application Insights Instrumentation Key.

Type: Guid
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Metrics

Optional dictionary with custom request metrics.

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: Benannt
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Name of the command initiated with dependency call.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Benannt
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Properties

Optional dictionary with custom properties.

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResultCode

The dependency call result code.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Benannt
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RoleInstance

Defines whether the process was successfully processed.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Benannt
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RoleName

Defines whether the process was successfully processed.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Benannt
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Success

Defines whether the process was successfully processed.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Benannt
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Target

Target of the command initiated with dependency call.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Benannt
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Timestamp

The datetime when telemetry was recorded. Default is UTC.Now.

Type: DateTimeOffset
Parameter Sets: (All)
Aliases: StartTime

Required: False
Position: Benannt
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Type

The name of the dependency type being tracked.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DeveloperMode

Enables the application insights developer mode.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS