Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. containerservice
  5. getLoadBalancer
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.containerservice.getLoadBalancer

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    The configurations regarding multiple standard load balancers. If not supplied, single load balancer mode will be used. Multiple standard load balancers mode will be used if at lease one configuration is supplied. There has to be a configuration named kubernetes. Azure REST API version: 2024-03-02-preview.

    Other available API versions: 2024-04-02-preview, 2024-05-02-preview, 2024-06-02-preview, 2024-07-02-preview, 2024-09-02-preview.

    Using getLoadBalancer

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getLoadBalancer(args: GetLoadBalancerArgs, opts?: InvokeOptions): Promise<GetLoadBalancerResult>
function getLoadBalancerOutput(args: GetLoadBalancerOutputArgs, opts?: InvokeOptions): Output<GetLoadBalancerResult>
    def get_load_balancer(load_balancer_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      resource_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetLoadBalancerResult
def get_load_balancer_output(load_balancer_name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      resource_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetLoadBalancerResult]
    func LookupLoadBalancer(ctx *Context, args *LookupLoadBalancerArgs, opts ...InvokeOption) (*LookupLoadBalancerResult, error)
func LookupLoadBalancerOutput(ctx *Context, args *LookupLoadBalancerOutputArgs, opts ...InvokeOption) LookupLoadBalancerResultOutput

    > Note: This function is named LookupLoadBalancer in the Go SDK.

    public static class GetLoadBalancer 
{
    public static Task<GetLoadBalancerResult> InvokeAsync(GetLoadBalancerArgs args, InvokeOptions? opts = null)
    public static Output<GetLoadBalancerResult> Invoke(GetLoadBalancerInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetLoadBalancerResult> getLoadBalancer(GetLoadBalancerArgs args, InvokeOptions options)
public static Output<GetLoadBalancerResult> getLoadBalancer(GetLoadBalancerArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:containerservice:getLoadBalancer
  arguments:
    # arguments dictionary

    The following arguments are supported:

    LoadBalancerName string
    The name of the load balancer.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ResourceName string
    The name of the managed cluster resource.
    LoadBalancerName string
    The name of the load balancer.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ResourceName string
    The name of the managed cluster resource.
    loadBalancerName String
    The name of the load balancer.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    resourceName String
    The name of the managed cluster resource.
    loadBalancerName string
    The name of the load balancer.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    resourceName string
    The name of the managed cluster resource.
    load_balancer_name str
    The name of the load balancer.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    resource_name str
    The name of the managed cluster resource.
    loadBalancerName String
    The name of the load balancer.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    resourceName String
    The name of the managed cluster resource.

    getLoadBalancer Result

    The following output properties are available:

    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    PrimaryAgentPoolName string
    Required field. A string value that must specify the ID of an existing agent pool. All nodes in the given pool will always be added to this load balancer. This agent pool must have at least one node and minCount>=1 for autoscaling operations. An agent pool can only be the primary pool for a single load balancer.
    ProvisioningState string
    The current provisioning state.
    SystemData Pulumi.AzureNative.ContainerService.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    AllowServicePlacement bool
    Whether to automatically place services on the load balancer. If not supplied, the default value is true. If set to false manually, both of the external and the internal load balancer will not be selected for services unless they explicitly target it.
    NodeSelector Pulumi.AzureNative.ContainerService.Outputs.LabelSelectorResponse
    Nodes that match this selector will be possible members of this load balancer.
    ServiceLabelSelector Pulumi.AzureNative.ContainerService.Outputs.LabelSelectorResponse
    Only services that must match this selector can be placed on this load balancer.
    ServiceNamespaceSelector Pulumi.AzureNative.ContainerService.Outputs.LabelSelectorResponse
    Services created in namespaces that match the selector can be placed on this load balancer.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    PrimaryAgentPoolName string
    Required field. A string value that must specify the ID of an existing agent pool. All nodes in the given pool will always be added to this load balancer. This agent pool must have at least one node and minCount>=1 for autoscaling operations. An agent pool can only be the primary pool for a single load balancer.
    ProvisioningState string
    The current provisioning state.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    AllowServicePlacement bool
    Whether to automatically place services on the load balancer. If not supplied, the default value is true. If set to false manually, both of the external and the internal load balancer will not be selected for services unless they explicitly target it.
    NodeSelector LabelSelectorResponse
    Nodes that match this selector will be possible members of this load balancer.
    ServiceLabelSelector LabelSelectorResponse
    Only services that must match this selector can be placed on this load balancer.
    ServiceNamespaceSelector LabelSelectorResponse
    Services created in namespaces that match the selector can be placed on this load balancer.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    primaryAgentPoolName String
    Required field. A string value that must specify the ID of an existing agent pool. All nodes in the given pool will always be added to this load balancer. This agent pool must have at least one node and minCount>=1 for autoscaling operations. An agent pool can only be the primary pool for a single load balancer.
    provisioningState String
    The current provisioning state.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    allowServicePlacement Boolean
    Whether to automatically place services on the load balancer. If not supplied, the default value is true. If set to false manually, both of the external and the internal load balancer will not be selected for services unless they explicitly target it.
    nodeSelector LabelSelectorResponse
    Nodes that match this selector will be possible members of this load balancer.
    serviceLabelSelector LabelSelectorResponse
    Only services that must match this selector can be placed on this load balancer.
    serviceNamespaceSelector LabelSelectorResponse
    Services created in namespaces that match the selector can be placed on this load balancer.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    primaryAgentPoolName string
    Required field. A string value that must specify the ID of an existing agent pool. All nodes in the given pool will always be added to this load balancer. This agent pool must have at least one node and minCount>=1 for autoscaling operations. An agent pool can only be the primary pool for a single load balancer.
    provisioningState string
    The current provisioning state.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    allowServicePlacement boolean
    Whether to automatically place services on the load balancer. If not supplied, the default value is true. If set to false manually, both of the external and the internal load balancer will not be selected for services unless they explicitly target it.
    nodeSelector LabelSelectorResponse
    Nodes that match this selector will be possible members of this load balancer.
    serviceLabelSelector LabelSelectorResponse
    Only services that must match this selector can be placed on this load balancer.
    serviceNamespaceSelector LabelSelectorResponse
    Services created in namespaces that match the selector can be placed on this load balancer.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the resource
    primary_agent_pool_name str
    Required field. A string value that must specify the ID of an existing agent pool. All nodes in the given pool will always be added to this load balancer. This agent pool must have at least one node and minCount>=1 for autoscaling operations. An agent pool can only be the primary pool for a single load balancer.
    provisioning_state str
    The current provisioning state.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    allow_service_placement bool
    Whether to automatically place services on the load balancer. If not supplied, the default value is true. If set to false manually, both of the external and the internal load balancer will not be selected for services unless they explicitly target it.
    node_selector LabelSelectorResponse
    Nodes that match this selector will be possible members of this load balancer.
    service_label_selector LabelSelectorResponse
    Only services that must match this selector can be placed on this load balancer.
    service_namespace_selector LabelSelectorResponse
    Services created in namespaces that match the selector can be placed on this load balancer.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    primaryAgentPoolName String
    Required field. A string value that must specify the ID of an existing agent pool. All nodes in the given pool will always be added to this load balancer. This agent pool must have at least one node and minCount>=1 for autoscaling operations. An agent pool can only be the primary pool for a single load balancer.
    provisioningState String
    The current provisioning state.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    allowServicePlacement Boolean
    Whether to automatically place services on the load balancer. If not supplied, the default value is true. If set to false manually, both of the external and the internal load balancer will not be selected for services unless they explicitly target it.
    nodeSelector Property Map
    Nodes that match this selector will be possible members of this load balancer.
    serviceLabelSelector Property Map
    Only services that must match this selector can be placed on this load balancer.
    serviceNamespaceSelector Property Map
    Services created in namespaces that match the selector can be placed on this load balancer.

    Supporting Types

    LabelSelectorRequirementResponse

    Key string
    key is the label key that the selector applies to.
    Operator string
    operator represents a key's relationship to a set of values. Valid operators are In and NotIn
    Values List<string>
    values is an array of string values, the values array must be non-empty.
    Key string
    key is the label key that the selector applies to.
    Operator string
    operator represents a key's relationship to a set of values. Valid operators are In and NotIn
    Values []string
    values is an array of string values, the values array must be non-empty.
    key String
    key is the label key that the selector applies to.
    operator String
    operator represents a key's relationship to a set of values. Valid operators are In and NotIn
    values List<String>
    values is an array of string values, the values array must be non-empty.
    key string
    key is the label key that the selector applies to.
    operator string
    operator represents a key's relationship to a set of values. Valid operators are In and NotIn
    values string[]
    values is an array of string values, the values array must be non-empty.
    key str
    key is the label key that the selector applies to.
    operator str
    operator represents a key's relationship to a set of values. Valid operators are In and NotIn
    values Sequence[str]
    values is an array of string values, the values array must be non-empty.
    key String
    key is the label key that the selector applies to.
    operator String
    operator represents a key's relationship to a set of values. Valid operators are In and NotIn
    values List<String>
    values is an array of string values, the values array must be non-empty.

    LabelSelectorResponse

    MatchExpressions List<Pulumi.AzureNative.ContainerService.Inputs.LabelSelectorRequirementResponse>
    matchExpressions is a list of label selector requirements. The requirements are ANDed.
    MatchLabels List<string>
    matchLabels is an array of {key=value} pairs. A single {key=value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is key, the operator is In, and the values array contains only value. The requirements are ANDed.
    MatchExpressions []LabelSelectorRequirementResponse
    matchExpressions is a list of label selector requirements. The requirements are ANDed.
    MatchLabels []string
    matchLabels is an array of {key=value} pairs. A single {key=value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is key, the operator is In, and the values array contains only value. The requirements are ANDed.
    matchExpressions List<LabelSelectorRequirementResponse>
    matchExpressions is a list of label selector requirements. The requirements are ANDed.
    matchLabels List<String>
    matchLabels is an array of {key=value} pairs. A single {key=value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is key, the operator is In, and the values array contains only value. The requirements are ANDed.
    matchExpressions LabelSelectorRequirementResponse[]
    matchExpressions is a list of label selector requirements. The requirements are ANDed.
    matchLabels string[]
    matchLabels is an array of {key=value} pairs. A single {key=value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is key, the operator is In, and the values array contains only value. The requirements are ANDed.
    match_expressions Sequence[LabelSelectorRequirementResponse]
    matchExpressions is a list of label selector requirements. The requirements are ANDed.
    match_labels Sequence[str]
    matchLabels is an array of {key=value} pairs. A single {key=value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is key, the operator is In, and the values array contains only value. The requirements are ANDed.
    matchExpressions List<Property Map>
    matchExpressions is a list of label selector requirements. The requirements are ANDed.
    matchLabels List<String>
    matchLabels is an array of {key=value} pairs. A single {key=value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is key, the operator is In, and the values array contains only value. The requirements are ANDed.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native