Web Tests - List By Component

Service:

Application Insights

API Version:

2022-06-15

Rufen Sie alle Application Insights-Webtests ab, die für die angegebene Komponente definiert sind.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
componentName	path	True	string	Der Name der Application Insights-Komponentenressource.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	webTestListResult	Eine Liste mit mindestens 0 Webtestdefinitionen.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

webTestListByComponent

Sample Request

HTTP

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

Java

/** Samples for WebTests ListByComponent. */
public final class Main {
    /*
     * x-ms-original-file: specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2022-06-15/examples/WebTestListByComponent.json
     */
    /**
     * Sample code: webTestListByComponent.
     *
     * @param manager Entry point to ApplicationInsightsManager.
     */
    public static void webTestListByComponent(
        com.azure.resourcemanager.applicationinsights.ApplicationInsightsManager manager) {
        manager.webTests().listByComponent("my-component", "my-resource-group", 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_list_by_component.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.list_by_component(
        component_name="my-component",
        resource_group_name="my-resource-group",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2022-06-15/examples/WebTestListByComponent.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

dotnet

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

// Generated from example definition: specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2022-06-15/examples/WebTestListByComponent.json
// this example is just showing the usage of "WebTests_ListByComponent" 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 ApplicationInsightsComponentResource created on azure
// for more information of creating ApplicationInsightsComponentResource, please refer to the document of ApplicationInsightsComponentResource
string subscriptionId = "subid";
string resourceGroupName = "my-resource-group";
string componentName = "my-component";
ResourceIdentifier applicationInsightsComponentResourceId = ApplicationInsightsComponentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, componentName);
ApplicationInsightsComponentResource applicationInsightsComponent = client.GetApplicationInsightsComponentResource(applicationInsightsComponentResourceId);

// invoke the operation and iterate over the result
await foreach (WebTestResource item in applicationInsightsComponent.GetWebTestsAsync())
{
    // the variable item 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
    WebTestData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/my-resource-group/providers/Microsoft.Insights/webtests/my-webtest-my-component",
      "name": "my-webtest-my-component",
      "type": "Microsoft.Insights/webtests",
      "location": "southcentralus",
      "tags": {
        "hidden-link:/subscriptions/subid/resourceGroups/my-resource-group/providers/Microsoft.Insights/components/my-component": "Resource"
      },
      "kind": "ping",
      "properties": {
        "SyntheticMonitorId": "my-webtest-my-component",
        "Name": "my-webtest",
        "Description": "",
        "Enabled": false,
        "Frequency": 900,
        "Timeout": 120,
        "Kind": "ping",
        "RetryEnabled": true,
        "Locations": [
          {
            "Id": "apac-hk-hkn-azr"
          }
        ],
        "Configuration": {
          "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>"
        },
        "provisioningState": "Succeeded"
      }
    }
  ],
  "nextLink": null
}

Definitionen

Name	Beschreibung
Configuration	Eine XML-Konfigurationsspezifikation für einen WebTest.
ContentValidation	Die Auflistung von Inhaltsüberprüfungseigenschaften
HeaderField	Ein Header, der dem WebTest hinzugefügt werden soll.
Request	Die Auflistung der Anforderungseigenschaften
ValidationRules	Die Auflistung der Eigenschaften der Validierungsregel
WebTest	Eine Application Insights-WebTest-Definition.
WebTestGeolocation	Geo-physischer Speicherort, an dem ein WebTest ausgeführt werden soll. Sie müssen mindestens einen Speicherort angeben, an dem der Test ausgeführt werden soll.
WebTestKind	Die Art von WebTest, die dieser Webtest überwacht. Die Wahlmöglichkeiten sind Ping, Mehrschritt und Standard.
webTestListResult	Eine Liste mit mindestens 0 Application Insights WebTest-Definitionen.

Configuration

Eine XML-Konfigurationsspezifikation für einen WebTest.

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

ContentValidation

Die Auflistung von Inhaltsüberprüfungseigenschaften

Name	Typ	Beschreibung
ContentMatch	string	Inhalt, nach dem bei der Rückgabe des 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 ist, wird die Überprüfung erfolgreich ausgeführt, wenn eine Übereinstimmung für die ContentMatch-Zeichenfolge vorhanden ist. Bei false tritt bei der Überprüfung ein Fehler auf, wenn eine Übereinstimmung vorliegt.

HeaderField

Ein Header, der dem WebTest hinzugefügt werden soll.

Name	Typ	Beschreibung
key	string	Der Name des Headers.
value	string	Der Wert des Headers.

Request

Die Auflistung der Anforderungseigenschaften

Name	Typ	Beschreibung
FollowRedirects	boolean	Folgen Sie den Umleitungen für diesen Webtest.
Headers	HeaderField[]	Liste der Header 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 Sie die abhängige Anforderung für diesen WebTest.
RequestBody	string	Base64-codierter Zeichenfolgentext, der mit diesem Webtest gesendet werden soll.
RequestUrl	string	Zu testende URL-Speicherort.

ValidationRules

Die Auflistung der Eigenschaften der Validierungsregel

Name	Typ	Beschreibung
ContentValidation	ContentValidation	Die Auflistung von Inhaltsüberprüfungseigenschaften
ExpectedHttpStatusCode	integer	Überprüfen Sie, ob der WebTest den bereitgestellten HTTP-status Code zurückgibt.
IgnoreHttpStatusCode	boolean	Wenn festgelegt, ignoriert die Überprüfung den status Code.
SSLCertRemainingLifetimeCheck	integer	Es bleiben noch einige Tage zu überprüfen, 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

Eine Application Insights-WebTest-Definition.

Name	Typ	Standardwert	Beschreibung
id	string		Azure-Ressourcen-ID
kind	WebTestKind	ping	Die Art von WebTest, die dieser Webtest überwacht. Die Wahlmöglichkeiten sind Ping, Mehrschritt und Standard.
location	string		Ressourcenspeicherort
name	string		Name der Azure-Ressource
properties.Configuration	Configuration		Eine XML-Konfigurationsspezifikation für einen WebTest.
properties.Description	string		Benutzerdefinierte Beschreibung für diesen WebTest.
properties.Enabled	boolean		Ist der Test, der aktiv überwacht wird.
properties.Frequency	integer	300	Intervall in Sekunden zwischen Testläufen für diesen WebTest. Der Standardwert ist 300.
properties.Kind	WebTestKind	ping	Die Art des Webtests ist dies, gültige Optionen sind Ping, Mehrschritt und Standard.
properties.Locations	WebTestGeolocation[]		Eine Liste, von wo aus die Tests physisch ausgeführt werden sollen, um eine globale Abdeckung für die Barrierefreiheit Ihrer Anwendung zu gewährleisten.
properties.Name	string		Benutzerdefinierter Name, wenn dieser WebTest.
properties.Request	Request		Die Auflistung der Anforderungseigenschaften
properties.RetryEnabled	boolean		Lassen Sie Wiederholungen zu, 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	30	Sekunden, bis für diesen WebTest ein Timeout auftritt und ein Fehler auftritt. Standardwert: 30.
properties.ValidationRules	ValidationRules		Die Auflistung der Eigenschaften der Validierungsregel
properties.provisioningState	string		Aktueller Status dieser Komponente, unabhängig davon, ob innerhalb der definierten Ressourcengruppe bereitgestellt wurde oder nicht. Benutzer können diesen Wert nicht ändern, können aber daraus lesen. Zu den Werten gehören Erfolgreich, Bereitstellen, Abgebrochen und Fehler.
tags	object		Ressourcentags
type	string		Azure-Ressourcentyp

WebTestGeolocation

Geo-physischer Speicherort, an dem ein WebTest ausgeführt werden soll. Sie müssen mindestens einen Speicherort angeben, an dem der Test ausgeführt werden soll.

Name	Typ	Beschreibung
Id	string	Standort-ID für den WebTest, von dem aus ausgeführt werden soll.

WebTestKind

Die Art von WebTest, die dieser Webtest überwacht. Die Wahlmöglichkeiten sind Ping, Mehrschritt und Standard.

Name	Typ	Beschreibung
multistep	string
ping	string
standard	string

webTestListResult

Eine Liste mit mindestens 0 Application Insights WebTest-Definitionen.

Name	Typ	Beschreibung
nextLink	string	Der Link zum Abrufen des nächsten Teils der zurückgegebenen Liste von WebTest, sollte der Rückgabesatz für eine einzelne Anforderung zu groß sein. Ist möglicherweise NULL.
value	WebTest[]	Satz von Application Insights WebTest-Definitionen.