Skip to content

Commit 49e2d23

Browse files
geekrigeekri
committed
Test
Helpfile changes
1 parent f7ed47c commit 49e2d23

File tree

1 file changed

+97
-56
lines changed

1 file changed

+97
-56
lines changed

‎src/ServiceManagement/RecoveryServices/Commands.RecoveryServices/Microsoft.Azure.Commands.RecoveryServices.dll-help.xml

Lines changed: 97 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -2674,13 +2674,13 @@ Contosovault RecoveryServices-6JP
26742674
</command:command>
26752675

26762676
<!--Start-AzureSiteRecoveryTestFailoverJob-->
2677-
<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">
2677+
<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">
26782678
<command:details>
26792679
<command:name>
26802680
Start-AzureSiteRecoveryTestFailoverJob
26812681
</command:name>
26822682
<maml:description>
2683-
<maml:para>Start the Test Failover operation for a Virtual Machine or Recovery Plan under Azure Site Recovery</maml:para>
2683+
<maml:para>Start the Test Failover operation for a Protection Entity or Recovery Plan under Azure Site Recovery</maml:para>
26842684
</maml:description>
26852685
<maml:copyright>
26862686
<maml:para></maml:para>
@@ -2696,20 +2696,20 @@ Contosovault RecoveryServices-6JP
26962696
<command:syntax>
26972697
<command:syntaxItem>
26982698
<maml:name>Start-AzureSiteRecoveryTestFailoverJob</maml:name>
2699-
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named">
2700-
<maml:name>RecoveryPlan</maml:name>
2701-
<maml:description>
2702-
<maml:para>Recovery Plan object</maml:para>
2703-
</maml:description>
2704-
<command:parameterValue required="true" variableLength="false">ASRRecoveryPlan</command:parameterValue>
2705-
</command:parameter>
27062699
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
27072700
<maml:name>Direction</maml:name>
27082701
<maml:description>
27092702
<maml:para>Direction of the failover, either PrimaryToRecovery or RecoveryToPrimary</maml:para>
27102703
</maml:description>
27112704
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
27122705
</command:parameter>
2706+
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named">
2707+
<maml:name>RecoveryPlan</maml:name>
2708+
<maml:description>
2709+
<maml:para>Recovery Plan object</maml:para>
2710+
</maml:description>
2711+
<command:parameterValue required="true" variableLength="false">ASRRecoveryPlan</command:parameterValue>
2712+
</command:parameter>
27132713
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
27142714
<maml:name>WaitForCompletion</maml:name>
27152715
<maml:description>
@@ -2720,16 +2720,16 @@ Contosovault RecoveryServices-6JP
27202720
<command:syntaxItem>
27212721
<maml:name>Start-AzureSiteRecoveryTestFailoverJob</maml:name>
27222722
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
2723-
<maml:name>RpId</maml:name>
2723+
<maml:name>Direction</maml:name>
27242724
<maml:description>
2725-
<maml:para>Id of the Recovery Plan</maml:para>
2725+
<maml:para>Direction of the failover, either PrimaryToRecovery or RecoveryToPrimary</maml:para>
27262726
</maml:description>
27272727
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
27282728
</command:parameter>
27292729
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
2730-
<maml:name>Direction</maml:name>
2730+
<maml:name>RpId</maml:name>
27312731
<maml:description>
2732-
<maml:para>Direction of the failover, either PrimaryToRecovery or RecoveryToPrimary</maml:para>
2732+
<maml:para>Id of the Recovery Plan</maml:para>
27332733
</maml:description>
27342734
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
27352735
</command:parameter>
@@ -2742,20 +2742,20 @@ Contosovault RecoveryServices-6JP
27422742
</command:syntaxItem>
27432743
<command:syntaxItem>
27442744
<maml:name>Start-AzureSiteRecoveryTestFailoverJob</maml:name>
2745-
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named">
2746-
<maml:name>ProtectionEntity</maml:name>
2747-
<maml:description>
2748-
<maml:para>Protection Entity object</maml:para>
2749-
</maml:description>
2750-
<command:parameterValue required="true" variableLength="false">ASRProtectionEntity</command:parameterValue>
2751-
</command:parameter>
27522745
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
27532746
<maml:name>Direction</maml:name>
27542747
<maml:description>
27552748
<maml:para>Direction of the failover, either PrimaryToRecovery or RecoveryToPrimary</maml:para>
27562749
</maml:description>
27572750
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
27582751
</command:parameter>
2752+
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named">
2753+
<maml:name>ProtectionEntity</maml:name>
2754+
<maml:description>
2755+
<maml:para>Protection Entity object</maml:para>
2756+
</maml:description>
2757+
<command:parameterValue required="true" variableLength="false">ASRProtectionEntity</command:parameterValue>
2758+
</command:parameter>
27592759
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
27602760
<maml:name>WaitForCompletion</maml:name>
27612761
<maml:description>
@@ -2765,12 +2765,12 @@ Contosovault RecoveryServices-6JP
27652765
</command:syntaxItem>
27662766
<command:syntaxItem>
27672767
<maml:name>Start-AzureSiteRecoveryTestFailoverJob</maml:name>
2768-
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named">
2769-
<maml:name>ProtectionEntity</maml:name>
2768+
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
2769+
<maml:name>Direction</maml:name>
27702770
<maml:description>
2771-
<maml:para>Protection Entity object</maml:para>
2771+
<maml:para>Direction of the failover, either PrimaryToRecovery or RecoveryToPrimary</maml:para>
27722772
</maml:description>
2773-
<command:parameterValue required="true" variableLength="false">ASRProtectionEntity</command:parameterValue>
2773+
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
27742774
</command:parameter>
27752775
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
27762776
<maml:name>LogicalNetworkId</maml:name>
@@ -2779,12 +2779,12 @@ Contosovault RecoveryServices-6JP
27792779
</maml:description>
27802780
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
27812781
</command:parameter>
2782-
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
2783-
<maml:name>Direction</maml:name>
2782+
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named">
2783+
<maml:name>ProtectionEntity</maml:name>
27842784
<maml:description>
2785-
<maml:para>Direction of the failover, either PrimaryToRecovery or RecoveryToPrimary</maml:para>
2785+
<maml:para>Protection Entity object</maml:para>
27862786
</maml:description>
2787-
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
2787+
<command:parameterValue required="true" variableLength="false">ASRProtectionEntity</command:parameterValue>
27882788
</command:parameter>
27892789
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
27902790
<maml:name>WaitForCompletion</maml:name>
@@ -2795,6 +2795,13 @@ Contosovault RecoveryServices-6JP
27952795
</command:syntaxItem>
27962796
<command:syntaxItem>
27972797
<maml:name>Start-AzureSiteRecoveryTestFailoverJob</maml:name>
2798+
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
2799+
<maml:name>Direction</maml:name>
2800+
<maml:description>
2801+
<maml:para>Direction of the failover, either PrimaryToRecovery or RecoveryToPrimary</maml:para>
2802+
</maml:description>
2803+
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
2804+
</command:parameter>
27982805
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
27992806
<maml:name>ProtectionEntity</maml:name>
28002807
<maml:description>
@@ -2809,13 +2816,6 @@ Contosovault RecoveryServices-6JP
28092816
</maml:description>
28102817
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
28112818
</command:parameter>
2812-
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
2813-
<maml:name>Direction</maml:name>
2814-
<maml:description>
2815-
<maml:para>Direction of the failover, either PrimaryToRecovery or RecoveryToPrimary</maml:para>
2816-
</maml:description>
2817-
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
2818-
</command:parameter>
28192819
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
28202820
<maml:name>WaitForCompletion</maml:name>
28212821
<maml:description>
@@ -2826,23 +2826,23 @@ Contosovault RecoveryServices-6JP
28262826
<command:syntaxItem>
28272827
<maml:name>Start-AzureSiteRecoveryTestFailoverJob</maml:name>
28282828
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
2829-
<maml:name>ProtectionContainerId</maml:name>
2829+
<maml:name>Direction</maml:name>
28302830
<maml:description>
2831-
<maml:para>Id of the Protection Container</maml:para>
2831+
<maml:para>Direction of the failover, either PrimaryToRecovery or RecoveryToPrimary</maml:para>
28322832
</maml:description>
28332833
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
28342834
</command:parameter>
28352835
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
2836-
<maml:name>ProtectionEntityId</maml:name>
2836+
<maml:name>ProtectionContainerId</maml:name>
28372837
<maml:description>
2838-
<maml:para>Id of the Protection Entity</maml:para>
2838+
<maml:para>Id of the Protection Container</maml:para>
28392839
</maml:description>
28402840
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
28412841
</command:parameter>
28422842
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
2843-
<maml:name>Direction</maml:name>
2843+
<maml:name>ProtectionEntityId</maml:name>
28442844
<maml:description>
2845-
<maml:para>Direction of the failover, either PrimaryToRecovery or RecoveryToPrimary</maml:para>
2845+
<maml:para>Id of the Protection Entity</maml:para>
28462846
</maml:description>
28472847
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
28482848
</command:parameter>
@@ -2856,30 +2856,30 @@ Contosovault RecoveryServices-6JP
28562856
<command:syntaxItem>
28572857
<maml:name>Start-AzureSiteRecoveryTestFailoverJob</maml:name>
28582858
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
2859-
<maml:name>ProtectionContainerId</maml:name>
2859+
<maml:name>Direction</maml:name>
28602860
<maml:description>
2861-
<maml:para>Id of the Protection Container</maml:para>
2861+
<maml:para>Direction of the failover, either PrimaryToRecovery or RecoveryToPrimary</maml:para>
28622862
</maml:description>
28632863
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
28642864
</command:parameter>
28652865
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
2866-
<maml:name>ProtectionEntityId</maml:name>
2866+
<maml:name>LogicalNetworkId</maml:name>
28672867
<maml:description>
2868-
<maml:para>Id of the Protection Entity</maml:para>
2868+
<maml:para>Logical Network Id</maml:para>
28692869
</maml:description>
28702870
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
28712871
</command:parameter>
28722872
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
2873-
<maml:name>LogicalNetworkId</maml:name>
2873+
<maml:name>ProtectionContainerId</maml:name>
28742874
<maml:description>
2875-
<maml:para>Logical Network Id</maml:para>
2875+
<maml:para>Id of the Protection Container</maml:para>
28762876
</maml:description>
28772877
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
28782878
</command:parameter>
28792879
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
2880-
<maml:name>Direction</maml:name>
2880+
<maml:name>ProtectionEntityId</maml:name>
28812881
<maml:description>
2882-
<maml:para>Direction of the failover, either PrimaryToRecovery or RecoveryToPrimary</maml:para>
2882+
<maml:para>Id of the Protection Entity</maml:para>
28832883
</maml:description>
28842884
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
28852885
</command:parameter>
@@ -2892,6 +2892,13 @@ Contosovault RecoveryServices-6JP
28922892
</command:syntaxItem>
28932893
<command:syntaxItem>
28942894
<maml:name>Start-AzureSiteRecoveryTestFailoverJob</maml:name>
2895+
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
2896+
<maml:name>Direction</maml:name>
2897+
<maml:description>
2898+
<maml:para>Direction of the failover, either PrimaryToRecovery or RecoveryToPrimary</maml:para>
2899+
</maml:description>
2900+
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
2901+
</command:parameter>
28952902
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
28962903
<maml:name>ProtectionContainerId</maml:name>
28972904
<maml:description>
@@ -2913,13 +2920,6 @@ Contosovault RecoveryServices-6JP
29132920
</maml:description>
29142921
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
29152922
</command:parameter>
2916-
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
2917-
<maml:name>Direction</maml:name>
2918-
<maml:description>
2919-
<maml:para>Direction of the failover, either PrimaryToRecovery or RecoveryToPrimary</maml:para>
2920-
</maml:description>
2921-
<command:parameterValue required="true" variableLength="false">string</command:parameterValue>
2922-
</command:parameter>
29232923
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
29242924
<maml:name>WaitForCompletion</maml:name>
29252925
<maml:description>
@@ -3134,6 +3134,47 @@ Contosovault RecoveryServices-6JP
31343134
</command:commandLine>
31353135
</command:commandLines>
31363136
</command:example>
3137+
3138+
<command:example>
3139+
<maml:title>
3140+
-------------------------- EXAMPLE 2 --------------------------
3141+
</maml:title>
3142+
<maml:introduction>
3143+
<maml:para>C:\PS&gt;</maml:para>
3144+
</maml:introduction>
3145+
<dev:code>
3146+
$RP = Get-AzureSiteRecoveryRecoveryPlan -Name &quot;RP1&quot;
3147+
Start-AzureSiteRecoveryTestFailoverJob -RecoveryPlan $RP -Direction PrimaryToRecovery
3148+
3149+
Name :
3150+
ID : 4a991243-a97f-4617-97be-a6e0dc99a2ff
3151+
ClientRequestId : 0ae1226f-b68d-4131-b2e8-17bb4c19fa29-2015-02-17 14:35:46Z-P
3152+
State : NotStarted
3153+
StateDescription : NotStarted
3154+
StartTime :
3155+
EndTime :
3156+
TargetObjectId :
3157+
TargetObjectType :
3158+
TargetObjectName :
3159+
AllowedActions :
3160+
Tasks : {}
3161+
Errors : {}
3162+
</dev:code>
3163+
<dev:remarks>
3164+
<maml:para>Description</maml:para>
3165+
<maml:para>-----------</maml:para>
3166+
<maml:para></maml:para>
3167+
<maml:para></maml:para>
3168+
<maml:para></maml:para>
3169+
<maml:para></maml:para>
3170+
<maml:para></maml:para>
3171+
</dev:remarks>
3172+
<command:commandLines>
3173+
<command:commandLine>
3174+
<command:commandText></command:commandText>
3175+
</command:commandLine>
3176+
</command:commandLines>
3177+
</command:example>
31373178
</command:examples>
31383179
<!-- Link section -->
31393180
<maml:relatedLinks>

0 commit comments

Comments
 (0)