Поделиться через

Web Tests - Create Or Update

  • Ссылка
Служба:
Application Insights
Версия API:
2022-06-15

Создает или обновляет определение веб-теста Application Insights.

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

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId
 path True

string

minLength: 1

Идентификатор целевой подписки.
webTestName
 path True

string

Имя ресурса WebTest Application Insights.
api-version
 query True

string

minLength: 1

Версия API, используемая для этой операции.

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

Имя Обязательно Тип Описание
location True

string

Расположение ресурса
properties.Kind True

WebTestKind

Тип веб-теста это, допустимые варианты: ping, multistep и standard.
properties.Locations True

WebTestGeolocation[]

Список мест, где физически выполнять тесты, чтобы предоставить глобальное покрытие для специальных возможностей вашего приложения.
properties.Name True

string

Определяемое пользователем имя, если этот WebTest.
properties.SyntheticMonitorId True

string

Уникальный идентификатор этого веб-теста. Обычно это значение совпадает с полем "Имя".
kind

WebTestKind

Тип WebTest, который просматривает этот веб-тест. Выбор — это связь, многоэтапная и стандартная.
properties.Configuration

Configuration

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

string

Определяемое пользователем описание этого webTest.
properties.Enabled

boolean

Выполняется активное наблюдение за тестом.
properties.Frequency

integer (int32)

Интервал в секундах между выполнением тестов для этого webTest. Значение по умолчанию — 300.
properties.Request

Request

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

boolean

Разрешить повторные попытки в случае сбоя WebTest.
properties.Timeout

integer (int32)

Секунды, пока этот веб-тест не завершится временем ожидания и завершится сбоем. Значение по умолчанию — 30.
properties.ValidationRules

ValidationRules

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

object

Теги ресурсов

Ответы

Имя Тип Описание
200 OK

WebTest

Успешно создан или обновлен веб-тест Application Insights.

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

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

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

Примеры

webTestCreate
webTestCreateStandard
webTestUpdate

webTestCreate

Образец запроса

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

{
  "location": "South Central US",
  "kind": "ping",
  "properties": {
    "Name": "my-webtest-my-component",
    "SyntheticMonitorId": "my-webtest-my-component",
    "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>"
    },
    "Description": "Ping web test alert for mytestwebapp",
    "Enabled": true,
    "Frequency": 900,
    "Timeout": 120,
    "Kind": "ping",
    "RetryEnabled": true,
    "Locations": [
      {
        "Id": "us-fl-mia-edge"
      }
    ]
  }
}

Пример ответа

Код состояния:
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"
  },
  "kind": "ping",
  "properties": {
    "Name": "my-webtest-my-component",
    "SyntheticMonitorId": "my-webtest-my-component",
    "Description": "Ping web test alert for mytestwebapp",
    "Enabled": true,
    "Frequency": 900,
    "Timeout": 120,
    "Kind": "ping",
    "RetryEnabled": true,
    "Locations": [
      {
        "Id": "us-fl-mia-edge"
      }
    ],
    "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"
  }
}

webTestCreateStandard

Образец запроса

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

{
  "location": "South Central US",
  "properties": {
    "Name": "my-webtest-my-component",
    "SyntheticMonitorId": "my-webtest-my-component",
    "Description": "Ping web test alert for mytestwebapp",
    "Enabled": true,
    "Frequency": 900,
    "Timeout": 120,
    "Kind": "standard",
    "RetryEnabled": true,
    "Request": {
      "RequestUrl": "https://bing.com",
      "Headers": [
        {
          "key": "Content-Language",
          "value": "de-DE"
        },
        {
          "key": "Accept-Language",
          "value": "de-DE"
        }
      ],
      "HttpVerb": "POST",
      "RequestBody": "SGVsbG8gd29ybGQ="
    },
    "ValidationRules": {
      "SSLCheck": true,
      "SSLCertRemainingLifetimeCheck": 100
    },
    "Locations": [
      {
        "Id": "us-fl-mia-edge"
      }
    ]
  }
}

Пример ответа

Код состояния:
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"
  },
  "properties": {
    "Name": "my-webtest-my-component",
    "SyntheticMonitorId": "my-webtest-my-component",
    "Description": "Ping web test alert for mytestwebapp",
    "Enabled": true,
    "Frequency": 900,
    "Timeout": 120,
    "Kind": "standard",
    "RetryEnabled": true,
    "Locations": [
      {
        "Id": "us-fl-mia-edge"
      }
    ],
    "Request": {
      "RequestUrl": "https://bing.com",
      "Headers": [
        {
          "key": "Content-Language",
          "value": "de-DE"
        },
        {
          "key": "Accept-Language",
          "value": "de-DE"
        }
      ],
      "HttpVerb": "POST",
      "RequestBody": "SGVsbG8gd29ybGQ="
    },
    "ValidationRules": {
      "SSLCheck": true,
      "SSLCertRemainingLifetimeCheck": 100
    },
    "provisioningState": "Succeeded"
  }
}

webTestUpdate

Образец запроса

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

{
  "location": "South Central US",
  "kind": "ping",
  "properties": {
    "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>"
    },
    "Frequency": 600,
    "Timeout": 30,
    "Locations": [
      {
        "Id": "us-fl-mia-edge"
      },
      {
        "Id": "apac-hk-hkn-azr"
      }
    ],
    "Kind": "ping",
    "Name": "my-webtest-my-component",
    "SyntheticMonitorId": "my-webtest-my-component"
  }
}

Пример ответа

Код состояния:
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"
  },
  "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

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

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

Определение WebTest Application Insights.
WebTestGeolocation

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

Тип WebTest, который просматривает этот веб-тест. Выбор — это связь, многоэтапная и стандартная.

Configuration

Object

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

Имя Тип Описание
WebTest

string

Спецификация XML веб-теста для запуска в приложении.

ContentValidation

Object

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

Имя Тип Описание
ContentMatch

string

Содержимое для поиска в возврате WebTest. Не должно быть пустым или пустым.
IgnoreCase

boolean

Если задано, это значение не учитывает регистр проверки ContentMatch.
PassIfTextFound

boolean

Если значение true, проверка будет проходить, если для строки ContentMatch имеется совпадение. Если значение false, проверка завершится ошибкой при наличии совпадения

HeaderField

Object

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

Имя Тип Описание
key

string

Имя заголовка.
value

string

Значение заголовка.

Request

Object

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

Имя Тип Описание
FollowRedirects

boolean

Следуйте перенаправлениям для этого веб-теста.
Headers

HeaderField[]

Список заголовков и их значений для добавления в вызов WebTest.
HttpVerb

string

Http-команда, используемая для этого веб-теста.
ParseDependentRequests

boolean

Анализ зависимого запроса для этого webTest.
RequestBody

string

Текст строки в кодировке Base64 для отправки с помощью этого веб-теста.
RequestUrl

string

Расположение URL-адреса для тестирования.

ValidationRules

Object

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

Имя Тип Описание
ContentValidation

ContentValidation

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

integer (int32)

Убедитесь, что WebTest возвращает предоставленный код состояния HTTP.
IgnoreHttpStatusCode

boolean

При установке проверка будет игнорировать код состояния.
SSLCertRemainingLifetimeCheck

integer (int32)

Количество дней для проверки по-прежнему остается до истечения срока действия существующего SSL-сертификата. Значение должно быть положительным, а sslcheck должно иметь значение true.
SSLCheck

boolean

Проверяет, является ли SSL-сертификат допустимым.

WebTest

Object

Определение WebTest Application Insights.

Имя Тип Default value Описание
id

string

Идентификатор ресурса Azure
kind

WebTestKind

ping

Тип WebTest, который просматривает этот веб-тест. Выбор — это связь, многоэтапная и стандартная.
location

string

Расположение ресурса
name

string

Имя ресурса Azure
properties.Configuration

Configuration

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

string

Определяемое пользователем описание этого webTest.
properties.Enabled

boolean

Выполняется активное наблюдение за тестом.
properties.Frequency

integer (int32)

300

Интервал в секундах между выполнением тестов для этого webTest. Значение по умолчанию — 300.
properties.Kind

WebTestKind

ping

Тип веб-теста это, допустимые варианты: ping, multistep и standard.
properties.Locations

WebTestGeolocation[]

Список мест, где физически выполнять тесты, чтобы предоставить глобальное покрытие для специальных возможностей вашего приложения.
properties.Name

string

Определяемое пользователем имя, если этот WebTest.
properties.Request

Request

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

boolean

Разрешить повторные попытки в случае сбоя WebTest.
properties.SyntheticMonitorId

string

Уникальный идентификатор этого веб-теста. Обычно это значение совпадает с полем "Имя".
properties.Timeout

integer (int32)

30

Секунды, пока этот веб-тест не завершится временем ожидания и завершится сбоем. Значение по умолчанию — 30.
properties.ValidationRules

ValidationRules

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

string

Текущее состояние этого компонента, подготовлено ли оно в группе ресурсов. Пользователи не могут изменить это значение, но могут прочитать его. К значениям относятся успешное выполнение, развертывание, отмена и сбой.
tags

object

Теги ресурсов
type

string

Тип ресурса Azure

WebTestGeolocation

Object

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

Имя Тип Описание
Id

string

Идентификатор расположения для запуска WebTest.

WebTestKind

Перечисление

Тип WebTest, который просматривает этот веб-тест. Выбор — это связь, многоэтапная и стандартная.

Значение Описание
multistep
ping
standard