Skip to content

Commit b8891b8

Browse files
riyanshpalriyanshpal
committed
update help
1 parent 081f748 commit b8891b8

5 files changed

+58
-110
lines changed

‎src/RecoveryServices/RecoveryServices/help/Start-AzRecoveryServicesAsrApplyClusterRecoveryPoint.md

Lines changed: 17 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -8,34 +8,42 @@ schema: 2.0.0
88
# Start-AzRecoveryServicesAsrApplyClusterRecoveryPoint
99

1010
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
11+
Changes a recovery point for a failed over repliction protection cluster before committing the failover operation
1212

1313
## SYNTAX
1414

1515
```
1616
Start-AzRecoveryServicesAsrApplyClusterRecoveryPoint [-ClusterRecoveryPoint <ASRClusterRecoveryPoint>]
1717
-ReplicationProtectionCluster <ASRReplicationProtectionCluster>
1818
[-NodeRecoveryPoints <System.Collections.Generic.List`1[System.String]>] [-LatestProcessedRecoveryPoints]
19-
[-DefaultProfile <IAzureContextContainer>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
19+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
2020
[<CommonParameters>]
2121
```
2222

2323
## DESCRIPTION
24-
{{ Fill in the Description }}
24+
The **Start-AzRecoveryServicesAsrApplyClusterRecoveryPoint** changes the recovery point for a failed over protected item before it commits the failover operation.
25+
You can check whether the job succeeded by using the Get-AzRecoveryServicesAsrJob cmdlet.
2526

2627
## EXAMPLES
2728

2829
### Example 1
2930
```powershell
30-
PS C:\> {{ Add example code here }}
31+
$currentJob = Start-AzRecoveryServicesAsrApplyClusterRecoveryPoint -ReplicationProtectionCluster $protectionCluster -LatestProcessedRecoveryPoint
3132
```
3233

33-
{{ Add example description here }}
34+
Starts applying the recovery point on specified cluster. If LatestProcessedRecoveryPoint is passed and no specific recovery point is provided, it will pick the lastest processed recovery points and returns the ASR job used to track the operation.
35+
36+
### Example 2
37+
```powershell
38+
$currentJob = Start-AzRecoveryServicesAsrApplyClusterRecoveryPoint -ReplicationProtectionCluster $protectionCluster -ClusterRecoveryPoint $clusterRecoveryPoint -NodeRecoveryPoints $nodeRecoveryPoints
39+
```
40+
41+
Starts applying the recovery point on specified cluster and by passing ClusterRecoveryPoint and NodeRecoveryPoints, it will pick the specified recovery points and returns the ASR job used to track the operation.
3442

3543
## PARAMETERS
3644

3745
### -ClusterRecoveryPoint
38-
{{ Fill ClusterRecoveryPoint Description }}
46+
Specifies the recovery point for the cluster.
3947

4048
```yaml
4149
Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRClusterRecoveryPoint
@@ -65,7 +73,7 @@ Accept wildcard characters: False
6573
```
6674
6775
### -LatestProcessedRecoveryPoints
68-
{{ Fill LatestProcessedRecoveryPoints Description }}
76+
Fetch the latest processed recovery points if not passed for cluster or any individual node.
6977
7078
```yaml
7179
Type: System.Management.Automation.SwitchParameter
@@ -80,7 +88,7 @@ Accept wildcard characters: False
8088
```
8189
8290
### -NodeRecoveryPoints
83-
{{ Fill NodeRecoveryPoints Description }}
91+
Specifies the recovery points for the nodes which are not part of cluster recovery point.
8492
8593
```yaml
8694
Type: System.Collections.Generic.List`1[System.String]
@@ -94,23 +102,8 @@ Accept pipeline input: False
94102
Accept wildcard characters: False
95103
```
96104
97-
### -ProgressAction
98-
{{ Fill ProgressAction Description }}
99-
100-
```yaml
101-
Type: System.Management.Automation.ActionPreference
102-
Parameter Sets: (All)
103-
Aliases: proga
104-
105-
Required: False
106-
Position: Named
107-
Default value: None
108-
Accept pipeline input: False
109-
Accept wildcard characters: False
110-
```
111-
112105
### -ReplicationProtectionCluster
113-
{{ Fill ReplicationProtectionCluster Description }}
106+
Specifies the replication protection cluster.
114107
115108
```yaml
116109
Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectionCluster

‎src/RecoveryServices/RecoveryServices/help/Start-AzRecoveryServicesAsrClusterCommitFailoverJob.md

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,28 @@ schema: 2.0.0
88
# Start-AzRecoveryServicesAsrClusterCommitFailoverJob
99

1010
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
11+
Starts the commit failover action for a replication protection cluster.
1212

1313
## SYNTAX
1414

1515
```
1616
Start-AzRecoveryServicesAsrClusterCommitFailoverJob
1717
-ReplicationProtectionCluster <ASRReplicationProtectionCluster> [-DefaultProfile <IAzureContextContainer>]
18-
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
18+
[-WhatIf] [-Confirm] [<CommonParameters>]
1919
```
2020

2121
## DESCRIPTION
22-
{{ Fill in the Description }}
22+
The **Start-AzRecoveryServicesAsrClusterCommitFailoverJob** cmdlet starts the commit failover process for an Azure Site Recovery object after a failover operation.
23+
You can check whether the job succeeded by using the Get-AzRecoveryServicesAsrJob cmdlet.
2324

2425
## EXAMPLES
2526

2627
### Example 1
2728
```powershell
28-
PS C:\> {{ Add example code here }}
29+
$CommitFailoverJob = Start-AzRecoveryServicesAsrClusterCommitFailoverJob -ReplicationProtectionCluster $protectionCluster
2930
```
3031

31-
{{ Add example description here }}
32+
Starts the commit failover for the specified replication protection cluster and returns the ASR job used to track the operation.
3233

3334
## PARAMETERS
3435

@@ -47,23 +48,8 @@ Accept pipeline input: False
4748
Accept wildcard characters: False
4849
```
4950
50-
### -ProgressAction
51-
{{ Fill ProgressAction Description }}
52-
53-
```yaml
54-
Type: System.Management.Automation.ActionPreference
55-
Parameter Sets: (All)
56-
Aliases: proga
57-
58-
Required: False
59-
Position: Named
60-
Default value: None
61-
Accept pipeline input: False
62-
Accept wildcard characters: False
63-
```
64-
6551
### -ReplicationProtectionCluster
66-
{{ Fill ReplicationProtectionCluster Description }}
52+
Specifies the replication protection cluster.
6753
6854
```yaml
6955
Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectionCluster

‎src/RecoveryServices/RecoveryServices/help/Start-AzRecoveryServicesAsrClusterTestFailoverCleanupJob.md

Lines changed: 9 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,33 +8,35 @@ schema: 2.0.0
88
# Start-AzRecoveryServicesAsrClusterTestFailoverCleanupJob
99

1010
## SYNOPSIS
11-
{{ Fill in the Synopsis }}
11+
Starts the test failover cleanup operation for a cluster.
1212

1313
## SYNTAX
1414

1515
```
1616
Start-AzRecoveryServicesAsrClusterTestFailoverCleanupJob
1717
-ReplicationProtectionCluster <ASRReplicationProtectionCluster> [-Comment <String>]
18-
[-DefaultProfile <IAzureContextContainer>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
18+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
1919
[<CommonParameters>]
2020
```
2121

2222
## DESCRIPTION
23-
{{ Fill in the Description }}
23+
The **Start-AzRecoveryServicesAsrClusterTestFailoverCleanupJob** cmdlet starts the test failover cleanup operation on a replication protection cluster on which a test failover has been performed.
24+
You can check whether the job succeeded by using the Get-AzRecoveryServicesAsrJob cmdlet.
2425

2526
## EXAMPLES
2627

2728
### Example 1
2829
```powershell
29-
PS C:\> {{ Add example code here }}
30+
$currentJob = Start-AzRecoveryServicesAsrClusterTestFailoverCleanupJob -ReplicationProtectionCluster $protectionCluster -Comment "testing done"
31+
3032
```
3133

32-
{{ Add example description here }}
34+
Starts the test failover cleanup operation for a replication protection cluster.
3335

3436
## PARAMETERS
3537

3638
### -Comment
37-
{{ Fill Comment Description }}
39+
User Comment for Test Failover Cleanup.
3840

3941
```yaml
4042
Type: System.String
@@ -63,23 +65,8 @@ Accept pipeline input: False
6365
Accept wildcard characters: False
6466
```
6567
66-
### -ProgressAction
67-
{{ Fill ProgressAction Description }}
68-
69-
```yaml
70-
Type: System.Management.Automation.ActionPreference
71-
Parameter Sets: (All)
72-
Aliases: proga
73-
74-
Required: False
75-
Position: Named
76-
Default value: None
77-
Accept pipeline input: False
78-
Accept wildcard characters: False
79-
```
80-
8168
### -ReplicationProtectionCluster
82-
{{ Fill ReplicationProtectionCluster Description }}
69+
Specifies the replication protection cluster.
8370
8471
```yaml
8572
Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectionCluster

‎src/RecoveryServices/RecoveryServices/help/Start-AzRecoveryServicesAsrClusterTestFailoverJob.md

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Start-AzRecoveryServicesAsrClusterTestFailoverJob
1717
-ReplicationProtectionCluster <ASRReplicationProtectionCluster> -Direction <String>
1818
[-ClusterRecoveryPoint <ASRClusterRecoveryPoint>]
1919
[-NodeRecoveryPoints <System.Collections.Generic.List`1[System.String]>] [-LatestProcessedRecoveryPoints]
20-
-AzureVMNetworkId <String> [-DefaultProfile <IAzureContextContainer>] [-ProgressAction <ActionPreference>]
20+
-AzureVMNetworkId <String> [-DefaultProfile <IAzureContextContainer>]
2121
[-WhatIf] [-Confirm] [<CommonParameters>]
2222
```
2323

@@ -32,14 +32,14 @@ You can check whether the job succeeded by using the Get-AzRecoveryServicesAsrJo
3232
$currentJob = Start-AzRecoveryServicesAsrClusterTestFailoverJob -ReplicationProtectionCluster $protectionCluster -Direction PrimaryToRecovery -AzureVMNetworkId $TestRecoveryNetwork -LatestProcessedRecoveryPoint
3333
```
3434

35-
Starts a test failover job for the specified cluster and by passing LatestProcessedRecoveryPoint, it will pick the lastest processed recovery points if not passed returns the ASR job used to track the operation.
35+
Starts a test failover operation for the specified cluster. If LatestProcessedRecoveryPoint is passed and no specific recovery point is provided, it will pick the lastest processed recovery points and the ASR job used to track the operation.
3636

3737
### Example 2
3838
```powershell
3939
$currentJob = Start-AzRecoveryServicesAsrClusterTestFailoverJob -ReplicationProtectionCluster $protectionCluster -Direction PrimaryToRecovery -AzureVMNetworkId $TestRecoveryNetwork -ClusterRecoveryPoint $clusterRecoveryPoint -NodeRecoveryPoints $nodeRecoveryPoints
4040
```
4141

42-
Starts a test failover job for the specified cluster and by passing ClusterRecoveryPoint and NodeRecoveryPoints, it will pick the specified recovery points returns the ASR job used to track the operation.
42+
Starts a test failover operation for the specified cluster and by passing ClusterRecoveryPoint and NodeRecoveryPoints, it will pick the specified recovery points and returns the ASR job used to track the operation.
4343

4444
## PARAMETERS
4545

@@ -138,21 +138,6 @@ Accept pipeline input: False
138138
Accept wildcard characters: False
139139
```
140140
141-
### -ProgressAction
142-
{{ Fill ProgressAction Description }}
143-
144-
```yaml
145-
Type: System.Management.Automation.ActionPreference
146-
Parameter Sets: (All)
147-
Aliases: proga
148-
149-
Required: False
150-
Position: Named
151-
Default value: None
152-
Accept pipeline input: False
153-
Accept wildcard characters: False
154-
```
155-
156141
### -ReplicationProtectionCluster
157142
Specifies the replication protection cluster.
158143

‎src/RecoveryServices/RecoveryServices/help/Start-AzRecoveryServicesAsrClusterUnplannedFailoverJob.md

Lines changed: 22 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -17,26 +17,34 @@ Start-AzRecoveryServicesAsrClusterUnplannedFailoverJob
1717
-ReplicationProtectionCluster <ASRReplicationProtectionCluster> -Direction <String> [-PerformSourceSideAction]
1818
[-LatestProcessedRecoveryPoints] [-ClusterRecoveryPoint <ASRClusterRecoveryPoint>]
1919
[-NodeRecoveryPoints <System.Collections.Generic.List`1[System.String]>]
20-
[-DefaultProfile <IAzureContextContainer>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
20+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
2121
[<CommonParameters>]
2222
```
2323

2424
## DESCRIPTION
25-
{{ Fill in the Description }}
25+
The **Start-AzRecoveryServicesAsrClusterUnplannedFailoverJob** cmdlet starts unplanned failover of an Azure Site Recovery replication protection cluster.
26+
You can check whether the job succeeded by using the Get-AzRecoveryServicesAsrJob cmdlet.
2627

2728
## EXAMPLES
2829

2930
### Example 1
3031
```powershell
31-
PS C:\> {{ Add example code here }}
32+
$currentJob = Start-AzRecoveryServicesAsrClusterUnplannedFailoverJob -ReplicationProtectionCluster $protectionCluster -Direction PrimaryToRecovery -LatestProcessedRecoveryPoint
3233
```
3334

34-
{{ Add example description here }}
35+
Starts a unplanned failover operation for the specified cluster. If LatestProcessedRecoveryPoint is passed and no specific recovery point is provided, it will pick the lastest processed recovery points and the ASR job used to track the operation.
36+
37+
### Example 2
38+
```powershell
39+
$currentJob = Start-AzRecoveryServicesAsrClusterUnplannedFailoverJob -ReplicationProtectionCluster $protectionCluster -Direction PrimaryToRecovery -ClusterRecoveryPoint $clusterRecoveryPoint -NodeRecoveryPoints $nodeRecoveryPoints
40+
```
41+
42+
Starts a unplanned failover operation for the specified cluster and by passing ClusterRecoveryPoint and NodeRecoveryPoints, it will pick the specified recovery points and returns the ASR job used to track the operation.
3543

3644
## PARAMETERS
3745

3846
### -ClusterRecoveryPoint
39-
{{ Fill ClusterRecoveryPoint Description }}
47+
Specifies the recovery point for the cluster.
4048

4149
```yaml
4250
Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRClusterRecoveryPoint
@@ -66,7 +74,11 @@ Accept wildcard characters: False
6674
```
6775
6876
### -Direction
69-
{{ Fill Direction Description }}
77+
Specifies the failover direction.
78+
The acceptable values for this parameter are:
79+
80+
- PrimaryToRecovery
81+
- RecoveryToPrimary
7082
7183
```yaml
7284
Type: System.String
@@ -82,7 +94,7 @@ Accept wildcard characters: False
8294
```
8395
8496
### -LatestProcessedRecoveryPoints
85-
{{ Fill LatestProcessedRecoveryPoints Description }}
97+
Fetch the latest processed recovery points if not passed for cluster or any individual node.
8698
8799
```yaml
88100
Type: System.Management.Automation.SwitchParameter
@@ -97,7 +109,7 @@ Accept wildcard characters: False
97109
```
98110
99111
### -NodeRecoveryPoints
100-
{{ Fill NodeRecoveryPoints Description }}
112+
Specifies the recovery points for the nodes which are not part of cluster recovery point.
101113
102114
```yaml
103115
Type: System.Collections.Generic.List`1[System.String]
@@ -112,7 +124,7 @@ Accept wildcard characters: False
112124
```
113125
114126
### -PerformSourceSideAction
115-
{{ Fill PerformSourceSideAction Description }}
127+
Perform operation in source side before starting unplanned failover.
116128
117129
```yaml
118130
Type: System.Management.Automation.SwitchParameter
@@ -126,23 +138,8 @@ Accept pipeline input: False
126138
Accept wildcard characters: False
127139
```
128140
129-
### -ProgressAction
130-
{{ Fill ProgressAction Description }}
131-
132-
```yaml
133-
Type: System.Management.Automation.ActionPreference
134-
Parameter Sets: (All)
135-
Aliases: proga
136-
137-
Required: False
138-
Position: Named
139-
Default value: None
140-
Accept pipeline input: False
141-
Accept wildcard characters: False
142-
```
143-
144141
### -ReplicationProtectionCluster
145-
{{ Fill ReplicationProtectionCluster Description }}
142+
Specifies the replication protection cluster.
146143
147144
```yaml
148145
Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectionCluster

0 commit comments

Comments
 (0)