Diagnostics - Execute Site Analysis

サービス:

App Service

API バージョン:

2024-11-01

分析の実行の説明

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses/{analysisName}/execute?api-version=2024-11-01

省略可能なパラメーターを含む:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses/{analysisName}/execute?startTime={startTime}&endTime={endTime}&timeGrain={timeGrain}&api-version=2024-11-01

URI パラメーター

名前	/	必須	型	説明
analysisName	path	True	string	分析リソース名
diagnosticCategory	path	True	string	カテゴリ名
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	リソースが属するリソース グループの名前。
siteName	path	True	string	サイト名
subscriptionId	path	True	string	Azure のサブスクリプション ID。 これは GUID 形式の文字列です (例: 000000000-0000-0000-0000-000000000000)。
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]	時間グレイン

応答

名前	型	説明
200 OK	DiagnosticAnalysis	[OK]
Other Status Codes	DefaultErrorResponse	App Service エラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

Execute site analysis

Execute site slot analysis

Execute site analysis

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability/analyses/apprestartanalyses/execute?api-version=2024-11-01

Java

/**
 * Samples for Diagnostics ExecuteSiteAnalysisSlot.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/Diagnostics_ExecuteSiteAnalysis.json
     */
    /**
     * Sample code: Execute site analysis.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void executeSiteAnalysis(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getDiagnostics().executeSiteAnalysisSlotWithResponse(
            "Sample-WestUSResourceGroup", "SampleApp", "availability", "apprestartanalyses", "Production", 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_execute_site_analysis.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.execute_site_analysis(
        resource_group_name="Sample-WestUSResourceGroup",
        site_name="SampleApp",
        diagnostic_category="availability",
        analysis_name="apprestartanalyses",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/Diagnostics_ExecuteSiteAnalysis.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_ExecuteSiteAnalysis.json
func ExampleDiagnosticsClient_ExecuteSiteAnalysisSlot_executeSiteAnalysis() {
	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().ExecuteSiteAnalysisSlot(ctx, "Sample-WestUSResourceGroup", "SampleApp", "availability", "apprestartanalyses", "Production", &armappservice.DiagnosticsClientExecuteSiteAnalysisSlotOptions{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.DiagnosticAnalysis = armappservice.DiagnosticAnalysis{
	// 	Name: to.Ptr("apprestartanalysis"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability/analyses/apprestartanalyses"),
	// 	Properties: &armappservice.DiagnosticAnalysisProperties{
	// 		AbnormalTimePeriods: []*armappservice.AbnormalTimePeriod{
	// 			{
	// 				EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T22:50:00.000Z"); return t}()),
	// 				Events: []*armappservice.DetectorAbnormalTimePeriod{
	// 					{
	// 						Type: to.Ptr(armappservice.IssueTypeServiceIncident),
	// 						EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T22:21:48.000Z"); return t}()),
	// 						Message: to.Ptr("Your application process was restarted as application environment variables changed. This can most likely occur due to update in app settings or swap operation. This event occurred multiple times during the day."),
	// 						MetaData: [][]*armappservice.NameValuePair{
	// 							[]*armappservice.NameValuePair{
	// 								{
	// 									Name: to.Ptr("feature"),
	// 									Value: to.Ptr("auditlogs"),
	// 								},
	// 								{
	// 									Name: to.Ptr("displayedName"),
	// 									Value: to.Ptr("Check Audit Logs"),
	// 						}}},
	// 						Priority: to.Ptr[float64](0),
	// 						Solutions: []*armappservice.Solution{
	// 						},
	// 						StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T22:21:50.000Z"); return t}()),
	// 				}},
	// 				Solutions: []*armappservice.Solution{
	// 				},
	// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-05T22:50:00.000Z"); return t}()),
	// 		}},
	// 		EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T22:50:00.000Z"); return t}()),
	// 		NonCorrelatedDetectors: []*armappservice.DetectorDefinition{
	// 		},
	// 		Payload: []*armappservice.AnalysisData{
	// 			{
	// 				Data: [][]*armappservice.NameValuePair{
	// 				},
	// 				Metrics: []*armappservice.DiagnosticMetricSet{
	// 					{
	// 						Name: to.Ptr("All Application Stop Events"),
	// 						EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T22:50:00.000Z"); return t}()),
	// 						StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-05T22:50:00.000Z"); return t}()),
	// 						TimeGrain: to.Ptr("00:05:00"),
	// 						Values: []*armappservice.DiagnosticMetricSample{
	// 							{
	// 								RoleInstance: to.Ptr("RD00155D3C15BE"),
	// 								Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T00:00:00.000Z"); return t}()),
	// 								Total: to.Ptr[float64](2),
	// 							},
	// 							{
	// 								IsAggregated: to.Ptr(true),
	// 								Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T00:00:00.000Z"); return t}()),
	// 								Total: to.Ptr[float64](2),
	// 							},
	// 							{
	// 								RoleInstance: to.Ptr("RD00155D3C15C1"),
	// 								Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T00:10:00.000Z"); return t}()),
	// 								Total: to.Ptr[float64](2),
	// 							},
	// 							{
	// 								RoleInstance: to.Ptr("RD00155D3BE0FB"),
	// 								Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T00:10:00.000Z"); return t}()),
	// 								Total: to.Ptr[float64](2),
	// 							},
	// 							{
	// 								IsAggregated: to.Ptr(true),
	// 								Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T00:10:00.000Z"); return t}()),
	// 								Total: to.Ptr[float64](4),
	// 						}},
	// 					},
	// 					{
	// 						Name: to.Ptr("User Events"),
	// 						EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T22:50:00.000Z"); return t}()),
	// 						StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-05T22:50:00.000Z"); return t}()),
	// 						TimeGrain: to.Ptr("00:05:00"),
	// 						Unit: to.Ptr(""),
	// 						Values: []*armappservice.DiagnosticMetricSample{
	// 							{
	// 								IsAggregated: to.Ptr(true),
	// 								Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T22:20:00.000Z"); return t}()),
	// 								Total: to.Ptr[float64](3),
	// 							},
	// 							{
	// 								RoleInstance: to.Ptr("RD00155D3C09FC"),
	// 								Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T22:20:00.000Z"); return t}()),
	// 								Total: to.Ptr[float64](1),
	// 							},
	// 							{
	// 								RoleInstance: to.Ptr("RD00155D3C2ADC"),
	// 								Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T22:20:00.000Z"); return t}()),
	// 								Total: to.Ptr[float64](1),
	// 							},
	// 							{
	// 								RoleInstance: to.Ptr("RD00155D3C214E"),
	// 								Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T22:20:00.000Z"); return t}()),
	// 								Total: to.Ptr[float64](1),
	// 						}},
	// 				}},
	// 				Source: to.Ptr("workerprocessrecycle"),
	// 		}},
	// 		StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-05T22:50:00.000Z"); return t}()),
	// 	},
	// }
}

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 Execute Analysis
 *
 * @summary Description for Execute Analysis
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/Diagnostics_ExecuteSiteAnalysis.json
 */
async function executeSiteAnalysis() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName =
    process.env["APPSERVICE_RESOURCE_GROUP"] || "Sample-WestUSResourceGroup";
  const siteName = "SampleApp";
  const diagnosticCategory = "availability";
  const analysisName = "apprestartanalyses";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.diagnostics.executeSiteAnalysis(
    resourceGroupName,
    siteName,
    diagnosticCategory,
    analysisName,
  );
  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.Models;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/Diagnostics_ExecuteSiteAnalysis.json
// this example is just showing the usage of "Diagnostics_ExecuteSiteAnalysis" 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 SiteDiagnosticAnalysisResource created on azure
// for more information of creating SiteDiagnosticAnalysisResource, please refer to the document of SiteDiagnosticAnalysisResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "Sample-WestUSResourceGroup";
string siteName = "SampleApp";
string diagnosticCategory = "availability";
string analysisName = "apprestartanalyses";
ResourceIdentifier siteDiagnosticAnalysisResourceId = SiteDiagnosticAnalysisResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, siteName, diagnosticCategory, analysisName);
SiteDiagnosticAnalysisResource siteDiagnosticAnalysis = client.GetSiteDiagnosticAnalysisResource(siteDiagnosticAnalysisResourceId);

// invoke the operation
DiagnosticAnalysis result = await siteDiagnosticAnalysis.ExecuteAsync();

Console.WriteLine($"Succeeded: {result}");

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/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability/analyses/apprestartanalyses",
  "name": "apprestartanalysis",
  "properties": {
    "startTime": "2017-11-05T22:50:00Z",
    "endTime": "2017-11-06T22:50:00Z",
    "abnormalTimePeriods": [
      {
        "startTime": "2017-11-05T22:50:00Z",
        "endTime": "2017-11-06T22:50:00Z",
        "events": [
          {
            "startTime": "2017-11-06T22:21:50Z",
            "endTime": "2017-11-06T22:21:48Z",
            "message": "Your application process was restarted as application environment variables changed. This can most likely occur due to update in app settings or swap operation. This event occurred multiple times during the day.",
            "source": null,
            "priority": 0,
            "metaData": [
              [
                {
                  "name": "feature",
                  "value": "auditlogs"
                },
                {
                  "name": "displayedName",
                  "value": "Check Audit Logs"
                }
              ]
            ],
            "type": "ServiceIncident",
            "solutions": []
          }
        ],
        "solutions": []
      }
    ],
    "payload": [
      {
        "source": "workerprocessrecycle",
        "metrics": [
          {
            "name": "All Application Stop Events",
            "unit": null,
            "startTime": "2017-11-05T22:50:00Z",
            "endTime": "2017-11-06T22:50:00Z",
            "timeGrain": "00:05:00",
            "values": [
              {
                "timestamp": "2017-11-06T00:00:00Z",
                "roleInstance": "RD00155D3C15BE",
                "total": 2
              },
              {
                "timestamp": "2017-11-06T00:00:00Z",
                "total": 2,
                "isAggregated": true
              },
              {
                "timestamp": "2017-11-06T00:10:00Z",
                "roleInstance": "RD00155D3C15C1",
                "total": 2
              },
              {
                "timestamp": "2017-11-06T00:10:00Z",
                "roleInstance": "RD00155D3BE0FB",
                "total": 2
              },
              {
                "timestamp": "2017-11-06T00:10:00Z",
                "total": 4,
                "isAggregated": true
              }
            ]
          },
          {
            "name": "User Events",
            "unit": "",
            "startTime": "2017-11-05T22:50:00Z",
            "endTime": "2017-11-06T22:50:00Z",
            "timeGrain": "00:05:00",
            "values": [
              {
                "timestamp": "2017-11-06T22:20:00Z",
                "total": 3,
                "isAggregated": true
              },
              {
                "timestamp": "2017-11-06T22:20:00Z",
                "roleInstance": "RD00155D3C09FC",
                "total": 1
              },
              {
                "timestamp": "2017-11-06T22:20:00Z",
                "roleInstance": "RD00155D3C2ADC",
                "total": 1
              },
              {
                "timestamp": "2017-11-06T22:20:00Z",
                "roleInstance": "RD00155D3C214E",
                "total": 1
              }
            ]
          }
        ],
        "data": [],
        "detectorMetaData": null
      }
    ],
    "nonCorrelatedDetectors": []
  }
}

Execute site slot analysis

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability/analyses/apprestartanalyses/execute?api-version=2024-11-01

Java

/**
 * Samples for Diagnostics ExecuteSiteAnalysisSlot.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/Diagnostics_ExecuteSiteAnalysisSlot.
     * json
     */
    /**
     * Sample code: Execute site slot analysis.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void executeSiteSlotAnalysis(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getDiagnostics().executeSiteAnalysisSlotWithResponse(
            "Sample-WestUSResourceGroup", "SampleApp", "availability", "apprestartanalyses", "staging", 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_execute_site_analysis_slot.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.execute_site_analysis(
        resource_group_name="Sample-WestUSResourceGroup",
        site_name="SampleApp",
        diagnostic_category="availability",
        analysis_name="apprestartanalyses",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/Diagnostics_ExecuteSiteAnalysisSlot.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_ExecuteSiteAnalysisSlot.json
func ExampleDiagnosticsClient_ExecuteSiteAnalysisSlot_executeSiteSlotAnalysis() {
	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().ExecuteSiteAnalysisSlot(ctx, "Sample-WestUSResourceGroup", "SampleApp", "availability", "apprestartanalyses", "staging", &armappservice.DiagnosticsClientExecuteSiteAnalysisSlotOptions{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.DiagnosticAnalysis = armappservice.DiagnosticAnalysis{
	// 	Name: to.Ptr("apprestartanalysis"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/slots/staging/diagnostics/availability/analyses/apprestartanalyses"),
	// 	Properties: &armappservice.DiagnosticAnalysisProperties{
	// 		AbnormalTimePeriods: []*armappservice.AbnormalTimePeriod{
	// 			{
	// 				EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T22:50:00.000Z"); return t}()),
	// 				Events: []*armappservice.DetectorAbnormalTimePeriod{
	// 					{
	// 						Type: to.Ptr(armappservice.IssueTypeServiceIncident),
	// 						EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T22:21:48.000Z"); return t}()),
	// 						Message: to.Ptr("Your application process was restarted as application environment variables changed. This can most likely occur due to update in app settings or swap operation. This event occurred multiple times during the day."),
	// 						MetaData: [][]*armappservice.NameValuePair{
	// 							[]*armappservice.NameValuePair{
	// 								{
	// 									Name: to.Ptr("feature"),
	// 									Value: to.Ptr("auditlogs"),
	// 								},
	// 								{
	// 									Name: to.Ptr("displayedName"),
	// 									Value: to.Ptr("Check Audit Logs"),
	// 						}}},
	// 						Priority: to.Ptr[float64](0),
	// 						Solutions: []*armappservice.Solution{
	// 						},
	// 						StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T22:21:50.000Z"); return t}()),
	// 				}},
	// 				Solutions: []*armappservice.Solution{
	// 				},
	// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-05T22:50:00.000Z"); return t}()),
	// 		}},
	// 		EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T22:50:00.000Z"); return t}()),
	// 		NonCorrelatedDetectors: []*armappservice.DetectorDefinition{
	// 		},
	// 		Payload: []*armappservice.AnalysisData{
	// 			{
	// 				Data: [][]*armappservice.NameValuePair{
	// 				},
	// 				Metrics: []*armappservice.DiagnosticMetricSet{
	// 					{
	// 						Name: to.Ptr("All Application Stop Events"),
	// 						EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T22:50:00.000Z"); return t}()),
	// 						StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-05T22:50:00.000Z"); return t}()),
	// 						TimeGrain: to.Ptr("00:05:00"),
	// 						Values: []*armappservice.DiagnosticMetricSample{
	// 							{
	// 								RoleInstance: to.Ptr("RD00155D3C15BE"),
	// 								Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T00:00:00.000Z"); return t}()),
	// 								Total: to.Ptr[float64](2),
	// 							},
	// 							{
	// 								IsAggregated: to.Ptr(true),
	// 								Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T00:00:00.000Z"); return t}()),
	// 								Total: to.Ptr[float64](2),
	// 							},
	// 							{
	// 								RoleInstance: to.Ptr("RD00155D3C15C1"),
	// 								Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T00:10:00.000Z"); return t}()),
	// 								Total: to.Ptr[float64](2),
	// 							},
	// 							{
	// 								RoleInstance: to.Ptr("RD00155D3BE0FB"),
	// 								Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T00:10:00.000Z"); return t}()),
	// 								Total: to.Ptr[float64](2),
	// 							},
	// 							{
	// 								IsAggregated: to.Ptr(true),
	// 								Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T00:10:00.000Z"); return t}()),
	// 								Total: to.Ptr[float64](4),
	// 						}},
	// 					},
	// 					{
	// 						Name: to.Ptr("User Events"),
	// 						EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T22:50:00.000Z"); return t}()),
	// 						StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-05T22:50:00.000Z"); return t}()),
	// 						TimeGrain: to.Ptr("00:05:00"),
	// 						Unit: to.Ptr(""),
	// 						Values: []*armappservice.DiagnosticMetricSample{
	// 							{
	// 								IsAggregated: to.Ptr(true),
	// 								Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T22:20:00.000Z"); return t}()),
	// 								Total: to.Ptr[float64](3),
	// 							},
	// 							{
	// 								RoleInstance: to.Ptr("RD00155D3C09FC"),
	// 								Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T22:20:00.000Z"); return t}()),
	// 								Total: to.Ptr[float64](1),
	// 							},
	// 							{
	// 								RoleInstance: to.Ptr("RD00155D3C2ADC"),
	// 								Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T22:20:00.000Z"); return t}()),
	// 								Total: to.Ptr[float64](1),
	// 							},
	// 							{
	// 								RoleInstance: to.Ptr("RD00155D3C214E"),
	// 								Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-06T22:20:00.000Z"); return t}()),
	// 								Total: to.Ptr[float64](1),
	// 						}},
	// 				}},
	// 				Source: to.Ptr("workerprocessrecycle"),
	// 		}},
	// 		StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-11-05T22:50:00.000Z"); return t}()),
	// 	},
	// }
}

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 Execute Analysis
 *
 * @summary Description for Execute Analysis
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/Diagnostics_ExecuteSiteAnalysisSlot.json
 */
async function executeSiteSlotAnalysis() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName =
    process.env["APPSERVICE_RESOURCE_GROUP"] || "Sample-WestUSResourceGroup";
  const siteName = "SampleApp";
  const diagnosticCategory = "availability";
  const analysisName = "apprestartanalyses";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.diagnostics.executeSiteAnalysis(
    resourceGroupName,
    siteName,
    diagnosticCategory,
    analysisName,
  );
  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.Models;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/Diagnostics_ExecuteSiteAnalysisSlot.json
// this example is just showing the usage of "Diagnostics_ExecuteSiteAnalysis" 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 SiteDiagnosticAnalysisResource created on azure
// for more information of creating SiteDiagnosticAnalysisResource, please refer to the document of SiteDiagnosticAnalysisResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "Sample-WestUSResourceGroup";
string siteName = "SampleApp";
string diagnosticCategory = "availability";
string analysisName = "apprestartanalyses";
ResourceIdentifier siteDiagnosticAnalysisResourceId = SiteDiagnosticAnalysisResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, siteName, diagnosticCategory, analysisName);
SiteDiagnosticAnalysisResource siteDiagnosticAnalysis = client.GetSiteDiagnosticAnalysisResource(siteDiagnosticAnalysisResourceId);

// invoke the operation
DiagnosticAnalysis result = await siteDiagnosticAnalysis.ExecuteAsync();

Console.WriteLine($"Succeeded: {result}");

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/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/slots/staging/diagnostics/availability/analyses/apprestartanalyses",
  "name": "apprestartanalysis",
  "properties": {
    "startTime": "2017-11-05T22:50:00Z",
    "endTime": "2017-11-06T22:50:00Z",
    "abnormalTimePeriods": [
      {
        "startTime": "2017-11-05T22:50:00Z",
        "endTime": "2017-11-06T22:50:00Z",
        "events": [
          {
            "startTime": "2017-11-06T22:21:50Z",
            "endTime": "2017-11-06T22:21:48Z",
            "message": "Your application process was restarted as application environment variables changed. This can most likely occur due to update in app settings or swap operation. This event occurred multiple times during the day.",
            "source": null,
            "priority": 0,
            "metaData": [
              [
                {
                  "name": "feature",
                  "value": "auditlogs"
                },
                {
                  "name": "displayedName",
                  "value": "Check Audit Logs"
                }
              ]
            ],
            "type": "ServiceIncident",
            "solutions": []
          }
        ],
        "solutions": []
      }
    ],
    "payload": [
      {
        "source": "workerprocessrecycle",
        "metrics": [
          {
            "name": "All Application Stop Events",
            "unit": null,
            "startTime": "2017-11-05T22:50:00Z",
            "endTime": "2017-11-06T22:50:00Z",
            "timeGrain": "00:05:00",
            "values": [
              {
                "timestamp": "2017-11-06T00:00:00Z",
                "roleInstance": "RD00155D3C15BE",
                "total": 2
              },
              {
                "timestamp": "2017-11-06T00:00:00Z",
                "total": 2,
                "isAggregated": true
              },
              {
                "timestamp": "2017-11-06T00:10:00Z",
                "roleInstance": "RD00155D3C15C1",
                "total": 2
              },
              {
                "timestamp": "2017-11-06T00:10:00Z",
                "roleInstance": "RD00155D3BE0FB",
                "total": 2
              },
              {
                "timestamp": "2017-11-06T00:10:00Z",
                "total": 4,
                "isAggregated": true
              }
            ]
          },
          {
            "name": "User Events",
            "unit": "",
            "startTime": "2017-11-05T22:50:00Z",
            "endTime": "2017-11-06T22:50:00Z",
            "timeGrain": "00:05:00",
            "values": [
              {
                "timestamp": "2017-11-06T22:20:00Z",
                "total": 3,
                "isAggregated": true
              },
              {
                "timestamp": "2017-11-06T22:20:00Z",
                "roleInstance": "RD00155D3C09FC",
                "total": 1
              },
              {
                "timestamp": "2017-11-06T22:20:00Z",
                "roleInstance": "RD00155D3C2ADC",
                "total": 1
              },
              {
                "timestamp": "2017-11-06T22:20:00Z",
                "roleInstance": "RD00155D3C214E",
                "total": 1
              }
            ]
          }
        ],
        "data": [],
        "detectorMetaData": null
      }
    ],
    "nonCorrelatedDetectors": []
  }
}

定義

名前	説明
AbnormalTimePeriod	診断で特定された異常な期間を表すクラス
AnalysisData	分析に使用される検出器の証拠を表すクラス
DataSource	検出器で使用されるデータ ソースを表すクラス
DefaultErrorResponse	App Service エラー応答。
Details
DetectorAbnormalTimePeriod	異常な期間を表すクラスが検出されました。
DetectorDefinition	検出器の定義を表すクラス
DiagnosticAnalysis	アプリケーションで実行される診断分析を表すクラス
DiagnosticMetricSample	診断メトリックを表すクラス
DiagnosticMetricSet	診断メトリック情報を表すクラス
Error	エラー モデル。
IssueType	Detector の種類を表します。
NameValuePair	名前の値のペア。
ResponseMetaData
Solution	問題の解決策を表すクラスが検出されました。
SolutionType	ソリューションの種類

AbnormalTimePeriod

Object

診断で特定された異常な期間を表すクラス

名前	型	説明
endTime	string (date-time)	ダウンタイムの終了時刻
events	DetectorAbnormalTimePeriod[]	ダウンタイムの考えられる原因の一覧
solutions	Solution[]	提案されたソリューションの一覧
startTime	string (date-time)	ダウンタイムの開始時刻

AnalysisData

Object

分析に使用される検出器の証拠を表すクラス

名前	型	説明
data	NameValuePair[]	その他のソース データ
detectorDefinition	DetectorDefinition	Detector の定義
detectorMetaData	ResponseMetaData	Detector メタ データ
metrics	DiagnosticMetricSet[]	ソース メトリック
source	string	Detector の名前

DataSource

Object

検出器で使用されるデータ ソースを表すクラス

名前	型	説明
dataSourceUri	NameValuePair[]	データソース URI リンク
instructions	string[]	データ ソースに対する手順 (ある場合)

DefaultErrorResponse

Object

App Service エラー応答。

名前	型	説明
error	Error	エラー モデル。

Details

Object

名前	型	説明
code	string	プログラムによってエラーを識別するための標準化された文字列。
message	string	エラーの詳細な説明とデバッグ情報。
target	string	エラーの詳細な説明とデバッグ情報。

DetectorAbnormalTimePeriod

Object

異常な期間を表すクラスが検出されました。

名前	型	説明
endTime	string (date-time)	関連付けられたイベントの終了時刻
message	string	イベントを説明するメッセージ
metaData	NameValuePair[]	ダウンタイム メタデータ
priority	number (double)	検出機能のランクを表します。
solutions	Solution[]	提案されたソリューションの一覧
source	string	Detector の名前を表します。
startTime	string (date-time)	関連付けられたイベントの開始時刻
type	IssueType	Detector の種類を表します。

DetectorDefinition

Object

検出器の定義を表すクラス

名前	型	説明
description	string	検出器の説明
displayName	string	検出器の表示名
isEnabled	boolean	検出機能が有効かどうかを表すフラグ。
rank	number (double)	検出器ランク

DiagnosticAnalysis

Object

アプリケーションで実行される診断分析を表すクラス

名前	型	説明
id	string	リソース ID。
kind	string	リソースの種類。
name	string	リソース名。
properties.abnormalTimePeriods	AbnormalTimePeriod[]	期間の一覧。
properties.endTime	string (date-time)	期間の終了時刻
properties.nonCorrelatedDetectors	DetectorDefinition[]	コアレートしなかった検出器の各検出器によるデータ
properties.payload	AnalysisData[]	各検出器によるデータ
properties.startTime	string (date-time)	期間の開始時刻
type	string	リソースの種類。

DiagnosticMetricSample

Object

診断メトリックを表すクラス

名前	型	説明
isAggregated	boolean	値がすべてのワーカーにわたって集計されているかどうか
maximum	number (double)	期間中にサンプリングされたメトリックの最大値
minimum	number (double)	期間中にサンプリングされたメトリックの最小値
roleInstance	string	ロール インスタンス。 このカウンターがインスタンスごとにない場合は Null。これは返され、返される必要があるインスタンス名である必要があります。つまり、CPU とメモリは RDWORKERNAME (LargeDed..._IN_0) を返します。RDWORKERNAME は下のマシン名で、RoleInstance 名はかっこで指定します。
timestamp	string (date-time)	メトリックを測定する時刻
total	number (double)	メトリックの合計値。 複数の測定値が行われる場合、これはすべて合計になります。

DiagnosticMetricSet

Object

診断メトリック情報を表すクラス

名前	型	説明
endTime	string (date-time)	期間の終了時刻
name	string	メトリックの名前
startTime	string (date-time)	期間の開始時刻
timeGrain	string	表示される時間グレイン。 現時点でサポートされているグレインは PT1M、PT1H、P1D です
unit	string	メトリックの単位
values	DiagnosticMetricSample[]	{Microsoft.Web.Hosting.Administration.DiagnosticMetricSet.TimeGrain} に基づく、選択した期間のメトリック値のコレクション

Error

Object

エラー モデル。

名前	型	説明
code	string	プログラムによってエラーを識別するための標準化された文字列。
details	Details[]	詳細なエラー。
innererror	string	デバッグ エラーの詳細。
message	string	エラーの詳細な説明とデバッグ情報。
target	string	エラーの詳細な説明とデバッグ情報。

IssueType

列挙

Detector の種類を表します。

値	説明
AppCrash
AppDeployment
AseDeployment
Other
PlatformIssue
RuntimeIssueDetected
ServiceIncident
UserIssue

NameValuePair

Object

名前の値のペア。

名前	型	説明
name	string	ペア名。
value	string	ペア値。

ResponseMetaData

Object

名前	型	説明
dataSource	DataSource	データのソース

Solution

Object

問題の解決策を表すクラスが検出されました。

名前	型	説明
data	NameValuePair[]	ソリューション データ。
description	string	ソリューションの説明
displayName	string	ソリューションの表示名
id	number (double)	ソリューション ID。
metadata	NameValuePair[]	ソリューション メタデータ。
order	number (double)	ソリューションの順序。
type	SolutionType	ソリューションの種類

SolutionType

列挙

ソリューションの種類

値	説明
BestPractices
DeepInvestigation
QuickSolution