Web Tests - List By Component

Ссылка

Service:: Application Insights

API Version:: 2022-06-15

Получение всех веб-тестов Application Insights, определенных для указанного компонента.

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

Параметры URI

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

Ответы

Имя	Тип	Описание
200 OK	webTestListResult	Список, содержащий 0 или более определений веб-тестов.

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

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Scopes

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

Примеры

webTestListByComponent

Sample Request

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

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

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

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
}

Определения

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

Configuration

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

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

ContentValidation

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

Имя	Тип	Описание
ContentMatch	string	Содержимое для поиска в возврате WebTest. Не должен иметь значение 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	Анализ зависимого запроса для этого WebTest.
RequestBody	string	Текст строки в кодировке Base64 для отправки с помощью этого веб-теста.
RequestUrl	string	Проверяемое расположение URL-адреса.

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	Интервал в секундах между тестовых запусков для этого WebTest. Значение по умолчанию — 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

webTestListResult

Список из 0 или более определений WebTest Application Insights.

Имя	Тип	Описание
nextLink	string	Ссылка для получения следующей части возвращенного списка WebTest, если возвращаемый набор слишком велик для одного запроса. Может принимать значение NULL.
value	WebTest[]	Набор определений WebTest Application Insights.

Web Tests - List By Component

Параметры URI

Ответы

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

azure_auth

Scopes

Примеры

webTestListByComponent

Sample Request

Sample Response

Определения

Configuration

ContentValidation

HeaderField

Request

ValidationRules

WebTest

WebTestGeolocation

WebTestKind

webTestListResult

Дополнительные ресурсы