Web Tests - Update Tags

Ссылка

Service:: Application Insights

API Version:: 2022-06-15

Обновления теги, связанные с веб-тестом Application Insights.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов. Регистр букв в имени не учитывается.
subscriptionId	path	True	string	Идентификатор целевой подписки.
webTestName	path	True	string	Имя ресурса Application Insights WebTest.
api-version	query	True	string	Версия API, используемая для данной операции.

Текст запроса

Имя	Тип	Описание
tags	object	Теги ресурсов

Ответы

Имя	Тип	Описание
200 OK	WebTest	Успешное обновление тегов веб-теста Application Insights. Теги веб-тестов обновляются и возвращаются вместе с остальными свойствами объекта WebTest.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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

Определения

Имя	Описание
Configuration	Спецификация конфигурации XML для WebTest.
ContentValidation	Коллекция свойств проверки содержимого
HeaderField	Заголовок, добавляемый в WebTest.
Request	Коллекция свойств запроса
TagsResource	Контейнер, содержащий только теги для ресурса, что позволяет пользователю обновлять теги в экземпляре WebTest.
ValidationRules	Коллекция свойств правила проверки
WebTest	Определение Веб-теста Application Insights.
WebTestGeolocation	Географическое расположение для запуска WebTest. Необходимо указать одно или несколько расположений для запуска теста.
WebTestKind	Тип WebTest, который просматривает этот веб-тест. Возможные варианты: ping, multistep и standard.

Configuration

Спецификация конфигурации XML для WebTest.

Имя	Тип	Описание
WebTest	string	Спецификация XML WebTest для запуска в приложении.

ContentValidation

Коллекция свойств проверки содержимого

Имя	Тип	Описание
ContentMatch	string	Содержимое для поиска в возвращаемом веб-тесте. Не должен иметь значение NULL или быть пустым.
IgnoreCase	boolean	Если задано это значение, регистр проверки ContentMatch не учитывается.
PassIfTextFound	boolean	Если значение равно true, проверка будет пройдена, если для строки ContentMatch имеется совпадение. Если задано значение false, проверка завершится ошибкой при наличии совпадения

HeaderField

Заголовок, добавляемый в WebTest.

Имя	Тип	Описание
key	string	Имя заголовка.
value	string	Значение заголовка.

Request

Коллекция свойств запроса

Имя	Тип	Описание
FollowRedirects	boolean	Следуйте перенаправлениям для этого веб-теста.
Headers	HeaderField[]	Список заголовков и их значений, добавляемых в вызов WebTest.
HttpVerb	string	Http-команда, используемая для этого веб-теста.
ParseDependentRequests	boolean	Анализ зависимого запроса для этого веб-теста.
RequestBody	string	Текст строки в кодировке Base64 для отправки с помощью этого веб-теста.
RequestUrl	string	Расположение URL-адреса для проверки.

TagsResource

Контейнер, содержащий только теги для ресурса, что позволяет пользователю обновлять теги в экземпляре WebTest.

Имя	Тип	Описание
tags	object	Теги ресурсов

ValidationRules

Коллекция свойств правила проверки

Имя	Тип	Описание
ContentValidation	ContentValidation	Коллекция свойств проверки содержимого
ExpectedHttpStatusCode	integer	Убедитесь, что WebTest возвращает предоставленный код состояния HTTP.
IgnoreHttpStatusCode	boolean	Если этот параметр задан, проверка будет игнорировать код состояния.
SSLCertRemainingLifetimeCheck	integer	До истечения срока действия существующего SSL-сертификата остается несколько дней до проверка. Значение должно быть положительным, а значение SSLCheck должно иметь значение true.
SSLCheck	boolean	Проверяет, действителен ли SSL-сертификат.

WebTest

Определение Веб-теста Application Insights.

Имя	Тип	Значение по умолчанию	Описание
id	string		Идентификатор ресурса Azure
kind	WebTestKind	ping	Тип WebTest, который просматривает этот веб-тест. Возможные варианты: ping, multistep и standard.
location	string		Расположение ресурса
name	string		Имя ресурса Azure
properties.Configuration	Configuration		Спецификация конфигурации XML для WebTest.
properties.Description	string		Определенное пользователем описание для этого веб-теста.
properties.Enabled	boolean		Тест активно отслеживается.
properties.Frequency	integer	300	Интервал в секундах между запусками тестов для этого веб-теста. Значение по умолчанию — 300.
properties.Kind	WebTestKind	ping	Тип веб-теста это, допустимые варианты: ping, multistep и standard.
properties.Locations	WebTestGeolocation[]		Список физических запусков тестов, чтобы обеспечить глобальное покрытие доступности приложения.
properties.Name	string		Определяемое пользователем имя, если это WebTest.
properties.Request	Request		Коллекция свойств запроса
properties.RetryEnabled	boolean		Разрешите повторные попытки в случае сбоя веб-теста.
properties.SyntheticMonitorId	string		Уникальный идентификатор этого веб-теста. Обычно это значение совпадает с полем Имя.
properties.Timeout	integer	30	В секундах до этого веб-теста истекло время ожидания и завершится сбоем. Значение по умолчанию — 30.
properties.ValidationRules	ValidationRules		Коллекция свойств правила проверки
properties.provisioningState	string		Текущее состояние этого компонента, независимо от того, подготовлено ли оно к работе в определенной группе ресурсов. Пользователи не могут изменить это значение, но могут считывать его. Значения будут включать Succeeded, Deploying, Canceled и Failed.
tags	object		Теги ресурсов
type	string		Тип ресурса Azure

WebTestGeolocation

Географическое расположение для запуска WebTest. Необходимо указать одно или несколько расположений для запуска теста.

Имя	Тип	Описание
Id	string	Идентификатор расположения для веб-теста для запуска.

WebTestKind

Тип WebTest, который просматривает этот веб-тест. Возможные варианты: ping, multistep и standard.

Имя	Тип	Описание
multistep	string
ping	string
standard	string