Description for Get Site Analyses
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses?api-version=2023-01-01
URI Parameters
Name |
In |
Required |
Type |
Description |
diagnosticCategory
|
path |
True
|
string
|
Diagnostic Category
|
resourceGroupName
|
path |
True
|
string
|
Name of the resource group to which the resource belongs.
Regex pattern: ^[-\w\._\(\)]+[^\.]$
|
siteName
|
path |
True
|
string
|
Site Name
|
subscriptionId
|
path |
True
|
string
|
Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
|
api-version
|
query |
True
|
string
|
API Version
|
Responses
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name |
Description |
user_impersonation
|
impersonate your user account
|
Examples
List App Analyses
Sample Request
GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability/analyses?api-version=2023-01-01
/**
* Samples for Diagnostics ListSiteAnalyses.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/Diagnostics_ListSiteAnalyses.json
*/
/**
* Sample code: List App Analyses.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void listAppAnalyses(com.azure.resourcemanager.AzureResourceManager azure) {
azure.webApps().manager().serviceClient().getDiagnostics().listSiteAnalyses("Sample-WestUSResourceGroup",
"SampleApp", "availability", 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
from azure.identity import DefaultAzureCredential
from azure.mgmt.web import WebSiteManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-web
# USAGE
python diagnostics_list_site_analyses.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.list_site_analyses(
resource_group_name="Sample-WestUSResourceGroup",
site_name="SampleApp",
diagnostic_category="availability",
)
for item in response:
print(item)
# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/Diagnostics_ListSiteAnalyses.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
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/v2"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/738ab25fe76324897f273645906d4a0415068a6c/specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/Diagnostics_ListSiteAnalyses.json
func ExampleDiagnosticsClient_NewListSiteAnalysesPager_listAppAnalyses() {
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)
}
pager := clientFactory.NewDiagnosticsClient().NewListSiteAnalysesPager("Sample-WestUSResourceGroup", "SampleApp", "availability", nil)
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.DiagnosticAnalysisCollection = armappservice.DiagnosticAnalysisCollection{
// Value: []*armappservice.AnalysisDefinition{
// {
// Name: to.Ptr("appanalysis"),
// ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability/analyses/appanalysis"),
// Properties: &armappservice.AnalysisDefinitionProperties{
// Description: to.Ptr("Determine causes of availability loss as well as solutions for these problems"),
// },
// },
// {
// 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.AnalysisDefinitionProperties{
// Description: to.Ptr("Find the reasons that your app restarted"),
// },
// },
// {
// Name: to.Ptr("memoryanalysis"),
// ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability/analyses/memoryanalysis"),
// Properties: &armappservice.AnalysisDefinitionProperties{
// Description: to.Ptr("Detect issues with memory as well as suggest ways to troubleshoot memory problems"),
// },
// },
// {
// Name: to.Ptr("tcpconnectionsanalysis"),
// ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability/analyses/tcpconnectionsanalysis"),
// Properties: &armappservice.AnalysisDefinitionProperties{
// Description: to.Ptr("Analyze port usage and find out if a high number of connections is causing problems for your web app"),
// },
// },
// {
// Name: to.Ptr("perfanalysis"),
// ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability/analyses/perfanalysis"),
// Properties: &armappservice.AnalysisDefinitionProperties{
// Description: to.Ptr("Determine causes of performance degredation as well as solutions for these problems"),
// },
// }},
// }
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Description for Get Site Analyses
*
* @summary Description for Get Site Analyses
* x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/Diagnostics_ListSiteAnalyses.json
*/
async function listAppAnalyses() {
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 credential = new DefaultAzureCredential();
const client = new WebSiteManagementClient(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.diagnostics.listSiteAnalyses(
resourceGroupName,
siteName,
diagnosticCategory
)) {
resArray.push(item);
}
console.log(resArray);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample Response
{
"value": [
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability/analyses/appanalysis",
"name": "appanalysis",
"properties": {
"description": "Determine causes of availability loss as well as solutions for these problems"
}
},
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability/analyses/apprestartanalyses",
"name": "apprestartanalysis",
"properties": {
"description": "Find the reasons that your app restarted"
}
},
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability/analyses/memoryanalysis",
"name": "memoryanalysis",
"properties": {
"description": "Detect issues with memory as well as suggest ways to troubleshoot memory problems"
}
},
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability/analyses/tcpconnectionsanalysis",
"name": "tcpconnectionsanalysis",
"properties": {
"description": "Analyze port usage and find out if a high number of connections is causing problems for your web app"
}
},
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability/analyses/perfanalysis",
"name": "perfanalysis",
"properties": {
"description": "Determine causes of performance degredation as well as solutions for these problems"
}
}
]
}
List App Slot Analyses
Sample Request
GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability/analyses?api-version=2023-01-01
/**
* Samples for Diagnostics ListSiteAnalyses.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/Diagnostics_ListSiteAnalysesSlot.json
*/
/**
* Sample code: List App Slot Analyses.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void listAppSlotAnalyses(com.azure.resourcemanager.AzureResourceManager azure) {
azure.webApps().manager().serviceClient().getDiagnostics().listSiteAnalyses("Sample-WestUSResourceGroup",
"SampleApp", "availability", 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
from azure.identity import DefaultAzureCredential
from azure.mgmt.web import WebSiteManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-web
# USAGE
python diagnostics_list_site_analyses_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.list_site_analyses(
resource_group_name="Sample-WestUSResourceGroup",
site_name="SampleApp",
diagnostic_category="availability",
)
for item in response:
print(item)
# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/Diagnostics_ListSiteAnalysesSlot.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
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/v2"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/738ab25fe76324897f273645906d4a0415068a6c/specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/Diagnostics_ListSiteAnalysesSlot.json
func ExampleDiagnosticsClient_NewListSiteAnalysesPager_listAppSlotAnalyses() {
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)
}
pager := clientFactory.NewDiagnosticsClient().NewListSiteAnalysesPager("Sample-WestUSResourceGroup", "SampleApp", "availability", nil)
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.DiagnosticAnalysisCollection = armappservice.DiagnosticAnalysisCollection{
// Value: []*armappservice.AnalysisDefinition{
// {
// Name: to.Ptr("appanalysis"),
// ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/slots/staging/diagnostics/availability/analyses/appanalysis"),
// Properties: &armappservice.AnalysisDefinitionProperties{
// Description: to.Ptr("Determine causes of availability loss as well as solutions for these problems"),
// },
// },
// {
// 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.AnalysisDefinitionProperties{
// Description: to.Ptr("Find the reasons that your app restarted"),
// },
// },
// {
// Name: to.Ptr("memoryanalysis"),
// ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/slots/staging/diagnostics/availability/analyses/memoryanalysis"),
// Properties: &armappservice.AnalysisDefinitionProperties{
// Description: to.Ptr("Detect issues with memory as well as suggest ways to troubleshoot memory problems"),
// },
// },
// {
// Name: to.Ptr("tcpconnectionsanalysis"),
// ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/slots/staging/diagnostics/availability/analyses/tcpconnectionsanalysis"),
// Properties: &armappservice.AnalysisDefinitionProperties{
// Description: to.Ptr("Analyze port usage and find out if a high number of connections is causing problems for your web app"),
// },
// },
// {
// Name: to.Ptr("perfanalysis"),
// ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/slots/staging/diagnostics/availability/analyses/perfanalysis"),
// Properties: &armappservice.AnalysisDefinitionProperties{
// Description: to.Ptr("Determine causes of performance degredation as well as solutions for these problems"),
// },
// }},
// }
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Description for Get Site Analyses
*
* @summary Description for Get Site Analyses
* x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/Diagnostics_ListSiteAnalysesSlot.json
*/
async function listAppSlotAnalyses() {
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 credential = new DefaultAzureCredential();
const client = new WebSiteManagementClient(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.diagnostics.listSiteAnalyses(
resourceGroupName,
siteName,
diagnosticCategory
)) {
resArray.push(item);
}
console.log(resArray);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample Response
{
"value": [
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/slots/staging/diagnostics/availability/analyses/appanalysis",
"name": "appanalysis",
"properties": {
"description": "Determine causes of availability loss as well as solutions for these problems"
}
},
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/slots/staging/diagnostics/availability/analyses/apprestartanalyses",
"name": "apprestartanalysis",
"properties": {
"description": "Find the reasons that your app restarted"
}
},
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/slots/staging/diagnostics/availability/analyses/memoryanalysis",
"name": "memoryanalysis",
"properties": {
"description": "Detect issues with memory as well as suggest ways to troubleshoot memory problems"
}
},
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/slots/staging/diagnostics/availability/analyses/tcpconnectionsanalysis",
"name": "tcpconnectionsanalysis",
"properties": {
"description": "Analyze port usage and find out if a high number of connections is causing problems for your web app"
}
},
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/slots/staging/diagnostics/availability/analyses/perfanalysis",
"name": "perfanalysis",
"properties": {
"description": "Determine causes of performance degredation as well as solutions for these problems"
}
}
]
}
Definitions
AnalysisDefinition
Definition of Analysis
Name |
Type |
Description |
id
|
string
|
Resource Id.
|
kind
|
string
|
Kind of resource.
|
name
|
string
|
Resource Name.
|
properties.description
|
string
|
Description of the Analysis
|
type
|
string
|
Resource type.
|
DefaultErrorResponse
App Service error response.
Name |
Type |
Description |
error
|
Error
|
Error model.
|
Details
Name |
Type |
Description |
code
|
string
|
Standardized string to programmatically identify the error.
|
message
|
string
|
Detailed error description and debugging information.
|
target
|
string
|
Detailed error description and debugging information.
|
DiagnosticAnalysisCollection
Collection of Diagnostic Analyses
Name |
Type |
Description |
nextLink
|
string
|
Link to next page of resources.
|
value
|
AnalysisDefinition[]
|
Collection of resources.
|
Error
Error model.
Name |
Type |
Description |
code
|
string
|
Standardized string to programmatically identify the error.
|
details
|
Details[]
|
Detailed errors.
|
innererror
|
string
|
More information to debug error.
|
message
|
string
|
Detailed error description and debugging information.
|
target
|
string
|
Detailed error description and debugging information.
|