Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping.md

external help file	Module Name	online version	schema
Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml	Az.Network	https://learn.microsoft.com/powershell/module/az.network/get-azloadbalancerbackendaddressinboundnatruleportmapping	2.0.0

Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping

SYNOPSIS

Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping retrieves inbound nat rule port mapping list for one backend address.

SYNTAX

GetByNameParameterSet (Default)

Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping -ResourceGroupName <String>
 -LoadBalancerName <String> [-Name <String>] [-IpAddress <String>]
 [-NetworkInterfaceIpConfigurationId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]

GetByParentObjectParameterSet

Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping [-Name <String>] -LoadBalancer <PSLoadBalancer>
 [-IpAddress <String>] [-NetworkInterfaceIpConfigurationId <String>] [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

GetByResourceIdParameterSet

Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping -ResourceId <String> [-IpAddress <String>]
 [-NetworkInterfaceIpConfigurationId <String>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]

DESCRIPTION

Get-AzLoadBalancerBackendAddressPool retrieves inbound nat rule port mapping list for one backend address.

EXAMPLES

Example 1

## Get inbound nat rule port mapping by NIC id
Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping -ResourceGroupName $rgname -LoadBalancerName $lbName -NetworkInterfaceIpConfigurationId $ipconfig.Id -Name pool1

Example 2

## Get inbound nat rule port mapping by ip address
$testIpAddress1 = "10.0.0.5"
Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping -ResourceGroupName $rgname -LoadBalancerName $lbName -Name $backendAddressPoolName -IpAddress $testIpAddress1

Example 3

## Get inbound nat rule port mapping by ip address and load balancer object
$slb = Get-AzLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup"
Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping -LoadBalancer $slb -Name $backendAddressPoolName -IpAddress $testIpAddress1

Example 4

## Get inbound nat rule port mapping by ip address and backend pool id
Get-AzLoadBalancerBackendAddressInboundNatRulePortMapping -ResourceId $backendPool1.Id -IpAddress $testIpAddress1

PARAMETERS

-DefaultProfile

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

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

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

-IpAddress

Type: System.String
Parameter Sets: (All)
Aliases:

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

-LoadBalancer

Specifies the load balancer that has the backend address pool

Type: Microsoft.Azure.Commands.Network.Models.PSLoadBalancer
Parameter Sets: GetByParentObjectParameterSet
Aliases:

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

-LoadBalancerName

The name of the load balancer.

Type: System.String
Parameter Sets: GetByNameParameterSet
Aliases:

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

-Name

The name of the backend address pool.

Type: System.String
Parameter Sets: GetByNameParameterSet, GetByParentObjectParameterSet
Aliases:

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

-NetworkInterfaceIpConfigurationId

Type: System.String
Parameter Sets: (All)
Aliases:

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

-ResourceGroupName

The resource group name of the load balancer.

Type: System.String
Parameter Sets: GetByNameParameterSet
Aliases:

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

-ResourceId

Type: System.String
Parameter Sets: GetByResourceIdParameterSet
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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.

INPUTS

Microsoft.Azure.Commands.Network.Models.PSLoadBalancer

System.String

OUTPUTS

Microsoft.Azure.Commands.Network.Models.PSInboundNatRulePortMapping

NOTES

RELATED LINKS

Get-AzLoadBalancer