Diagnostics - Get Hosting Environment Detector Response

서비스:

App Service

API 버전:

2024-04-01

호스팅 환경 감지기 응답 가져오기에 대한 설명

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

선택적 매개 변수:

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-04-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
detectorName	path	True	string	Detector 리소스 이름
name	path	True	string	App Service Environment 이름
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	리소스가 속한 리소스 그룹의 이름입니다.
subscriptionId	path	True	string	Azure 구독 ID입니다. GUID 형식 문자열입니다(예: 000000000-0000-0000-0000-0000000000000).
api-version	query	True	string	API 버전
endTime	query		string (date-time)	종료 시간
startTime	query		string (date-time)	시작 시간
timeGrain	query		string pattern: PT[1-9][0-9]+[SMH]	시간 조직

응답

Name	형식	Description
200 OK	DetectorResponse	그래
Other Status Codes	DefaultErrorResponse	App Service 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Get App Service Environment Detector Responses

샘플 요청

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-04-01

Java

/**
 * Samples for Diagnostics GetHostingEnvironmentDetectorResponse.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-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-04-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/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b5d78da207e9c5d8f82e95224039867271f47cdf/specification/web/resource-manager/Microsoft.Web/stable/2024-04-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-04-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-04-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 HostingEnvironmentDetectorResource created on azure
// for more information of creating HostingEnvironmentDetectorResource, please refer to the document of HostingEnvironmentDetectorResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "Sample-WestUSResourceGroup";
string name = "SampleAppServiceEnvironment";
string detectorName = "runtimeavailability";
ResourceIdentifier hostingEnvironmentDetectorResourceId = HostingEnvironmentDetectorResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name, detectorName);
HostingEnvironmentDetectorResource hostingEnvironmentDetector = client.GetHostingEnvironmentDetectorResource(hostingEnvironmentDetectorResourceId);

// invoke the operation
HostingEnvironmentDetectorResource result = await hostingEnvironmentDetector.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
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

샘플 응답

상태 코드:

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

정의

Name	Description
DataProviderMetadata	데이터 공급자에 대한 추가 구성
DataTableResponseColumn	열 정의
DataTableResponseObject	열 및 원시 행 값을 정의하는 데이터 테이블
DefaultErrorResponse	App Service 오류 응답입니다.
Details
DetectorInfo	감지기의 정의
DetectorResponse	Detector의 응답을 나타내는 클래스
DetectorType	이 탐지기가 Analysis Detector인지 여부입니다.
DiagnosticData	렌더링 지침이 포함된 데이터 집합
Error	오류 모델입니다.
InsightStatus	탐지기에서 생성된 가장 심각한 인사이트 수준입니다.
KeyValuePair[String,Object]
QueryUtterancesResult	발화 쿼리의 결과입니다.
QueryUtterancesResults	감지기를 적용할 수 있는 제안된 발화
Rendering	데이터 렌더링 지침
RenderingType	렌더링 형식
SampleUtterance	샘플 발화.
Status	탐지기에서 생성된 가장 심각한 인사이트의 상태를 식별합니다.
SupportTopic	고유한 지원 항목을 정의합니다.

DataProviderMetadata

Object

데이터 공급자에 대한 추가 구성

Name	형식	Description
propertyBag	KeyValuePair[String,Object][]	데이터 공급자에 대한 설정
providerName	string

DataTableResponseColumn

Object

열 정의

Name	형식	Description
columnName	string	열의 이름
columnType	string	열 형식
dataType	string	'String' 또는 'Int32'와 같은 데이터 형식입니다.

DataTableResponseObject

Object

열 및 원시 행 값을 정의하는 데이터 테이블

Name	형식	Description
columns	DataTableResponseColumn[]	데이터 형식이 있는 열 목록
rows	string[]	원시 행 값
tableName	string	테이블의 이름

DefaultErrorResponse

Object

App Service 오류 응답입니다.

Name	형식	Description
error	Error	오류 모델입니다.

Details

Object

Name	형식	Description
code	string	프로그래밍 방식으로 오류를 식별하는 표준화된 문자열입니다.
message	string	자세한 오류 설명 및 디버깅 정보입니다.
target	string	자세한 오류 설명 및 디버깅 정보입니다.

DetectorInfo

Object

감지기의 정의

Name	형식	Description
analysisType	string[]	이 탐지기가 적용되어야 하는 분석 유형입니다.
author	string	탐지기의 작성자입니다.
category	string	문제 범주입니다. 이것은 검출기에 대한 그룹을 구성하는 데 사용됩니다.
description	string	탐지기 및 그 목적에 대한 간단한 설명입니다.
id	string	탐지기의 ID
name	string	탐지기 이름
score	number (float)	ML 기반 일치를 구동하는 탐지기의 점수를 정의합니다.
supportTopicList	SupportTopic[]	이 탐지기가 사용되는 지원 항목 목록입니다.
type	DetectorType	이 탐지기가 Analysis Detector인지 여부입니다.

DetectorResponse

Object

Detector의 응답을 나타내는 클래스

Name	형식	Description
id	string	리소스 ID입니다.
kind	string	리소스 종류입니다.
name	string	리소스 이름입니다.
properties.dataProvidersMetadata	DataProviderMetadata[]	UI에서 사용할 다른 데이터 공급자에 대한 추가 구성
properties.dataset	DiagnosticData[]	데이터 세트
properties.metadata	DetectorInfo	감지기에 대한 메타데이터
properties.status	Status	가장 심각한 인사이트의 상태를 나타냅니다.
properties.suggestedUtterances	QueryUtterancesResults	감지기를 적용할 수 있는 제안된 발화입니다.
type	string	리소스 종류입니다.

DetectorType

열거형

이 탐지기가 Analysis Detector인지 여부입니다.

값	Description
Analysis
CategoryOverview
Detector

DiagnosticData

Object

렌더링 지침이 포함된 데이터 집합

Name	형식	Description
renderingProperties	Rendering	테이블을 렌더링하는 방법을 설명하는 속성
table	DataTableResponseObject	테이블 형식의 데이터

Error

Object

오류 모델입니다.

Name	형식	Description
code	string	프로그래밍 방식으로 오류를 식별하는 표준화된 문자열입니다.
details	Details[]	자세한 오류입니다.
innererror	string	디버그 오류에 대한 자세한 정보입니다.
message	string	자세한 오류 설명 및 디버깅 정보입니다.
target	string	자세한 오류 설명 및 디버깅 정보입니다.

InsightStatus

열거형

탐지기에서 생성된 가장 심각한 인사이트 수준입니다.

값	Description
Critical
Info
None
Success
Warning

KeyValuePair[String,Object]

Object

Name	형식	Description
key	string
value	object

QueryUtterancesResult

Object

발화 쿼리의 결과입니다.

Name	형식	Description
sampleUtterance	SampleUtterance	샘플 발화입니다.
score	number (float)	샘플 발화의 점수입니다.

QueryUtterancesResults

Object

감지기를 적용할 수 있는 제안된 발화

Name	형식	Description
query	string	쿼리를 검색합니다.
results	QueryUtterancesResult[]	검색 쿼리에 대한 발화 결과의 배열입니다.

Rendering

Object

데이터 렌더링 지침

Name	형식	Description
description	string	해석에 도움이 되는 데이터에 대한 설명
title	string	데이터 제목
type	RenderingType	렌더링 형식

RenderingType

열거형

렌더링 형식

값	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

샘플 발화.

Name	형식	Description
links	string[]	샘플 발화의 특성을 연결합니다.
qid	string	샘플 발화의 질문 ID입니다(stackoverflow 질문 제목용).
text	string	샘플 발화의 텍스트 특성입니다.

Status

Object

탐지기에서 생성된 가장 심각한 인사이트의 상태를 식별합니다.

Name	형식	Description
message	string	설명 메시지입니다.
statusId	InsightStatus	탐지기에서 생성된 가장 심각한 인사이트 수준입니다.

SupportTopic

Object

고유한 지원 항목을 정의합니다.

Name	형식	Description
id	string	지원 항목 ID
pesId	string	고유 리소스 ID