1. Packages
  2. Azure Native
  3. API Docs
  4. kubernetesruntime
  5. LoadBalancer
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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

azure-native.kubernetesruntime.LoadBalancer

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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

    A LoadBalancer resource for an Arc connected cluster (Microsoft.Kubernetes/connectedClusters) Azure REST API version: 2024-03-01.

    Other available API versions: 2023-10-01-preview.

    Example Usage

    LoadBalancers_CreateOrUpdate

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var loadBalancer = new AzureNative.KubernetesRuntime.LoadBalancer("loadBalancer", new()
        {
            Addresses = new[]
            {
                "192.168.50.1/24",
                "192.168.51.2-192.168.51.10",
            },
            AdvertiseMode = AzureNative.KubernetesRuntime.AdvertiseMode.ARP,
            LoadBalancerName = "testlb",
            ResourceUri = "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1",
            ServiceSelector = 
            {
                { "app", "frontend" },
            },
        });
    
    });
    
    package main
    
    import (
    	kubernetesruntime "github.com/pulumi/pulumi-azure-native-sdk/kubernetesruntime/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := kubernetesruntime.NewLoadBalancer(ctx, "loadBalancer", &kubernetesruntime.LoadBalancerArgs{
    			Addresses: pulumi.StringArray{
    				pulumi.String("192.168.50.1/24"),
    				pulumi.String("192.168.51.2-192.168.51.10"),
    			},
    			AdvertiseMode:    pulumi.String(kubernetesruntime.AdvertiseModeARP),
    			LoadBalancerName: pulumi.String("testlb"),
    			ResourceUri:      pulumi.String("subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1"),
    			ServiceSelector: pulumi.StringMap{
    				"app": pulumi.String("frontend"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.kubernetesruntime.LoadBalancer;
    import com.pulumi.azurenative.kubernetesruntime.LoadBalancerArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var loadBalancer = new LoadBalancer("loadBalancer", LoadBalancerArgs.builder()
                .addresses(            
                    "192.168.50.1/24",
                    "192.168.51.2-192.168.51.10")
                .advertiseMode("ARP")
                .loadBalancerName("testlb")
                .resourceUri("subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1")
                .serviceSelector(Map.of("app", "frontend"))
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    load_balancer = azure_native.kubernetesruntime.LoadBalancer("loadBalancer",
        addresses=[
            "192.168.50.1/24",
            "192.168.51.2-192.168.51.10",
        ],
        advertise_mode=azure_native.kubernetesruntime.AdvertiseMode.ARP,
        load_balancer_name="testlb",
        resource_uri="subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1",
        service_selector={
            "app": "frontend",
        })
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const loadBalancer = new azure_native.kubernetesruntime.LoadBalancer("loadBalancer", {
        addresses: [
            "192.168.50.1/24",
            "192.168.51.2-192.168.51.10",
        ],
        advertiseMode: azure_native.kubernetesruntime.AdvertiseMode.ARP,
        loadBalancerName: "testlb",
        resourceUri: "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1",
        serviceSelector: {
            app: "frontend",
        },
    });
    
    resources:
      loadBalancer:
        type: azure-native:kubernetesruntime:LoadBalancer
        properties:
          addresses:
            - 192.168.50.1/24
            - 192.168.51.2-192.168.51.10
          advertiseMode: ARP
          loadBalancerName: testlb
          resourceUri: subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1
          serviceSelector:
            app: frontend
    

    Create LoadBalancer Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new LoadBalancer(name: string, args: LoadBalancerArgs, opts?: CustomResourceOptions);
    @overload
    def LoadBalancer(resource_name: str,
                     args: LoadBalancerArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def LoadBalancer(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     addresses: Optional[Sequence[str]] = None,
                     advertise_mode: Optional[Union[str, AdvertiseMode]] = None,
                     resource_uri: Optional[str] = None,
                     bgp_peers: Optional[Sequence[str]] = None,
                     load_balancer_name: Optional[str] = None,
                     service_selector: Optional[Mapping[str, str]] = None)
    func NewLoadBalancer(ctx *Context, name string, args LoadBalancerArgs, opts ...ResourceOption) (*LoadBalancer, error)
    public LoadBalancer(string name, LoadBalancerArgs args, CustomResourceOptions? opts = null)
    public LoadBalancer(String name, LoadBalancerArgs args)
    public LoadBalancer(String name, LoadBalancerArgs args, CustomResourceOptions options)
    
    type: azure-native:kubernetesruntime:LoadBalancer
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args LoadBalancerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args LoadBalancerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args LoadBalancerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LoadBalancerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LoadBalancerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var azure_nativeLoadBalancerResource = new AzureNative.KubernetesRuntime.LoadBalancer("azure-nativeLoadBalancerResource", new()
    {
        Addresses = new[]
        {
            "string",
        },
        AdvertiseMode = "string",
        ResourceUri = "string",
        BgpPeers = new[]
        {
            "string",
        },
        LoadBalancerName = "string",
        ServiceSelector = 
        {
            { "string", "string" },
        },
    });
    
    example, err := kubernetesruntime.NewLoadBalancer(ctx, "azure-nativeLoadBalancerResource", &kubernetesruntime.LoadBalancerArgs{
    	Addresses: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	AdvertiseMode: pulumi.String("string"),
    	ResourceUri:   pulumi.String("string"),
    	BgpPeers: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	LoadBalancerName: pulumi.String("string"),
    	ServiceSelector: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var azure_nativeLoadBalancerResource = new LoadBalancer("azure-nativeLoadBalancerResource", LoadBalancerArgs.builder()
        .addresses("string")
        .advertiseMode("string")
        .resourceUri("string")
        .bgpPeers("string")
        .loadBalancerName("string")
        .serviceSelector(Map.of("string", "string"))
        .build());
    
    azure_native_load_balancer_resource = azure_native.kubernetesruntime.LoadBalancer("azure-nativeLoadBalancerResource",
        addresses=["string"],
        advertise_mode="string",
        resource_uri="string",
        bgp_peers=["string"],
        load_balancer_name="string",
        service_selector={
            "string": "string",
        })
    
    const azure_nativeLoadBalancerResource = new azure_native.kubernetesruntime.LoadBalancer("azure-nativeLoadBalancerResource", {
        addresses: ["string"],
        advertiseMode: "string",
        resourceUri: "string",
        bgpPeers: ["string"],
        loadBalancerName: "string",
        serviceSelector: {
            string: "string",
        },
    });
    
    type: azure-native:kubernetesruntime:LoadBalancer
    properties:
        addresses:
            - string
        advertiseMode: string
        bgpPeers:
            - string
        loadBalancerName: string
        resourceUri: string
        serviceSelector:
            string: string
    

    LoadBalancer Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The LoadBalancer resource accepts the following input properties:

    Addresses List<string>
    IP Range
    AdvertiseMode string | Pulumi.AzureNative.KubernetesRuntime.AdvertiseMode
    Advertise Mode
    ResourceUri string
    The fully qualified Azure Resource manager identifier of the resource.
    BgpPeers List<string>
    The list of BGP peers it should advertise to. Null or empty means to advertise to all peers.
    LoadBalancerName string
    The name of the LoadBalancer
    ServiceSelector Dictionary<string, string>
    A dynamic label mapping to select related services. For instance, if you want to create a load balancer only for services with label "a=b", then please specify {"a": "b"} in the field.
    Addresses []string
    IP Range
    AdvertiseMode string | AdvertiseMode
    Advertise Mode
    ResourceUri string
    The fully qualified Azure Resource manager identifier of the resource.
    BgpPeers []string
    The list of BGP peers it should advertise to. Null or empty means to advertise to all peers.
    LoadBalancerName string
    The name of the LoadBalancer
    ServiceSelector map[string]string
    A dynamic label mapping to select related services. For instance, if you want to create a load balancer only for services with label "a=b", then please specify {"a": "b"} in the field.
    addresses List<String>
    IP Range
    advertiseMode String | AdvertiseMode
    Advertise Mode
    resourceUri String
    The fully qualified Azure Resource manager identifier of the resource.
    bgpPeers List<String>
    The list of BGP peers it should advertise to. Null or empty means to advertise to all peers.
    loadBalancerName String
    The name of the LoadBalancer
    serviceSelector Map<String,String>
    A dynamic label mapping to select related services. For instance, if you want to create a load balancer only for services with label "a=b", then please specify {"a": "b"} in the field.
    addresses string[]
    IP Range
    advertiseMode string | AdvertiseMode
    Advertise Mode
    resourceUri string
    The fully qualified Azure Resource manager identifier of the resource.
    bgpPeers string[]
    The list of BGP peers it should advertise to. Null or empty means to advertise to all peers.
    loadBalancerName string
    The name of the LoadBalancer
    serviceSelector {[key: string]: string}
    A dynamic label mapping to select related services. For instance, if you want to create a load balancer only for services with label "a=b", then please specify {"a": "b"} in the field.
    addresses Sequence[str]
    IP Range
    str | AdvertiseMode
    Advertise Mode
    resource_uri str
    The fully qualified Azure Resource manager identifier of the resource.
    bgp_peers Sequence[str]
    The list of BGP peers it should advertise to. Null or empty means to advertise to all peers.
    load_balancer_name str
    The name of the LoadBalancer
    service_selector Mapping[str, str]
    A dynamic label mapping to select related services. For instance, if you want to create a load balancer only for services with label "a=b", then please specify {"a": "b"} in the field.
    addresses List<String>
    IP Range
    advertiseMode String | "ARP" | "BGP" | "Both"
    Advertise Mode
    resourceUri String
    The fully qualified Azure Resource manager identifier of the resource.
    bgpPeers List<String>
    The list of BGP peers it should advertise to. Null or empty means to advertise to all peers.
    loadBalancerName String
    The name of the LoadBalancer
    serviceSelector Map<String>
    A dynamic label mapping to select related services. For instance, if you want to create a load balancer only for services with label "a=b", then please specify {"a": "b"} in the field.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LoadBalancer resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    Resource provision state
    SystemData Pulumi.AzureNative.KubernetesRuntime.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"
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    Resource provision 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"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    Resource provision 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"
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    provisioningState string
    Resource provision 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"
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    provisioning_state str
    Resource provision 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"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    Resource provision 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"

    Supporting Types

    AdvertiseMode, AdvertiseModeArgs

    ARP
    ARPARP advertise mode
    BGP
    BGPBGP advertise mode
    Both
    Bothboth ARP and BGP advertise mode
    AdvertiseModeARP
    ARPARP advertise mode
    AdvertiseModeBGP
    BGPBGP advertise mode
    AdvertiseModeBoth
    Bothboth ARP and BGP advertise mode
    ARP
    ARPARP advertise mode
    BGP
    BGPBGP advertise mode
    Both
    Bothboth ARP and BGP advertise mode
    ARP
    ARPARP advertise mode
    BGP
    BGPBGP advertise mode
    Both
    Bothboth ARP and BGP advertise mode
    ARP
    ARPARP advertise mode
    BGP
    BGPBGP advertise mode
    BOTH
    Bothboth ARP and BGP advertise mode
    "ARP"
    ARPARP advertise mode
    "BGP"
    BGPBGP advertise mode
    "Both"
    Bothboth ARP and BGP advertise mode

    SystemDataResponse, SystemDataResponseArgs

    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.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:kubernetesruntime:LoadBalancer testlb /{resourceUri}/providers/Microsoft.KubernetesRuntime/loadBalancers/{loadBalancerName} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi