Skip to content

Commit f098865

Browse files
committed
Update paramter sets for gateway operations and help doc
1 parent db15652 commit f098865

11 files changed

+190
-137
lines changed

src/ResourceManager/AnalysisServices/Commands.AnalysisServices/Commands/SetAzureRmAnalysisServicesServer.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ public class SetAzureAnalysisServicesServer : AnalysisServicesCmdletBase
3131
{
3232
private const string ParamSetDefault = "Default";
3333
private const string ParamSetDisableBackup = "DisableBackup";
34+
private const string ParamSetDisassociatGateway = "DisassociateGateway";
3435

3536
[Parameter(ValueFromPipelineByPropertyName = true, Position = 0, Mandatory = true,
3637
HelpMessage = "Name of the server.")]
@@ -89,10 +90,12 @@ public int ReadonlyReplicaCount
8990
public PsAzureAnalysisServicesFirewallConfig FirewallConfig { get; set; }
9091

9192
[Parameter(ValueFromPipelineByPropertyName = true, Mandatory = false,
93+
ParameterSetName = ParamSetDefault,
9294
HelpMessage = "Gateway resource ID")]
9395
public string GatewayResourceId { get; set; }
9496

9597
[Parameter(ValueFromPipelineByPropertyName = true, Mandatory = false,
98+
ParameterSetName = ParamSetDisassociatGateway,
9699
HelpMessage = "Disassociate current gateway")]
97100
public SwitchParameter DisassociateGateway { get; set; }
98101

src/ResourceManager/AnalysisServices/Commands.AnalysisServices/help/AzureRM.AnalysisServices.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
Module Name: AzureRM.AnalysisServices
33
Module Guid: acace26c-1775-4100-85c0-20c4d71eaa21
44
Download Help Link: None_Azure
@@ -14,6 +14,12 @@ This topic displays help topics for the Azure AnalysisServices cmdlets.
1414
### [Get-AzureRmAnalysisServicesServer](Get-AzureRmAnalysisServicesServer.md)
1515
Gets the details of an Analysis Services server.
1616

17+
### [New-AzureRmAnalysisServicesFirewallConfig](New-AzureRmAnalysisServicesFirewallConfig.md)
18+
Creates a new Analysis Services firewall config
19+
20+
### [New-AzureRmAnalysisServicesFirewallRule](New-AzureRmAnalysisServicesFirewallRule.md)
21+
Creates a new Analysis Services firewall rule
22+
1723
### [New-AzureRmAnalysisServicesServer](New-AzureRmAnalysisServicesServer.md)
1824
Creates a new Analysis Services server
1925

@@ -32,9 +38,3 @@ Suspends an instance of Analysis Services server
3238
### [Test-AzureRmAnalysisServicesServer](Test-AzureRmAnalysisServicesServer.md)
3339
Tests the existence of an instance of Analysis Services server
3440

35-
### [New-AzureRmAnalysisServicesFirewallConfig](New-AzureRmAnalysisServicesFirewallConfig.md)
36-
Creates a new firewall config for Analysis Services server
37-
38-
### [New-AzureRmAnalysisServicesFirewallRule](New-AzureRmAnalysisServicesFirewallRule.md)
39-
Creates a new firewall rule for Analysis Services server
40-

src/ResourceManager/AnalysisServices/Commands.AnalysisServices/help/Get-AzureRmAnalysisServicesServer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
external help file: Microsoft.Azure.Commands.AnalysisServices.dll-Help.xml
33
Module Name: AzureRM.AnalysisServices
44
online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.analysisservices/get-azurermanalysisservicesserver

src/ResourceManager/AnalysisServices/Commands.AnalysisServices/help/New-AzureRmAnalysisServicesFirewallConfig.md

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
external help file: Microsoft.Azure.Commands.AnalysisServices.dll-Help.xml
33
Module Name: AzureRM.AnalysisServices
44
online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.analysisservices/new-azurermanalysisservicesfirewallconfig
@@ -13,7 +13,9 @@ Creates a new Analysis Services firewall config
1313
## SYNTAX
1414

1515
```
16-
New-AzureRmAnalysisServicesFirewallConfig [-EnablePowerBIService] [-FirewallRule] List<Microsoft.Azure.Commands.AnalysisServices.Models.AzureAnalysisServicesFirewallRule>
16+
New-AzureRmAnalysisServicesFirewallConfig [-EnablePowerBIService]
17+
[-FirewallRule <System.Collections.Generic.List`1[Microsoft.Azure.Commands.AnalysisServices.Models.PsAzureAnalysisServicesFirewallRule]>]
18+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1719
```
1820

1921
## DESCRIPTION
@@ -32,6 +34,19 @@ Creates a firewall config object with two rules while also enabling access from
3234

3335
## PARAMETERS
3436

37+
### -DefaultProfile
38+
The credentials, account, tenant, and subscription used for communication with Azure.```yaml
39+
Type: IAzureContextContainer
40+
Parameter Sets: (All)
41+
Aliases: AzureRmContext, AzureCredential
42+
43+
Required: False
44+
Position: Named
45+
Default value: None
46+
Accept pipeline input: False
47+
Accept wildcard characters: False
48+
```
49+
3550
### -EnablePowerBIService
3651
A flag to indicate if the firewall is allowing access from Power BI
3752
@@ -41,7 +56,7 @@ Parameter Sets: (All)
4156
Aliases:
4257
4358
Required: False
44-
Position: 0
59+
Position: Named
4560
Default value: None
4661
Accept pipeline input: False
4762
Accept wildcard characters: False
@@ -51,23 +66,28 @@ Accept wildcard characters: False
5166
A list of firewall rules
5267

5368
```yaml
54-
Type: List<Microsoft.Azure.Commands.AnalysisServices.Models.AzureAnalysisServicesFirewallRule>
69+
Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.AnalysisServices.Models.PsAzureAnalysisServicesFirewallRule]
5570
Parameter Sets: (All)
5671
Aliases:
5772

58-
Required: True
59-
Position: 1
73+
Required: False
74+
Position: Named
6075
Default value: None
61-
Accept pipeline input: False
76+
Accept pipeline input: True (ByPropertyName)
6277
Accept wildcard characters: False
6378
```
6479
80+
### CommonParameters
81+
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).
82+
6583
## INPUTS
6684
6785
## OUTPUTS
6886
6987
### Microsoft.Azure.Commands.AnalysisServices.Models.AzureAnalysisServicesFirewallConfig
7088
89+
## NOTES
90+
7191
## RELATED LINKS
7292
7393
[New-AzureRmAnalysisServicesFirewallRule](./New-AzureRmAnalysisServicesFirewallRule.md)

src/ResourceManager/AnalysisServices/Commands.AnalysisServices/help/New-AzureRmAnalysisServicesFirewallRule.md

Lines changed: 31 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
external help file: Microsoft.Azure.Commands.AnalysisServices.dll-Help.xml
33
Module Name: AzureRM.AnalysisServices
44
online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.analysisservices/new-azurermanalysisservicesfirewallrule
@@ -13,7 +13,8 @@ Creates a new Analysis Services firewall rule
1313
## SYNTAX
1414

1515
```
16-
New-AzureRmAnalysisServicesFirewallRule [-FirewallRuleName] <String> [-RangeStart] <String> [-RangeEnd] <String>
16+
New-AzureRmAnalysisServicesFirewallRule [-FirewallRuleName] <String> [-RangeStart] <String>
17+
[-RangeEnd] <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1718
```
1819

1920
## DESCRIPTION
@@ -30,6 +31,19 @@ Creates a firewall rule named rule1 with start range 0.0.0.0 and end range 255.2
3031

3132
## PARAMETERS
3233

34+
### -DefaultProfile
35+
The credentials, account, tenant, and subscription used for communication with Azure.```yaml
36+
Type: IAzureContextContainer
37+
Parameter Sets: (All)
38+
Aliases: AzureRmContext, AzureCredential
39+
40+
Required: False
41+
Position: Named
42+
Default value: None
43+
Accept pipeline input: False
44+
Accept wildcard characters: False
45+
```
46+
3347
### -FirewallRuleName
3448
Name of firewall rule
3549
@@ -41,46 +55,51 @@ Aliases:
4155
Required: True
4256
Position: 0
4357
Default value: None
44-
Accept pipeline input: False
58+
Accept pipeline input: True (ByPropertyName)
4559
Accept wildcard characters: False
4660
```
4761

48-
### -RangeStart
49-
The range start of a firewall rule
62+
### -RangeEnd
63+
The range end of a firewall rule
5064

5165
```yaml
5266
Type: String
5367
Parameter Sets: (All)
5468
Aliases:
5569

5670
Required: True
57-
Position: 1
71+
Position: 2
5872
Default value: None
59-
Accept pipeline input: False
73+
Accept pipeline input: True (ByPropertyName)
6074
Accept wildcard characters: False
6175
```
6276
63-
### -RangeEnd
64-
The range end of a firewall rule
77+
### -RangeStart
78+
The range start of a firewall rule
6579
6680
```yaml
6781
Type: String
6882
Parameter Sets: (All)
69-
Aliases: AzureRmContext, AzureCredential
83+
Aliases:
7084

7185
Required: True
72-
Position: 2
86+
Position: 1
7387
Default value: None
74-
Accept pipeline input: False
88+
Accept pipeline input: True (ByPropertyName)
7589
Accept wildcard characters: False
7690
```
7791
92+
### CommonParameters
93+
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).
94+
7895
## INPUTS
7996
8097
## OUTPUTS
8198
8299
### Microsoft.Azure.Commands.AnalysisServices.Models.AzureAnalysisServicesFirewallRule
83100
101+
## NOTES
102+
84103
## RELATED LINKS
85104
86105
[New-AzureRmAnalysisServicesFirewallConfig](./New-AzureRmAnalysisServicesFirewallConfig.md)

0 commit comments

Comments
 (0)