Skip to content

Latest commit

 

History

History
167 lines (123 loc) · 4.16 KB

Get-AzureEffectiveRouteTable.md

File metadata and controls

167 lines (123 loc) · 4.16 KB
external help file ms.assetid online version schema
Microsoft.WindowsAzure.Commands.ServiceManagement.Network.dll-Help.xml
82CF6E71-FFE2-4B2C-8AAD-04C137AD5706
2.0.0

Get-AzureEffectiveRouteTable

SYNOPSIS

Gets the route applied in a virtual machine.

[!INCLUDE rdfe-banner]

SYNTAX

IaaSGetEffectiveRouteTableParamSet

Get-AzureEffectiveRouteTable -VM <PersistentVMRoleContext> -ServiceName <String>
 [-NetworkInterfaceName <String>] [-Profile <AzureSMProfile>] [<CommonParameters>]

SlotGetEffectiveRouteTableParamSet

Get-AzureEffectiveRouteTable -ServiceName <String> [-Slot <String>] -RoleInstanceName <String>
 [-NetworkInterfaceName <String>] [-Profile <AzureSMProfile>] [<CommonParameters>]

DESCRIPTION

The Get-AzureEffectiveRouteTable cmdlet gets the route applied in a virtual machine. This operation could take several seconds to finish.

EXAMPLES

Example 1: Get the effective route applied a virtual machine

PS C:\> Get-AzureVM -ServiceName "ContosoService" -Name "ContosoVM06" | Get-AzureEffectiveRouteTable

This command gets a virtual machine named ContosoVM06 for the service named ContosoService, and passes that virtual machine object to the current cmdlet. The current cmdlet gets the route applied to that virtual machine.

PARAMETERS

-NetworkInterfaceName

Specifies the name of the network adapter for which this cmdlet gets effective routes.

Type: String
Parameter Sets: (All)
Aliases: 

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

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Type: AzureSMProfile
Parameter Sets: (All)
Aliases: 

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

-RoleInstanceName

Specifies the name of a PaaS role for which this cmdlet gets effective routes.

Type: String
Parameter Sets: SlotGetEffectiveRouteTableParamSet
Aliases: 

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

-ServiceName

Specifies the name of a cloud service. The PaaS role for which this cmdlet gets effective routes belongs to the service that this parameter specifies.

Type: String
Parameter Sets: (All)
Aliases: 

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

-Slot

Specifies a PaaS slot. The PaaS role for which this cmdlet gets effective routes has the slot that this parameter specifies. Valid values are:

  • Production
  • Staging

The default value is Production.

Type: String
Parameter Sets: SlotGetEffectiveRouteTableParamSet
Aliases: 

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

-VM

Specifies the virtual machine object for which this cmdlet gets effective routes.

Type: PersistentVMRoleContext
Parameter Sets: IaaSGetEffectiveRouteTableParamSet
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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 (https://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

System.Collections.Generic.IEnumerable<Microsoft.WindowsAzure.Management.Network.Models.EffectiveRouteTable, Microsoft.WindowsAzure.Management.Network>

NOTES

RELATED LINKS

Get-AzureRouteTable

New-AzureRouteTable

Remove-AzureRouteTable

Remove-AzureSubnetRouteTable

Set-AzureSubnetRouteTable