Edit

Share via

New-AzStaticRoute

  • Reference
Module:
Az.Network

Creates a StaticRoute object which can then be added to a RoutingConfiguration object.

Syntax

New-AzStaticRoute
   -Name <String>
   -AddressPrefix <String[]>
   -NextHopIpAddress <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Creates a StaticRoute object.

Examples

Example 1

New-AzStaticRoute -Name "route1" -AddressPrefix @("10.20.0.0/16", "10.30.0.0/16") -NextHopIpAddress "10.90.0.5"

Name   AddressPrefixes              NextHopIpAddress
----   ---------------              ----------------
route1 {10.20.0.0/16, 10.30.0.0/16} 10.90.0.5

The above command will create a StaticRoute object which can then be added to a RoutingConfiguration object.

Parameters

-AddressPrefix

List of address prefixes.

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

The route name.

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

-NextHopIpAddress

The next hop ip address.

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

Inputs

String

Outputs

PSStaticRoute