Web Tests - Get

Service:

Application Insights

API-versie:

2022-06-15

Een specifieke Application Insights-webtestdefinitie ophalen.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/webtests/{webTestName}?api-version=2022-06-15

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string minLength: 1	De id van het doelabonnement.
webTestName	path	True	string	De naam van de Application Insights WebTest-resource.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	WebTest	Ann Application Insights-webtestdefinitie.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

webTestGet

Voorbeeldaanvraag

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/my-resource-group/providers/Microsoft.Insights/webtests/my-webtest-01-mywebservice?api-version=2022-06-15

Java

/**
 * Samples for WebTests GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2022-06-15/examples/WebTestGet.json
     */
    /**
     * Sample code: webTestGet.
     * 
     * @param manager Entry point to ApplicationInsightsManager.
     */
    public static void webTestGet(com.azure.resourcemanager.applicationinsights.ApplicationInsightsManager manager) {
        manager.webTests().getByResourceGroupWithResponse("my-resource-group", "my-webtest-01-mywebservice",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.applicationinsights import ApplicationInsightsManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-applicationinsights
# USAGE
    python web_test_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApplicationInsightsManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.web_tests.get(
        resource_group_name="my-resource-group",
        web_test_name="my-webtest-01-mywebservice",
    )
    print(response)


# x-ms-original-file: specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2022-06-15/examples/WebTestGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapplicationinsights_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/applicationinsights/armapplicationinsights/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/8a0168458930c86636a76bcd7acfdc9c81291bfc/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2022-06-15/examples/WebTestGet.json
func ExampleWebTestsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapplicationinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWebTestsClient().Get(ctx, "my-resource-group", "my-webtest-01-mywebservice", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.WebTest = armapplicationinsights.WebTest{
	// 	Name: to.Ptr("my-webtest-01-mywebservice"),
	// 	Type: to.Ptr("Microsoft.Insights/webtests"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/my-test-resources/providers/Microsoft.Insights/webtests/my-webtest-01-mywebservice"),
	// 	Location: to.Ptr("southcentralus"),
	// 	Tags: map[string]*string{
	// 		"hidden-link:/subscriptions/subid/resourceGroups/my-test-resources/providers/Microsoft.Insights/components/mytester": to.Ptr("Resource"),
	// 	},
	// 	Kind: to.Ptr(armapplicationinsights.WebTestKindPing),
	// 	Properties: &armapplicationinsights.WebTestProperties{
	// 		Configuration: &armapplicationinsights.WebTestPropertiesConfiguration{
	// 			WebTest: to.Ptr("<WebTest Name=\"mytest-webtest-01\" Id=\"0317d26b-8672-4370-bd6b-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=\"a55ce143-4f1e-a7e6-b69e-123456789abc\" Version=\"1.1\" Url=\"http://mytester.azurewebsites.net\" ThinkTime=\"0\" Timeout=\"30\" ParseDependentRequests=\"False\" FollowRedirects=\"True\" RecordResult=\"True\" Cache=\"False\" ResponseTimeGoal=\"0\" Encoding=\"utf-8\" ExpectedHttpStatusCode=\"200\" ExpectedResponseUrl=\"\" ReportingName=\"\" IgnoreHttpStatusCode=\"False\" /></Items></WebTest>"),
	// 		},
	// 		Description: to.Ptr(""),
	// 		Enabled: to.Ptr(false),
	// 		Frequency: to.Ptr[int32](900),
	// 		WebTestKind: to.Ptr(armapplicationinsights.WebTestKindPing),
	// 		Locations: []*armapplicationinsights.WebTestGeolocation{
	// 			{
	// 				Location: to.Ptr("us-fl-mia-edge"),
	// 			},
	// 			{
	// 				Location: to.Ptr("apac-hk-hkn-azr"),
	// 		}},
	// 		WebTestName: to.Ptr("mytest-webtest-01"),
	// 		RetryEnabled: to.Ptr(true),
	// 		SyntheticMonitorID: to.Ptr("my-webtest-01-mywebservice"),
	// 		Timeout: to.Ptr[int32](30),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApplicationInsightsManagementClient } = require("@azure/arm-appinsights");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Get a specific Application Insights web test definition.
 *
 * @summary Get a specific Application Insights web test definition.
 * x-ms-original-file: specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2022-06-15/examples/WebTestGet.json
 */
async function webTestGet() {
  const subscriptionId = process.env["APPLICATIONINSIGHTS_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName =
    process.env["APPLICATIONINSIGHTS_RESOURCE_GROUP"] || "my-resource-group";
  const webTestName = "my-webtest-01-mywebservice";
  const credential = new DefaultAzureCredential();
  const client = new ApplicationInsightsManagementClient(credential, subscriptionId);
  const result = await client.webTests.get(resourceGroupName, webTestName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApplicationInsights.Models;
using Azure.ResourceManager.ApplicationInsights;

// Generated from example definition: specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2022-06-15/examples/WebTestGet.json
// this example is just showing the usage of "WebTests_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApplicationInsightsWebTestResource created on azure
// for more information of creating ApplicationInsightsWebTestResource, please refer to the document of ApplicationInsightsWebTestResource
string subscriptionId = "subid";
string resourceGroupName = "my-resource-group";
string webTestName = "my-webtest-01-mywebservice";
ResourceIdentifier applicationInsightsWebTestResourceId = ApplicationInsightsWebTestResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, webTestName);
ApplicationInsightsWebTestResource applicationInsightsWebTest = client.GetApplicationInsightsWebTestResource(applicationInsightsWebTestResourceId);

// invoke the operation
ApplicationInsightsWebTestResource result = await applicationInsightsWebTest.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ApplicationInsightsWebTestData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Voorbeeldrespons

Statuscode:

200

{
  "id": "/subscriptions/subid/resourceGroups/my-test-resources/providers/Microsoft.Insights/webtests/my-webtest-01-mywebservice",
  "name": "my-webtest-01-mywebservice",
  "type": "Microsoft.Insights/webtests",
  "location": "southcentralus",
  "tags": {
    "hidden-link:/subscriptions/subid/resourceGroups/my-test-resources/providers/Microsoft.Insights/components/mytester": "Resource"
  },
  "kind": "ping",
  "properties": {
    "SyntheticMonitorId": "my-webtest-01-mywebservice",
    "Name": "mytest-webtest-01",
    "Description": "",
    "Enabled": false,
    "Frequency": 900,
    "Timeout": 30,
    "Kind": "ping",
    "RetryEnabled": true,
    "Locations": [
      {
        "Id": "us-fl-mia-edge"
      },
      {
        "Id": "apac-hk-hkn-azr"
      }
    ],
    "Configuration": {
      "WebTest": "<WebTest Name=\"mytest-webtest-01\" Id=\"0317d26b-8672-4370-bd6b-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=\"a55ce143-4f1e-a7e6-b69e-123456789abc\" Version=\"1.1\" Url=\"http://mytester.azurewebsites.net\" ThinkTime=\"0\" Timeout=\"30\" ParseDependentRequests=\"False\" FollowRedirects=\"True\" RecordResult=\"True\" Cache=\"False\" ResponseTimeGoal=\"0\" Encoding=\"utf-8\" ExpectedHttpStatusCode=\"200\" ExpectedResponseUrl=\"\" ReportingName=\"\" IgnoreHttpStatusCode=\"False\" /></Items></WebTest>"
    },
    "provisioningState": "Succeeded"
  }
}

Definities

Name	Description
Configuration	Een XML-configuratiespecificatie voor een WebTest.
ContentValidation	De verzameling eigenschappen van inhoudsvalidatie
HeaderField	Een header die moet worden toegevoegd aan de WebTest.
Request	De verzameling aanvraageigenschappen
ValidationRules	De verzameling eigenschappen van validatieregels
WebTest	Een Application Insights WebTest-definitie.
WebTestGeolocation	Geo-fysieke locatie voor het uitvoeren van een WebTest vanaf. U moet een of meer locaties opgeven van waaruit de test moet worden uitgevoerd.
WebTestKind	Het type WebTest dat door deze webtest wordt bewaakt. Keuzes zijn ping, multistep en standaard.

Configuration

Object

Een XML-configuratiespecificatie voor een WebTest.

Name	Type	Description
WebTest	string	De XML-specificatie van een WebTest die moet worden uitgevoerd voor een toepassing.

ContentValidation

Object

De verzameling eigenschappen van inhoudsvalidatie

Name	Type	Description
ContentMatch	string	Inhoud die moet worden gezocht in de return van de WebTest. Mag niet null of leeg zijn.
IgnoreCase	boolean	Wanneer deze waarde is ingesteld, is de case voor validatie van ContentMatch niet hoofdlettergevoelig.
PassIfTextFound	boolean	Wanneer waar, wordt de validatie doorgegeven als er een overeenkomst is voor de ContentMatch-tekenreeks. Als dit onwaar is, mislukt de validatie als er een overeenkomst is

HeaderField

Object

Een header die moet worden toegevoegd aan de WebTest.

Name	Type	Description
key	string	De naam van de koptekst.
value	string	De waarde van de koptekst.

Request

Object

De verzameling aanvraageigenschappen

Name	Type	Description
FollowRedirects	boolean	Volg omleidingen voor deze webtest.
Headers	HeaderField[]	Lijst met headers en de bijbehorende waarden om toe te voegen aan de webtest-aanroep.
HttpVerb	string	Http-werkwoord dat moet worden gebruikt voor deze webtest.
ParseDependentRequests	boolean	ParseEr afhankelijke aanvraag voor deze WebTest.
RequestBody	string	Met Base64 gecodeerde tekenreekstekst die met deze webtest moet worden verzonden.
RequestUrl	string	Url-locatie die moet worden getest.

ValidationRules

Object

De verzameling eigenschappen van validatieregels

Name	Type	Description
ContentValidation	ContentValidation	De verzameling eigenschappen van inhoudsvalidatie
ExpectedHttpStatusCode	integer (int32)	Controleer of de WebTest de opgegeven HTTP-statuscode retourneert.
IgnoreHttpStatusCode	boolean	Wanneer deze is ingesteld, negeert de validatie de statuscode.
SSLCertRemainingLifetimeCheck	integer (int32)	Een aantal dagen om te controleren blijft bestaan voordat het bestaande SSL-certificaat verloopt. De waarde moet positief zijn en de SSLCheck moet zijn ingesteld op true.
SSLCheck	boolean	Controleert of het SSL-certificaat nog steeds geldig is.

WebTest

Object

Een Application Insights WebTest-definitie.

Name	Type	Default value	Description
id	string		Azure-resource-id
kind	WebTestKind	ping	Het type WebTest dat door deze webtest wordt bewaakt. Keuzes zijn ping, multistep en standaard.
location	string		Resourcelocatie
name	string		Azure-resourcenaam
properties.Configuration	Configuration		Een XML-configuratiespecificatie voor een WebTest.
properties.Description	string		Door de gebruiker gedefinieerde beschrijving voor deze WebTest.
properties.Enabled	boolean		Wordt de test actief bewaakt.
properties.Frequency	integer (int32)	300	Interval in seconden tussen testuitvoeringen voor deze WebTest. De standaardwaarde is 300.
properties.Kind	WebTestKind	ping	Het soort webtest is dat geldige keuzes zijn ping, multistep en standaard.
properties.Locations	WebTestGeolocation[]		Een lijst met waar u de tests fysiek kunt uitvoeren om globale dekking te bieden voor toegankelijkheid van uw toepassing.
properties.Name	string		Door de gebruiker gedefinieerde naam als deze WebTest.
properties.Request	Request		De verzameling aanvraageigenschappen
properties.RetryEnabled	boolean		Toestaan voor nieuwe pogingen als deze webtest mislukt.
properties.SyntheticMonitorId	string		Unieke id van deze webtest. Dit is doorgaans dezelfde waarde als het veld Naam.
properties.Timeout	integer (int32)	30	Seconden totdat deze WebTest een time-out krijgt en mislukt. De standaardwaarde is 30.
properties.ValidationRules	ValidationRules		De verzameling eigenschappen van validatieregels
properties.provisioningState	string		Huidige status van dit onderdeel, ongeacht of deze al dan niet is ingericht binnen de resourcegroep die is gedefinieerd. Gebruikers kunnen deze waarde niet wijzigen, maar ze kunnen deze wel lezen. Waarden zijn geslaagd, implementeren, annuleren en mislukt.
tags	object		Resourcetags
type	string		Azure-resourcetype

WebTestGeolocation

Object

Geo-fysieke locatie voor het uitvoeren van een WebTest vanaf. U moet een of meer locaties opgeven van waaruit de test moet worden uitgevoerd.

Name	Type	Description
Id	string	Locatie-id voor de WebTest waaruit moet worden uitgevoerd.

WebTestKind

Inventarisatie

Het type WebTest dat door deze webtest wordt bewaakt. Keuzes zijn ping, multistep en standaard.

Waarde	Description
multistep
ping
standard