Get-AzPeeringConnectionMonitorTest

Reference

Module:: Az.Peering

Gets an existing connection monitor test with the specified name under the given subscription, resource group and peering service.

Syntax

Get-AzPeeringConnectionMonitorTest
   -PeeringServiceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzPeeringConnectionMonitorTest
   -Name <String>
   -PeeringServiceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzPeeringConnectionMonitorTest
   -InputObject <IPeeringIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets an existing connection monitor test with the specified name under the given subscription, resource group and peering service.

Examples

Example 1: Lists all connection monitor tests

Get-AzPeeringConnectionMonitorTest -ResourceGroupName DemoRG -PeeringServiceName DRTest

SourceAgent Destination DestinationPort TestFrequency Sucessful ProvisioningState
----------- ----------- --------------- ------------- --------- -----------------
Agent 1     1.1.1.1     80              30            True      Succeeded
Agent 2     8.8.8.8     80              30            True      Succeeded

Lists all connection monitor test objects

Example 2: Get single connection monitor test

Get-AzPeeringConnectionMonitorTest -ResourceGroupName DemoRG -PeeringServiceName DRTest -Name TestName

SourceAgent Destination DestinationPort TestFrequency Sucessful ProvisioningState
----------- ----------- --------------- ------------- --------- -----------------
Agent 1     1.1.1.1     80              30            True      Succeeded

Gets a single connection monitor test

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

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

-Name

The name of the connection monitor test

Type:	String
Aliases:	ConnectionMonitorTestName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PeeringServiceName

The name of the peering service.

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

-ResourceGroupName

The name of the resource group.

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

-SubscriptionId

The Azure subscription ID.

Type:	String[]
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

IPeeringIdentity

Outputs

IConnectionMonitorTest

Share via