Get-AzureIPForwarding
Gets the status of IP forwarding.
Note
The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.
The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.
Syntax
IaaSIPForwardingParamSet
Get-AzureIPForwarding
-VM <PersistentVMRoleContext>
-ServiceName <String>
[-NetworkInterfaceName <String>]
[-Profile <AzureSMProfile>]
[<CommonParameters>]
SlotIPForwardingParamSet
Get-AzureIPForwarding
-ServiceName <String>
-RoleName <String>
[-Slot <String>]
[-NetworkInterfaceName <String>]
[-Profile <AzureSMProfile>]
[<CommonParameters>]
Description
The Get-AzureIPForwarding cmdlet gets the status of IP forwarding.
Examples
Example 1: Get IP forwarding status for a virtual machine
PS C:\> Get-AzureVM -ServiceName "ContosoService" -Name "ContosoVM06" | Get-AzureIPForwarding
Disabled
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 status of IP forwarding for that virtual machine.
Parameters
-NetworkInterfaceName
Specifies the name of the network adapter for which this cmdlet gets IP forwarding status.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | AzureSMProfile |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RoleName
Specifies the name of a PaaS role for which this cmdlet gets IP forwarding status.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SlotIPForwardingParamSet
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ServiceName
Specifies the name of a cloud service. The PaaS role belongs to the service that this parameter specifies.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Slot
Specifies a PaaS slot. The PaaS role for which this cmdlet gets forwarding status has the slot that this parameter specifies. Valid values are:
- Production
- Staging
The default value is Production.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SlotIPForwardingParamSet
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VM
Specifies the virtual machine object for which this cmdlet gets IP forwarding status.
Parameter properties
| Type: | PersistentVMRoleContext |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
IaaSIPForwardingParamSet
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.