Skip to content

Commit c1bd480

Browse files
dantedallagdantedallag
committed
adding marksdown files for stack commands
1 parent 24f41bb commit c1bd480

21 files changed

+4471
-17
lines changed

‎src/Resources/ResourceManager/Implementation/DeploymentStacks/GetAzManagementGroupDeploymentStack.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ public class GetAzManagementGroupDeploymentStack : DeploymentStacksCmdletBase
2828
#region Cmdlet Parameters and Parameter Set Definitions
2929

3030
internal const string GetByResourceIdParameterSetName = "GetByResourceId";
31-
internal const string GetByManagementGroupIdAndStackNameParameterSetName = "GetByManagementGroupIdAndStackName";
31+
internal const string GetByManagementGroupIdAndNameParameterSetName = "GetByManagementGroupIdAndName";
3232
internal const string ListByManagementGroupIdParameterSetName = "ListByManagmentGroupId";
3333

3434
[Alias("StackName")]
35-
[Parameter(Position = 1, Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = GetByManagementGroupIdAndStackNameParameterSetName,
35+
[Parameter(Position = 1, Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = GetByManagementGroupIdAndNameParameterSetName,
3636
HelpMessage = "The name of the DeploymentStack to get")]
3737
[ValidateNotNullOrEmpty]
3838
public string Name { get; set; }
@@ -45,7 +45,7 @@ public class GetAzManagementGroupDeploymentStack : DeploymentStacksCmdletBase
4545

4646
[Parameter(Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = ListByManagementGroupIdParameterSetName,
4747
HelpMessage = "The id of the ManagementGroup where the DeploymentStack is deployed")]
48-
[Parameter(Position = 0, Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = GetByManagementGroupIdAndStackNameParameterSetName,
48+
[Parameter(Position = 0, Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = GetByManagementGroupIdAndNameParameterSetName,
4949
HelpMessage = "The id of the ManagementGroup where the DeploymentStack is deployed")]
5050
[ValidateNotNullOrEmpty]
5151
public string ManagementGroupId { get; set; }
@@ -71,7 +71,7 @@ protected override void OnProcessRecord()
7171
}
7272
WriteObject(DeploymentStacksSdkClient.GetManagementGroupDeploymentStack(ManagementGroupId, Name), true);
7373
break;
74-
case GetByManagementGroupIdAndStackNameParameterSetName:
74+
case GetByManagementGroupIdAndNameParameterSetName:
7575
WriteObject(DeploymentStacksSdkClient.GetManagementGroupDeploymentStack(ManagementGroupId, Name, true));
7676
break;
7777
case ListByManagementGroupIdParameterSetName:

‎src/Resources/ResourceManager/Implementation/DeploymentStacks/GetAzResourceGroupDeploymentStack.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ public class GetAzResourceGroupDeploymentStack : DeploymentStacksCmdletBase
2929

3030
#region Cmdlet Parameters and Parameter Set Definitions
3131

32-
internal const string GetByResourceIdParameterSetName = "GetDeploymentStackByResourceId";
33-
internal const string ListByResourceGroupNameParameterSetName = "ListDeploymentStacksByResourceGroupName";
34-
internal const string GetByDeploymentStackNameParameterSetName = "GetDeploymentStackByStackName";
32+
internal const string GetByResourceIdParameterSetName = "GetByResourceId";
33+
internal const string ListByResourceGroupNameParameterSetName = "ListByResourceGroupName";
34+
internal const string GetByDeploymentStackNameParameterSetName = "GetByName";
3535

3636
[Alias("Id")]
3737
[Parameter(Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = GetByResourceIdParameterSetName,

‎src/Resources/ResourceManager/Implementation/DeploymentStacks/GetAzSubscriptionDeploymentStack.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@ public class GetAzSubscriptionDeploymentStack : DeploymentStacksCmdletBase
2727
{
2828
#region Cmdlet Parameters and Parameter Set Definitions
2929

30-
internal const string GetByStackNameParameterSetname = "GetIndividualDeploymentStack";
31-
internal const string GetByResourceIdParameterSetName = "GetDeploymentStackByResourceId";
30+
internal const string GetByNameParameterSetname = "GetByName";
31+
internal const string GetByResourceIdParameterSetName = "GetByResourceId";
3232
internal const string ListParameterSetname = "ListDeploymentStacks";
3333

3434
[Alias("StackName")]
35-
[Parameter(Position = 0, Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = GetByStackNameParameterSetname,
35+
[Parameter(Position = 0, Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = GetByNameParameterSetname,
3636
HelpMessage = "The name of the DeploymentStack to get")]
3737
[ValidateNotNullOrEmpty]
3838
public string Name { get; set; }
@@ -54,7 +54,7 @@ protected override void OnProcessRecord()
5454
this.GetResourcesClient();
5555
switch (ParameterSetName)
5656
{
57-
case GetByStackNameParameterSetname:
57+
case GetByNameParameterSetname:
5858
WriteObject(DeploymentStacksSdkClient.GetSubscriptionDeploymentStack(Name), true);
5959
break;
6060
case GetByResourceIdParameterSetName:

‎src/Resources/ResourceManager/Implementation/DeploymentStacks/RemoveAzManagmentGroupDeploymentStack.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,16 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
2222
using System.Text;
2323

2424
[Cmdlet("Remove", Common.AzureRMConstants.AzureRMPrefix + "ManagementGroupDeploymentStack",
25-
SupportsShouldProcess = true, DefaultParameterSetName = RemoveByResourceNameParameterSetName), OutputType(typeof(bool))]
25+
SupportsShouldProcess = true, DefaultParameterSetName = RemoveByNameParameterSetName), OutputType(typeof(bool))]
2626
public class RemoveAzManagementGroupDeploymentStack : DeploymentStacksCmdletBase
2727
{
2828
#region Cmdlet Parameters and Parameter Set Definitions
2929

3030
internal const string RemoveByResourceIdParameterSetName = "RemoveByResourceId";
31-
internal const string RemoveByResourceNameParameterSetName = "RemoveByResourceName";
31+
internal const string RemoveByNameParameterSetName = "RemoveByName";
3232

3333
[Alias("StackName")]
34-
[Parameter(Position = 1, Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = RemoveByResourceNameParameterSetName,
34+
[Parameter(Position = 1, Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = RemoveByNameParameterSetName,
3535
HelpMessage = "The name of the DeploymentStack to delete")]
3636
[ValidateNotNullOrEmpty]
3737
public string Name { get; set; }

‎src/Resources/ResourceManager/Implementation/DeploymentStacks/RemoveAzSubscriptionDeploymentStack.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,16 @@ namespace Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation
2323
using System.Text;
2424

2525
[Cmdlet("Remove", Common.AzureRMConstants.AzureRMPrefix + "SubscriptionDeploymentStack",
26-
SupportsShouldProcess = true, DefaultParameterSetName = RemoveByResourceNameParameterSetName), OutputType(typeof(bool))]
26+
SupportsShouldProcess = true, DefaultParameterSetName = RemoveByNameParameterSetName), OutputType(typeof(bool))]
2727
public class RemoveAzSubscriptionDeploymentStack : DeploymentStacksCmdletBase
2828
{
2929
#region Cmdlet Parameters and Parameter Set Definitions
3030

3131
internal const string RemoveByResourceIdParameterSetName = "RemoveByResourceId";
32-
internal const string RemoveByResourceNameParameterSetName = "RemoveByResourceName";
32+
internal const string RemoveByNameParameterSetName = "RemoveByName";
3333

3434
[Alias("StackName")]
35-
[Parameter(Position = 0, Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = RemoveByResourceNameParameterSetName,
35+
[Parameter(Position = 0, Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = RemoveByNameParameterSetName,
3636
HelpMessage = "The name of the deploymentStack to delete")]
3737
[ValidateNotNullOrEmpty]
3838
public string Name { get; set; }

‎src/Resources/Resources/help/Export-AzManagementGroupDeploymentStackTemplate.md

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
---
2+
external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml
3+
Module Name: Az.Resources
4+
online version: https://docs.microsoft.com/powershell/module/az.resources/update-azrolemanagementpolicy
5+
schema: 2.0.0
6+
---
7+
8+
# Export-AzManagementGroupDeploymentStackTemplate
9+
10+
## SYNOPSIS
11+
Exports a Management Group scoped Deployment Stack Template.
12+
13+
## SYNTAX
14+
15+
### ExportByNameAndManagmentGroupId (Default)
16+
```
17+
Export-AzManagementGroupDeploymentStackTemplate [-Name] <String> [-ManagementGroupId] <String> [-Pre]
18+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
19+
```
20+
21+
### ExportByResourceId
22+
```
23+
Export-AzManagementGroupDeploymentStackTemplate -ResourceId <String> [-Pre]
24+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
25+
```
26+
27+
## DESCRIPTION
28+
{{ Fill in the Description }}
29+
30+
## EXAMPLES
31+
32+
### Example 1
33+
```powershell
34+
PS C:\> {{ Add example code here }}
35+
```
36+
37+
{{ Add example description here }}
38+
39+
## PARAMETERS
40+
41+
### -DefaultProfile
42+
The credentials, account, tenant, and subscription used for communication with Azure.
43+
44+
```yaml
45+
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
46+
Parameter Sets: (All)
47+
Aliases: AzContext, AzureRmContext, AzureCredential
48+
49+
Required: False
50+
Position: Named
51+
Default value: None
52+
Accept pipeline input: False
53+
Accept wildcard characters: False
54+
```
55+
56+
### -ManagementGroupId
57+
The id of the ManagementGroup where the DeploymentStack is deployed
58+
59+
```yaml
60+
Type: System.String
61+
Parameter Sets: ExportByNameAndManagmentGroupId
62+
Aliases:
63+
64+
Required: True
65+
Position: 0
66+
Default value: None
67+
Accept pipeline input: True (ByPropertyName)
68+
Accept wildcard characters: False
69+
```
70+
71+
### -Name
72+
The name of the DeploymentStack to get
73+
74+
```yaml
75+
Type: System.String
76+
Parameter Sets: ExportByNameAndManagmentGroupId
77+
Aliases: StackName
78+
79+
Required: True
80+
Position: 1
81+
Default value: None
82+
Accept pipeline input: True (ByPropertyName)
83+
Accept wildcard characters: False
84+
```
85+
86+
### -Pre
87+
When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use.
88+
89+
```yaml
90+
Type: System.Management.Automation.SwitchParameter
91+
Parameter Sets: (All)
92+
Aliases:
93+
94+
Required: False
95+
Position: Named
96+
Default value: None
97+
Accept pipeline input: False
98+
Accept wildcard characters: False
99+
```
100+
101+
### -ResourceId
102+
ResourceId of the DeploymentStack to get
103+
104+
```yaml
105+
Type: System.String
106+
Parameter Sets: ExportByResourceId
107+
Aliases: Id
108+
109+
Required: True
110+
Position: Named
111+
Default value: None
112+
Accept pipeline input: True (ByPropertyName)
113+
Accept wildcard characters: False
114+
```
115+
116+
### CommonParameters
117+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
118+
119+
## INPUTS
120+
121+
### System.String
122+
123+
## OUTPUTS
124+
125+
### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeploymentStackTemplateDefinition
126+
127+
## NOTES
128+
129+
## RELATED LINKS

‎src/Resources/Resources/help/Export-AzResourceGroupDeploymentStackTemplate.md

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
---
2+
external help file: Microsoft.Azure.PowerShell.Cmdlets.ResourceManager.dll-Help.xml
3+
Module Name: Az.Resources
4+
online version: https://docs.microsoft.com/powershell/module/az.resources/update-azrolemanagementpolicy
5+
schema: 2.0.0
6+
---
7+
8+
# Export-AzResourceGroupDeploymentStackTemplate
9+
10+
## SYNOPSIS
11+
Exports a Resource Group scoped Deployment Stack Template.
12+
13+
## SYNTAX
14+
15+
### ExportByNameAndResourceGroupName (Default)
16+
```
17+
Export-AzResourceGroupDeploymentStackTemplate [-ResourceGroupName] <String> [-Name] <String> [-Pre]
18+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
19+
```
20+
21+
### ExportByResourceId
22+
```
23+
Export-AzResourceGroupDeploymentStackTemplate -ResourceId <String> [-Pre]
24+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
25+
```
26+
27+
## DESCRIPTION
28+
{{ Fill in the Description }}
29+
30+
## EXAMPLES
31+
32+
### Example 1
33+
```powershell
34+
PS C:\> {{ Add example code here }}
35+
```
36+
37+
{{ Add example description here }}
38+
39+
## PARAMETERS
40+
41+
### -DefaultProfile
42+
The credentials, account, tenant, and subscription used for communication with Azure.
43+
44+
```yaml
45+
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
46+
Parameter Sets: (All)
47+
Aliases: AzContext, AzureRmContext, AzureCredential
48+
49+
Required: False
50+
Position: Named
51+
Default value: None
52+
Accept pipeline input: False
53+
Accept wildcard characters: False
54+
```
55+
56+
### -Name
57+
The name of the DeploymentStack to get
58+
59+
```yaml
60+
Type: System.String
61+
Parameter Sets: ExportByNameAndResourceGroupName
62+
Aliases: StackName
63+
64+
Required: True
65+
Position: 1
66+
Default value: None
67+
Accept pipeline input: True (ByPropertyName)
68+
Accept wildcard characters: False
69+
```
70+
71+
### -Pre
72+
When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use.
73+
74+
```yaml
75+
Type: System.Management.Automation.SwitchParameter
76+
Parameter Sets: (All)
77+
Aliases:
78+
79+
Required: False
80+
Position: Named
81+
Default value: None
82+
Accept pipeline input: False
83+
Accept wildcard characters: False
84+
```
85+
86+
### -ResourceGroupName
87+
The name of the ResourceGroup where the DeploymentStack is deployed
88+
89+
```yaml
90+
Type: System.String
91+
Parameter Sets: ExportByNameAndResourceGroupName
92+
Aliases:
93+
94+
Required: True
95+
Position: 0
96+
Default value: None
97+
Accept pipeline input: True (ByPropertyName)
98+
Accept wildcard characters: False
99+
```
100+
101+
### -ResourceId
102+
ResourceId of the DeploymentStack to get
103+
104+
```yaml
105+
Type: System.String
106+
Parameter Sets: ExportByResourceId
107+
Aliases: Id
108+
109+
Required: True
110+
Position: Named
111+
Default value: None
112+
Accept pipeline input: True (ByPropertyName)
113+
Accept wildcard characters: False
114+
```
115+
116+
### CommonParameters
117+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
118+
119+
## INPUTS
120+
121+
### System.String
122+
123+
## OUTPUTS
124+
125+
### Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSDeploymentStackTemplateDefinition
126+
127+
## NOTES
128+
129+
## RELATED LINKS

0 commit comments

Comments
 (0)