Get-AzLoadBalancer
Gets a load balancer.
Syntax
NoExpand (Default)
Get-AzLoadBalancer
[-ResourceGroupName <String>]
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Expand
Get-AzLoadBalancer
-ResourceGroupName <String>
-Name <String>
-ExpandResource <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzLoadBalancer cmdlet gets one or more Azure load balancers that are contained in a resource group.
Examples
Example 1: Get a load balancer
Get-AzLoadBalancer -Name "MyLoadBalancer1" -ResourceGroupName "MyResourceGroup"
Name : MyLoadBalancer1
ResourceGroupName : MyResourceGroup
Location : australiaeast
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/M
icrosoft.Network/loadBalancers/MyLoadBalancer1
Etag : W/"00000000-0000-0000-0000-000000000000"
ResourceGuid : 00000000-0000-0000-0000-000000000000
ProvisioningState : Succeeded
Tags :
FrontendIpConfigurations : []
BackendAddressPools : []
LoadBalancingRules : []
Probes : []
InboundNatRules : []
InboundNatPools : []
Sku : {
"Name": "Basic",
"Tier": "Regional"
}
This command gets the load balancer named MyLoadBalancer. A load balancer must exist before you can run this cmdlet.
Example 2: List load balancers using filtering
Get-AzLoadBalancer -Name MyLoadBalancer*
Name : MyLoadBalancer1
ResourceGroupName : MyResourceGroup
Location : australiaeast
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/M
icrosoft.Network/loadBalancers/MyLoadBalancer1
Etag : W/"00000000-0000-0000-0000-000000000000"
ResourceGuid : 00000000-0000-0000-0000-000000000000
ProvisioningState : Succeeded
Tags :
FrontendIpConfigurations : []
BackendAddressPools : []
LoadBalancingRules : []
Probes : []
InboundNatRules : []
InboundNatPools : []
Sku : {
"Name": "Basic",
"Tier": "Regional"
}
Name : MyLoadBalancer2
ResourceGroupName : MyResourceGroup
Location : australiaeast
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/M
icrosoft.Network/loadBalancers/MyLoadBalancer2
Etag : W/"00000000-0000-0000-0000-000000000000"
ResourceGuid : 00000000-0000-0000-0000-000000000000
ProvisioningState : Succeeded
Tags :
FrontendIpConfigurations : []
BackendAddressPools : []
LoadBalancingRules : []
Probes : []
InboundNatRules : []
InboundNatPools : []
Sku : {
"Name": "Basic",
"Tier": "Regional"
}
This command gets all load balancers with a name that starts with "MyLoadBalancer"
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ExpandResource
The Get-AzLoadBalancer cmdlet gets one or more Azure load balancers that are contained in a resource group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Expand
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Name
The Get-AzLoadBalancer cmdlet gets one or more Azure load balancers that are contained in a resource group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
| Aliases: | ResourceName |
Parameter sets
NoExpand
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceGroupName
The Get-AzLoadBalancer cmdlet gets one or more Azure load balancers that are contained in a resource group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
Parameter sets
NoExpand
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| 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.