Web Tests - Get

Serviço:

Application Insights

Versão da API:

2022-06-15

Obtenha uma definição de teste Web específica do Application Insights.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
subscriptionId	path	True	string	O ID da subscrição de destino.
webTestName	path	True	string	O nome do recurso Application Insights WebTest.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	WebTest	Definição de teste Web Ann Application Insights.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

webTestGet

Pedido de amostra

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

Resposta da amostra

Código de estado:

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

Definições

Name	Description
Configuration	Uma especificação de configuração XML para um WebTest.
ContentValidation	A coleção de propriedades de validação de conteúdos
HeaderField	Um cabeçalho a adicionar ao WebTest.
Request	A coleção de propriedades do pedido
ValidationRules	A coleção de propriedades da regra de validação
WebTest	Uma definição do Application Insights WebTest.
WebTestGeolocation	Localização geográfica física para executar um WebTest a partir de. Tem de especificar uma ou mais localizações para o teste ser executado.
WebTestKind	O tipo de WebTest que este teste Web observa. As opções são ping, multistep e standard.

Configuration

Uma especificação de configuração XML para um WebTest.

Name	Tipo	Description
WebTest	string	A especificação XML de um WebTest para executar numa aplicação.

ContentValidation

A coleção de propriedades de validação de conteúdos

Name	Tipo	Description
ContentMatch	string	Conteúdo a procurar na devolução do WebTest. Não pode ser nulo ou estar vazio.
IgnoreCase	boolean	Quando definido, este valor torna as maiúsculas e minúsculas de validação ContentMatch insensíveis.
PassIfTextFound	boolean	Quando verdadeiro, a validação será transmitida se existir uma correspondência para a cadeia ContentMatch. Se for falso, a validação falhará se existir uma correspondência

HeaderField

Um cabeçalho a adicionar ao WebTest.

Name	Tipo	Description
key	string	O nome do cabeçalho.
value	string	O valor do cabeçalho.

Request

A coleção de propriedades do pedido

Name	Tipo	Description
FollowRedirects	boolean	Siga os redirecionamentos para este teste Web.
Headers	HeaderField[]	Lista de cabeçalhos e respetivos valores a adicionar à chamada WebTest.
HttpVerb	string	Verbo Http a utilizar para este teste Web.
ParseDependentRequests	boolean	Analisar pedido dependente para este WebTest.
RequestBody	string	Corpo de cadeia codificada base64 para enviar com este teste Web.
RequestUrl	string	Localização do URL a testar.

ValidationRules

A coleção de propriedades da regra de validação

Name	Tipo	Description
ContentValidation	ContentValidation	A coleção de propriedades de validação de conteúdos
ExpectedHttpStatusCode	integer	Confirme que o WebTest devolve o código de estado http fornecido.
IgnoreHttpStatusCode	boolean	Quando definida, a validação ignorará o código de estado.
SSLCertRemainingLifetimeCheck	integer	Ainda falta um número de dias para verificar se o certificado SSL existente expira. O valor tem de ser positivo e o SSLCheck tem de ser definido como verdadeiro.
SSLCheck	boolean	Verifica se o certificado SSL ainda é válido.

WebTest

Uma definição do Application Insights WebTest.

Name	Tipo	Default value	Description
id	string		ID do recurso do Azure
kind	WebTestKind	ping	O tipo de WebTest que este teste Web observa. As opções são ping, multistep e standard.
location	string		Localização do recurso
name	string		Nome do recurso do Azure
properties.Configuration	Configuration		Uma especificação de configuração XML para um WebTest.
properties.Description	string		Descrição definida pelo utilizador para este WebTest.
properties.Enabled	boolean		O teste está a ser monitorizado ativamente.
properties.Frequency	integer	300	Intervalo em segundos entre execuções de teste para este WebTest. O valor predefinido é 300.
properties.Kind	WebTestKind	ping	O tipo de teste Web que isto é, as opções válidas são ping, multistep e standard.
properties.Locations	WebTestGeolocation[]		Uma lista de onde executar fisicamente os testes para dar cobertura global para a acessibilidade da sua aplicação.
properties.Name	string		Nome definido pelo utilizador se este WebTest.
properties.Request	Request		A coleção de propriedades do pedido
properties.RetryEnabled	boolean		Permitir repetições caso este WebTest falhe.
properties.SyntheticMonitorId	string		ID exclusivo deste WebTest. Normalmente, este é o mesmo valor que o campo Nome.
properties.Timeout	integer	30	Segundos até este WebTest exceder o tempo limite e falhar. O valor predefinido é 30.
properties.ValidationRules	ValidationRules		A coleção de propriedades da regra de validação
properties.provisioningState	string		O estado atual deste componente, quer tenha ou não sido aprovisionado no grupo de recursos que está definido. Os utilizadores não podem alterar este valor, mas podem ler a partir do mesmo. Os valores incluirão Êxito, Implementação, Cancelado e Falhado.
tags	object		Etiquetas de recursos
type	string		Tipo de recurso do Azure

WebTestGeolocation

Localização geográfica física para executar um WebTest a partir de. Tem de especificar uma ou mais localizações para o teste ser executado.

Name	Tipo	Description
Id	string	ID de localização do WebTest a partir do qual pode ser executado.

WebTestKind

O tipo de WebTest que este teste Web observa. As opções são ping, multistep e standard.

Name	Tipo	Description
multistep	string
ping	string
standard	string