@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 8.72 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* LoadBalancer resource.
*
* Uses Azure REST API version 2024-05-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01.
*
* Other available API versions: 2018-06-01, 2018-07-01, 2018-08-01, 2018-10-01, 2018-11-01, 2018-12-01, 2019-02-01, 2019-04-01, 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-07-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native network [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class LoadBalancer extends pulumi.CustomResource {
/**
* Get an existing LoadBalancer resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): LoadBalancer;
/**
* Returns true if the given object is an instance of LoadBalancer. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is LoadBalancer;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Collection of backend address pools used by a load balancer.
*/
readonly backendAddressPools: pulumi.Output<outputs.network.BackendAddressPoolResponse[] | undefined>;
/**
* A unique read-only string that changes whenever the resource is updated.
*/
readonly etag: pulumi.Output<string>;
/**
* The extended location of the load balancer.
*/
readonly extendedLocation: pulumi.Output<outputs.network.ExtendedLocationResponse | undefined>;
/**
* Object representing the frontend IPs to be used for the load balancer.
*/
readonly frontendIPConfigurations: pulumi.Output<outputs.network.FrontendIPConfigurationResponse[] | undefined>;
/**
* Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound NAT rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.
*/
readonly inboundNatPools: pulumi.Output<outputs.network.InboundNatPoolResponse[] | undefined>;
/**
* Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.
*/
readonly inboundNatRules: pulumi.Output<outputs.network.InboundNatRuleResponse[] | undefined>;
/**
* Object collection representing the load balancing rules Gets the provisioning.
*/
readonly loadBalancingRules: pulumi.Output<outputs.network.LoadBalancingRuleResponse[] | undefined>;
/**
* Resource location.
*/
readonly location: pulumi.Output<string | undefined>;
/**
* Resource name.
*/
readonly name: pulumi.Output<string>;
/**
* The outbound rules.
*/
readonly outboundRules: pulumi.Output<outputs.network.OutboundRuleResponse[] | undefined>;
/**
* Collection of probe objects used in the load balancer.
*/
readonly probes: pulumi.Output<outputs.network.ProbeResponse[] | undefined>;
/**
* The provisioning state of the load balancer resource.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* The resource GUID property of the load balancer resource.
*/
readonly resourceGuid: pulumi.Output<string>;
/**
* The load balancer SKU.
*/
readonly sku: pulumi.Output<outputs.network.LoadBalancerSkuResponse | undefined>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Resource type.
*/
readonly type: pulumi.Output<string>;
/**
* Create a LoadBalancer resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: LoadBalancerArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a LoadBalancer resource.
*/
export interface LoadBalancerArgs {
/**
* Collection of backend address pools used by a load balancer.
* These are also available as standalone resources. Do not mix inline and standalone resource as they will conflict with each other, leading to resources deletion.
*/
backendAddressPools?: pulumi.Input<pulumi.Input<inputs.network.BackendAddressPoolArgs>[]>;
/**
* The extended location of the load balancer.
*/
extendedLocation?: pulumi.Input<inputs.network.ExtendedLocationArgs>;
/**
* Object representing the frontend IPs to be used for the load balancer.
*/
frontendIPConfigurations?: pulumi.Input<pulumi.Input<inputs.network.FrontendIPConfigurationArgs>[]>;
/**
* Resource ID.
*/
id?: pulumi.Input<string>;
/**
* Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound NAT rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.
*/
inboundNatPools?: pulumi.Input<pulumi.Input<inputs.network.InboundNatPoolArgs>[]>;
/**
* Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.
* These are also available as standalone resources. Do not mix inline and standalone resource as they will conflict with each other, leading to resources deletion.
*/
inboundNatRules?: pulumi.Input<pulumi.Input<inputs.network.InboundNatRuleArgs>[]>;
/**
* The name of the load balancer.
*/
loadBalancerName?: pulumi.Input<string>;
/**
* Object collection representing the load balancing rules Gets the provisioning.
*/
loadBalancingRules?: pulumi.Input<pulumi.Input<inputs.network.LoadBalancingRuleArgs>[]>;
/**
* Resource location.
*/
location?: pulumi.Input<string>;
/**
* The outbound rules.
*/
outboundRules?: pulumi.Input<pulumi.Input<inputs.network.OutboundRuleArgs>[]>;
/**
* Collection of probe objects used in the load balancer.
*/
probes?: pulumi.Input<pulumi.Input<inputs.network.ProbeArgs>[]>;
/**
* The name of the resource group.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The load balancer SKU.
*/
sku?: pulumi.Input<inputs.network.LoadBalancerSkuArgs>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}