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 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	資源群組的名稱。 名稱不區分大小寫。
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
webTestName	path	True	string	Application Insights WebTest 資源的名稱。
api-version	query	True	string	用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	WebTest	Ann Application Insights Web 測試定義。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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

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.Resources;
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"
  }
}

定義

名稱	Description
Configuration	WebTest 的 XML 組態規格。
ContentValidation	內容驗證屬性的集合
HeaderField	要新增至 WebTest 的標頭。
Request	要求屬性的集合
ValidationRules	驗證規則屬性的集合
WebTest	Application Insights WebTest 定義。
WebTestGeolocation	要從中執行 WebTest 的地理位置。 您必須指定要執行測試的一或多個位置。
WebTestKind	此 Web 測試所監看的 WebTest 種類。 選擇為 ping、multistep 和 standard。

Configuration

WebTest 的 XML 組態規格。

名稱	類型	Description
WebTest	string	要針對應用程式執行的 WebTest XML 規格。

ContentValidation

內容驗證屬性的集合

名稱	類型	Description
ContentMatch	string	在 WebTest 的傳回中尋找的內容。 不得為 Null 或空白。
IgnoreCase	boolean	設定時，這個值會使 ContentMatch 驗證大小寫不區分。
PassIfTextFound	boolean	若為 true，如果 ContentMatch 字串符合，驗證就會通過。 如果為 false，如果相符項目，驗證將會失敗

HeaderField

要新增至 WebTest 的標頭。

名稱	類型	Description
key	string	標頭的名稱。
value	string	標頭的值。

Request

要求屬性的集合

名稱	類型	Description
FollowRedirects	boolean	請遵循此 Web 測試的重新導向。
Headers	HeaderField[]	要新增至 WebTest 呼叫的標頭及其值清單。
HttpVerb	string	要用於此 Web 測試的 Http 動詞。
ParseDependentRequests	boolean	剖析此 WebTest 的相依要求。
RequestBody	string	要與此 Web 測試一起傳送的 Base64 編碼字串本文。
RequestUrl	string	要測試的URL位置。

ValidationRules

驗證規則屬性的集合

名稱	類型	Description
ContentValidation	ContentValidation	內容驗證屬性的集合
ExpectedHttpStatusCode	integer	驗證 WebTest 是否傳回提供的 HTTP 狀態代碼。
IgnoreHttpStatusCode	boolean	設定時，驗證將會忽略狀態代碼。
SSLCertRemainingLifetimeCheck	integer	在現有 SSL 憑證到期之前，仍要檢查的天數。 值必須是正數，且 SSLCheck 必須設定為 true。
SSLCheck	boolean	檢查 SSL 憑證是否仍然有效。

WebTest

Application Insights WebTest 定義。

名稱	類型	預設值	Description
id	string		Azure 資源標識碼
kind	WebTestKind	ping	此 Web 測試所監看的 WebTest 種類。 選擇為 ping、multistep 和 standard。
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	這是 Web 測試的種類，有效的選擇是 ping、multistep 和 standard。
properties.Locations	WebTestGeolocation[]		實際執行測試的位置清單，以提供應用程式的可存取性全域涵蓋範圍。
properties.Name	string		如果使用者定義名稱，則為這個 WebTest。
properties.Request	Request		要求屬性的集合
properties.RetryEnabled	boolean		如果此 WebTest 失敗，則允許重試。
properties.SyntheticMonitorId	string		此 WebTest 的唯一標識碼。 這通常與 [名稱] 欄位的值相同。
properties.Timeout	integer	30	此 WebTest 逾時並失敗的秒數。 預設值為 30。
properties.ValidationRules	ValidationRules		驗證規則屬性的集合
properties.provisioningState	string		此元件的目前狀態，是否已在已定義的資源群組內布建。 用戶無法變更此值，但可以從中讀取。 值會包含 [成功]、[部署]、[已取消] 和 [失敗]。
tags	object		資源標籤
type	string		Azure 資源類型

WebTestGeolocation

要從中執行 WebTest 的地理位置。 您必須指定要執行測試的一或多個位置。

名稱	類型	Description
Id	string	要從中執行之 WebTest 的位置標識碼。

WebTestKind

此 Web 測試所監看的 WebTest 種類。 選擇為 ping、multistep 和 standard。

名稱	類型	Description
multistep	string
ping	string
standard	string