Ask Learn
Preview
Ask Learn is an AI assistant that can answer questions, clarify concepts, and define terms using trusted Microsoft documentation.
Please sign in to use Ask Learn.
Sign inGet-NetworkControllerLoadBalancerBackendAddressPool
This cmdlet retrieves the back end address pool configuration associated with a load balancer.
Get-NetworkControllerLoadBalancerBackendAddressPool
[-LoadBalancerId] <String[]>
[[-ResourceId] <String[]>]
-ConnectionUri <Uri>
[-CertificateThumbprint <String>]
[-Credential <PSCredential>]
[-PassInnerException]
[<CommonParameters>]
This cmdlet retrieves the back end address pool configuration associated with a load balancer. The backend address pool contains the Dynamic IPs (DIPs) that make up the members of the load balanced set of VMs.
This example retrieves all the backend address pool resources from a load balancer resource named lb1
Get-NetworkControllerLoadBalancerBackendAddressPool -ConnectionUri https://networkcontroller -LoadBalancerId lb1
Specifies the digital public key X.509 certificate of a user account that has permission to perform this action.This is the certificate thumbprint of the certificate.This thumbprint must also be provided in the ClientCertificateThumbprint parameter in the Install-NetworkController or Set-NetworkController cmdlet so that Network Controller can authorize this user.
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
Specifies the Uniform Resource Identifier (URI) of the Network Controller, used by all Representational State Transfer (REST) clients to connect to Network Controller.
| Type: | Uri |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
Specifies a user credential that has permission to perform this action.The default value is the current user.This user must be present in the security group provided in the ClientSecurityGroup parameter in the Install-NetworkController cmdlet.
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
Specifies the load balancer where the backend address pool belongs
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
This cmdlet retrieves the back end address pool configuration associated with a load balancer. The backend address pool contains the Dynamic IPs (DIPs) that make up the members of the load balanced set of VMs.
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
Specifies the unique identifier for the backend address pool
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
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.
Following properties can be retrieved for a backend address pool:
- Backend IP configurations of the members of the pool
- Outbound NAT rules associated with the backend address pool
- Load balancing rules associated with the backend address pool