Skip to content

Commit 046f51d

Browse files
Adding detailed description of cmdlets and parameters in help file.
1 parent d9d19c3 commit 046f51d

File tree

48 files changed

+288
-313
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+288
-313
lines changed

src/ResourceManager/RecoveryServices.SiteRecovery/Commands.RecoveryServices.SiteRecovery/Fabrics/NewAzureRmRecoveryServicesAsrFabric.cs

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -48,15 +48,6 @@ public class NewAzureRmRecoveryServicesAsrFabric : SiteRecoveryCmdletBase
4848
[ValidateSet(Constants.HyperVSite)]
4949
public string Type { get; set; }
5050

51-
/// <summary>
52-
/// Gets or Sets the location
53-
/// </summary>
54-
[Parameter(
55-
ParameterSetName = ASRParameterSets.Default,
56-
Mandatory = false)]
57-
[ValidateNotNullOrEmpty]
58-
public string Location { get; set; }
59-
6051
/// <summary>
6152
/// ProcessRecord of the command.
6253
/// </summary>
@@ -70,15 +61,7 @@ public override void ExecuteSiteRecoveryCmdlet()
7061
var input = new FabricCreationInput();
7162
input.Properties = new FabricCreationInputProperties();
7263

73-
if (string.IsNullOrEmpty(this.Location))
74-
{
75-
input.Properties.CustomDetails = new FabricSpecificCreationInput();
76-
}
77-
else
78-
{
79-
input.Properties.CustomDetails =
80-
new AzureFabricCreationInput { Location = this.Location };
81-
}
64+
input.Properties.CustomDetails = new FabricSpecificCreationInput();
8265

8366
var response = this.RecoveryServicesClient.CreateAzureSiteRecoveryFabric(
8467
this.Name,

src/ResourceManager/RecoveryServices.SiteRecovery/Commands.RecoveryServices.SiteRecovery/help/Edit-AzureRmRecoveryServicesAsrRecoveryPlan.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Appends a group to existing Azure Site Recovery recovery plan and returns the in
4949
## PARAMETERS
5050

5151
### -AddProtectedItems
52-
Protected items to be added or removed.
52+
List of ASR replication protected items to be added to the recovery plan group in the recovery plan object.
5353

5454
```yaml
5555
Type: ASRReplicationProtectedItem[]
@@ -64,7 +64,7 @@ Accept wildcard characters: False
6464
```
6565
6666
### -AppendGroup
67-
Indicates that this operation appends the group to the recovery plan object.
67+
Switch parameter to append a recovery plan group to the recovery plan object.
6868
6969
```yaml
7070
Type: SwitchParameter
@@ -79,7 +79,7 @@ Accept wildcard characters: False
7979
```
8080
8181
### -Group
82-
Specifies a Site Recovery plan group.
82+
Specifies a recovery plan group.
8383
8484
```yaml
8585
Type: ASRRecoveryPlanGroup
@@ -94,7 +94,7 @@ Accept wildcard characters: False
9494
```
9595
9696
### -InputObject
97-
{{Fill InputObject Description}}
97+
The ASR recovery plan object to be edited (In memory operation. To update the recovery plan run Update-AzureRmASRRecoveryPlan with the edited recovery plan object.)
9898
9999
```yaml
100100
Type: ASRRecoveryPlan
@@ -109,7 +109,7 @@ Accept wildcard characters: False
109109
```
110110
111111
### -RemoveGroup
112-
Removes the specified Site Recovery recovery plan group.
112+
Removes the specified group from the recovery plan object.
113113
114114
```yaml
115115
Type: ASRRecoveryPlanGroup
@@ -124,7 +124,7 @@ Accept wildcard characters: False
124124
```
125125
126126
### -RemoveProtectedItems
127-
{{Fill RemoveProtectedItems Description}}
127+
List of ASR replication protected items to be removed from the recovery plan group in the recovery plan object.
128128
129129
```yaml
130130
Type: ASRReplicationProtectedItem[]

src/ResourceManager/RecoveryServices.SiteRecovery/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrFabric.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ schema: 2.0.0
77
# Get-AzureRmRecoveryServicesAsrFabric
88

99
## SYNOPSIS
10-
Get the properties of an Azure Site Recovery Fabric.
10+
Get the details of an Azure Site Recovery Fabric.
1111

1212
## SYNTAX
1313

@@ -36,12 +36,12 @@ The **Get-AzureRmRecoveryServicesAsrFabric** cmdlet gets the properties of a spe
3636
PS C:\> $fabrics = Get-AzureRmRecoveryServicesAsrFabric
3737
```
3838

39-
Returns all the Azure Site Recovery fabrics.
39+
Returns all the Azure Site Recovery fabrics in the vault.
4040

4141
## PARAMETERS
4242

4343
### -FriendlyName
44-
Specifies the friendly name of the Azure Site Recovery Fabric.
44+
Search for the ASR fabric by the friendly name of the fabric.
4545

4646
```yaml
4747
Type: String
@@ -56,7 +56,7 @@ Accept wildcard characters: False
5656
```
5757
5858
### -Name
59-
Specifies the name of the Azure Site Recovery Fabric.
59+
Search for the ASR fabric by the name of the fabric.
6060
6161
```yaml
6262
Type: String

src/ResourceManager/RecoveryServices.SiteRecovery/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrJob.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ schema: 2.0.0
77
# Get-AzureRmRecoveryServicesAsrJob
88

99
## SYNOPSIS
10-
Gets the operation information for the current Site Recovery vault.
10+
Gets the details of the specified ASR job or the list of recent ASR jobs in the Recovery Services vault.
1111

1212
## SYNTAX
1313

@@ -29,7 +29,7 @@ Get-AzureRmRecoveryServicesAsrJob -Job <ASRJob> [<CommonParameters>]
2929

3030
## DESCRIPTION
3131
The **Get-AzureRmRecoveryServicesAsrJob** cmdlet gets Azure Site Recovery jobs.
32-
You can use this cmdlet to view the operation information for the current Site Recovery vault.
32+
You can use this cmdlet to view the ASR jobs in the Recovery Services vault.
3333

3434
## EXAMPLES
3535

@@ -38,7 +38,7 @@ You can use this cmdlet to view the operation information for the current Site R
3838
PS C:\> $jobs = Get-AzureRmRecoveryServicesAsrJob -TargetObjectId $ASRObjectId
3939
```
4040

41-
Returns all the jobs specific to a particular target ASR object Id.
41+
Returns all the jobs on a particular ASR object(reference the ASR object such as replicated item or recovery plan by its ID.)
4242

4343
## PARAMETERS
4444

@@ -61,7 +61,7 @@ Accept wildcard characters: False
6161
```
6262
6363
### -Job
64-
Specifies the Site Recovery job.
64+
Specifies the ASR job object to get updated details for.
6565
6666
```yaml
6767
Type: ASRJob
@@ -76,7 +76,7 @@ Accept wildcard characters: False
7676
```
7777
7878
### -Name
79-
Specifies a unique name that identifies the job.
79+
Specify the ASR job by name.
8080
8181
```yaml
8282
Type: String
@@ -107,7 +107,7 @@ Accept wildcard characters: False
107107
```
108108
109109
### -State
110-
Specifies the input state for a Site Recovery job.
110+
Specifies the state for a ASR job.
111111
This cmdlet gets all jobs that match the specified state.
112112
The acceptable values for this parameter are:
113113
@@ -133,7 +133,7 @@ Accept wildcard characters: False
133133
```
134134
135135
### -TargetObjectId
136-
Specifies the ID of the object targeted by the job.
136+
Specifies the ID of the object. Used to search for jobs on the specified object.
137137
138138
```yaml
139139
Type: String

src/ResourceManager/RecoveryServices.SiteRecovery/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrNetwork.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,12 @@ The **Get-AzureRmRecoveryServicesAsrNetwork** cmdlet gets information about Azur
3636
PS C:\> $Networks = Get-AzureRmRecoveryServicesAsrNetwork -Fabric $Fabric
3737
```
3838

39-
Gets all networks in passed fabric.
39+
Gets all known networks in the specified fabric.
4040

4141
## PARAMETERS
4242

4343
### -Fabric
44-
Fabric object
44+
ASR fabric object
4545

4646
```yaml
4747
Type: ASRFabric
@@ -56,7 +56,7 @@ Accept wildcard characters: False
5656
```
5757
5858
### -FriendlyName
59-
Friendly name of network.
59+
Friendly name of network ASR object.
6060
6161
```yaml
6262
Type: String
@@ -71,7 +71,7 @@ Accept wildcard characters: False
7171
```
7272
7373
### -Name
74-
Name of object.
74+
Name of network ASR object.
7575
7676
```yaml
7777
Type: String

src/ResourceManager/RecoveryServices.SiteRecovery/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrNetworkMapping.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Get-AzureRmRecoveryServicesAsrNetworkMapping -Name <String> -Network <ASRNetwork
2222
```
2323

2424
## DESCRIPTION
25-
The **Get-AzureRmRecoveryServicesAsrNetworkMapping** cmdlet gets information about Azure Site Recovery network mappings for the current Site Recovery vault.
25+
The **Get-AzureRmRecoveryServicesAsrNetworkMapping** cmdlet gets information about Azure Site Recovery network mappings for the Recovery Services vault.
2626

2727
## EXAMPLES
2828

@@ -36,7 +36,7 @@ Gets all networks mappings for the passed Network.
3636
## PARAMETERS
3737

3838
### -Name
39-
{{Fill Name Description}}
39+
The name of the ASR network mapping object to get.
4040

4141
```yaml
4242
Type: String
@@ -51,7 +51,7 @@ Accept wildcard characters: False
5151
```
5252
5353
### -Network
54-
{{Fill Network Description}}
54+
Get the ASR network mappings corresponding to the specified network ASR object.
5555
5656
```yaml
5757
Type: ASRNetwork
@@ -82,4 +82,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
8282

8383
[New-AzureRmRecoveryServicesAsrNetworkMapping](./New-AzureRmRecoveryServicesAsrNetworkMapping.md)
8484

85-
[Remove-AzureRmRecoveryServicesAsrNetworkMapping](./Remove-AzureRmRecoveryServicesAsrNetworkMapping.md)
85+
[Remove-AzureRmRecoveryServicesAsrNetworkMapping](./Remove-AzureRmRecoveryServicesAsrNetworkMapping.md)

src/ResourceManager/RecoveryServices.SiteRecovery/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrPolicy.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ schema: 2.0.0
77
# Get-AzureRmRecoveryServicesAsrPolicy
88

99
## SYNOPSIS
10-
Gets Site Recovery protection policies.
10+
Gets ASR replication policies.
1111

1212
## SYNTAX
1313

@@ -27,7 +27,7 @@ Get-AzureRmRecoveryServicesAsrPolicy -FriendlyName <String> [<CommonParameters>]
2727
```
2828

2929
## DESCRIPTION
30-
The **Get-AzureRmRecoveryServicesAsrPolicy** cmdlet gets the list of configured Azure Site Recovery protection policies or a specific protection policy by name.
30+
The **Get-AzureRmRecoveryServicesAsrPolicy** cmdlet gets the list of configured Azure Site Recovery replication policies or a specific replication policy by name.
3131

3232
## EXAMPLES
3333

@@ -36,12 +36,12 @@ The **Get-AzureRmRecoveryServicesAsrPolicy** cmdlet gets the list of configured
3636
PS C:\> $Policy = Get-AzureRmRecoveryServicesAsrPolicy -Name $PolicyName
3737
```
3838

39-
Retruns a policy with the passed name.
39+
Retruns the replication policy with the specified name.
4040

4141
## PARAMETERS
4242

4343
### -FriendlyName
44-
Specifies the friendly name of the Site Recovery replication policy.
44+
Specifies the friendly name of the ASR replication policy.
4545

4646
```yaml
4747
Type: String
@@ -56,7 +56,7 @@ Accept wildcard characters: False
5656
```
5757
5858
### -Name
59-
Specifies the name of the Site Recovery replication policy.
59+
Specifies the name of the ASR replication policy.
6060
6161
```yaml
6262
Type: String

src/ResourceManager/RecoveryServices.SiteRecovery/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrProtectableItem.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ schema: 2.0.0
77
# Get-AzureRmRecoveryServicesAsrProtectableItem
88

99
## SYNOPSIS
10-
Get the protectable items in a Protection Container.
10+
Get the protectable items in an ASR protection container.
1111

1212
## SYNTAX
1313

@@ -39,12 +39,12 @@ The **Get-AzureRmRecoveryServicesAsrProtectableItem** cmdlet gets the protectabl
3939
PS C:\> $ProtectableItems = Get-AzureRmRecoveryServicesAsrProtectableItem -ProtectionContainer $Container
4040
```
4141

42-
Gets all the protectable items in passed container.
42+
Gets all the protectable items in specified ASR protection container.
4343

4444
## PARAMETERS
4545

4646
### -FriendlyName
47-
Specifies the friendly name of the Azure Site Recovery protectable item.
47+
Specifies the friendly name of the ASR protectable item.
4848

4949
```yaml
5050
Type: String
@@ -59,7 +59,7 @@ Accept wildcard characters: False
5959
```
6060
6161
### -Name
62-
Specifies the name of the Azure Site Recovery protectable item.
62+
Specifies the name of the ASR protectable item.
6363
6464
```yaml
6565
Type: String

src/ResourceManager/RecoveryServices.SiteRecovery/Commands.RecoveryServices.SiteRecovery/help/Get-AzureRmRecoveryServicesAsrProtectionContainer.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ schema: 2.0.0
77
# Get-AzureRmRecoveryServicesAsrProtectionContainer
88

99
## SYNOPSIS
10-
Gets protection containers for the current Site Recovery vault.
10+
Gets ASR protection containers in the Recovery Services vault.
1111

1212
## SYNTAX
1313

@@ -28,9 +28,9 @@ Get-AzureRmRecoveryServicesAsrProtectionContainer -FriendlyName <String> -Fabric
2828
```
2929

3030
## DESCRIPTION
31-
The **Get-AzureRmRecoveryServicesAsrProtectionContainer** cmdlet gets protection containers for the current Azure Site Recovery vault.
32-
A protection container is a logical container for protected objects such as virtual machines.
33-
Protection policies define replication settings for protected items and can be associated with a protection container and applied to a protected entity.
31+
The **Get-AzureRmRecoveryServicesAsrProtectionContainer** cmdlet gets Azure Site Recovery protection containers in the Recovery Services vault.
32+
A protection container is a logical container for protectable(discovered) and protected objects such as virtual machines.
33+
Replication policies define replication settings for protected items and can be associated with a protection container and applied to a protectable item.
3434

3535
## EXAMPLES
3636

@@ -39,12 +39,12 @@ Protection policies define replication settings for protected items and can be a
3939
PS C:\> $ProtectionContainers = Get-AzureRmRecoveryServicesAsrFabric | Get-AzureRmRecoveryServicesAsrProtectionContainer
4040
```
4141

42-
Gets all containers in all piped fabrics.
42+
Gets all the ASR protection containers in the specified ASR fabric (the pipeline input in the above example.)
4343

4444
## PARAMETERS
4545

4646
### -Fabric
47-
{{Fill Fabric Description}}
47+
Look for the protection container in the specified ASR fabric.
4848

4949
```yaml
5050
Type: ASRFabric
@@ -59,7 +59,7 @@ Accept wildcard characters: False
5959
```
6060
6161
### -FriendlyName
62-
Specifies the friendly name of the protection container.
62+
Specifies the friendly name of the ASR protection container to look for.
6363
6464
```yaml
6565
Type: String
@@ -74,7 +74,7 @@ Accept wildcard characters: False
7474
```
7575
7676
### -Name
77-
Specifies the name of the protection container.
77+
Specifies the name of the ASR protection container to look for.
7878
7979
```yaml
8080
Type: String

0 commit comments

Comments
 (0)