Edit

Share via


New-AzNetworkWatcherConnectionMonitorEndpointObject

Creates connection monitor endpoint.

Syntax

AzureVM

New-AzNetworkWatcherConnectionMonitorEndpointObject
    -Name <String>
    -ResourceId <String>
    [-AzureVM]
    [-Address <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

AzureVNet

New-AzNetworkWatcherConnectionMonitorEndpointObject
    -Name <String>
    -ResourceId <String>
    [-AzureVNet]
    [-IncludeItem <PSNetworkWatcherConnectionMonitorEndpointScopeItem[]>]
    [-ExcludeItem <PSNetworkWatcherConnectionMonitorEndpointScopeItem[]>]
    [-CoverageLevel <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

AzureSubnet

New-AzNetworkWatcherConnectionMonitorEndpointObject
    -Name <String>
    -ResourceId <String>
    [-AzureSubnet]
    [-ExcludeItem <PSNetworkWatcherConnectionMonitorEndpointScopeItem[]>]
    [-CoverageLevel <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ExternalAddress

New-AzNetworkWatcherConnectionMonitorEndpointObject
    -Name <String>
    -Address <String>
    [-ExternalAddress]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

MMAWorkspaceMachine

New-AzNetworkWatcherConnectionMonitorEndpointObject
    -Name <String>
    -ResourceId <String>
    -Address <String>
    [-MMAWorkspaceMachine]
    [-IncludeItem <PSNetworkWatcherConnectionMonitorEndpointScopeItem[]>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

MMAWorkspaceNetwork

New-AzNetworkWatcherConnectionMonitorEndpointObject
    -Name <String>
    -ResourceId <String>
    -IncludeItem <PSNetworkWatcherConnectionMonitorEndpointScopeItem[]>
    [-MMAWorkspaceNetwork]
    [-ExcludeItem <PSNetworkWatcherConnectionMonitorEndpointScopeItem[]>]
    [-CoverageLevel <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

AzureVMSS

New-AzNetworkWatcherConnectionMonitorEndpointObject
    -Name <String>
    -ResourceId <String>
    [-AzureVMSS]
    [-IncludeItem <PSNetworkWatcherConnectionMonitorEndpointScopeItem[]>]
    [-ExcludeItem <PSNetworkWatcherConnectionMonitorEndpointScopeItem[]>]
    [-CoverageLevel <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

AzureArcVM

New-AzNetworkWatcherConnectionMonitorEndpointObject
    -Name <String>
    -ResourceId <String>
    [-AzureArcVM]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

New-AzNetworkWatcherConnectionMonitorEndpointObject cmdlet creates connection monitor endpoint.

Examples

Example 1

$MySrcResourceId1 = "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myresourceGroup/providers/Microsoft.OperationalInsights/workspaces/myworkspace"
$SrcEndpointScopeItem1 = New-AzNetworkWatcherConnectionMonitorEndpointScopeItemObject -Address "WIN-P0HGNDO2S1B"
$SourceEndpointObject1 = New-AzNetworkWatcherConnectionMonitorEndpointObject -Name "workspaceEndpoint" -MMAWorkspaceMachine -ResourceId $MySrcResourceId1 -IncludeItem $SrcEndpointScopeItem1
Name       : workspaceEndpoint
Type       : MMAWorkspaceMachine
ResourceId : /subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myresourceGroup/providers/Microsoft.OperationalInsights/workspaces/myworkspace
Address    :
Scope     : {
               "Include": [
                 {
                   "Address": "WIN-P0HGNDO2S1B"
                 }
               ]
             }

Parameters

-Address

Address of the connection monitor endpoint (IP or domain name).

Parameter properties

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

Parameter sets

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

-AzureArcVM

AzureArc VM endpoint switch

Parameter properties

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

Parameter sets

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

-AzureSubnet

Azure Subnet endpoint switch.

Parameter properties

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

Parameter sets

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

-AzureVM

Azure VM endpoint switch.

Parameter properties

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

Parameter sets

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

-AzureVMSS

Azure Virtual Machine Scale sets.

Parameter properties

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

Parameter sets

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

-AzureVNet

Azure Vnet endpoint switch.

Parameter properties

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

Parameter sets

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

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

Parameter sets

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

-CoverageLevel

Test coverage for the endpoint. Supported values are Default, Low, BelowAverage, Average, AboveAverage, Full.

Parameter properties

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

Parameter sets

AzureVNet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
AzureSubnet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
MMAWorkspaceNetwork
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
AzureVMSS
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

-ExcludeItem

List of items which need to be excluded from endpoint scope.

Parameter properties

Type:

PSNetworkWatcherConnectionMonitorEndpointScopeItem[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

AzureVNet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
AzureSubnet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
MMAWorkspaceNetwork
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
AzureVMSS
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ExternalAddress

External Address endpoint switch.

Parameter properties

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

Parameter sets

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

-IncludeItem

List of items which need to be included into endpoint scope.

Parameter properties

Type:

PSNetworkWatcherConnectionMonitorEndpointScopeItem[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

AzureVNet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
MMAWorkspaceMachine
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
AzureVMSS
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MMAWorkspaceMachine

MMA Workspace Machine endpoint switch.

Parameter properties

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

Parameter sets

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

-MMAWorkspaceNetwork

MMA Workspace Network endpoint switch.

Parameter properties

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

Parameter sets

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

-Name

The name of the connection monitor endpoint.

Parameter properties

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

Parameter sets

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

-ResourceId

Resource ID of the connection monitor endpoint.

Parameter properties

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

Parameter sets

AzureVM
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
AzureVNet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
AzureSubnet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
MMAWorkspaceMachine
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
MMAWorkspaceNetwork
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
AzureVMSS
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
AzureArcVM
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

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

Parameter sets

(All)
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

PSNetworkWatcherConnectionMonitorEndpointObject