en-US/AzSpeedTest-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzRegion</command:name> <command:verb>Get</command:verb> <command:noun>AzRegion</command:noun> <maml:description> <maml:para>Return a list of Azure Regions.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Return a list of Azure regions.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzRegion</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-AzRegion</dev:code> <dev:remarks> <maml:para>australiaeast australiasoutheast brazilsouth canadacentral canadaeast centralindia centralus eastasia eastus eastus2 francecentral japaneast japanwest koreacentral koreasouth northcentralus northeurope southcentralus southeastasia southindia uksouth ukwest westcentralus westeurope westindia westus westus2</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-AzRegionLatency</command:name> <command:verb>Test</command:verb> <command:noun>AzRegionLatency</command:noun> <maml:description> <maml:para>Tests network latency to one or more Azure regions.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Tests network latency to one or more Azure regions.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-AzRegionLatency</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Iterations</maml:name> <maml:Description> <maml:para>The number of test iterations to run in each region.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>DelaySeconds</maml:name> <maml:Description> <maml:para>An optional number of seconds to wait between each iteration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>DelayMilliseconds</maml:name> <maml:Description> <maml:para>An optional number of milliseconds to wait between each iteration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Region</maml:name> <maml:Description> <maml:para>The region(s) to test. By default ALL available Azure regions will be tested.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Iterations</maml:name> <maml:Description> <maml:para>The number of test iterations to run in each region.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>DelaySeconds</maml:name> <maml:Description> <maml:para>An optional number of seconds to wait between each iteration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>DelayMilliseconds</maml:name> <maml:Description> <maml:para>An optional number of milliseconds to wait between each iteration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Region</maml:name> <maml:Description> <maml:para>The region(s) to test. By default ALL available Azure regions will be tested.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Test-AzRegionLatency -Region westus</dev:code> <dev:remarks> <maml:para>RawResults : {@{Time=4/18/18 8:54:46 PM; Timespan=00:00:00.0350430; LatencyMS=35}, @{Time=4/18/18 8:54:46 PM; Timespan=00:00:00.0339910; LatencyMS=33}, @{Time=4/18/18 8:54:46 PM; Timespan=00:00:00.0336530; LatencyMS=33}, @{Time=4/18/18 8:54:46 PM; Timespan=00:00:00.0349360; LatencyMS=34}...} ComputerName : HDK3948GKLD TotalTime : 00:00:03.8771200 Region : westus Maximum : 52 Average : 35.02 Minimum : 32</maml:para> <maml:para>Test the network latency from the local computer to the West US Azure region.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$results = Test-AzRegionLatency -Region eastus -Iterations 300 -DelaySeconds 1</dev:code> <dev:remarks> <maml:para>Test the network latency from the local comptuer to the East US Azure region. Run this test for 5 minutes and delay each iteration by 1 second.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |