Web Tests - Get

サービス:

Application Insights

API バージョン:

2022-06-15

特定の Application Insights Web テスト定義を取得します。

GET 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	ターゲット サブスクリプションの ID。
webTestName	path	True	string	Application Insights WebTest リソースの名前。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	WebTest	Ann Application Insights Web テスト定義。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

webTestGet

要求のサンプル

HTTP

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

Java

/**
 * Samples for WebTests GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2022-06-15/examples/WebTestGet.json
     */
    /**
     * Sample code: webTestGet.
     * 
     * @param manager Entry point to ApplicationInsightsManager.
     */
    public static void webTestGet(com.azure.resourcemanager.applicationinsights.ApplicationInsightsManager manager) {
        manager.webTests().getByResourceGroupWithResponse("my-resource-group", "my-webtest-01-mywebservice",
            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_get.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.get(
        resource_group_name="my-resource-group",
        web_test_name="my-webtest-01-mywebservice",
    )
    print(response)


# x-ms-original-file: specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2022-06-15/examples/WebTestGet.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

Go

package armapplicationinsights_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/applicationinsights/armapplicationinsights/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/8a0168458930c86636a76bcd7acfdc9c81291bfc/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2022-06-15/examples/WebTestGet.json
func ExampleWebTestsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapplicationinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWebTestsClient().Get(ctx, "my-resource-group", "my-webtest-01-mywebservice", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.WebTest = armapplicationinsights.WebTest{
	// 	Name: to.Ptr("my-webtest-01-mywebservice"),
	// 	Type: to.Ptr("Microsoft.Insights/webtests"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/my-test-resources/providers/Microsoft.Insights/webtests/my-webtest-01-mywebservice"),
	// 	Location: to.Ptr("southcentralus"),
	// 	Tags: map[string]*string{
	// 		"hidden-link:/subscriptions/subid/resourceGroups/my-test-resources/providers/Microsoft.Insights/components/mytester": to.Ptr("Resource"),
	// 	},
	// 	Kind: to.Ptr(armapplicationinsights.WebTestKindPing),
	// 	Properties: &armapplicationinsights.WebTestProperties{
	// 		Configuration: &armapplicationinsights.WebTestPropertiesConfiguration{
	// 			WebTest: to.Ptr("<WebTest Name=\"mytest-webtest-01\" Id=\"0317d26b-8672-4370-bd6b-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=\"a55ce143-4f1e-a7e6-b69e-123456789abc\" Version=\"1.1\" Url=\"http://mytester.azurewebsites.net\" ThinkTime=\"0\" Timeout=\"30\" ParseDependentRequests=\"False\" FollowRedirects=\"True\" RecordResult=\"True\" Cache=\"False\" ResponseTimeGoal=\"0\" Encoding=\"utf-8\" ExpectedHttpStatusCode=\"200\" ExpectedResponseUrl=\"\" ReportingName=\"\" IgnoreHttpStatusCode=\"False\" /></Items></WebTest>"),
	// 		},
	// 		Description: to.Ptr(""),
	// 		Enabled: to.Ptr(false),
	// 		Frequency: to.Ptr[int32](900),
	// 		WebTestKind: to.Ptr(armapplicationinsights.WebTestKindPing),
	// 		Locations: []*armapplicationinsights.WebTestGeolocation{
	// 			{
	// 				Location: to.Ptr("us-fl-mia-edge"),
	// 			},
	// 			{
	// 				Location: to.Ptr("apac-hk-hkn-azr"),
	// 		}},
	// 		WebTestName: to.Ptr("mytest-webtest-01"),
	// 		RetryEnabled: to.Ptr(true),
	// 		SyntheticMonitorID: to.Ptr("my-webtest-01-mywebservice"),
	// 		Timeout: to.Ptr[int32](30),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 	},
	// }
}

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

JavaScript

const { ApplicationInsightsManagementClient } = require("@azure/arm-appinsights");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Get a specific Application Insights web test definition.
 *
 * @summary Get a specific Application Insights web test definition.
 * x-ms-original-file: specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2022-06-15/examples/WebTestGet.json
 */
async function webTestGet() {
  const subscriptionId = process.env["APPLICATIONINSIGHTS_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName =
    process.env["APPLICATIONINSIGHTS_RESOURCE_GROUP"] || "my-resource-group";
  const webTestName = "my-webtest-01-mywebservice";
  const credential = new DefaultAzureCredential();
  const client = new ApplicationInsightsManagementClient(credential, subscriptionId);
  const result = await client.webTests.get(resourceGroupName, webTestName);
  console.log(result);
}

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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApplicationInsights.Models;
using Azure.ResourceManager.ApplicationInsights;

// Generated from example definition: specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2022-06-15/examples/WebTestGet.json
// this example is just showing the usage of "WebTests_Get" 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 ApplicationInsightsWebTestResource created on azure
// for more information of creating ApplicationInsightsWebTestResource, please refer to the document of ApplicationInsightsWebTestResource
string subscriptionId = "subid";
string resourceGroupName = "my-resource-group";
string webTestName = "my-webtest-01-mywebservice";
ResourceIdentifier applicationInsightsWebTestResourceId = ApplicationInsightsWebTestResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, webTestName);
ApplicationInsightsWebTestResource applicationInsightsWebTest = client.GetApplicationInsightsWebTestResource(applicationInsightsWebTestResourceId);

// invoke the operation
ApplicationInsightsWebTestResource result = await applicationInsightsWebTest.GetAsync();

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

応答のサンプル

状態コード:

200

{
  "id": "/subscriptions/subid/resourceGroups/my-test-resources/providers/Microsoft.Insights/webtests/my-webtest-01-mywebservice",
  "name": "my-webtest-01-mywebservice",
  "type": "Microsoft.Insights/webtests",
  "location": "southcentralus",
  "tags": {
    "hidden-link:/subscriptions/subid/resourceGroups/my-test-resources/providers/Microsoft.Insights/components/mytester": "Resource"
  },
  "kind": "ping",
  "properties": {
    "SyntheticMonitorId": "my-webtest-01-mywebservice",
    "Name": "mytest-webtest-01",
    "Description": "",
    "Enabled": false,
    "Frequency": 900,
    "Timeout": 30,
    "Kind": "ping",
    "RetryEnabled": true,
    "Locations": [
      {
        "Id": "us-fl-mia-edge"
      },
      {
        "Id": "apac-hk-hkn-azr"
      }
    ],
    "Configuration": {
      "WebTest": "<WebTest Name=\"mytest-webtest-01\" Id=\"0317d26b-8672-4370-bd6b-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=\"a55ce143-4f1e-a7e6-b69e-123456789abc\" Version=\"1.1\" Url=\"http://mytester.azurewebsites.net\" ThinkTime=\"0\" Timeout=\"30\" ParseDependentRequests=\"False\" FollowRedirects=\"True\" RecordResult=\"True\" Cache=\"False\" ResponseTimeGoal=\"0\" Encoding=\"utf-8\" ExpectedHttpStatusCode=\"200\" ExpectedResponseUrl=\"\" ReportingName=\"\" IgnoreHttpStatusCode=\"False\" /></Items></WebTest>"
    },
    "provisioningState": "Succeeded"
  }
}

定義

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

Configuration

Object

WebTest の XML 構成仕様。

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

ContentValidation

Object

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

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

HeaderField

Object

WebTest に追加するヘッダー。

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

Request

Object

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

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

ValidationRules

Object

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

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

WebTest

Object

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

WebTestGeolocation

Object

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

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

WebTestKind

列挙

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

値	説明
multistep
ping
standard