Get-AzureRMNetworkWatcherReachabilityReport
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
Run cmdlet in the background
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The name of the city.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The name of the country.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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 |
The end time for the Azure reachability report.
Type: | DateTime |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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 |
The network watcher resource
Type: | PSNetworkWatcher |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Location of the network watcher.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The name of network watcher.
Type: | String |
Aliases: | ResourceName, Name |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
List of Internet service providers.
Type: | List<T>[String] |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The name of the network watcher resource group.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The Id of network watcher resource.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
The start time for the Azure reachability report.
Type: | DateTime |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The name of the state.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Parameters: NetworkWatcher (ByValue)
Outputs
Notes
Keywords: azure, azurerm, arm, resource, management, manager, network, networking, network watcher, reachability, report
Related Links
- New-AzureRmNetworkWatcher
- Get-AzureRmNetworkWatcher
- Remove-AzureRmNetworkWatcher
- Get-AzureRmNetworkWatcherNextHop
- Get-AzureRmNetworkWatcherSecurityGroupView
- Get-AzureRmNetworkWatcherTopology
- Start-AzureRmNetworkWatcherResourceTroubleshooting
- New-AzureRmNetworkWatcherPacketCapture
- New-AzureRmPacketCaptureFilterConfig
- Get-AzureRmNetworkWatcherPacketCapture
- Remove-AzureRmNetworkWatcherPacketCapture
- Stop-AzureRmNetworkWatcherPacketCapture
- New-AzureRmNetworkWatcherProtocolConfiguration
- Test-AzureRmNetworkWatcherIPFlow
- Test-AzureRmNetworkWatcherConnectivity
- Stop-AzureRmNetworkWatcherConnectionMonitor
- Start-AzureRmNetworkWatcherConnectionMonitor
- Set-AzureRmNetworkWatcherConnectionMonitor
- Set-AzureRmNetworkWatcherConfigFlowLog
- Remove-AzureRmNetworkWatcherConnectionMonitor
- New-AzureRmNetworkWatcherConnectionMonitor
- Get-AzureRmNetworkWatcherTroubleshootingResult
- Get-AzureRMNetworkWatcherReachabilityReport
- Get-AzureRmNetworkWatcherReachabilityProvidersList
- Get-AzureRmNetworkWatcherFlowLogStatus
- Get-AzureRmNetworkWatcherConnectionMonitorReport
- Get-AzureRmNetworkWatcherConnectionMonitor