Web Tests - Update Tags

Référence

Service:: Application Insights

API Version:: 2022-06-15

Mises à jour les balises associées à un test web Application Insights.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/webtests/{webTestName}?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.
webTestName	path	True	string	Nom de la ressource WebTest Application Insights.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
tags	object	Balises de ressource

Réponses

Nom	Type	Description
200 OK	WebTest	La mise à jour des balises de test web Application Insights a réussi. Les balises de test web sont mises à jour et retournées avec le reste des propriétés de l’objet WebTest.

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

webTestUpdateTags

Sample Request

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

{
  "tags": {
    "hidden-link:/subscriptions/subid/resourceGroups/my-resource-group/providers/Microsoft.Insights/components/my-component": "Resource",
    "CustomField-01": "This is a random value",
    "SystemType": "A08",
    "Color": "AzureBlue"
  }
}

import com.azure.resourcemanager.applicationinsights.models.WebTest;
import java.util.HashMap;
import java.util.Map;

/** Samples for WebTests UpdateTags. */
public final class Main {
    /*
     * x-ms-original-file: specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2022-06-15/examples/WebTestUpdateTagsOnly.json
     */
    /**
     * Sample code: webTestUpdateTags.
     *
     * @param manager Entry point to ApplicationInsightsManager.
     */
    public static void webTestUpdateTags(
        com.azure.resourcemanager.applicationinsights.ApplicationInsightsManager manager) {
        WebTest resource =
            manager
                .webTests()
                .getByResourceGroupWithResponse(
                    "my-resource-group", "my-webtest-my-component", com.azure.core.util.Context.NONE)
                .getValue();
        resource
            .update()
            .withTags(
                mapOf(
                    "Color",
                    "AzureBlue",
                    "CustomField-01",
                    "This is a random value",
                    "SystemType",
                    "A08",
                    "hidden-link:/subscriptions/subid/resourceGroups/my-resource-group/providers/Microsoft.Insights/components/my-component",
                    "Resource"))
            .apply();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

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/WebTestUpdateTagsOnly.json
// this example is just showing the usage of "WebTests_UpdateTags" 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 WebTestResource created on azure
// for more information of creating WebTestResource, please refer to the document of WebTestResource
string subscriptionId = "subid";
string resourceGroupName = "my-resource-group";
string webTestName = "my-webtest-my-component";
ResourceIdentifier webTestResourceId = WebTestResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, webTestName);
WebTestResource webTest = client.GetWebTestResource(webTestResourceId);

// invoke the operation
ComponentTag webTestTags = new ComponentTag()
{
    Tags =
    {
    ["Color"] = "AzureBlue",
    ["CustomField-01"] = "This is a random value",
    ["SystemType"] = "A08",
    ["hidden-link:/subscriptions/subid/resourceGroups/my-resource-group/providers/Microsoft.Insights/components/my-component"] = "Resource",
    },
};
WebTestResource result = await webTest.UpdateAsync(webTestTags);

// 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
WebTestData 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

Sample Response

Status code:: 200

{
  "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",
    "CustomField-01": "This is a random value",
    "SystemType": "A08",
    "Color": "AzureBlue"
  },
  "kind": "ping",
  "properties": {
    "Name": "my-webtest-my-component",
    "SyntheticMonitorId": "my-webtest-my-component",
    "Description": "Ping web test alert for mytestwebapp",
    "Enabled": true,
    "Frequency": 600,
    "Timeout": 30,
    "Kind": "ping",
    "RetryEnabled": true,
    "Locations": [
      {
        "Id": "us-fl-mia-edge"
      },
      {
        "Id": "apac-hk-hkn-azr"
      }
    ],
    "Configuration": {
      "WebTest": "<WebTest Name=\"my-webtest\" Id=\"678ddf96-1ab8-44c8-9274-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=\"a4162485-9114-fcfc-e086-123456789abc\" Version=\"1.1\" Url=\"http://my-component.azurewebsites.net\" ThinkTime=\"0\" Timeout=\"30\" ParseDependentRequests=\"True\" FollowRedirects=\"True\" RecordResult=\"True\" Cache=\"False\" ResponseTimeGoal=\"0\" Encoding=\"utf-8\" ExpectedHttpStatusCode=\"200\" ExpectedResponseUrl=\"\" ReportingName=\"\" IgnoreHttpStatusCode=\"False\" /></Items></WebTest>"
    },
    "provisioningState": "Succeeded"
  }
}

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 à WebTest.
Request	Collection de propriétés de requête
TagsResource	Conteneur contenant uniquement les balises d’une ressource, ce qui permet à l’utilisateur de mettre à jour les balises sur un instance WebTest.
ValidationRules	Collection de propriétés de règle de validation
WebTest	Définition De test web Application Insights.
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.

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 insensible à 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 s’il existe une correspondance

HeaderField

En-tête à ajouter à 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	Analysez 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 d’URL à tester.

TagsResource

Conteneur contenant uniquement les balises d’une ressource, ce qui permet à l’utilisateur de mettre à jour les balises sur un instance WebTest.

Nom	Type	Description
tags	object	Balises de ressource

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 webTest retourne le code http status fourni.
IgnoreHttpStatusCode	boolean	Une fois définie, la validation ignore le code status.
SSLCertRemainingLifetimeCheck	integer	Il reste encore 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 De test web Application Insights.

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 fait-il l’objet d’une surveillance active.
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 d’exécution physique des tests pour fournir une couverture globale de l’accessibilité de votre application.
properties.Name	string		Nom défini par l’utilisateur si ce WebTest.
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 jusqu’à ce 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, s’il a été provisionné ou non dans le groupe de ressources qu’il est défini. Les utilisateurs ne peuvent pas modifier cette valeur, mais peuvent la lire. Les valeurs incluent Réussi, Déploiement, Annulé et Échec.
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 du WebTest à partir duquel 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

Partager via