azure.loadtest.LoadTest (v4)

Azure v4.42.0 (4.x), Mar 9 26

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleLoadTest = new Azure.LoadTest.LoadTest("exampleLoadTest", new Azure.LoadTest.LoadTestArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = "West Europe",
        });
    }

}

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/loadtest"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = loadtest.NewLoadTest(ctx, "exampleLoadTest", &loadtest.LoadTestArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Example coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleLoadTest = new azure.loadtest.LoadTest("exampleLoadTest", {
    resourceGroupName: exampleResourceGroup.name,
    location: "West Europe",
});

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_load_test = azure.loadtest.LoadTest("exampleLoadTest",
    resource_group_name=example_resource_group.name,
    location="West Europe")

Example coming soon!

Create LoadTest Resource

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

Constructor syntax

new LoadTest(name: string, args: LoadTestArgs, opts?: CustomResourceOptions);

@overload
def LoadTest(resource_name: str,
             args: LoadTestArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def LoadTest(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             resource_group_name: Optional[str] = None,
             location: Optional[str] = None,
             name: Optional[str] = None,
             tags: Optional[Mapping[str, str]] = None)

func NewLoadTest(ctx *Context, name string, args LoadTestArgs, opts ...ResourceOption) (*LoadTest, error)

public LoadTest(string name, LoadTestArgs args, CustomResourceOptions? opts = null)

public LoadTest(String name, LoadTestArgs args)
public LoadTest(String name, LoadTestArgs args, CustomResourceOptions options)

type: azure:loadtest:LoadTest
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 LoadTestArgs: 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 LoadTestArgs: 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 LoadTestArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args LoadTestArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args LoadTestArgs: 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 loadTestResource = new Azure.LoadTest.LoadTest("loadTestResource", new()
{
    ResourceGroupName = "string",
    Location = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

example, err := loadtest.NewLoadTest(ctx, "loadTestResource", &loadtest.LoadTestArgs{
	ResourceGroupName: pulumi.String("string"),
	Location:          pulumi.String("string"),
	Name:              pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

var loadTestResource = new LoadTest("loadTestResource", LoadTestArgs.builder()
    .resourceGroupName("string")
    .location("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

load_test_resource = azure.loadtest.LoadTest("loadTestResource",
    resource_group_name="string",
    location="string",
    name="string",
    tags={
        "string": "string",
    })

const loadTestResource = new azure.loadtest.LoadTest("loadTestResource", {
    resourceGroupName: "string",
    location: "string",
    name: "string",
    tags: {
        string: "string",
    },
});

type: azure:loadtest:LoadTest
properties:
    location: string
    name: string
    resourceGroupName: string
    tags:
        string: string

LoadTest 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 LoadTest resource accepts the following input properties:

ResourceGroupName string: The name of the Resource Group where the Load Test should exist. Changing this forces a new Load Test to be created.
Location string: The Azure Region where the Load Test should exist. Changing this forces a new Load Test to be created.
Name string: The name which should be used for this Load Test. Changing this forces a new Load Test to be created.
Tags Dictionary<string, string>: A mapping of tags which should be assigned to the Load Test.

ResourceGroupName string: The name of the Resource Group where the Load Test should exist. Changing this forces a new Load Test to be created.
Location string: The Azure Region where the Load Test should exist. Changing this forces a new Load Test to be created.
Name string: The name which should be used for this Load Test. Changing this forces a new Load Test to be created.
Tags map[string]string: A mapping of tags which should be assigned to the Load Test.

resourceGroupName String: The name of the Resource Group where the Load Test should exist. Changing this forces a new Load Test to be created.
location String: The Azure Region where the Load Test should exist. Changing this forces a new Load Test to be created.
name String: The name which should be used for this Load Test. Changing this forces a new Load Test to be created.
tags Map<String,String>: A mapping of tags which should be assigned to the Load Test.

resourceGroupName string: The name of the Resource Group where the Load Test should exist. Changing this forces a new Load Test to be created.
location string: The Azure Region where the Load Test should exist. Changing this forces a new Load Test to be created.
name string: The name which should be used for this Load Test. Changing this forces a new Load Test to be created.
tags {[key: string]: string}: A mapping of tags which should be assigned to the Load Test.

resource_group_name str: The name of the Resource Group where the Load Test should exist. Changing this forces a new Load Test to be created.
location str: The Azure Region where the Load Test should exist. Changing this forces a new Load Test to be created.
name str: The name which should be used for this Load Test. Changing this forces a new Load Test to be created.
tags Mapping[str, str]: A mapping of tags which should be assigned to the Load Test.

resourceGroupName String: The name of the Resource Group where the Load Test should exist. Changing this forces a new Load Test to be created.
location String: The Azure Region where the Load Test should exist. Changing this forces a new Load Test to be created.
name String: The name which should be used for this Load Test. Changing this forces a new Load Test to be created.
tags Map<String>: A mapping of tags which should be assigned to the Load Test.

Outputs

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

DataplaneUri string: Public URI of the Data Plane.
Id string: The provider-assigned unique ID for this managed resource.

DataplaneUri string: Public URI of the Data Plane.
Id string: The provider-assigned unique ID for this managed resource.

dataplaneUri String: Public URI of the Data Plane.
id String: The provider-assigned unique ID for this managed resource.

dataplaneUri string: Public URI of the Data Plane.
id string: The provider-assigned unique ID for this managed resource.

dataplane_uri str: Public URI of the Data Plane.
id str: The provider-assigned unique ID for this managed resource.

dataplaneUri String: Public URI of the Data Plane.
id String: The provider-assigned unique ID for this managed resource.

Look up Existing LoadTest Resource

Get an existing LoadTest resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: LoadTestState, opts?: CustomResourceOptions): LoadTest

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dataplane_uri: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> LoadTest

func GetLoadTest(ctx *Context, name string, id IDInput, state *LoadTestState, opts ...ResourceOption) (*LoadTest, error)

public static LoadTest Get(string name, Input<string> id, LoadTestState? state, CustomResourceOptions? opts = null)

public static LoadTest get(String name, Output<String> id, LoadTestState state, CustomResourceOptions options)

resources:  _:    type: azure:loadtest:LoadTest    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

DataplaneUri string: Public URI of the Data Plane.
Location string: The Azure Region where the Load Test should exist. Changing this forces a new Load Test to be created.
Name string: The name which should be used for this Load Test. Changing this forces a new Load Test to be created.
ResourceGroupName string: The name of the Resource Group where the Load Test should exist. Changing this forces a new Load Test to be created.
Tags Dictionary<string, string>: A mapping of tags which should be assigned to the Load Test.

DataplaneUri string: Public URI of the Data Plane.
Location string: The Azure Region where the Load Test should exist. Changing this forces a new Load Test to be created.
Name string: The name which should be used for this Load Test. Changing this forces a new Load Test to be created.
ResourceGroupName string: The name of the Resource Group where the Load Test should exist. Changing this forces a new Load Test to be created.
Tags map[string]string: A mapping of tags which should be assigned to the Load Test.

dataplaneUri String: Public URI of the Data Plane.
location String: The Azure Region where the Load Test should exist. Changing this forces a new Load Test to be created.
name String: The name which should be used for this Load Test. Changing this forces a new Load Test to be created.
resourceGroupName String: The name of the Resource Group where the Load Test should exist. Changing this forces a new Load Test to be created.
tags Map<String,String>: A mapping of tags which should be assigned to the Load Test.

dataplaneUri string: Public URI of the Data Plane.
location string: The Azure Region where the Load Test should exist. Changing this forces a new Load Test to be created.
name string: The name which should be used for this Load Test. Changing this forces a new Load Test to be created.
resourceGroupName string: The name of the Resource Group where the Load Test should exist. Changing this forces a new Load Test to be created.
tags {[key: string]: string}: A mapping of tags which should be assigned to the Load Test.

dataplane_uri str: Public URI of the Data Plane.
location str: The Azure Region where the Load Test should exist. Changing this forces a new Load Test to be created.
name str: The name which should be used for this Load Test. Changing this forces a new Load Test to be created.
resource_group_name str: The name of the Resource Group where the Load Test should exist. Changing this forces a new Load Test to be created.
tags Mapping[str, str]: A mapping of tags which should be assigned to the Load Test.

dataplaneUri String: Public URI of the Data Plane.
location String: The Azure Region where the Load Test should exist. Changing this forces a new Load Test to be created.
name String: The name which should be used for this Load Test. Changing this forces a new Load Test to be created.
resourceGroupName String: The name of the Resource Group where the Load Test should exist. Changing this forces a new Load Test to be created.
tags Map<String>: A mapping of tags which should be assigned to the Load Test.

Import

Load tests can be imported using the resource id, e.g.

 $ pulumi import azure:loadtest/loadTest:LoadTest example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.LoadTestService/loadtests/example

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

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure

azure.loadtest.LoadTest

On this page

On this page

Example Usage

Create LoadTest Resource

Constructor syntax

Parameters

Constructor example

LoadTest Resource Properties

Inputs

Outputs

Look up Existing LoadTest Resource

Import

Package Details

On this page

On this page