Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-AzureRoute

Set-AzureRoute

microsoft.windowsazure.commands.servicemanagement.network.dll

Synopsis

Creates a new route in the specified route table.

Syntax

Set-AzureRoute [-RouteTable] [-RouteName] [-AddressPrefix] [-NextHopType] [-NextHopIpAddress] [-PipelineVariable] [-Profile] [<CommonParameters>]

Detailed Description

Creates a new route in the specified route table. Routes take effect almost immediately on the VMs associated with this route table.

Parameters

-AddressPrefix <string>

Aliases

None

Required?

true

Position

3

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-NextHopIpAddress <string>

This is needed only when NextHopType is 'VirtualAppliance'. This will be the IP address of the Appliance that will be the next hop for traffic using this route.

Aliases

None

Required?

false

Position

5

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-NextHopType <string>

The next hop type will be one of the supported next hops.: * VPNGateway * VNETLocal * Internet * VirtualAppliance * Null

Aliases

None

Required?

true

Position

4

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PipelineVariable <string>

Not Specified

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Profile <AzureProfile>

Not Specified

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-RouteName <string>

Name of the new route being added.

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-RouteTable <IRouteTable>

The route table in which the new route is added.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

true (ByValue, ByPropertyName)

Accept wildcard characters?

false

Input Type


Return Type


Notes

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS>

Description

-----------

This examples shows creation of route table and inserting of a route pointing to virtual appliance

          New-AzureRouteTable -Name AppRT -Location uswest -Label 'Appliance Route Table' | Set-AzureRoute -RouteName approute -AddressPrefix 10.0.0.0/24 -NextHopType VirtualAppliance -NextHopIpAddress 10.0.1.5

          Routes                        Name                          Location                      Label
          ------                        ----                          --------                      -----
          {approute}                    AppRT                         West US                       Appliance Route Table
        

-------------------------- EXAMPLE 2 --------------------------

C:\PS>

Description

-----------

This example shows insertion of a route to an existing route table

          Get-AzureRouteTable -Name AppRT | Set-AzureRoute -RouteName internetRoute -AddressPrefix 0.0.0.0/0 -NextHopType Internet

          Routes                        Name                          Location                      Label
          ------                        ----                          --------                      -----
          {approute, internetroute}     AppRT                         West US                       Appliance Route Table