Diagnostics - Get Site Detector

Service:

App Service

API Version:

2023-12-01

Description for Get Detector

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors/{detectorName}?api-version=2023-12-01

URI Parameters

Name	In	Required	Type	Description
detectorName	path	True	string	Detector Name
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

Name	Type	Description
200 OK	DetectorDefinitionResource	OK
Other Status Codes	DefaultErrorResponse	App Service error response.

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

Get App Detector

Get App Slot Detector

Get App Detector

Sample Request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability/detectors/sitecrashes?api-version=2023-12-01

Sample Response

Status code:

200

{
  "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/diagnostics/availability/detectors/sitecrashes",
  "name": "sitecrashes",
  "properties": {
    "displayName": "Site Crash Events",
    "description": null,
    "rank": 9,
    "isEnabled": true
  }
}

Get App Slot Detector

Sample Request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/Sample-WestUSResourceGroup/providers/Microsoft.Web/sites/SampleApp/diagnostics/availability/detectors/sitecrashes?api-version=2023-12-01

Sample Response

Status code:

200

{
  "id": "/subscriptions/ef90e930-9d7f-4a60-8a99-748e0eea69de/resourceGroups/Build2015DemoRG/providers/Microsoft.Web/sites/BuggyBakery/slots/staging/diagnostics/availability/detectors/sitecrashes",
  "name": "sitecrashes",
  "properties": {
    "displayName": "Site Crash Events",
    "description": null,
    "rank": 9,
    "isEnabled": true
  }
}

Definitions

Name	Description
DefaultErrorResponse	App Service error response.
Details
DetectorDefinitionResource	ARM resource for a detector definition
Error	Error model.

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.

DetectorDefinitionResource

ARM resource for a detector definition

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.description	string	Description of the detector
properties.displayName	string	Display name of the detector
properties.isEnabled	boolean	Flag representing whether detector is enabled or not.
properties.rank	number	Detector Rank
type	string	Resource type.

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.