1. Packages
  2. Azure Native
  3. API Docs
  4. insights
  5. getWebTest
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.9.0 published on Wednesday, Sep 27, 2023 by Pulumi

azure-native.insights.getWebTest

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.9.0 published on Wednesday, Sep 27, 2023 by Pulumi

    Get a specific Application Insights web test definition. Azure REST API version: 2022-06-15.

    Using getWebTest

    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 getWebTest(args: GetWebTestArgs, opts?: InvokeOptions): Promise<GetWebTestResult>
    function getWebTestOutput(args: GetWebTestOutputArgs, opts?: InvokeOptions): Output<GetWebTestResult>
    def get_web_test(resource_group_name: Optional[str] = None,
                     web_test_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetWebTestResult
    def get_web_test_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                     web_test_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetWebTestResult]
    func LookupWebTest(ctx *Context, args *LookupWebTestArgs, opts ...InvokeOption) (*LookupWebTestResult, error)
    func LookupWebTestOutput(ctx *Context, args *LookupWebTestOutputArgs, opts ...InvokeOption) LookupWebTestResultOutput

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

    public static class GetWebTest 
    {
        public static Task<GetWebTestResult> InvokeAsync(GetWebTestArgs args, InvokeOptions? opts = null)
        public static Output<GetWebTestResult> Invoke(GetWebTestInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetWebTestResult> getWebTest(GetWebTestArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:insights:getWebTest
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string

    The name of the resource group. The name is case insensitive.

    WebTestName string

    The name of the Application Insights WebTest resource.

    ResourceGroupName string

    The name of the resource group. The name is case insensitive.

    WebTestName string

    The name of the Application Insights WebTest resource.

    resourceGroupName String

    The name of the resource group. The name is case insensitive.

    webTestName String

    The name of the Application Insights WebTest resource.

    resourceGroupName string

    The name of the resource group. The name is case insensitive.

    webTestName string

    The name of the Application Insights WebTest resource.

    resource_group_name str

    The name of the resource group. The name is case insensitive.

    web_test_name str

    The name of the Application Insights WebTest resource.

    resourceGroupName String

    The name of the resource group. The name is case insensitive.

    webTestName String

    The name of the Application Insights WebTest resource.

    getWebTest Result

    The following output properties are available:

    Id string

    Azure resource Id

    Location string

    Resource location

    Locations List<Pulumi.AzureNative.Insights.Outputs.WebTestGeolocationResponse>

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

    Name string

    Azure resource name

    ProvisioningState 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.

    SyntheticMonitorId string

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

    Type string

    Azure resource type

    WebTestKind string

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

    WebTestName string

    User defined name if this WebTest.

    Configuration Pulumi.AzureNative.Insights.Outputs.WebTestPropertiesResponseConfiguration

    An XML configuration specification for a WebTest.

    Description string

    User defined description for this WebTest.

    Enabled bool

    Is the test actively being monitored.

    Frequency int

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

    Kind string

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

    Request Pulumi.AzureNative.Insights.Outputs.WebTestPropertiesResponseRequest

    The collection of request properties

    RetryEnabled bool

    Allow for retries should this WebTest fail.

    Tags Dictionary<string, string>

    Resource tags

    Timeout int

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

    ValidationRules Pulumi.AzureNative.Insights.Outputs.WebTestPropertiesResponseValidationRules

    The collection of validation rule properties

    Id string

    Azure resource Id

    Location string

    Resource location

    Locations []WebTestGeolocationResponse

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

    Name string

    Azure resource name

    ProvisioningState 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.

    SyntheticMonitorId string

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

    Type string

    Azure resource type

    WebTestKind string

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

    WebTestName string

    User defined name if this WebTest.

    Configuration WebTestPropertiesResponseConfiguration

    An XML configuration specification for a WebTest.

    Description string

    User defined description for this WebTest.

    Enabled bool

    Is the test actively being monitored.

    Frequency int

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

    Kind string

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

    Request WebTestPropertiesResponseRequest

    The collection of request properties

    RetryEnabled bool

    Allow for retries should this WebTest fail.

    Tags map[string]string

    Resource tags

    Timeout int

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

    ValidationRules WebTestPropertiesResponseValidationRules

    The collection of validation rule properties

    id String

    Azure resource Id

    location String

    Resource location

    locations List<WebTestGeolocationResponse>

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

    name String

    Azure resource name

    provisioningState 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.

    syntheticMonitorId String

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

    type String

    Azure resource type

    webTestKind String

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

    webTestName String

    User defined name if this WebTest.

    configuration WebTestPropertiesResponseConfiguration

    An XML configuration specification for a WebTest.

    description String

    User defined description for this WebTest.

    enabled Boolean

    Is the test actively being monitored.

    frequency Integer

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

    kind String

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

    request WebTestPropertiesResponseRequest

    The collection of request properties

    retryEnabled Boolean

    Allow for retries should this WebTest fail.

    tags Map<String,String>

    Resource tags

    timeout Integer

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

    validationRules WebTestPropertiesResponseValidationRules

    The collection of validation rule properties

    id string

    Azure resource Id

    location string

    Resource location

    locations WebTestGeolocationResponse[]

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

    name string

    Azure resource name

    provisioningState 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.

    syntheticMonitorId string

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

    type string

    Azure resource type

    webTestKind string

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

    webTestName string

    User defined name if this WebTest.

    configuration WebTestPropertiesResponseConfiguration

    An XML configuration specification for a WebTest.

    description string

    User defined description for this WebTest.

    enabled boolean

    Is the test actively being monitored.

    frequency number

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

    kind string

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

    request WebTestPropertiesResponseRequest

    The collection of request properties

    retryEnabled boolean

    Allow for retries should this WebTest fail.

    tags {[key: string]: string}

    Resource tags

    timeout number

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

    validationRules WebTestPropertiesResponseValidationRules

    The collection of validation rule properties

    id str

    Azure resource Id

    location str

    Resource location

    locations Sequence[WebTestGeolocationResponse]

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

    name str

    Azure resource name

    provisioning_state str

    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.

    synthetic_monitor_id str

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

    type str

    Azure resource type

    web_test_kind str

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

    web_test_name str

    User defined name if this WebTest.

    configuration WebTestPropertiesResponseConfiguration

    An XML configuration specification for a WebTest.

    description str

    User defined description for this WebTest.

    enabled bool

    Is the test actively being monitored.

    frequency int

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

    kind str

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

    request WebTestPropertiesResponseRequest

    The collection of request properties

    retry_enabled bool

    Allow for retries should this WebTest fail.

    tags Mapping[str, str]

    Resource tags

    timeout int

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

    validation_rules WebTestPropertiesResponseValidationRules

    The collection of validation rule properties

    id String

    Azure resource Id

    location String

    Resource location

    locations List<Property Map>

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

    name String

    Azure resource name

    provisioningState 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.

    syntheticMonitorId String

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

    type String

    Azure resource type

    webTestKind String

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

    webTestName String

    User defined name if this WebTest.

    configuration Property Map

    An XML configuration specification for a WebTest.

    description String

    User defined description for this WebTest.

    enabled Boolean

    Is the test actively being monitored.

    frequency Number

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

    kind String

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

    request Property Map

    The collection of request properties

    retryEnabled Boolean

    Allow for retries should this WebTest fail.

    tags Map<String>

    Resource tags

    timeout Number

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

    validationRules Property Map

    The collection of validation rule properties

    Supporting Types

    HeaderFieldResponse

    HeaderFieldName string

    The name of the header.

    HeaderFieldValue string

    The value of the header.

    HeaderFieldName string

    The name of the header.

    HeaderFieldValue string

    The value of the header.

    headerFieldName String

    The name of the header.

    headerFieldValue String

    The value of the header.

    headerFieldName string

    The name of the header.

    headerFieldValue string

    The value of the header.

    header_field_name str

    The name of the header.

    header_field_value str

    The value of the header.

    headerFieldName String

    The name of the header.

    headerFieldValue String

    The value of the header.

    WebTestGeolocationResponse

    Location string

    Location ID for the WebTest to run from.

    Location string

    Location ID for the WebTest to run from.

    location String

    Location ID for the WebTest to run from.

    location string

    Location ID for the WebTest to run from.

    location str

    Location ID for the WebTest to run from.

    location String

    Location ID for the WebTest to run from.

    WebTestPropertiesResponseConfiguration

    WebTest string

    The XML specification of a WebTest to run against an application.

    WebTest string

    The XML specification of a WebTest to run against an application.

    webTest String

    The XML specification of a WebTest to run against an application.

    webTest string

    The XML specification of a WebTest to run against an application.

    web_test str

    The XML specification of a WebTest to run against an application.

    webTest String

    The XML specification of a WebTest to run against an application.

    WebTestPropertiesResponseContentValidation

    ContentMatch string

    Content to look for in the return of the WebTest. Must not be null or empty.

    IgnoreCase bool

    When set, this value makes the ContentMatch validation case insensitive.

    PassIfTextFound bool

    When true, validation will pass if there is a match for the ContentMatch string. If false, validation will fail if there is a match

    ContentMatch string

    Content to look for in the return of the WebTest. Must not be null or empty.

    IgnoreCase bool

    When set, this value makes the ContentMatch validation case insensitive.

    PassIfTextFound bool

    When true, validation will pass if there is a match for the ContentMatch string. If false, validation will fail if there is a match

    contentMatch String

    Content to look for in the return of the WebTest. Must not be null or empty.

    ignoreCase Boolean

    When set, this value makes the ContentMatch validation case insensitive.

    passIfTextFound Boolean

    When true, validation will pass if there is a match for the ContentMatch string. If false, validation will fail if there is a match

    contentMatch string

    Content to look for in the return of the WebTest. Must not be null or empty.

    ignoreCase boolean

    When set, this value makes the ContentMatch validation case insensitive.

    passIfTextFound boolean

    When true, validation will pass if there is a match for the ContentMatch string. If false, validation will fail if there is a match

    content_match str

    Content to look for in the return of the WebTest. Must not be null or empty.

    ignore_case bool

    When set, this value makes the ContentMatch validation case insensitive.

    pass_if_text_found bool

    When true, validation will pass if there is a match for the ContentMatch string. If false, validation will fail if there is a match

    contentMatch String

    Content to look for in the return of the WebTest. Must not be null or empty.

    ignoreCase Boolean

    When set, this value makes the ContentMatch validation case insensitive.

    passIfTextFound Boolean

    When true, validation will pass if there is a match for the ContentMatch string. If false, validation will fail if there is a match

    WebTestPropertiesResponseRequest

    FollowRedirects bool

    Follow redirects for this web test.

    Headers List<Pulumi.AzureNative.Insights.Inputs.HeaderFieldResponse>

    List of headers and their values to add to the WebTest call.

    HttpVerb string

    Http verb to use for this web test.

    ParseDependentRequests bool

    Parse Dependent request for this WebTest.

    RequestBody string

    Base64 encoded string body to send with this web test.

    RequestUrl string

    Url location to test.

    FollowRedirects bool

    Follow redirects for this web test.

    Headers []HeaderFieldResponse

    List of headers and their values to add to the WebTest call.

    HttpVerb string

    Http verb to use for this web test.

    ParseDependentRequests bool

    Parse Dependent request for this WebTest.

    RequestBody string

    Base64 encoded string body to send with this web test.

    RequestUrl string

    Url location to test.

    followRedirects Boolean

    Follow redirects for this web test.

    headers List<HeaderFieldResponse>

    List of headers and their values to add to the WebTest call.

    httpVerb String

    Http verb to use for this web test.

    parseDependentRequests Boolean

    Parse Dependent request for this WebTest.

    requestBody String

    Base64 encoded string body to send with this web test.

    requestUrl String

    Url location to test.

    followRedirects boolean

    Follow redirects for this web test.

    headers HeaderFieldResponse[]

    List of headers and their values to add to the WebTest call.

    httpVerb string

    Http verb to use for this web test.

    parseDependentRequests boolean

    Parse Dependent request for this WebTest.

    requestBody string

    Base64 encoded string body to send with this web test.

    requestUrl string

    Url location to test.

    follow_redirects bool

    Follow redirects for this web test.

    headers Sequence[HeaderFieldResponse]

    List of headers and their values to add to the WebTest call.

    http_verb str

    Http verb to use for this web test.

    parse_dependent_requests bool

    Parse Dependent request for this WebTest.

    request_body str

    Base64 encoded string body to send with this web test.

    request_url str

    Url location to test.

    followRedirects Boolean

    Follow redirects for this web test.

    headers List<Property Map>

    List of headers and their values to add to the WebTest call.

    httpVerb String

    Http verb to use for this web test.

    parseDependentRequests Boolean

    Parse Dependent request for this WebTest.

    requestBody String

    Base64 encoded string body to send with this web test.

    requestUrl String

    Url location to test.

    WebTestPropertiesResponseValidationRules

    ContentValidation Pulumi.AzureNative.Insights.Inputs.WebTestPropertiesResponseContentValidation

    The collection of content validation properties

    ExpectedHttpStatusCode int

    Validate that the WebTest returns the http status code provided.

    IgnoreHttpStatusCode bool

    When set, validation will ignore the status code.

    SSLCertRemainingLifetimeCheck int

    A number of days to check still remain before the the existing SSL cert expires. Value must be positive and the SSLCheck must be set to true.

    SSLCheck bool

    Checks to see if the SSL cert is still valid.

    ContentValidation WebTestPropertiesResponseContentValidation

    The collection of content validation properties

    ExpectedHttpStatusCode int

    Validate that the WebTest returns the http status code provided.

    IgnoreHttpStatusCode bool

    When set, validation will ignore the status code.

    SSLCertRemainingLifetimeCheck int

    A number of days to check still remain before the the existing SSL cert expires. Value must be positive and the SSLCheck must be set to true.

    SSLCheck bool

    Checks to see if the SSL cert is still valid.

    contentValidation WebTestPropertiesResponseContentValidation

    The collection of content validation properties

    expectedHttpStatusCode Integer

    Validate that the WebTest returns the http status code provided.

    ignoreHttpStatusCode Boolean

    When set, validation will ignore the status code.

    sSLCertRemainingLifetimeCheck Integer

    A number of days to check still remain before the the existing SSL cert expires. Value must be positive and the SSLCheck must be set to true.

    sSLCheck Boolean

    Checks to see if the SSL cert is still valid.

    contentValidation WebTestPropertiesResponseContentValidation

    The collection of content validation properties

    expectedHttpStatusCode number

    Validate that the WebTest returns the http status code provided.

    ignoreHttpStatusCode boolean

    When set, validation will ignore the status code.

    sSLCertRemainingLifetimeCheck number

    A number of days to check still remain before the the existing SSL cert expires. Value must be positive and the SSLCheck must be set to true.

    sSLCheck boolean

    Checks to see if the SSL cert is still valid.

    content_validation WebTestPropertiesResponseContentValidation

    The collection of content validation properties

    expected_http_status_code int

    Validate that the WebTest returns the http status code provided.

    ignore_http_status_code bool

    When set, validation will ignore the status code.

    s_sl_cert_remaining_lifetime_check int

    A number of days to check still remain before the the existing SSL cert expires. Value must be positive and the SSLCheck must be set to true.

    s_sl_check bool

    Checks to see if the SSL cert is still valid.

    contentValidation Property Map

    The collection of content validation properties

    expectedHttpStatusCode Number

    Validate that the WebTest returns the http status code provided.

    ignoreHttpStatusCode Boolean

    When set, validation will ignore the status code.

    sSLCertRemainingLifetimeCheck Number

    A number of days to check still remain before the the existing SSL cert expires. Value must be positive and the SSLCheck must be set to true.

    sSLCheck Boolean

    Checks to see if the SSL cert is still valid.

    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.9.0 published on Wednesday, Sep 27, 2023 by Pulumi