Edit

Share via


New-AzNetworkWatcherConnectionMonitorProtocolConfigurationObject

Create protocol configuration used to perform test evaluation over TCP, HTTP or ICMP.

Syntax

TCP

New-AzNetworkWatcherConnectionMonitorProtocolConfigurationObject
    -Port <UInt16>
    [-TcpProtocol]
    [-DisableTraceRoute]
    [-DestinationPortBehavior <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

HTTP

New-AzNetworkWatcherConnectionMonitorProtocolConfigurationObject
    [-HttpProtocol]
    [-Port <UInt16>]
    [-Method <String>]
    [-Path <String>]
    [-RequestHeader <Hashtable>]
    [-ValidStatusCodeRange <String[]>]
    [-PreferHTTPS]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ICMP

New-AzNetworkWatcherConnectionMonitorProtocolConfigurationObject
    [-IcmpProtocol]
    [-DisableTraceRoute]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The New-AzNetworkWatcherConnectionMonitorProtocolConfigurationObject cmdlet creates protocol configuration used to perform test evaluation over TCP, HTTP or ICMP.

Examples

Example 1

$TcpProtocolConfiguration = New-AzNetworkWatcherConnectionMonitorProtocolConfigurationObject -TcpProtocol -Port 80 -DisableTraceRoute
Port              : 80
DisableTraceRoute : False

Example 2

Create protocol configuration used to perform test evaluation over TCP, HTTP or ICMP. (autogenerated)

New-AzNetworkWatcherConnectionMonitorProtocolConfigurationObject -IcmpProtocol

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DestinationPortBehavior

Destination port behavior. Supported values are None, ListenIfAvailable.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

TCP
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisableTraceRoute

Value indicating whether path evaluation with trace route should be disabled.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

TCP
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ICMP
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-HttpProtocol

HTTP protocol switch.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

HTTP
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IcmpProtocol

ICMP protocol switch.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ICMP
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Method

The HTTP method to use.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

HTTP
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Path

The path component of the URI. For instance, "/dir1/dir2".

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

HTTP
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Port

The port to connect to.

Parameter properties

Type:

Nullable<T>[UInt16]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

TCP
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PreferHTTPS

Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

HTTP
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RequestHeader

The HTTP headers to transmit with the request.

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

HTTP
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TcpProtocol

TCP protocol switch.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

TCP
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ValidStatusCodeRange

HTTP status codes to consider successful. For instance, "2xx,301-304,418".

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

HTTP
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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

Inputs

None

Outputs

PSNetworkWatcherConnectionMonitorTcpConfiguration

PSNetworkWatcherConnectionMonitorHttpConfiguration

PSNetworkWatcherConnectionMonitorIcmpConfiguration