Web Tests - List By Component

Service:

Application Insights

API Version:

2022-06-15

指定したコンポーネントに対して定義されているすべての Application Insights Web テストを取得します。

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	ターゲット サブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	webTestListResult	0 個以上の Web テスト定義を含むリスト。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

webTestListByComponent

Sample Request

HTTP

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

Java

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

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_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

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/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	WebTest の XML 構成仕様。
ContentValidation	コンテンツ検証プロパティのコレクション
HeaderField	WebTest に追加するヘッダー。
Request	要求プロパティのコレクション
ValidationRules	検証規則のプロパティのコレクション
WebTest	Application Insights WebTest 定義。
WebTestGeolocation	WebTest を実行する地理的な場所。 テストを実行する場所を 1 つ以上指定する必要があります。
WebTestKind	この Web テストで監視される WebTest の種類。 選択肢は ping、マルチステップ、標準です。
webTestListResult	0 個以上の Application Insights WebTest 定義の一覧。

Configuration

WebTest の XML 構成仕様。

名前	型	説明
WebTest	string	アプリケーションに対して実行する WebTest の XML 仕様。

ContentValidation

コンテンツ検証プロパティのコレクション

名前	型	説明
ContentMatch	string	WebTest の戻り値で検索するコンテンツ。 null または空にすることはできません。
IgnoreCase	boolean	この値を設定すると、ContentMatch 検証では大文字と小文字が区別されません。
PassIfTextFound	boolean	true の場合、ContentMatch 文字列に一致するものがある場合、検証は渡されます。 false の場合、一致する場合、検証は失敗します

HeaderField

WebTest に追加するヘッダー。

名前	型	説明
key	string	ヘッダーの名前。
value	string	ヘッダーの値です。

Request

要求プロパティのコレクション

名前	型	説明
FollowRedirects	boolean	この Web テストのリダイレクトに従います。
Headers	HeaderField[]	WebTest 呼び出しに追加するヘッダーとその値の一覧。
HttpVerb	string	この Web テストに使用する Http 動詞。
ParseDependentRequests	boolean	この WebTest の依存要求を解析します。
RequestBody	string	この Web テストで送信する Base64 エンコード文字列本文。
RequestUrl	string	テストする URL の場所。

ValidationRules

検証規則のプロパティのコレクション

名前	型	説明
ContentValidation	ContentValidation	コンテンツ検証プロパティのコレクション
ExpectedHttpStatusCode	integer	指定された http 状態コードが WebTest から返されることを検証します。
IgnoreHttpStatusCode	boolean	設定すると、検証は状態コードを無視します。
SSLCertRemainingLifetimeCheck	integer	既存の SSL 証明書の有効期限が切れるまでチェック日数が残ります。 値は正の値で、SSLCheck は true に設定する必要があります。
SSLCheck	boolean	SSL 証明書がまだ有効かどうかを確認します。

WebTest

Application Insights WebTest 定義。

名前	型	既定値	説明
id	string		Azure リソース ID
kind	WebTestKind	ping	この Web テストで監視される WebTest の種類。 選択肢は ping、マルチステップ、標準です。
location	string		リソースの場所
name	string		Azure リソース名
properties.Configuration	Configuration		WebTest の XML 構成仕様。
properties.Description	string		この WebTest のユーザー定義の説明。
properties.Enabled	boolean		テストがアクティブに監視されているか。
properties.Frequency	integer	300	この WebTest のテスト実行の間隔 (秒単位)。 既定値は 300 です。
properties.Kind	WebTestKind	ping	これは、有効な選択肢は ping、マルチステップ、標準の Web テストの種類です。
properties.Locations	WebTestGeolocation[]		アプリケーションのアクセシビリティをグローバルにカバーするためにテストを物理的に実行する場所の一覧。
properties.Name	string		この WebTest の場合は、ユーザー定義の名前。
properties.Request	Request		要求プロパティのコレクション
properties.RetryEnabled	boolean		この WebTest が失敗した場合は、再試行を許可します。
properties.SyntheticMonitorId	string		この WebTest の一意の ID。 通常、これは [名前] フィールドと同じ値です。
properties.Timeout	integer	30	この WebTest がタイムアウトして失敗するまでの秒数。 既定値は 30 です。
properties.ValidationRules	ValidationRules		検証規則のプロパティのコレクション
properties.provisioningState	string		このコンポーネントの現在の状態。それが定義されているリソース グループ内にプロビジョニングされているかどうか。 ユーザーはこの値を変更できませんが、そこから読み取ることができます。 値には、Succeeded、Deploying、Canceled、Failed が含まれます。
tags	object		リソース タグ
type	string		Azure リソースタイプ

WebTestGeolocation

WebTest を実行する地理的な場所。 テストを実行する場所を 1 つ以上指定する必要があります。

名前	型	説明
Id	string	WebTest の実行元の場所 ID。

WebTestKind

この Web テストで監視される WebTest の種類。 選択肢は ping、マルチステップ、標準です。

名前	型	説明
multistep	string
ping	string
standard	string

webTestListResult

0 個以上の Application Insights WebTest 定義の一覧。

名前	型	説明
nextLink	string	返される WebTest のリストの次の部分を取得するためのリンク。返されるセットが 1 つの要求に対して大きすぎる場合。 null も指定できます。
value	WebTest[]	Application Insights WebTest 定義のセット。