Skip to content

Fix issue with Network help #3629

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 15, 2017
Merged

Fix issue with Network help #3629

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
80ecaaa
Fix incorrect Network markdown files
cormacpayne Mar 14, 2017
aa6e82c
Fix format of examples in incorrect markdown files
cormacpayne Mar 14, 2017
7e7a024
Generate XML help for Network based on changes
cormacpayne Mar 14, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2,363 changes: 528 additions & 1,835 deletions src/ResourceManager/Network/Commands.Network/Microsoft.Azure.Commands.Network.dll-Help.xml
View file
Open in desktop

Large diffs are not rendered by default.

178 changes: 67 additions & 111 deletions ...er/Network/Commands.Network/help/Add-AzureRmExpressRouteCircuitAuthorization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,122 +1,96 @@
---
external help file: Microsoft.Azure.Commands.Network.dll-Help.xml
ms.assetid: 9D9D079C-5557-40DC-8CFB-1DCD446D9109
online version:
ms.assetid: 9994E2B2-20A1-4E95-9A9F-379B8B63F7F5
online version:
schema: 2.0.0
---

# Add-AzureRmApplicationGatewayUrlPathMapConfig
# Add-AzureRmExpressRouteCircuitAuthorization

## SYNOPSIS
Adds an array of URL path mappings to a backend server pool.

## SYNTAX
Adds an ExpressRoute circuit authorization.

### SetByResourceId
```
Add-AzureRmApplicationGatewayUrlPathMapConfig -ApplicationGateway <PSApplicationGateway> -Name <String>
-PathRules <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule]>
[-DefaultBackendAddressPoolId <String>] [-DefaultBackendHttpSettingsId <String>]
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
```
## SYNTAX

### SetByResource
```
Add-AzureRmApplicationGatewayUrlPathMapConfig -ApplicationGateway <PSApplicationGateway> -Name <String>
-PathRules <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule]>
[-DefaultBackendAddressPool <PSApplicationGatewayBackendAddressPool>]
[-DefaultBackendHttpSettings <PSApplicationGatewayBackendHttpSettings>]
Add-AzureRmExpressRouteCircuitAuthorization -Name <String> -ExpressRouteCircuit <PSExpressRouteCircuit>
[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
```

## DESCRIPTION
The **Add-AzureRmApplicationGatewayUrlPathMapConfig** cmdlet adds an array of URL path mappings to a back end server pool.

The **Add-AzureRmExpressRouteCircuitAuthorization** cmdlet adds an authorization to an ExpressRoute
circuit. ExpressRoute circuits connect your on-premises network to the Microsoft cloud by using a
connectivity provider instead of the public Internet. The owner of an ExpressRoute circuit can
create as many as 10 authorizations for each circuit; these authorizations generate an
authorization key that can be used by a virtual network owner to connect his or her network to the
circuit (one authorization per virtual network). **Add-AzureRmExpressRouteCircuitAuthorization**
adds a new authorization to a circuit and, at the same time, generates the corresponding
authorization key. These keys can be viewed at any time by running the
Get-AzureRmExpressRouteCircuitAuthorization cmdlet and, as needed, can then be copied and forwarded
to the appropriate network owner.

Note that, after running **Add-AzureRmExpressRouteCircuitAuthorization**, you must call the
Set-AzureRmExpressRouteCircuit cmdlet to activate the key. If you do not call
**Set-AzureRmExpressRouteCircuit** the authorization will be added to the circuit but will not be
enabled for use.

## EXAMPLES

### 1:
```
### Example 1: Add an authorization to the specified ExpressRoute circuit

```powershell
$Circuit = Get-AzureRmExpressRouteCircuit -Name "ContosoCircuit" -ResourceGroupName "ContosoResourceGroup"
Add-AzureRmExpressRouteCircuitAuthorization -Name "ContosoCircuitAuthorization" -Circuit $Circuit
Set-AzureRmExpressRouteCircuit -ExpressRouteCircuit $Circuit
```

## PARAMETERS

### -ApplicationGateway
Specifies the application gateway to which this cmdlet adds a URL path map configuration.

```yaml
Type: PSApplicationGateway
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
```
The commands in this example add a new authorization to an existing ExpressRoute circuit. The first
command uses **Get-AzureRmExpressRouteCircuit** to create an object reference to a circuit named
ContosoCircuit. That object reference is stored in a variable named $Circuit.

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

```yaml
Type: PSApplicationGatewayBackendAddressPool
Parameter Sets: SetByResource
Aliases:
## PARAMETERS

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Name

### -DefaultBackendAddressPoolId
Specifies the default backend address pool ID.
Specifies the name of the circuit authorization to be added.

```yaml
Type: String
Parameter Sets: SetByResourceId
Aliases:
Parameter Sets: (All)
Aliases:

Required: False
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -DefaultBackendHttpSettings
Specifies the default backend HTTP settings to use in case none of the rules specified in the *pathRules* parameter match.

```yaml
Type: PSApplicationGatewayBackendHttpSettings
Parameter Sets: SetByResource
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ExpressRouteCircuit

### -DefaultBackendHttpSettingsId
Specifies the default backend HTTP settings ID.
Specifies the ExpressRoute circuit that this cmdlet adds the authorization to.

```yaml
Type: String
Parameter Sets: SetByResourceId
Aliases:
Type: PSExpressRouteCircuit
Parameter Sets: (All)
Aliases:

Required: False
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
```

### -InformationAction

Specifies how this cmdlet responds to an information event.

The acceptable values for this parameter are:
Expand All @@ -141,6 +115,7 @@ Accept wildcard characters: False
```

### -InformationVariable

Specifies an information variable.

```yaml
Expand All @@ -155,54 +130,35 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -Name
Specifies the URL path map name that this cmdlet adds to the backend server pool.

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -PathRules
Specifies a list of path rules.
The path rules are order sensitive, they are applied in order they are specified.

```yaml
Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPathRule]
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
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).

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).

## INPUTS

### PSExpressRouteCircuit
**Add-AzureRmExpressRouteCircuitAuthorization** accepts pipelined instances of the
**Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit** object.

## OUTPUTS

### PSExpressRouteCircuit
**Add-AzureRmExpressRouteCircuitAuthorization** modifies instances of the
**Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit** object.

## NOTES

## RELATED LINKS

[Get-AzureRmApplicationGatewayUrlPathMapConfig](./Get-AzureRmApplicationGatewayUrlPathMapConfig.md)

[New-AzureRmApplicationGatewayUrlPathMapConfig](./New-AzureRmApplicationGatewayUrlPathMapConfig.md)
[Get-AzureRmExpressRouteCircuit](./Get-AzureRmExpressRouteCircuit.md)

[Remove-AzureRmApplicationGatewayUrlPathMapConfig](./Remove-AzureRmApplicationGatewayUrlPathMapConfig.md)
[Get-AzureRmExpressRouteCircuitAuthorization](./Get-AzureRmExpressRouteCircuitAuthorization.md)

[Set-AzureRmApplicationGatewayUrlPathMapConfig](./Set-AzureRmApplicationGatewayUrlPathMapConfig.md)
[New-AzureRmExpressRouteCircuitAuthorization](./New-AzureRmExpressRouteCircuitAuthorization.md)

[Remove-AzureRmExpressRouteCircuitAuthorization](./Remove-AzureRmExpressRouteCircuitAuthorization.md)

[Set-AzureRmExpressRouteCircuit](./Set-AzureRmExpressRouteCircuit.md)
Loading