Web Tests - List By Resource Group

Service:

Application Insights

API Version:

2022-06-15

Obtenez tous les tests web Application Insights définis pour le groupe de ressources spécifié.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	webTestListResult	Liste contenant au moins 0 définitions de test web.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

webTestListByResourceGroup

Sample Request

HTTP

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

Java

/** Samples for WebTests ListByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2022-06-15/examples/WebTestListByResourceGroup.json
     */
    /**
     * Sample code: webTestListByResourceGroup.
     *
     * @param manager Entry point to ApplicationInsightsManager.
     */
    public static void webTestListByResourceGroup(
        com.azure.resourcemanager.applicationinsights.ApplicationInsightsManager manager) {
        manager.webTests().listByResourceGroup("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_resource_group.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_resource_group(
        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/WebTestListByResourceGroup.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/WebTestListByResourceGroup.json
// this example is just showing the usage of "WebTests_ListByResourceGroup" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "my-resource-group";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this WebTestResource
WebTestCollection collection = resourceGroupResource.GetWebTests();

// invoke the operation and iterate over the result
await foreach (WebTestResource item in collection.GetAllAsync())
{
    // 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"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/my-resource-group/providers/Microsoft.Insights/webtests/my-webtest-my-other-component",
      "name": "my-webtest-my-other-component",
      "type": "Microsoft.Insights/webtests",
      "location": "southcentralus",
      "tags": {
        "Test": "You can delete this synthetic monitor anytime",
        "hidden-link:/subscriptions/subid/resourceGroups/my-resource-group/providers/Microsoft.Insights/components/my-other-component": "Resource"
      },
      "kind": "ping",
      "properties": {
        "SyntheticMonitorId": "my-webtest-my-other-component",
        "Name": "342bccf4-722f-496d-b064-123456789abc",
        "Description": "",
        "Enabled": false,
        "Frequency": 300,
        "Timeout": 90,
        "Kind": "ping",
        "RetryEnabled": false,
        "Locations": [
          {
            "Id": "us-fl-mia-edge"
          }
        ],
        "Configuration": {
          "WebTest": "<WebTest Name=\"342bccf4-722f-496d-b064-123456789abc\" Id=\"00a15cc1-c903-4f97-9af4-123456789abc\" Enabled=\"False\" 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=\"347e1924-9899-4c6e-ad78-123456789abc\" Version=\"1.1\" Url=\"http://my-other-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
}

Définitions

Nom	Description
Configuration	Spécification de configuration XML pour un test web.
ContentValidation	Collection de propriétés de validation de contenu
HeaderField	En-tête à ajouter au WebTest.
Request	Collection de propriétés de requête
ValidationRules	Collection de propriétés de règle de validation
WebTest	Définition Application Insights WebTest.
WebTestGeolocation	Emplacement géo physique à partir duquel exécuter un Test Web. Vous devez spécifier un ou plusieurs emplacements à partir duquel le test doit s’exécuter.
WebTestKind	Le type de WebTest que ce test web surveille. Les choix sont ping, multi-étapes et standard.
webTestListResult	Liste de 0 ou plusieurs définitions WebTest Application Insights.

Configuration

Spécification de configuration XML pour un test web.

Nom	Type	Description
WebTest	string	Spécification XML d’un WebTest à exécuter sur une application.

ContentValidation

Collection de propriétés de validation de contenu

Nom	Type	Description
ContentMatch	string	Contenu à rechercher dans le retour du WebTest. Ne doit pas être vide ou avoir la valeur null.
IgnoreCase	boolean	Lorsqu’elle est définie, cette valeur rend la validation ContentMatch non sensible à la casse.
PassIfTextFound	boolean	Lorsque la valeur est true, la validation passe s’il existe une correspondance pour la chaîne ContentMatch. Si la valeur est false, la validation échoue en cas de correspondance

HeaderField

En-tête à ajouter au WebTest.

Nom	Type	Description
key	string	Nom de l'en-tête.
value	string	Valeur de l'en-tête.

Request

Collection de propriétés de requête

Nom	Type	Description
FollowRedirects	boolean	Suivez les redirections pour ce test web.
Headers	HeaderField[]	Liste des en-têtes et de leurs valeurs à ajouter à l’appel WebTest.
HttpVerb	string	Verbe Http à utiliser pour ce test web.
ParseDependentRequests	boolean	Analyser la requête dépendante pour ce test web.
RequestBody	string	Corps de chaîne encodé en base64 à envoyer avec ce test web.
RequestUrl	string	Emplacement url à tester.

ValidationRules

Collection de propriétés de règle de validation

Nom	Type	Description
ContentValidation	ContentValidation	Collection de propriétés de validation de contenu
ExpectedHttpStatusCode	integer	Vérifiez que le WebTest retourne le code http status fourni.
IgnoreHttpStatusCode	boolean	Lorsqu’elle est définie, la validation ignore le code status.
SSLCertRemainingLifetimeCheck	integer	Il reste un certain nombre de jours à case activée avant l’expiration du certificat SSL existant. La valeur doit être positive et sslCheck doit avoir la valeur true.
SSLCheck	boolean	Vérifie si le certificat SSL est toujours valide.

WebTest

Définition Application Insights WebTest.

Nom	Type	Valeur par défaut	Description
id	string		ID de ressource Azure
kind	WebTestKind	ping	Le type de WebTest que ce test web surveille. Les choix sont ping, multi-étapes et standard.
location	string		Emplacement de la ressource
name	string		Nom de la ressource Azure
properties.Configuration	Configuration		Spécification de configuration XML pour un test web.
properties.Description	string		Description définie par l’utilisateur pour ce Test Web.
properties.Enabled	boolean		Le test est-il activement surveillé.
properties.Frequency	integer	300	Intervalle en secondes entre les exécutions de tests pour ce test WebTest. La valeur par défaut est 300.
properties.Kind	WebTestKind	ping	Le type de test web qu’il s’agit, les choix valides sont ping, multi-étapes et standard.
properties.Locations	WebTestGeolocation[]		Liste de l’emplacement à partir duquel exécuter physiquement les tests pour fournir une couverture globale de l’accessibilité de votre application.
properties.Name	string		Nom défini par l’utilisateur si ce Test Web.
properties.Request	Request		Collection de propriétés de requête
properties.RetryEnabled	boolean		Autoriser les nouvelles tentatives en cas d’échec de ce test web.
properties.SyntheticMonitorId	string		ID unique de ce Test Web. Il s’agit généralement de la même valeur que le champ Nom.
properties.Timeout	integer	30	Secondes avant que ce Test Web expire et échoue. La valeur par défaut est 30.
properties.ValidationRules	ValidationRules		Collection de propriétés de règle de validation
properties.provisioningState	string		État actuel de ce composant, qu’il ait été provisionné ou non dans le groupe de ressources qu’il est défini. Les utilisateurs ne peuvent pas modifier cette valeur, mais sont en mesure de lire à partir de celle-ci. Les valeurs incluent Succeeded, Deploying, Canceled et Failed.
tags	object		Balises de ressource
type	string		Type de ressource Azure

WebTestGeolocation

Emplacement géo physique à partir duquel exécuter un Test Web. Vous devez spécifier un ou plusieurs emplacements à partir duquel le test doit s’exécuter.

Nom	Type	Description
Id	string	ID d’emplacement à partir duquel le WebTest doit s’exécuter.

WebTestKind

Le type de WebTest que ce test web surveille. Les choix sont ping, multi-étapes et standard.

Nom	Type	Description
multistep	string
ping	string
standard	string

webTestListResult

Liste de 0 ou plusieurs définitions WebTest Application Insights.

Nom	Type	Description
nextLink	string	Lien permettant d’obtenir la partie suivante de la liste renvoyée de WebTest, si le jeu de retour est trop volumineux pour une seule requête. Ce paramètre peut être null.
value	WebTest[]	Ensemble de définitions WebTest Application Insights.