Web Tests - Get

Servicio:

Application Insights

Versión de la API:

2022-06-15

Obtenga una definición de prueba web específica de Application Insights.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
webTestName	path	True	string	Nombre del recurso WebTest de Application Insights.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	WebTest	Definición de prueba web de Ann Application Insights.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

webTestGet

Solicitud de ejemplo

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

Respuesta de muestra

status code:

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"
  }
}

Definiciones

Nombre	Description
Configuration	Una especificación de configuración XML para un WebTest.
ContentValidation	Colección de propiedades de validación de contenido
HeaderField	Encabezado que se va a agregar a WebTest.
Request	Colección de propiedades de solicitud
ValidationRules	Colección de propiedades de regla de validación
WebTest	Una definición de WebTest de Application Insights.
WebTestGeolocation	Ubicación geográfica física desde la que ejecutar un WebTest. Debe especificar una o varias ubicaciones desde las que se ejecutará la prueba.
WebTestKind	Tipo de WebTest que esta prueba web supervisa. Las opciones son ping, multistep y estándar.

Configuration

Object

Una especificación de configuración XML para un WebTest.

Nombre	Tipo	Description
WebTest	string	Especificación XML de un WebTest que se va a ejecutar en una aplicación.

ContentValidation

Object

Colección de propiedades de validación de contenido

Nombre	Tipo	Description
ContentMatch	string	Contenido que se va a buscar en la devolución de WebTest. No debe ser null ni estar vacío.
IgnoreCase	boolean	Cuando se establece, este valor hace que el caso de validación contentMatch no distingue mayúsculas de minúsculas.
PassIfTextFound	boolean	Cuando es true, la validación pasará si hay una coincidencia para la cadena ContentMatch. Si es false, se producirá un error en la validación si hay una coincidencia.

HeaderField

Object

Encabezado que se va a agregar a WebTest.

Nombre	Tipo	Description
key	string	Nombre del encabezado.
value	string	Valor del encabezado.

Request

Object

Colección de propiedades de solicitud

Nombre	Tipo	Description
FollowRedirects	boolean	Siga las redirecciones para esta prueba web.
Headers	HeaderField[]	Lista de encabezados y sus valores que se van a agregar a la llamada a WebTest.
HttpVerb	string	Verbo HTTP que se va a usar para esta prueba web.
ParseDependentRequests	boolean	Analizar la solicitud dependiente de este WebTest.
RequestBody	string	Cuerpo de cadena codificado en Base64 para enviar con esta prueba web.
RequestUrl	string	Ubicación de la dirección URL que se va a probar.

ValidationRules

Object

Colección de propiedades de regla de validación

Nombre	Tipo	Description
ContentValidation	ContentValidation	Colección de propiedades de validación de contenido
ExpectedHttpStatusCode	integer (int32)	Compruebe que WebTest devuelve el código de estado HTTP proporcionado.
IgnoreHttpStatusCode	boolean	Cuando se establece, la validación omitirá el código de estado.
SSLCertRemainingLifetimeCheck	integer (int32)	Un número de días para comprobar aún permanece antes de que expire el certificado SSL existente. El valor debe ser positivo y SSLCheck debe establecerse en true.
SSLCheck	boolean	Comprueba si el certificado SSL sigue siendo válido.

WebTest

Object

Una definición de WebTest de Application Insights.

Nombre	Tipo	Valor predeterminado	Description
id	string		Identificador de recurso de Azure
kind	WebTestKind	ping	Tipo de WebTest que esta prueba web supervisa. Las opciones son ping, multistep y estándar.
location	string		Ubicación del recurso
name	string		Nombre del recurso de Azure
properties.Configuration	Configuration		Una especificación de configuración XML para un WebTest.
properties.Description	string		Descripción definida por el usuario para este WebTest.
properties.Enabled	boolean		Es la prueba que se está supervisando activamente.
properties.Frequency	integer (int32)	300	Intervalo en segundos entre ejecuciones de pruebas para este WebTest. El valor predeterminado es 300.
properties.Kind	WebTestKind	ping	El tipo de prueba web es, las opciones válidas son ping, multistep y estándar.
properties.Locations	WebTestGeolocation[]		Lista de dónde ejecutar físicamente las pruebas para proporcionar cobertura global para la accesibilidad de la aplicación.
properties.Name	string		Nombre definido por el usuario si este WebTest.
properties.Request	Request		Colección de propiedades de solicitud
properties.RetryEnabled	boolean		Permitir reintentos debe producir un error en WebTest.
properties.SyntheticMonitorId	string		Identificador único de este WebTest. Normalmente es el mismo valor que el campo Nombre.
properties.Timeout	integer (int32)	30	Segundos hasta que se produzca un tiempo de espera de WebTest y se produzca un error. El valor predeterminado es 30.
properties.ValidationRules	ValidationRules		Colección de propiedades de regla de validación
properties.provisioningState	string		Estado actual de este componente, independientemente de si se ha aprovisionado o no en el grupo de recursos que está definido. Los usuarios no pueden cambiar este valor, pero pueden leerlo. Los valores incluirán Succeeded, Deploying, Canceled y Failed.
tags	object		Etiquetas de recursos
type	string		Tipo de recurso de Azure

WebTestGeolocation

Object

Ubicación geográfica física desde la que ejecutar un WebTest. Debe especificar una o varias ubicaciones desde las que se ejecutará la prueba.

Nombre	Tipo	Description
Id	string	Id. de ubicación desde el que se va a ejecutar WebTest.

WebTestKind

Enumeración

Tipo de WebTest que esta prueba web supervisa. Las opciones son ping, multistep y estándar.

Valor	Description
multistep
ping
standard