Get-AzureRMNetworkWatcherReachabilityReport

NAME Get-AzureRMNetworkWatcherReachabilityReport



SYNOPSIS

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





SYNTAX

Get-AzureRMNetworkWatcherReachabilityReport [-AsJob] [-City <String>] [-Country <String>] [-DefaultProfile <IAzureContextContainer>] -EndTime

<DateTime> [-Location <System.Collections.Generic.List`1[System.String]>] -NetworkWatcher <PSNetworkWatcher> [-Provider

<System.Collections.Generic.List`1[System.String]>] -StartTime <DateTime> [-State <String>] [<CommonParameters>]



Get-AzureRMNetworkWatcherReachabilityReport [-AsJob] [-City <String>] [-Country <String>] [-DefaultProfile <IAzureContextContainer>] -EndTime

<DateTime> [-Location <System.Collections.Generic.List`1[System.String]>] -NetworkWatcherName <String> [-Provider

<System.Collections.Generic.List`1[System.String]>] -ResourceGroupName <String> -StartTime <DateTime> [-State <String>] [<CommonParameters>]



Get-AzureRMNetworkWatcherReachabilityReport [-AsJob] [-City <String>] [-Country <String>] [-DefaultProfile <IAzureContextContainer>] -EndTime

<DateTime> [-Location <System.Collections.Generic.List`1[System.String]>] [-Provider <System.Collections.Generic.List`1[System.String]>]

-ResourceId <String> -StartTime <DateTime> [-State <String>] [<CommonParameters>]





DESCRIPTION

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

regions.





PARAMETERS

-AsJob [<SwitchParameter>]

Run cmdlet in the background



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-City <String>

The name of the city.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Country <String>

The name of the country.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-EndTime <DateTime>

The end time for the Azure reachability report.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Location <System.Collections.Generic.List`1[System.String]>

Optional Azure regions to scope the query to.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-NetworkWatcher <PSNetworkWatcher>

The network watcher resource



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-NetworkWatcherName <String>

The name of network watcher.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Provider <System.Collections.Generic.List`1[System.String]>

List of Internet service providers.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ResourceGroupName <String>

The name of the network watcher resource group.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ResourceId <String>

The Id of network watcher resource.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-StartTime <DateTime>

The start time for the Azure reachability report.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-State <String>

The name of the state.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

Microsoft.Azure.Commands.Network.Models.PSNetworkWatcher

System.String





OUTPUTS

Microsoft.Azure.Commands.Network.Models.PSAzureReachabilityReport







NOTES





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



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.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... lityreport

New-AzureRmNetworkWatcher

Get-AzureRmNetworkWatcher

Remove-AzureRmNetworkWatcher

Test-AzureRmNetworkWatcherIPFlow

Get-AzureRmNetworkWatcherSecurityGroupView

Get-AzureRmNetworkWatcherTopology

Start-AzureRmNetworkWatcherResourceTroubleshooting

New-AzureRmNetworkWatcherPacketCapture

New-AzureRmPacketCaptureFilterConfig

Get-AzureRmNetworkWatcherPacketCapture

Remove-AzureRmNetworkWatcherPacketCapture

Stop-AzureRmNetworkWatcherPacketCapture