insights.azure.com/v1api20180501preview

insights.azure.com/v1api20180501preview

Package v1api20180501preview contains API Schema definitions for the insights v1api20180501preview API group

Resource Types:

    APIVersion (string alias)

    Value Description

    "2018-05-01-preview"

    HeaderField

    (Appears on:WebTestProperties_Request)

    A header to add to the WebTest.

    Field Description
    key
    string

    Key: The name of the header.

    value
    string

    Value: The value of the header.

    HeaderField_ARM

    (Appears on:WebTestProperties_Request_ARM)

    A header to add to the WebTest.

    Field Description
    key
    string

    Key: The name of the header.

    value
    string

    Value: The value of the header.

    HeaderField_STATUS

    (Appears on:WebTestProperties_Request_STATUS)

    A header to add to the WebTest.

    Field Description
    key
    string

    Key: The name of the header.

    value
    string

    Value: The value of the header.

    HeaderField_STATUS_ARM

    (Appears on:WebTestProperties_Request_STATUS_ARM)

    A header to add to the WebTest.

    Field Description
    key
    string

    Key: The name of the header.

    value
    string

    Value: The value of the header.

    WebTestGeolocation

    (Appears on:Webtest_Spec)

    Geo-physical location to run a WebTest from. You must specify one or more locations for the test to run from.

    Field Description
    Id
    string

    Id: Location ID for the WebTest to run from.

    WebTestGeolocation_ARM

    (Appears on:WebTestProperties_ARM)

    Geo-physical location to run a WebTest from. You must specify one or more locations for the test to run from.

    Field Description
    Id
    string

    Id: Location ID for the WebTest to run from.

    WebTestGeolocation_STATUS

    (Appears on:Webtest_STATUS)

    Geo-physical location to run a WebTest from. You must specify one or more locations for the test to run from.

    Field Description
    Id
    string

    Id: Location ID for the WebTest to run from.

    WebTestGeolocation_STATUS_ARM

    (Appears on:WebTestProperties_STATUS_ARM)

    Geo-physical location to run a WebTest from. You must specify one or more locations for the test to run from.

    Field Description
    Id
    string

    Id: Location ID for the WebTest to run from.

    WebTestProperties_ARM

    (Appears on:Webtest_Spec_ARM)

    Metadata describing a web test for an Azure resource.

    Field Description
    Configuration
    WebTestProperties_Configuration_ARM

    Configuration: An XML configuration specification for a WebTest.

    Description
    string

    Description: User defined description for this WebTest.

    Enabled
    bool

    Enabled: Is the test actively being monitored.

    Frequency
    int

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

    Kind
    WebTestProperties_Kind_ARM

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

    Locations
    []WebTestGeolocation_ARM

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

    Name
    string

    Name: User defined name if this WebTest.

    Request
    WebTestProperties_Request_ARM

    Request: The collection of request properties

    RetryEnabled
    bool

    RetryEnabled: Allow for retries should this WebTest fail.

    SyntheticMonitorId
    string

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

    Timeout
    int

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

    ValidationRules
    WebTestProperties_ValidationRules_ARM

    ValidationRules: The collection of validation rule properties

    WebTestProperties_Configuration

    (Appears on:Webtest_Spec)

    Field Description
    WebTest
    string

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

    WebTestProperties_Configuration_ARM

    (Appears on:WebTestProperties_ARM)

    Field Description
    WebTest
    string

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

    WebTestProperties_Configuration_STATUS

    (Appears on:Webtest_STATUS)

    Field Description
    WebTest
    string

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

    WebTestProperties_Configuration_STATUS_ARM

    (Appears on:WebTestProperties_STATUS_ARM)

    Field Description
    WebTest
    string

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

    WebTestProperties_Kind (string alias)

    (Appears on:Webtest_Spec)

    Value Description

    "basic"

    "multistep"

    "ping"

    "standard"

    WebTestProperties_Kind_ARM (string alias)

    (Appears on:WebTestProperties_ARM)

    Value Description

    "basic"

    "multistep"

    "ping"

    "standard"

    WebTestProperties_Kind_STATUS (string alias)

    (Appears on:Webtest_STATUS)

    Value Description

    "basic"

    "multistep"

    "ping"

    "standard"

    WebTestProperties_Kind_STATUS_ARM (string alias)

    (Appears on:WebTestProperties_STATUS_ARM)

    Value Description

    "basic"

    "multistep"

    "ping"

    "standard"

    WebTestProperties_Request

    (Appears on:Webtest_Spec)

    Field Description
    FollowRedirects
    bool

    FollowRedirects: Follow redirects for this web test.

    Headers
    []HeaderField

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

    HttpVerb
    string

    HttpVerb: Http verb to use for this web test.

    ParseDependentRequests
    bool

    ParseDependentRequests: Parse Dependent request for this WebTest.

    RequestBody
    string

    RequestBody: Base64 encoded string body to send with this web test.

    RequestUrl
    string

    RequestUrl: Url location to test.

    WebTestProperties_Request_ARM

    (Appears on:WebTestProperties_ARM)

    Field Description
    FollowRedirects
    bool

    FollowRedirects: Follow redirects for this web test.

    Headers
    []HeaderField_ARM

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

    HttpVerb
    string

    HttpVerb: Http verb to use for this web test.

    ParseDependentRequests
    bool

    ParseDependentRequests: Parse Dependent request for this WebTest.

    RequestBody
    string

    RequestBody: Base64 encoded string body to send with this web test.

    RequestUrl
    string

    RequestUrl: Url location to test.

    WebTestProperties_Request_STATUS

    (Appears on:Webtest_STATUS)

    Field Description
    FollowRedirects
    bool

    FollowRedirects: Follow redirects for this web test.

    Headers
    []HeaderField_STATUS

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

    HttpVerb
    string

    HttpVerb: Http verb to use for this web test.

    ParseDependentRequests
    bool

    ParseDependentRequests: Parse Dependent request for this WebTest.

    RequestBody
    string

    RequestBody: Base64 encoded string body to send with this web test.

    RequestUrl
    string

    RequestUrl: Url location to test.

    WebTestProperties_Request_STATUS_ARM

    (Appears on:WebTestProperties_STATUS_ARM)

    Field Description
    FollowRedirects
    bool

    FollowRedirects: Follow redirects for this web test.

    Headers
    []HeaderField_STATUS_ARM

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

    HttpVerb
    string

    HttpVerb: Http verb to use for this web test.

    ParseDependentRequests
    bool

    ParseDependentRequests: Parse Dependent request for this WebTest.

    RequestBody
    string

    RequestBody: Base64 encoded string body to send with this web test.

    RequestUrl
    string

    RequestUrl: Url location to test.

    WebTestProperties_STATUS_ARM

    (Appears on:Webtest_STATUS_ARM)

    Metadata describing a web test for an Azure resource.

    Field Description
    Configuration
    WebTestProperties_Configuration_STATUS_ARM

    Configuration: An XML configuration specification for a WebTest.

    Description
    string

    Description: User defined description for this WebTest.

    Enabled
    bool

    Enabled: Is the test actively being monitored.

    Frequency
    int

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

    Kind
    WebTestProperties_Kind_STATUS_ARM

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

    Locations
    []WebTestGeolocation_STATUS_ARM

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

    Name
    string

    Name: User defined name if this WebTest.

    provisioningState
    string

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

    Request
    WebTestProperties_Request_STATUS_ARM

    Request: The collection of request properties

    RetryEnabled
    bool

    RetryEnabled: Allow for retries should this WebTest fail.

    SyntheticMonitorId
    string

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

    Timeout
    int

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

    ValidationRules
    WebTestProperties_ValidationRules_STATUS_ARM

    ValidationRules: The collection of validation rule properties

    WebTestProperties_ValidationRules

    (Appears on:Webtest_Spec)

    Field Description
    ContentValidation
    WebTestProperties_ValidationRules_ContentValidation

    ContentValidation: The collection of content validation properties

    ExpectedHttpStatusCode
    int

    ExpectedHttpStatusCode: Validate that the WebTest returns the http status code provided.

    IgnoreHttpsStatusCode
    bool

    IgnoreHttpsStatusCode: When set, validation will ignore the status code.

    SSLCertRemainingLifetimeCheck
    int

    SSLCertRemainingLifetimeCheck: 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

    SSLCheck: Checks to see if the SSL cert is still valid.

    WebTestProperties_ValidationRules_ARM

    (Appears on:WebTestProperties_ARM)

    Field Description
    ContentValidation
    WebTestProperties_ValidationRules_ContentValidation_ARM

    ContentValidation: The collection of content validation properties

    ExpectedHttpStatusCode
    int

    ExpectedHttpStatusCode: Validate that the WebTest returns the http status code provided.

    IgnoreHttpsStatusCode
    bool

    IgnoreHttpsStatusCode: When set, validation will ignore the status code.

    SSLCertRemainingLifetimeCheck
    int

    SSLCertRemainingLifetimeCheck: 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

    SSLCheck: Checks to see if the SSL cert is still valid.

    WebTestProperties_ValidationRules_ContentValidation

    (Appears on:WebTestProperties_ValidationRules)

    Field Description
    ContentMatch
    string

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

    IgnoreCase
    bool

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

    PassIfTextFound
    bool

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

    WebTestProperties_ValidationRules_ContentValidation_ARM

    (Appears on:WebTestProperties_ValidationRules_ARM)

    Field Description
    ContentMatch
    string

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

    IgnoreCase
    bool

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

    PassIfTextFound
    bool

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

    WebTestProperties_ValidationRules_ContentValidation_STATUS

    (Appears on:WebTestProperties_ValidationRules_STATUS)

    Field Description
    ContentMatch
    string

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

    IgnoreCase
    bool

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

    PassIfTextFound
    bool

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

    WebTestProperties_ValidationRules_ContentValidation_STATUS_ARM

    (Appears on:WebTestProperties_ValidationRules_STATUS_ARM)

    Field Description
    ContentMatch
    string

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

    IgnoreCase
    bool

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

    PassIfTextFound
    bool

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

    WebTestProperties_ValidationRules_STATUS

    (Appears on:Webtest_STATUS)

    Field Description
    ContentValidation
    WebTestProperties_ValidationRules_ContentValidation_STATUS

    ContentValidation: The collection of content validation properties

    ExpectedHttpStatusCode
    int

    ExpectedHttpStatusCode: Validate that the WebTest returns the http status code provided.

    IgnoreHttpsStatusCode
    bool

    IgnoreHttpsStatusCode: When set, validation will ignore the status code.

    SSLCertRemainingLifetimeCheck
    int

    SSLCertRemainingLifetimeCheck: 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

    SSLCheck: Checks to see if the SSL cert is still valid.

    WebTestProperties_ValidationRules_STATUS_ARM

    (Appears on:WebTestProperties_STATUS_ARM)

    Field Description
    ContentValidation
    WebTestProperties_ValidationRules_ContentValidation_STATUS_ARM

    ContentValidation: The collection of content validation properties

    ExpectedHttpStatusCode
    int

    ExpectedHttpStatusCode: Validate that the WebTest returns the http status code provided.

    IgnoreHttpsStatusCode
    bool

    IgnoreHttpsStatusCode: When set, validation will ignore the status code.

    SSLCertRemainingLifetimeCheck
    int

    SSLCertRemainingLifetimeCheck: 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

    SSLCheck: Checks to see if the SSL cert is still valid.

    Webtest

    Generator information: - Generated from: /applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/webTests_API.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Insights/​webtests/​{webTestName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Webtest_Spec


    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    Configuration
    WebTestProperties_Configuration

    Configuration: An XML configuration specification for a WebTest.

    Description
    string

    Description: User defined description for this WebTest.

    Enabled
    bool

    Enabled: Is the test actively being monitored.

    Frequency
    int

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

    Kind
    WebTestProperties_Kind

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

    location
    string

    Location: Resource location

    Locations
    []WebTestGeolocation

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

    Name
    string

    Name: User defined name if this WebTest.

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

    Request
    WebTestProperties_Request

    Request: The collection of request properties

    RetryEnabled
    bool

    RetryEnabled: Allow for retries should this WebTest fail.

    SyntheticMonitorId
    string

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

    tags
    map[string]string

    Tags: Resource tags

    Timeout
    int

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

    ValidationRules
    WebTestProperties_ValidationRules

    ValidationRules: The collection of validation rule properties

    status
    Webtest_STATUS

    Webtest_STATUS

    (Appears on:Webtest)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    Configuration
    WebTestProperties_Configuration_STATUS

    Configuration: An XML configuration specification for a WebTest.

    Description
    string

    Description: User defined description for this WebTest.

    Enabled
    bool

    Enabled: Is the test actively being monitored.

    Frequency
    int

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

    id
    string

    Id: Azure resource Id

    Kind
    WebTestProperties_Kind_STATUS

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

    location
    string

    Location: Resource location

    Locations
    []WebTestGeolocation_STATUS

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

    name
    string

    Name: Azure resource name

    properties_name
    string

    PropertiesName: User defined name if this WebTest.

    provisioningState
    string

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

    Request
    WebTestProperties_Request_STATUS

    Request: The collection of request properties

    RetryEnabled
    bool

    RetryEnabled: Allow for retries should this WebTest fail.

    SyntheticMonitorId
    string

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

    tags
    map[string]string

    Tags: Resource tags

    Timeout
    int

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

    type
    string

    Type: Azure resource type

    ValidationRules
    WebTestProperties_ValidationRules_STATUS

    ValidationRules: The collection of validation rule properties

    Webtest_STATUS_ARM

    Field Description
    id
    string

    Id: Azure resource Id

    location
    string

    Location: Resource location

    name
    string

    Name: Azure resource name

    properties
    WebTestProperties_STATUS_ARM

    Properties: Metadata describing a web test for an Azure resource.

    tags
    map[string]string

    Tags: Resource tags

    type
    string

    Type: Azure resource type

    Webtest_Spec

    (Appears on:Webtest)

    Field Description
    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    Configuration
    WebTestProperties_Configuration

    Configuration: An XML configuration specification for a WebTest.

    Description
    string

    Description: User defined description for this WebTest.

    Enabled
    bool

    Enabled: Is the test actively being monitored.

    Frequency
    int

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

    Kind
    WebTestProperties_Kind

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

    location
    string

    Location: Resource location

    Locations
    []WebTestGeolocation

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

    Name
    string

    Name: User defined name if this WebTest.

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

    Request
    WebTestProperties_Request

    Request: The collection of request properties

    RetryEnabled
    bool

    RetryEnabled: Allow for retries should this WebTest fail.

    SyntheticMonitorId
    string

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

    tags
    map[string]string

    Tags: Resource tags

    Timeout
    int

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

    ValidationRules
    WebTestProperties_ValidationRules

    ValidationRules: The collection of validation rule properties

    Webtest_Spec_ARM

    Field Description
    location
    string

    Location: Resource location

    name
    string
    properties
    WebTestProperties_ARM

    Properties: Metadata describing a web test for an Azure resource.

    tags
    map[string]string

    Tags: Resource tags