Web Tests - Get

Dienst:

Application Insights

API-Version:

2022-06-15

Rufen Sie eine bestimmte Application Insights-Webtestdefinition ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
webTestName	path	True	string	Der Name der Application Insights WebTest-Ressource.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	WebTest	Ann Application Insights-Webtestdefinition.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

webTestGet

Beispielanforderung

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

Beispiel für eine Antwort

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"
  }
}

Definitionen

Name	Beschreibung
Configuration	Eine XML-Konfigurationsspezifikation für einen WebTest.
ContentValidation	Die Sammlung von Inhaltsüberprüfungseigenschaften
HeaderField	Eine Kopfzeile, die dem WebTest hinzugefügt werden soll.
Request	Die Sammlung von Anforderungseigenschaften
ValidationRules	Die Auflistung von Gültigkeitsregeleigenschaften
WebTest	Eine Application Insights WebTest-Definition.
WebTestGeolocation	Geo-physischer Standort zum Ausführen eines WebTest von. Sie müssen mindestens einen Speicherort angeben, aus dem der Test ausgeführt werden soll.
WebTestKind	Die Art von WebTest, die von diesem Webtest überwacht wird. Auswahlmöglichkeiten sind Ping, Mehrschritte und Standard.

Configuration

Objekt

Eine XML-Konfigurationsspezifikation für einen WebTest.

Name	Typ	Beschreibung
WebTest	string	Die XML-Spezifikation eines WebTest-Elements, das für eine Anwendung ausgeführt werden soll.

ContentValidation

Objekt

Die Sammlung von Inhaltsüberprüfungseigenschaften

Name	Typ	Beschreibung
ContentMatch	string	Inhalt, der in der Rückgabe von WebTest gesucht werden soll. Darf nicht null oder leer sein.
IgnoreCase	boolean	Wenn dieser Wert festgelegt ist, wird die Groß-/Kleinschreibung der ContentMatch-Überprüfung nicht beachtet.
PassIfTextFound	boolean	Wenn true, wird die Überprüfung übergeben, wenn eine Übereinstimmung für die ContentMatch-Zeichenfolge vorhanden ist. Bei "False" schlägt die Überprüfung fehl, wenn eine Übereinstimmung vorhanden ist.

HeaderField

Objekt

Eine Kopfzeile, die dem WebTest hinzugefügt werden soll.

Name	Typ	Beschreibung
key	string	Der Name der Kopfzeile.
value	string	Der Wert der Kopfzeile.

Request

Objekt

Die Sammlung von Anforderungseigenschaften

Name	Typ	Beschreibung
FollowRedirects	boolean	Folgen Sie Umleitungen für diesen Webtest.
Headers	HeaderField[]	Liste der Kopfzeilen und deren Werte, die dem WebTest-Aufruf hinzugefügt werden sollen.
HttpVerb	string	Http-Verb, das für diesen Webtest verwendet werden soll.
ParseDependentRequests	boolean	Analysieren der abhängigen Anforderung für diesen WebTest.
RequestBody	string	Base64-codierter Zeichenfolgentext, der mit diesem Webtest gesendet werden soll.
RequestUrl	string	Url-Speicherort, der getestet werden soll.

ValidationRules

Objekt

Die Auflistung von Gültigkeitsregeleigenschaften

Name	Typ	Beschreibung
ContentValidation	ContentValidation	Die Sammlung von Inhaltsüberprüfungseigenschaften
ExpectedHttpStatusCode	integer (int32)	Überprüfen Sie, ob der WebTest den bereitgestellten HTTP-Statuscode zurückgibt.
IgnoreHttpStatusCode	boolean	Bei Festlegung ignoriert die Überprüfung den Statuscode.
SSLCertRemainingLifetimeCheck	integer (int32)	Eine Anzahl von Tagen, die noch überprüft werden müssen, bevor das vorhandene SSL-Zertifikat abläuft. Der Wert muss positiv sein, und der SSLCheck muss auf "true" festgelegt werden.
SSLCheck	boolean	Überprüft, ob das SSL-Zertifikat noch gültig ist.

WebTest

Objekt

Eine Application Insights WebTest-Definition.

Name	Typ	Standardwert	Beschreibung
id	string		Azure-Ressourcen-ID
kind	WebTestKind	ping	Die Art von WebTest, die von diesem Webtest überwacht wird. Auswahlmöglichkeiten sind Ping, Mehrschritte und Standard.
location	string		Ressourcenspeicherort
name	string		Azure-Ressourcenname
properties.Configuration	Configuration		Eine XML-Konfigurationsspezifikation für einen WebTest.
properties.Description	string		Benutzerdefinierte Beschreibung für diesen WebTest.
properties.Enabled	boolean		Wird der Test aktiv überwacht.
properties.Frequency	integer (int32)	300	Intervall in Sekunden zwischen Testläufen für diesen WebTest. Der Standardwert ist 300.
properties.Kind	WebTestKind	ping	Dies ist die Art des Webtests, die gültige Auswahlmöglichkeiten sind Ping, Multisteps und Standard.
properties.Locations	WebTestGeolocation[]		Eine Liste, in der die Tests physisch ausgeführt werden sollen, um eine globale Abdeckung für die Barrierefreiheit Ihrer Anwendung zu ermöglichen.
properties.Name	string		Benutzerdefinierter Name, wenn dieser WebTest.
properties.Request	Request		Die Sammlung von Anforderungseigenschaften
properties.RetryEnabled	boolean		Fehler beim Zulassen von Wiederholungen, wenn dieser WebTest fehlschlägt.
properties.SyntheticMonitorId	string		Eindeutige ID dieses WebTest. Dies ist in der Regel derselbe Wert wie das Feld "Name".
properties.Timeout	integer (int32)	30	Sekunden, bis dieser WebTest timeout und fehlschlägt. Der Standardwert ist 30.
properties.ValidationRules	ValidationRules		Die Auflistung von Gültigkeitsregeleigenschaften
properties.provisioningState	string		Aktueller Status dieser Komponente, unabhängig davon, ob sie innerhalb der Ressourcengruppe bereitgestellt wurde, die sie definiert ist. Benutzer können diesen Wert nicht ändern, können aber daraus lesen. Die Werte umfassen "Erfolgreich", "Bereitstellen", "Abgebrochen" und "Fehlgeschlagen".
tags	object		Ressourcentags
type	string		Azure-Ressourcentyp

WebTestGeolocation

Objekt

Geo-physischer Standort zum Ausführen eines WebTest von. Sie müssen mindestens einen Speicherort angeben, aus dem der Test ausgeführt werden soll.

Name	Typ	Beschreibung
Id	string	Standort-ID für webTest, von der aus ausgeführt werden soll.

WebTestKind

Enumeration

Die Art von WebTest, die von diesem Webtest überwacht wird. Auswahlmöglichkeiten sind Ping, Mehrschritte und Standard.

Wert	Beschreibung
multistep
ping
standard