Skip to content

Commit a6c0dc9

Browse files
authored
Merge pull request #3629 from cormacpayne/fix-network-help
Fix issue with Network help
2 parents 7caf679 + 7e7a024 commit a6c0dc9

7 files changed

+799
-2369
lines changed

src/ResourceManager/Network/Commands.Network/Microsoft.Azure.Commands.Network.dll-Help.xml

Lines changed: 528 additions & 1835 deletions
Large diffs are not rendered by default.
Lines changed: 67 additions & 111 deletions
Original file line numberDiff line numberDiff line change
@@ -1,122 +1,96 @@
11
---
22
external help file: Microsoft.Azure.Commands.Network.dll-Help.xml
3-
ms.assetid: 9D9D079C-5557-40DC-8CFB-1DCD446D9109
4-
online version:
3+
ms.assetid: 9994E2B2-20A1-4E95-9A9F-379B8B63F7F5
4+
online version:
55
schema: 2.0.0
66
---
77

8-
# Add-AzureRmApplicationGatewayUrlPathMapConfig
8+
# Add-AzureRmExpressRouteCircuitAuthorization
99

1010
## SYNOPSIS
11-
Adds an array of URL path mappings to a backend server pool.
1211

13-
## SYNTAX
12+
Adds an ExpressRoute circuit authorization.
1413

15-
### SetByResourceId
16-
```
17-
Add-AzureRmApplicationGatewayUrlPathMapConfig -ApplicationGateway <PSApplicationGateway> -Name <String>
18-
-PathRules <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule]>
19-
[-DefaultBackendAddressPoolId <String>] [-DefaultBackendHttpSettingsId <String>]
20-
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
21-
```
14+
## SYNTAX
2215

23-
### SetByResource
2416
```
25-
Add-AzureRmApplicationGatewayUrlPathMapConfig -ApplicationGateway <PSApplicationGateway> -Name <String>
26-
-PathRules <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule]>
27-
[-DefaultBackendAddressPool <PSApplicationGatewayBackendAddressPool>]
28-
[-DefaultBackendHttpSettings <PSApplicationGatewayBackendHttpSettings>]
17+
Add-AzureRmExpressRouteCircuitAuthorization -Name <String> -ExpressRouteCircuit <PSExpressRouteCircuit>
2918
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
3019
```
3120

3221
## DESCRIPTION
33-
The **Add-AzureRmApplicationGatewayUrlPathMapConfig** cmdlet adds an array of URL path mappings to a back end server pool.
22+
23+
The **Add-AzureRmExpressRouteCircuitAuthorization** cmdlet adds an authorization to an ExpressRoute
24+
circuit. ExpressRoute circuits connect your on-premises network to the Microsoft cloud by using a
25+
connectivity provider instead of the public Internet. The owner of an ExpressRoute circuit can
26+
create as many as 10 authorizations for each circuit; these authorizations generate an
27+
authorization key that can be used by a virtual network owner to connect his or her network to the
28+
circuit (one authorization per virtual network). **Add-AzureRmExpressRouteCircuitAuthorization**
29+
adds a new authorization to a circuit and, at the same time, generates the corresponding
30+
authorization key. These keys can be viewed at any time by running the
31+
Get-AzureRmExpressRouteCircuitAuthorization cmdlet and, as needed, can then be copied and forwarded
32+
to the appropriate network owner.
33+
34+
Note that, after running **Add-AzureRmExpressRouteCircuitAuthorization**, you must call the
35+
Set-AzureRmExpressRouteCircuit cmdlet to activate the key. If you do not call
36+
**Set-AzureRmExpressRouteCircuit** the authorization will be added to the circuit but will not be
37+
enabled for use.
3438

3539
## EXAMPLES
3640

37-
### 1:
38-
```
41+
### Example 1: Add an authorization to the specified ExpressRoute circuit
3942

43+
```powershell
44+
$Circuit = Get-AzureRmExpressRouteCircuit -Name "ContosoCircuit" -ResourceGroupName "ContosoResourceGroup"
45+
Add-AzureRmExpressRouteCircuitAuthorization -Name "ContosoCircuitAuthorization" -Circuit $Circuit
46+
Set-AzureRmExpressRouteCircuit -ExpressRouteCircuit $Circuit
4047
```
4148

42-
## PARAMETERS
43-
44-
### -ApplicationGateway
45-
Specifies the application gateway to which this cmdlet adds a URL path map configuration.
46-
47-
```yaml
48-
Type: PSApplicationGateway
49-
Parameter Sets: (All)
50-
Aliases:
51-
52-
Required: True
53-
Position: Named
54-
Default value: None
55-
Accept pipeline input: True (ByValue)
56-
Accept wildcard characters: False
57-
```
49+
The commands in this example add a new authorization to an existing ExpressRoute circuit. The first
50+
command uses **Get-AzureRmExpressRouteCircuit** to create an object reference to a circuit named
51+
ContosoCircuit. That object reference is stored in a variable named $Circuit.
5852

59-
### -DefaultBackendAddressPool
60-
Specifies the default backend address pool to route in case none of the rules specified in the *pathRules* parameter match.
53+
In the second command, the **Add-AzureRmExpressRouteCircuitAuthorization** cmdlet is used to add a
54+
new authorization (ContosoCircuitAuthorization) to the ExpressRoute circuit. This command adds the
55+
authorization but does not activate that authorization. Activating an authorization requires the
56+
**Set-AzureRmExpressRouteCircuit** shown in the final command in the example.
6157

62-
```yaml
63-
Type: PSApplicationGatewayBackendAddressPool
64-
Parameter Sets: SetByResource
65-
Aliases:
58+
## PARAMETERS
6659

67-
Required: False
68-
Position: Named
69-
Default value: None
70-
Accept pipeline input: False
71-
Accept wildcard characters: False
72-
```
60+
### -Name
7361

74-
### -DefaultBackendAddressPoolId
75-
Specifies the default backend address pool ID.
62+
Specifies the name of the circuit authorization to be added.
7663

7764
```yaml
7865
Type: String
79-
Parameter Sets: SetByResourceId
80-
Aliases:
66+
Parameter Sets: (All)
67+
Aliases:
8168

82-
Required: False
69+
Required: True
8370
Position: Named
8471
Default value: None
8572
Accept pipeline input: False
8673
Accept wildcard characters: False
8774
```
8875
89-
### -DefaultBackendHttpSettings
90-
Specifies the default backend HTTP settings to use in case none of the rules specified in the *pathRules* parameter match.
91-
92-
```yaml
93-
Type: PSApplicationGatewayBackendHttpSettings
94-
Parameter Sets: SetByResource
95-
Aliases:
96-
97-
Required: False
98-
Position: Named
99-
Default value: None
100-
Accept pipeline input: False
101-
Accept wildcard characters: False
102-
```
76+
### -ExpressRouteCircuit
10377
104-
### -DefaultBackendHttpSettingsId
105-
Specifies the default backend HTTP settings ID.
78+
Specifies the ExpressRoute circuit that this cmdlet adds the authorization to.
10679
10780
```yaml
108-
Type: String
109-
Parameter Sets: SetByResourceId
110-
Aliases:
81+
Type: PSExpressRouteCircuit
82+
Parameter Sets: (All)
83+
Aliases:
11184

112-
Required: False
85+
Required: True
11386
Position: Named
11487
Default value: None
115-
Accept pipeline input: False
88+
Accept pipeline input: True (ByValue)
11689
Accept wildcard characters: False
11790
```
11891
11992
### -InformationAction
93+
12094
Specifies how this cmdlet responds to an information event.
12195
12296
The acceptable values for this parameter are:
@@ -141,6 +115,7 @@ Accept wildcard characters: False
141115
```
142116
143117
### -InformationVariable
118+
144119
Specifies an information variable.
145120
146121
```yaml
@@ -155,54 +130,35 @@ Accept pipeline input: False
155130
Accept wildcard characters: False
156131
```
157132
158-
### -Name
159-
Specifies the URL path map name that this cmdlet adds to the backend server pool.
160-
161-
```yaml
162-
Type: String
163-
Parameter Sets: (All)
164-
Aliases:
165-
166-
Required: True
167-
Position: Named
168-
Default value: None
169-
Accept pipeline input: False
170-
Accept wildcard characters: False
171-
```
172-
173-
### -PathRules
174-
Specifies a list of path rules.
175-
The path rules are order sensitive, they are applied in order they are specified.
176-
177-
```yaml
178-
Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule]
179-
Parameter Sets: (All)
180-
Aliases:
181-
182-
Required: True
183-
Position: Named
184-
Default value: None
185-
Accept pipeline input: False
186-
Accept wildcard characters: False
187-
```
188-
189133
### CommonParameters
190-
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).
134+
135+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
136+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
137+
-WarningAction, and -WarningVariable. For more information, see about_CommonParameters
138+
(http://go.microsoft.com/fwlink/?LinkID=113216).
191139
192140
## INPUTS
193141
142+
### PSExpressRouteCircuit
143+
**Add-AzureRmExpressRouteCircuitAuthorization** accepts pipelined instances of the
144+
**Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit** object.
145+
194146
## OUTPUTS
195147
148+
### PSExpressRouteCircuit
149+
**Add-AzureRmExpressRouteCircuitAuthorization** modifies instances of the
150+
**Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit** object.
151+
196152
## NOTES
197153
198154
## RELATED LINKS
199155
200-
[Get-AzureRmApplicationGatewayUrlPathMapConfig](./Get-AzureRmApplicationGatewayUrlPathMapConfig.md)
201-
202-
[New-AzureRmApplicationGatewayUrlPathMapConfig](./New-AzureRmApplicationGatewayUrlPathMapConfig.md)
156+
[Get-AzureRmExpressRouteCircuit](./Get-AzureRmExpressRouteCircuit.md)
203157
204-
[Remove-AzureRmApplicationGatewayUrlPathMapConfig](./Remove-AzureRmApplicationGatewayUrlPathMapConfig.md)
158+
[Get-AzureRmExpressRouteCircuitAuthorization](./Get-AzureRmExpressRouteCircuitAuthorization.md)
205159
206-
[Set-AzureRmApplicationGatewayUrlPathMapConfig](./Set-AzureRmApplicationGatewayUrlPathMapConfig.md)
160+
[New-AzureRmExpressRouteCircuitAuthorization](./New-AzureRmExpressRouteCircuitAuthorization.md)
207161
162+
[Remove-AzureRmExpressRouteCircuitAuthorization](./Remove-AzureRmExpressRouteCircuitAuthorization.md)
208163
164+
[Set-AzureRmExpressRouteCircuit](./Set-AzureRmExpressRouteCircuit.md)

0 commit comments

Comments
 (0)