Diagnostics - Get Hosting Environment Detector Response

Servicio:

App Service

Versión de la API:

2024-11-01

Descripción para obtener la respuesta del detector de entornos de hospedaje

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors/{detectorName}?api-version=2024-11-01

Con parámetros opcionales:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors/{detectorName}?startTime={startTime}&endTime={endTime}&timeGrain={timeGrain}&api-version=2024-11-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
detectorName	path	True	string	Nombre del recurso del detector
name	path	True	string	Nombre del entorno de App Service
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Nombre del grupo de recursos al que pertenece el recurso.
subscriptionId	path	True	string	Su identificador de suscripción de Azure. Se trata de una cadena con formato GUID (por ejemplo, 000000000-00000-0000-0000-00000000000000).
api-version	query	True	string	Versión de la API
endTime	query		string (date-time)	Hora de finalización
startTime	query		string (date-time)	Hora de comienzo
timeGrain	query		string pattern: PT[1-9][0-9]+[SMH]	Intervalo de tiempo

Respuestas

Nombre	Tipo	Description
200 OK	DetectorResponse	De acuerdo
Other Status Codes	DefaultErrorResponse	Respuesta de error de App Service.

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

Get App Service Environment Detector Responses

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/hostingEnvironments/SampleAppServiceEnvironment/detectors/runtimeavailability?api-version=2024-11-01

Java

/**
 * Samples for Diagnostics GetHostingEnvironmentDetectorResponse.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/
     * Diagnostics_GetHostingEnvironmentDetectorResponse.json
     */
    /**
     * Sample code: Get App Service Environment Detector Responses.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAppServiceEnvironmentDetectorResponses(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getDiagnostics().getHostingEnvironmentDetectorResponseWithResponse(
            "Sample-WestUSResourceGroup", "SampleAppServiceEnvironment", "runtimeavailability", null, null, null,
            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.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python diagnostics_get_hosting_environment_detector_response.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 = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.diagnostics.get_hosting_environment_detector_response(
        resource_group_name="Sample-WestUSResourceGroup",
        name="SampleAppServiceEnvironment",
        detector_name="runtimeavailability",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/Diagnostics_GetHostingEnvironmentDetectorResponse.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 armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82e9c6f9fbfa2d6d47d5e2a6a11c0ad2eb345c43/specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/Diagnostics_GetHostingEnvironmentDetectorResponse.json
func ExampleDiagnosticsClient_GetHostingEnvironmentDetectorResponse() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDiagnosticsClient().GetHostingEnvironmentDetectorResponse(ctx, "Sample-WestUSResourceGroup", "SampleAppServiceEnvironment", "runtimeavailability", &armappservice.DiagnosticsClientGetHostingEnvironmentDetectorResponseOptions{StartTime: nil,
		EndTime:   nil,
		TimeGrain: 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.DetectorResponse = armappservice.DetectorResponse{
	// 	Name: to.Ptr("runtimeavailability"),
	// 	ID: to.Ptr("/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/hostingEnvironments/SampleAppServiceEnvironment/detectors/runtimeavailability"),
	// 	Properties: &armappservice.DetectorResponseProperties{
	// 		Dataset: []*armappservice.DiagnosticData{
	// 			{
	// 				RenderingProperties: &armappservice.Rendering{
	// 					Description: to.Ptr("This detector breaks down the number of requests that your apps on this app service environment received for each status code."),
	// 					Title: to.Ptr("Requests by Status Code"),
	// 				},
	// 				Table: &armappservice.DataTableResponseObject{
	// 					Columns: []*armappservice.DataTableResponseColumn{
	// 						{
	// 							ColumnName: to.Ptr("PreciseTimeStamp"),
	// 							ColumnType: to.Ptr("datetime"),
	// 							DataType: to.Ptr("DateTime"),
	// 						},
	// 						{
	// 							ColumnName: to.Ptr("count_Http2xx"),
	// 							ColumnType: to.Ptr("long"),
	// 							DataType: to.Ptr("Int64"),
	// 						},
	// 						{
	// 							ColumnName: to.Ptr("count_Http3xx"),
	// 							ColumnType: to.Ptr("long"),
	// 							DataType: to.Ptr("Int64"),
	// 						},
	// 						{
	// 							ColumnName: to.Ptr("count_Http4xx"),
	// 							ColumnType: to.Ptr("long"),
	// 							DataType: to.Ptr("Int64"),
	// 						},
	// 						{
	// 							ColumnName: to.Ptr("count_Http5xx"),
	// 							ColumnType: to.Ptr("long"),
	// 							DataType: to.Ptr("Int64"),
	// 					}},
	// 					Rows: [][]*string{
	// 						[]*string{
	// 							to.Ptr("2018-03-27T00:25:00Z"),
	// 							to.Ptr("772705"),
	// 							to.Ptr("0"),
	// 							to.Ptr("0"),
	// 							to.Ptr("0")},
	// 							[]*string{
	// 								to.Ptr("2018-03-27T00:30:00Z"),
	// 								to.Ptr("787069"),
	// 								to.Ptr("0"),
	// 								to.Ptr("0"),
	// 								to.Ptr("0")},
	// 								[]*string{
	// 									to.Ptr("2018-03-27T00:35:00Z"),
	// 									to.Ptr("781627"),
	// 									to.Ptr("0"),
	// 									to.Ptr("1"),
	// 									to.Ptr("0")},
	// 									[]*string{
	// 										to.Ptr("2018-03-27T00:40:00Z"),
	// 										to.Ptr("785017"),
	// 										to.Ptr("0"),
	// 										to.Ptr("0"),
	// 										to.Ptr("0")},
	// 										[]*string{
	// 											to.Ptr("2018-03-27T00:45:00Z"),
	// 											to.Ptr("783518"),
	// 											to.Ptr("0"),
	// 											to.Ptr("0"),
	// 											to.Ptr("0")},
	// 											[]*string{
	// 												to.Ptr("2018-03-27T00:50:00Z"),
	// 												to.Ptr("785783"),
	// 												to.Ptr("0"),
	// 												to.Ptr("0"),
	// 												to.Ptr("0")},
	// 												[]*string{
	// 													to.Ptr("2018-03-27T00:55:00Z"),
	// 													to.Ptr("772874"),
	// 													to.Ptr("0"),
	// 													to.Ptr("0"),
	// 													to.Ptr("0")},
	// 													[]*string{
	// 														to.Ptr("2018-03-27T01:00:00Z"),
	// 														to.Ptr("787162"),
	// 														to.Ptr("0"),
	// 														to.Ptr("0"),
	// 														to.Ptr("0")},
	// 														[]*string{
	// 															to.Ptr("2018-03-27T01:05:00Z"),
	// 															to.Ptr("782036"),
	// 															to.Ptr("0"),
	// 															to.Ptr("0"),
	// 															to.Ptr("0")},
	// 															[]*string{
	// 																to.Ptr("2018-03-27T01:10:00Z"),
	// 																to.Ptr("784642"),
	// 																to.Ptr("0"),
	// 																to.Ptr("0"),
	// 																to.Ptr("0")}},
	// 																TableName: to.Ptr("Table_0"),
	// 															},
	// 													}},
	// 													Metadata: &armappservice.DetectorInfo{
	// 														Description: to.Ptr("This detector analyzes all the requests to all applications running on this app service environment."),
	// 														Category: to.Ptr("Availability and Performance"),
	// 													},
	// 												},
	// 											}
}

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 { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Description for Get Hosting Environment Detector Response
 *
 * @summary Description for Get Hosting Environment Detector Response
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/Diagnostics_GetHostingEnvironmentDetectorResponse.json
 */
async function getAppServiceEnvironmentDetectorResponses() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName =
    process.env["APPSERVICE_RESOURCE_GROUP"] || "Sample-WestUSResourceGroup";
  const name = "SampleAppServiceEnvironment";
  const detectorName = "runtimeavailability";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.diagnostics.getHostingEnvironmentDetectorResponse(
    resourceGroupName,
    name,
    detectorName,
  );
  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.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/Diagnostics_GetHostingEnvironmentDetectorResponse.json
// this example is just showing the usage of "Diagnostics_GetHostingEnvironmentDetectorResponse" 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 AppServiceEnvironmentResource created on azure
// for more information of creating AppServiceEnvironmentResource, please refer to the document of AppServiceEnvironmentResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "Sample-WestUSResourceGroup";
string name = "SampleAppServiceEnvironment";
ResourceIdentifier appServiceEnvironmentResourceId = AppServiceEnvironmentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
AppServiceEnvironmentResource appServiceEnvironment = client.GetAppServiceEnvironmentResource(appServiceEnvironmentResourceId);

// get the collection of this HostingEnvironmentDetectorResource
HostingEnvironmentDetectorCollection collection = appServiceEnvironment.GetHostingEnvironmentDetectors();

// invoke the operation
string detectorName = "runtimeavailability";
NullableResponse<HostingEnvironmentDetectorResource> response = await collection.GetIfExistsAsync(detectorName);
HostingEnvironmentDetectorResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // 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
    AppServiceDetectorData 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/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/hostingEnvironments/SampleAppServiceEnvironment/detectors/runtimeavailability",
  "name": "runtimeavailability",
  "properties": {
    "metadata": {
      "description": "This detector analyzes all the requests to all applications running on this app service environment.",
      "category": "Availability and Performance"
    },
    "dataset": [
      {
        "table": {
          "tableName": "Table_0",
          "columns": [
            {
              "columnName": "PreciseTimeStamp",
              "dataType": "DateTime",
              "columnType": "datetime"
            },
            {
              "columnName": "count_Http2xx",
              "dataType": "Int64",
              "columnType": "long"
            },
            {
              "columnName": "count_Http3xx",
              "dataType": "Int64",
              "columnType": "long"
            },
            {
              "columnName": "count_Http4xx",
              "dataType": "Int64",
              "columnType": "long"
            },
            {
              "columnName": "count_Http5xx",
              "dataType": "Int64",
              "columnType": "long"
            }
          ],
          "rows": [
            [
              "2018-03-27T00:25:00Z",
              "772705",
              "0",
              "0",
              "0"
            ],
            [
              "2018-03-27T00:30:00Z",
              "787069",
              "0",
              "0",
              "0"
            ],
            [
              "2018-03-27T00:35:00Z",
              "781627",
              "0",
              "1",
              "0"
            ],
            [
              "2018-03-27T00:40:00Z",
              "785017",
              "0",
              "0",
              "0"
            ],
            [
              "2018-03-27T00:45:00Z",
              "783518",
              "0",
              "0",
              "0"
            ],
            [
              "2018-03-27T00:50:00Z",
              "785783",
              "0",
              "0",
              "0"
            ],
            [
              "2018-03-27T00:55:00Z",
              "772874",
              "0",
              "0",
              "0"
            ],
            [
              "2018-03-27T01:00:00Z",
              "787162",
              "0",
              "0",
              "0"
            ],
            [
              "2018-03-27T01:05:00Z",
              "782036",
              "0",
              "0",
              "0"
            ],
            [
              "2018-03-27T01:10:00Z",
              "784642",
              "0",
              "0",
              "0"
            ]
          ]
        },
        "renderingProperties": {
          "title": "Requests by Status Code",
          "description": "This detector breaks down the number of requests that your apps on this app service environment received for each status code."
        }
      }
    ]
  }
}

Definiciones

Nombre	Description
DataProviderMetadata	Configuración adicional para proveedores de datos
DataTableResponseColumn	Definición de columnas
DataTableResponseObject	Tabla de datos que define columnas y valores de fila sin procesar
DefaultErrorResponse	Respuesta de error de App Service.
Details
DetectorInfo	Definición de Detector
DetectorResponse	Clase que representa la respuesta de Detector
DetectorType	Si este detector es un detector de análisis o no.
DiagnosticData	Conjunto de datos con instrucciones de representación
Error	Modelo de error.
InsightStatus	Nivel de la información más grave generada por el detector.
KeyValuePair[String,Object]
QueryUtterancesResult	Resultado de la consulta de expresiones.
QueryUtterancesResults	Expresiones sugeridas en las que se puede aplicar el detector
Rendering	Instrucciones para representar los datos
RenderingType	Tipo de representación
SampleUtterance	Expresión de ejemplo.
Status	Identifique el estado de la información más grave generada por el detector.
SupportTopic	Define un tema de soporte técnico único

DataProviderMetadata

Object

Configuración adicional para proveedores de datos

Nombre	Tipo	Description
propertyBag	KeyValuePair[String,Object][]	Configuración del proveedor de datos
providerName	string

DataTableResponseColumn

Object

Definición de columnas

Nombre	Tipo	Description
columnName	string	Nombre de la columna
columnType	string	Tipo columna
dataType	string	Tipo de datos similar a "String" o "Int32".

DataTableResponseObject

Object

Tabla de datos que define columnas y valores de fila sin procesar

Nombre	Tipo	Description
columns	DataTableResponseColumn[]	Lista de columnas con tipos de datos
rows	string[]	Valores de fila sin formato
tableName	string	Nombre de la tabla

DefaultErrorResponse

Object

Respuesta de error de App Service.

Nombre	Tipo	Description
error	Error	Modelo de error.

Details

Object

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar mediante programación el error.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

DetectorInfo

Object

Definición de Detector

Nombre	Tipo	Description
analysisType	string[]	Tipos de análisis a los que debe aplicarse este detector.
author	string	Autor del detector.
category	string	Categoría del problema. Esto sirve para organizar el grupo para los detectores.
description	string	Breve descripción del detector y su propósito.
id	string	Identificador del detector
name	string	Nombre del detector
score	number (float)	Define la puntuación de un detector para la coincidencia basada en ML.
supportTopicList	SupportTopic[]	Lista de temas de soporte técnico para los que está habilitado este detector.
type	DetectorType	Si este detector es un detector de análisis o no.

DetectorResponse

Object

Clase que representa la respuesta de Detector

Nombre	Tipo	Description
id	string	Identificador de recurso.
kind	string	Tipo de recurso.
name	string	Nombre del recurso.
properties.dataProvidersMetadata	DataProviderMetadata[]	Configuración adicional para distintos proveedores de datos que va a usar la interfaz de usuario
properties.dataset	DiagnosticData[]	Conjunto de datos
properties.metadata	DetectorInfo	metadatos del detector
properties.status	Status	Indica el estado de la información más grave.
properties.suggestedUtterances	QueryUtterancesResults	Expresiones sugeridas en las que el detector puede ser aplicable.
type	string	Tipo de recurso.

DetectorType

Enumeración

Si este detector es un detector de análisis o no.

Valor	Description
Analysis
CategoryOverview
Detector

DiagnosticData

Object

Conjunto de datos con instrucciones de representación

Nombre	Tipo	Description
renderingProperties	Rendering	Propiedades que describen cómo se debe representar la tabla
table	DataTableResponseObject	Datos en formulario de tabla

Error

Object

Modelo de error.

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar mediante programación el error.
details	Details[]	Errores detallados.
innererror	string	Más información para depurar el error.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

InsightStatus

Enumeración

Nivel de la información más grave generada por el detector.

Valor	Description
Critical
Info
None
Success
Warning

KeyValuePair[String,Object]

Object

Nombre	Tipo	Description
key	string
value	object

QueryUtterancesResult

Object

Resultado de la consulta de expresiones.

Nombre	Tipo	Description
sampleUtterance	SampleUtterance	Expresión de ejemplo.
score	number (float)	Puntuación de una expresión de ejemplo.

QueryUtterancesResults

Object

Expresiones sugeridas en las que se puede aplicar el detector

Nombre	Tipo	Description
query	string	Consulta de búsqueda.
results	QueryUtterancesResult[]	Matriz de resultados de expresiones para la consulta de búsqueda.

Rendering

Object

Instrucciones para representar los datos

Nombre	Tipo	Description
description	string	Descripción de los datos que le ayudarán a interpretarse
title	string	Título de los datos
type	RenderingType	Tipo de representación

RenderingType

Enumeración

Tipo de representación

Valor	Description
AppInsight
AppInsightEnablement
Card
ChangeAnalysisOnboarding
ChangeSets
ChangesView
DataSummary
DependencyGraph
Detector
DownTime
DropDown
DynamicInsight
Email
Form
Guage
Insights
Markdown
NoGraph
PieChart
SearchComponent
Solution
SummaryCard
Table
TimeSeries
TimeSeriesPerInstance

SampleUtterance

Object

Expresión de ejemplo.

Nombre	Tipo	Description
links	string[]	Atributo Links de la expresión de ejemplo.
qid	string	Identificador de pregunta de la expresión de ejemplo (para títulos de preguntas de stackoverflow).
text	string	Atributo de texto de la expresión de ejemplo.

Status

Object

Identifique el estado de la información más grave generada por el detector.

Nombre	Tipo	Description
message	string	Mensaje descriptivo.
statusId	InsightStatus	Nivel de la información más grave generada por el detector.

SupportTopic

Object

Define un tema de soporte técnico único

Nombre	Tipo	Description
id	string	Id. de tema de soporte técnico
pesId	string	Identificador de recurso único