pulumi-azure-native-kotlin/com.pulumi.azurenative.insights.kotlin/WebTest

WebTest

class WebTest : KotlinCustomResource

An Application Insights WebTest definition. Azure REST API version: 2022-06-15. Prior API version in Azure Native 1.x: 2015-05-01. Other available API versions: 2020-10-05-preview.

Example Usage

webTestCreate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var webTest = new AzureNative.Insights.WebTest("webTest", new()
    {
        Configuration = new AzureNative.Insights.Inputs.WebTestPropertiesConfigurationArgs
        {
            WebTest = "<WebTest Name=\"my-webtest\" Id=\"678ddf96-1ab8-44c8-9274-123456789abc\" Enabled=\"True\" CssProjectStructure=\"\" CssIteration=\"\" Timeout=\"120\" WorkItemIds=\"\" xmlns=\"http://microsoft.com/schemas/VisualStudio/TeamTest/2010\" Description=\"\" CredentialUserName=\"\" CredentialPassword=\"\" PreAuthenticate=\"True\" Proxy=\"default\" StopOnError=\"False\" RecordedResultFile=\"\" ResultsLocale=\"\" ><Items><Request Method=\"GET\" Guid=\"a4162485-9114-fcfc-e086-123456789abc\" Version=\"1.1\" Url=\"http://my-component.azurewebsites.net\" ThinkTime=\"0\" Timeout=\"120\" ParseDependentRequests=\"True\" FollowRedirects=\"True\" RecordResult=\"True\" Cache=\"False\" ResponseTimeGoal=\"0\" Encoding=\"utf-8\" ExpectedHttpStatusCode=\"200\" ExpectedResponseUrl=\"\" ReportingName=\"\" IgnoreHttpStatusCode=\"False\" /></Items></WebTest>",
        },
        Description = "Ping web test alert for mytestwebapp",
        Enabled = true,
        Frequency = 900,
        Kind = AzureNative.Insights.WebTestKind.Ping,
        Location = "South Central US",
        Locations = new[]
        {
            new AzureNative.Insights.Inputs.WebTestGeolocationArgs
            {
                Location = "us-fl-mia-edge",
            },
        },
        ResourceGroupName = "my-resource-group",
        RetryEnabled = true,
        SyntheticMonitorId = "my-webtest-my-component",
        Timeout = 120,
        WebTestKind = AzureNative.Insights.WebTestKind.Ping,
        WebTestName = "my-webtest-my-component",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-azure-native-sdk/insights/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := insights.NewWebTest(ctx, "webTest", &insights.WebTestArgs{
			Configuration: &insights.WebTestPropertiesConfigurationArgs{
				WebTest: pulumi.String("<WebTest Name=\"my-webtest\" Id=\"678ddf96-1ab8-44c8-9274-123456789abc\" Enabled=\"True\" CssProjectStructure=\"\" CssIteration=\"\" Timeout=\"120\" WorkItemIds=\"\" xmlns=\"http://microsoft.com/schemas/VisualStudio/TeamTest/2010\" Description=\"\" CredentialUserName=\"\" CredentialPassword=\"\" PreAuthenticate=\"True\" Proxy=\"default\" StopOnError=\"False\" RecordedResultFile=\"\" ResultsLocale=\"\" ><Items><Request Method=\"GET\" Guid=\"a4162485-9114-fcfc-e086-123456789abc\" Version=\"1.1\" Url=\"http://my-component.azurewebsites.net\" ThinkTime=\"0\" Timeout=\"120\" ParseDependentRequests=\"True\" FollowRedirects=\"True\" RecordResult=\"True\" Cache=\"False\" ResponseTimeGoal=\"0\" Encoding=\"utf-8\" ExpectedHttpStatusCode=\"200\" ExpectedResponseUrl=\"\" ReportingName=\"\" IgnoreHttpStatusCode=\"False\" /></Items></WebTest>"),
			},
			Description: pulumi.String("Ping web test alert for mytestwebapp"),
			Enabled:     pulumi.Bool(true),
			Frequency:   pulumi.Int(900),
			Kind:        insights.WebTestKindPing,
			Location:    pulumi.String("South Central US"),
			Locations: []insights.WebTestGeolocationArgs{
				{
					Location: pulumi.String("us-fl-mia-edge"),
				},
			},
			ResourceGroupName:  pulumi.String("my-resource-group"),
			RetryEnabled:       pulumi.Bool(true),
			SyntheticMonitorId: pulumi.String("my-webtest-my-component"),
			Timeout:            pulumi.Int(120),
			WebTestKind:        insights.WebTestKindPing,
			WebTestName:        pulumi.String("my-webtest-my-component"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.insights.WebTest;
import com.pulumi.azurenative.insights.WebTestArgs;
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 webTest = new WebTest("webTest", WebTestArgs.builder()
            .configuration(Map.of("webTest", "<WebTest Name=\"my-webtest\" Id=\"678ddf96-1ab8-44c8-9274-123456789abc\" Enabled=\"True\" CssProjectStructure=\"\" CssIteration=\"\" Timeout=\"120\" WorkItemIds=\"\" xmlns=\"http://microsoft.com/schemas/VisualStudio/TeamTest/2010\" Description=\"\" CredentialUserName=\"\" CredentialPassword=\"\" PreAuthenticate=\"True\" Proxy=\"default\" StopOnError=\"False\" RecordedResultFile=\"\" ResultsLocale=\"\" ><Items><Request Method=\"GET\" Guid=\"a4162485-9114-fcfc-e086-123456789abc\" Version=\"1.1\" Url=\"http://my-component.azurewebsites.net\" ThinkTime=\"0\" Timeout=\"120\" ParseDependentRequests=\"True\" FollowRedirects=\"True\" RecordResult=\"True\" Cache=\"False\" ResponseTimeGoal=\"0\" Encoding=\"utf-8\" ExpectedHttpStatusCode=\"200\" ExpectedResponseUrl=\"\" ReportingName=\"\" IgnoreHttpStatusCode=\"False\" /></Items></WebTest>"))
            .description("Ping web test alert for mytestwebapp")
            .enabled(true)
            .frequency(900)
            .kind("ping")
            .location("South Central US")
            .locations(Map.of("location", "us-fl-mia-edge"))
            .resourceGroupName("my-resource-group")
            .retryEnabled(true)
            .syntheticMonitorId("my-webtest-my-component")
            .timeout(120)
            .webTestKind("ping")
            .webTestName("my-webtest-my-component")
            .build());
    }
}
Content copied to clipboard

webTestCreateStandard

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var webTest = new AzureNative.Insights.WebTest("webTest", new()
    {
        Description = "Ping web test alert for mytestwebapp",
        Enabled = true,
        Frequency = 900,
        Location = "South Central US",
        Locations = new[]
        {
            new AzureNative.Insights.Inputs.WebTestGeolocationArgs
            {
                Location = "us-fl-mia-edge",
            },
        },
        Request = new AzureNative.Insights.Inputs.WebTestPropertiesRequestArgs
        {
            Headers = new[]
            {
                new AzureNative.Insights.Inputs.HeaderFieldArgs
                {
                    HeaderFieldName = "Content-Language",
                    HeaderFieldValue = "de-DE",
                },
                new AzureNative.Insights.Inputs.HeaderFieldArgs
                {
                    HeaderFieldName = "Accept-Language",
                    HeaderFieldValue = "de-DE",
                },
            },
            HttpVerb = "POST",
            RequestBody = "SGVsbG8gd29ybGQ=",
            RequestUrl = "https://bing.com",
        },
        ResourceGroupName = "my-resource-group",
        RetryEnabled = true,
        SyntheticMonitorId = "my-webtest-my-component",
        Timeout = 120,
        ValidationRules = new AzureNative.Insights.Inputs.WebTestPropertiesValidationRulesArgs
        {
            SSLCertRemainingLifetimeCheck = 100,
            SSLCheck = true,
        },
        WebTestKind = AzureNative.Insights.WebTestKind.Standard,
        WebTestName = "my-webtest-my-component",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-azure-native-sdk/insights/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := insights.NewWebTest(ctx, "webTest", &insights.WebTestArgs{
			Description: pulumi.String("Ping web test alert for mytestwebapp"),
			Enabled:     pulumi.Bool(true),
			Frequency:   pulumi.Int(900),
			Location:    pulumi.String("South Central US"),
			Locations: []insights.WebTestGeolocationArgs{
				{
					Location: pulumi.String("us-fl-mia-edge"),
				},
			},
			Request: insights.WebTestPropertiesResponseRequest{
				Headers: insights.HeaderFieldArray{
					&insights.HeaderFieldArgs{
						HeaderFieldName:  pulumi.String("Content-Language"),
						HeaderFieldValue: pulumi.String("de-DE"),
					},
					&insights.HeaderFieldArgs{
						HeaderFieldName:  pulumi.String("Accept-Language"),
						HeaderFieldValue: pulumi.String("de-DE"),
					},
				},
				HttpVerb:    pulumi.String("POST"),
				RequestBody: pulumi.String("SGVsbG8gd29ybGQ="),
				RequestUrl:  pulumi.String("https://bing.com"),
			},
			ResourceGroupName:  pulumi.String("my-resource-group"),
			RetryEnabled:       pulumi.Bool(true),
			SyntheticMonitorId: pulumi.String("my-webtest-my-component"),
			Timeout:            pulumi.Int(120),
			ValidationRules: &insights.WebTestPropertiesValidationRulesArgs{
				SSLCertRemainingLifetimeCheck: pulumi.Int(100),
				SSLCheck:                      pulumi.Bool(true),
			},
			WebTestKind: insights.WebTestKindStandard,
			WebTestName: pulumi.String("my-webtest-my-component"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.insights.WebTest;
import com.pulumi.azurenative.insights.WebTestArgs;
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 webTest = new WebTest("webTest", WebTestArgs.builder()
            .description("Ping web test alert for mytestwebapp")
            .enabled(true)
            .frequency(900)
            .location("South Central US")
            .locations(Map.of("location", "us-fl-mia-edge"))
            .request(Map.ofEntries(
                Map.entry("headers",
                    Map.ofEntries(
                        Map.entry("headerFieldName", "Content-Language"),
                        Map.entry("headerFieldValue", "de-DE")
                    ),
                    Map.ofEntries(
                        Map.entry("headerFieldName", "Accept-Language"),
                        Map.entry("headerFieldValue", "de-DE")
                    )),
                Map.entry("httpVerb", "POST"),
                Map.entry("requestBody", "SGVsbG8gd29ybGQ="),
                Map.entry("requestUrl", "https://bing.com")
            ))
            .resourceGroupName("my-resource-group")
            .retryEnabled(true)
            .syntheticMonitorId("my-webtest-my-component")
            .timeout(120)
            .validationRules(Map.ofEntries(
                Map.entry("sSLCertRemainingLifetimeCheck", 100),
                Map.entry("sSLCheck", true)
            ))
            .webTestKind("standard")
            .webTestName("my-webtest-my-component")
            .build());
    }
}
Content copied to clipboard

webTestUpdate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var webTest = new AzureNative.Insights.WebTest("webTest", new()
    {
        Configuration = new AzureNative.Insights.Inputs.WebTestPropertiesConfigurationArgs
        {
            WebTest = "<WebTest Name=\"my-webtest\" Id=\"678ddf96-1ab8-44c8-9274-123456789abc\" Enabled=\"True\" CssProjectStructure=\"\" CssIteration=\"\" Timeout=\"30\" WorkItemIds=\"\" xmlns=\"http://microsoft.com/schemas/VisualStudio/TeamTest/2010\" Description=\"\" CredentialUserName=\"\" CredentialPassword=\"\" PreAuthenticate=\"True\" Proxy=\"default\" StopOnError=\"False\" RecordedResultFile=\"\" ResultsLocale=\"\" ><Items><Request Method=\"GET\" Guid=\"a4162485-9114-fcfc-e086-123456789abc\" Version=\"1.1\" Url=\"http://my-component.azurewebsites.net\" ThinkTime=\"0\" Timeout=\"30\" ParseDependentRequests=\"True\" FollowRedirects=\"True\" RecordResult=\"True\" Cache=\"False\" ResponseTimeGoal=\"0\" Encoding=\"utf-8\" ExpectedHttpStatusCode=\"200\" ExpectedResponseUrl=\"\" ReportingName=\"\" IgnoreHttpStatusCode=\"False\" /></Items></WebTest>",
        },
        Frequency = 600,
        Kind = AzureNative.Insights.WebTestKind.Ping,
        Location = "South Central US",
        Locations = new[]
        {
            new AzureNative.Insights.Inputs.WebTestGeolocationArgs
            {
                Location = "us-fl-mia-edge",
            },
            new AzureNative.Insights.Inputs.WebTestGeolocationArgs
            {
                Location = "apac-hk-hkn-azr",
            },
        },
        ResourceGroupName = "my-resource-group",
        SyntheticMonitorId = "my-webtest-my-component",
        Timeout = 30,
        WebTestKind = AzureNative.Insights.WebTestKind.Ping,
        WebTestName = "my-webtest-my-component",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-azure-native-sdk/insights/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := insights.NewWebTest(ctx, "webTest", &insights.WebTestArgs{
			Configuration: &insights.WebTestPropertiesConfigurationArgs{
				WebTest: pulumi.String("<WebTest Name=\"my-webtest\" Id=\"678ddf96-1ab8-44c8-9274-123456789abc\" Enabled=\"True\" CssProjectStructure=\"\" CssIteration=\"\" Timeout=\"30\" WorkItemIds=\"\" xmlns=\"http://microsoft.com/schemas/VisualStudio/TeamTest/2010\" Description=\"\" CredentialUserName=\"\" CredentialPassword=\"\" PreAuthenticate=\"True\" Proxy=\"default\" StopOnError=\"False\" RecordedResultFile=\"\" ResultsLocale=\"\" ><Items><Request Method=\"GET\" Guid=\"a4162485-9114-fcfc-e086-123456789abc\" Version=\"1.1\" Url=\"http://my-component.azurewebsites.net\" ThinkTime=\"0\" Timeout=\"30\" ParseDependentRequests=\"True\" FollowRedirects=\"True\" RecordResult=\"True\" Cache=\"False\" ResponseTimeGoal=\"0\" Encoding=\"utf-8\" ExpectedHttpStatusCode=\"200\" ExpectedResponseUrl=\"\" ReportingName=\"\" IgnoreHttpStatusCode=\"False\" /></Items></WebTest>"),
			},
			Frequency: pulumi.Int(600),
			Kind:      insights.WebTestKindPing,
			Location:  pulumi.String("South Central US"),
			Locations: []insights.WebTestGeolocationArgs{
				{
					Location: pulumi.String("us-fl-mia-edge"),
				},
				{
					Location: pulumi.String("apac-hk-hkn-azr"),
				},
			},
			ResourceGroupName:  pulumi.String("my-resource-group"),
			SyntheticMonitorId: pulumi.String("my-webtest-my-component"),
			Timeout:            pulumi.Int(30),
			WebTestKind:        insights.WebTestKindPing,
			WebTestName:        pulumi.String("my-webtest-my-component"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.insights.WebTest;
import com.pulumi.azurenative.insights.WebTestArgs;
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 webTest = new WebTest("webTest", WebTestArgs.builder()
            .configuration(Map.of("webTest", "<WebTest Name=\"my-webtest\" Id=\"678ddf96-1ab8-44c8-9274-123456789abc\" Enabled=\"True\" CssProjectStructure=\"\" CssIteration=\"\" Timeout=\"30\" WorkItemIds=\"\" xmlns=\"http://microsoft.com/schemas/VisualStudio/TeamTest/2010\" Description=\"\" CredentialUserName=\"\" CredentialPassword=\"\" PreAuthenticate=\"True\" Proxy=\"default\" StopOnError=\"False\" RecordedResultFile=\"\" ResultsLocale=\"\" ><Items><Request Method=\"GET\" Guid=\"a4162485-9114-fcfc-e086-123456789abc\" Version=\"1.1\" Url=\"http://my-component.azurewebsites.net\" ThinkTime=\"0\" Timeout=\"30\" ParseDependentRequests=\"True\" FollowRedirects=\"True\" RecordResult=\"True\" Cache=\"False\" ResponseTimeGoal=\"0\" Encoding=\"utf-8\" ExpectedHttpStatusCode=\"200\" ExpectedResponseUrl=\"\" ReportingName=\"\" IgnoreHttpStatusCode=\"False\" /></Items></WebTest>"))
            .frequency(600)
            .kind("ping")
            .location("South Central US")
            .locations(
                Map.of("location", "us-fl-mia-edge"),
                Map.of("location", "apac-hk-hkn-azr"))
            .resourceGroupName("my-resource-group")
            .syntheticMonitorId("my-webtest-my-component")
            .timeout(30)
            .webTestKind("ping")
            .webTestName("my-webtest-my-component")
            .build());
    }
}
Content copied to clipboard

Import

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

$ pulumi import azure-native:insights:WebTest my-webtest-my-component /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/webtests/{webTestName}
Content copied to clipboard

Properties

Link copied to clipboard
val configuration: Output<WebTestPropertiesResponseConfiguration>?

An XML configuration specification for a WebTest.

Link copied to clipboard
val description: Output<String>?

User defined description for this WebTest.

Link copied to clipboard
val enabled: Output<Boolean>?

Is the test actively being monitored.

Link copied to clipboard
val frequency: Output<Int>?

Interval in seconds between test runs for this WebTest. Default value is 300.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val kind: Output<String>?

The kind of WebTest that this web test watches. Choices are ping, multistep and standard.

Link copied to clipboard
val location: Output<String>

Resource location

Link copied to clipboard
val locations: Output<List<WebTestGeolocationResponse>>

A list of where to physically run the tests from to give global coverage for accessibility of your application.

Link copied to clipboard
val name: Output<String>

Azure resource name

Link copied to clipboard
val provisioningState: Output<String>

Current state of this component, whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val request: Output<WebTestPropertiesResponseRequest>?

The collection of request properties

Link copied to clipboard
val retryEnabled: Output<Boolean>?

Allow for retries should this WebTest fail.

Link copied to clipboard
val syntheticMonitorId: Output<String>

Unique ID of this WebTest. This is typically the same value as the Name field.

Link copied to clipboard
val tags: Output<Map<String, String>>?

Resource tags

Link copied to clipboard
val timeout: Output<Int>?

Seconds until this WebTest will timeout and fail. Default value is 30.

Link copied to clipboard
val type: Output<String>

Azure resource type

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val validationRules: Output<WebTestPropertiesResponseValidationRules>?

The collection of validation rule properties

Link copied to clipboard
val webTestKind: Output<String>

The kind of web test this is, valid choices are ping, multistep and standard.

Link copied to clipboard
val webTestName: Output<String>

User defined name if this WebTest.