Get-AzureRMNetworkWatcherReachabilityReport

  • Reference
Module:
AzureRM.Network

Gets the relative latency score for internet service providers from a specified location to Azure regions.

Important

Because Az PowerShell modules now have all the capabilities of AzureRM PowerShell modules and more, we'll retire AzureRM PowerShell modules on 29 February 2024.

To avoid service interruptions, update your scripts that use AzureRM PowerShell modules to use Az PowerShell modules by 29 February 2024. To automatically update your scripts, follow the quickstart guide.

Syntax

Get-AzureRMNetworkWatcherReachabilityReport
   -NetworkWatcherName <String>
   -ResourceGroupName <String>
   [-Provider <System.Collections.Generic.List`1[System.String]>]
   [-Location <System.Collections.Generic.List`1[System.String]>]
   -StartTime <DateTime>
   -EndTime <DateTime>
   [-Country <String>]
   [-State <String>]
   [-City <String>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRMNetworkWatcherReachabilityReport
   -NetworkWatcher <PSNetworkWatcher>
   [-Provider <System.Collections.Generic.List`1[System.String]>]
   [-Location <System.Collections.Generic.List`1[System.String]>]
   -StartTime <DateTime>
   -EndTime <DateTime>
   [-Country <String>]
   [-State <String>]
   [-City <String>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRMNetworkWatcherReachabilityReport
   -ResourceId <String>
   [-Provider <System.Collections.Generic.List`1[System.String]>]
   [-Location <System.Collections.Generic.List`1[System.String]>]
   -StartTime <DateTime>
   -EndTime <DateTime>
   [-Country <String>]
   [-State <String>]
   [-City <String>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRMNetworkWatcherReachabilityReport
   -NetworkWatcherLocation <String>
   [-Provider <System.Collections.Generic.List`1[System.String]>]
   [-Location <System.Collections.Generic.List`1[System.String]>]
   -StartTime <DateTime>
   -EndTime <DateTime>
   [-Country <String>]
   [-State <String>]
   [-City <String>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzureRmNetworkWatcherReachabilityReport gets the relative latency score for internet service providers from a specified location to Azure regions.

Examples

Example 1

$nw = Get-AzureRmNetworkWatcher -Name NetworkWatcher -ResourceGroupName NetworkWatcherRG
Get-AzureRmNetworkWatcherReachabilityReport -NetworkWatcher $nw -Location "West US" -Country "United States" -StartTime "2017-10-10" -EndTime "2017-10-12"

"aggregationLevel" : "Country",
"providerLocation" : {
    "country" : "United States"
},
"reachabilityReport" : [
    {
        "provider" : "Frontier Communications of America, Inc. - ASN 5650",
        "azureLocation": "West US",
        "latencies": [
            {
                "timeStamp": "2017-10-10T00:00:00Z",
                "score": 94
            },
            {
                "timeStamp": "2017-10-11T00:00:00Z",
                "score": 94
            },
            {
                "timeStamp": "2017-10-12T00:00:00Z",
                "score": 94    
            }
        ]  
    }
]

Gets relative latencies to Azure Data Center in West US from 2017-10-10 to 2017-10-12 inside United State.

Parameters

-AsJob

Run cmdlet in the background

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-City

The name of the city.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Country

The name of the country.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-EndTime

The end time for the Azure reachability report.

Type:DateTime
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Location

Optional Azure regions to scope the query to.

Type:List<T>[String]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-NetworkWatcher

The network watcher resource

Type:PSNetworkWatcher
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-NetworkWatcherLocation

Location of the network watcher.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-NetworkWatcherName

The name of network watcher.

Type:String
Aliases:ResourceName, Name
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Provider

List of Internet service providers.

Type:List<T>[String]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceGroupName

The name of the network watcher resource group.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceId

The Id of network watcher resource.

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

The start time for the Azure reachability report.

Type:DateTime
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-State

The name of the state.

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

Inputs

PSNetworkWatcher

Parameters: NetworkWatcher (ByValue)

String

Outputs

PSAzureReachabilityReport

Notes

Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, reachability, report