diagnostics

Creates, updates, deletes, gets or lists a diagnostics resource.

Overview

Name	diagnostics
Type	Resource
Id	azure.web.diagnostics

Fields

The following fields are returned by SELECT queries:

get_site_analysis_slot

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	Description of the Analysis.
kind	string	Kind of resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_site_detector_slot

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	Description of the detector.
displayName	string	Display name of the detector.
isEnabled	boolean	Flag representing whether detector is enabled or not.
kind	string	Kind of resource.
rank	number	Detector Rank.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_site_analyses_slot

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	Description of the Analysis.
kind	string	Kind of resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_site_detector_response_slot

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
dataProvidersMetadata	array	Additional configuration for different data providers to be used by the UI.
dataset	array	Data Set.
kind	string	Kind of resource.
metadata	object	metadata for the detector.
status	object	Indicates status of the most severe insight.
suggestedUtterances	object	Suggested utterances where the detector can be applicable.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_site_analysis

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	Description of the Analysis.
kind	string	Kind of resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_site_detector

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	Description of the detector.
displayName	string	Display name of the detector.
isEnabled	boolean	Flag representing whether detector is enabled or not.
kind	string	Kind of resource.
rank	number	Detector Rank.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_site_detector_responses_slot

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
dataProvidersMetadata	array	Additional configuration for different data providers to be used by the UI.
dataset	array	Data Set.
kind	string	Kind of resource.
metadata	object	metadata for the detector.
status	object	Indicates status of the most severe insight.
suggestedUtterances	object	Suggested utterances where the detector can be applicable.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_site_analyses

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
description	string	Description of the Analysis.
kind	string	Kind of resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_site_detector_response

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
dataProvidersMetadata	array	Additional configuration for different data providers to be used by the UI.
dataset	array	Data Set.
kind	string	Kind of resource.
metadata	object	metadata for the detector.
status	object	Indicates status of the most severe insight.
suggestedUtterances	object	Suggested utterances where the detector can be applicable.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_hosting_environment_detector_response

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
dataProvidersMetadata	array	Additional configuration for different data providers to be used by the UI.
dataset	array	Data Set.
kind	string	Kind of resource.
metadata	object	metadata for the detector.
status	object	Indicates status of the most severe insight.
suggestedUtterances	object	Suggested utterances where the detector can be applicable.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_site_detector_responses

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
dataProvidersMetadata	array	Additional configuration for different data providers to be used by the UI.
dataset	array	Data Set.
kind	string	Kind of resource.
metadata	object	metadata for the detector.
status	object	Indicates status of the most severe insight.
suggestedUtterances	object	Suggested utterances where the detector can be applicable.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_hosting_environment_detector_responses

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
dataProvidersMetadata	array	Additional configuration for different data providers to be used by the UI.
dataset	array	Data Set.
kind	string	Kind of resource.
metadata	object	metadata for the detector.
status	object	Indicates status of the most severe insight.
suggestedUtterances	object	Suggested utterances where the detector can be applicable.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_site_analysis_slot	select	resource_group_name, site_name, diagnostic_category, analysis_name, slot, subscription_id		Get Site Analysis. Description for Get Site Analysis.
get_site_detector_slot	select	resource_group_name, site_name, diagnostic_category, detector_name, slot, subscription_id		Get Detector. Description for Get Detector.
list_site_analyses_slot	select	resource_group_name, site_name, diagnostic_category, slot, subscription_id		Get Site Analyses. Description for Get Site Analyses.
get_site_detector_response_slot	select	resource_group_name, site_name, detector_name, slot, subscription_id	startTime, endTime, timeGrain	Get site detector response. Description for Get site detector response.
get_site_analysis	select	resource_group_name, site_name, diagnostic_category, analysis_name, subscription_id		Get Site Analysis. Description for Get Site Analysis.
get_site_detector	select	resource_group_name, site_name, diagnostic_category, detector_name, subscription_id		Get Detector. Description for Get Detector.
list_site_detector_responses_slot	select	resource_group_name, site_name, slot, subscription_id		List Site Detector Responses. Description for List Site Detector Responses.
list_site_analyses	select	resource_group_name, site_name, diagnostic_category, subscription_id		Get Site Analyses. Description for Get Site Analyses.
get_site_detector_response	select	resource_group_name, site_name, detector_name, subscription_id	startTime, endTime, timeGrain	Get site detector response. Description for Get site detector response.
get_hosting_environment_detector_response	select	resource_group_name, name, detector_name, subscription_id	startTime, endTime, timeGrain	Get Hosting Environment Detector Response. Description for Get Hosting Environment Detector Response.
list_site_detector_responses	select	resource_group_name, site_name, subscription_id		List Site Detector Responses. Description for List Site Detector Responses.
list_hosting_environment_detector_responses	select	resource_group_name, name, subscription_id		List Hosting Environment Detector Responses. Description for List Hosting Environment Detector Responses.
list_site_diagnostic_categories	exec	resource_group_name, site_name, subscription_id		Get Diagnostics Categories. Description for Get Diagnostics Categories.
list_site_diagnostic_categories_slot	exec	resource_group_name, site_name, slot, subscription_id		Get Diagnostics Categories. Description for Get Diagnostics Categories.
list_site_detectors	exec	resource_group_name, site_name, diagnostic_category, subscription_id		Get Detectors. Description for Get Detectors.
list_site_detectors_slot	exec	resource_group_name, site_name, diagnostic_category, slot, subscription_id		Get Detectors. Description for Get Detectors.
get_site_diagnostic_category	exec	resource_group_name, site_name, diagnostic_category, subscription_id		Get Diagnostics Category. Description for Get Diagnostics Category.
get_site_diagnostic_category_slot	exec	resource_group_name, site_name, diagnostic_category, slot, subscription_id		Get Diagnostics Category. Description for Get Diagnostics Category.
execute_site_analysis	exec	resource_group_name, site_name, diagnostic_category, analysis_name, subscription_id	startTime, endTime, timeGrain	Execute Analysis. Description for Execute Analysis.
execute_site_analysis_slot	exec	resource_group_name, site_name, diagnostic_category, analysis_name, slot, subscription_id	startTime, endTime, timeGrain	Execute Analysis. Description for Execute Analysis.
execute_site_detector	exec	resource_group_name, site_name, detector_name, diagnostic_category, subscription_id	startTime, endTime, timeGrain	Execute Detector. Description for Execute Detector.
execute_site_detector_slot	exec	resource_group_name, site_name, detector_name, diagnostic_category, slot, subscription_id	startTime, endTime, timeGrain	Execute Detector. Description for Execute Detector.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
analysis_name	string	Analysis Name. Required.
detector_name	string	Detector Name. Required.
diagnostic_category	string	Diagnostic Category. Required.
name	string	App Service Environment Name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
site_name	string	Site Name. Required.
slot	string	Slot Name. Required.
subscription_id	string
endTime	string (date-time)	End Time. Default value is None.
startTime	string (date-time)	Start Time. Default value is None.
timeGrain	string	Time Grain. Default value is None.

SELECT examples

get_site_analysis_slot

Get Site Analysis. Description for Get Site Analysis.

SELECT
id,
name,
description,
kind,
systemData,
type
FROM azure.web.diagnostics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND site_name = '{{ site_name }}' -- required
AND diagnostic_category = '{{ diagnostic_category }}' -- required
AND analysis_name = '{{ analysis_name }}' -- required
AND slot = '{{ slot }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_site_detector_slot

Get Detector. Description for Get Detector.

SELECT
id,
name,
description,
displayName,
isEnabled,
kind,
rank,
systemData,
type
FROM azure.web.diagnostics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND site_name = '{{ site_name }}' -- required
AND diagnostic_category = '{{ diagnostic_category }}' -- required
AND detector_name = '{{ detector_name }}' -- required
AND slot = '{{ slot }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_site_analyses_slot

Get Site Analyses. Description for Get Site Analyses.

SELECT
id,
name,
description,
kind,
systemData,
type
FROM azure.web.diagnostics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND site_name = '{{ site_name }}' -- required
AND diagnostic_category = '{{ diagnostic_category }}' -- required
AND slot = '{{ slot }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_site_detector_response_slot

Get site detector response. Description for Get site detector response.

SELECT
id,
name,
dataProvidersMetadata,
dataset,
kind,
metadata,
status,
suggestedUtterances,
systemData,
type
FROM azure.web.diagnostics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND site_name = '{{ site_name }}' -- required
AND detector_name = '{{ detector_name }}' -- required
AND slot = '{{ slot }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND startTime = '{{ startTime }}'
AND endTime = '{{ endTime }}'
AND timeGrain = '{{ timeGrain }}'
;

get_site_analysis

Get Site Analysis. Description for Get Site Analysis.

SELECT
id,
name,
description,
kind,
systemData,
type
FROM azure.web.diagnostics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND site_name = '{{ site_name }}' -- required
AND diagnostic_category = '{{ diagnostic_category }}' -- required
AND analysis_name = '{{ analysis_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_site_detector

Get Detector. Description for Get Detector.

SELECT
id,
name,
description,
displayName,
isEnabled,
kind,
rank,
systemData,
type
FROM azure.web.diagnostics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND site_name = '{{ site_name }}' -- required
AND diagnostic_category = '{{ diagnostic_category }}' -- required
AND detector_name = '{{ detector_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_site_detector_responses_slot

List Site Detector Responses. Description for List Site Detector Responses.

SELECT
id,
name,
dataProvidersMetadata,
dataset,
kind,
metadata,
status,
suggestedUtterances,
systemData,
type
FROM azure.web.diagnostics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND site_name = '{{ site_name }}' -- required
AND slot = '{{ slot }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_site_analyses

Get Site Analyses. Description for Get Site Analyses.

SELECT
id,
name,
description,
kind,
systemData,
type
FROM azure.web.diagnostics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND site_name = '{{ site_name }}' -- required
AND diagnostic_category = '{{ diagnostic_category }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_site_detector_response

Get site detector response. Description for Get site detector response.

SELECT
id,
name,
dataProvidersMetadata,
dataset,
kind,
metadata,
status,
suggestedUtterances,
systemData,
type
FROM azure.web.diagnostics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND site_name = '{{ site_name }}' -- required
AND detector_name = '{{ detector_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND startTime = '{{ startTime }}'
AND endTime = '{{ endTime }}'
AND timeGrain = '{{ timeGrain }}'
;

get_hosting_environment_detector_response

Get Hosting Environment Detector Response. Description for Get Hosting Environment Detector Response.

SELECT
id,
name,
dataProvidersMetadata,
dataset,
kind,
metadata,
status,
suggestedUtterances,
systemData,
type
FROM azure.web.diagnostics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND detector_name = '{{ detector_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND startTime = '{{ startTime }}'
AND endTime = '{{ endTime }}'
AND timeGrain = '{{ timeGrain }}'
;

list_site_detector_responses

List Site Detector Responses. Description for List Site Detector Responses.

SELECT
id,
name,
dataProvidersMetadata,
dataset,
kind,
metadata,
status,
suggestedUtterances,
systemData,
type
FROM azure.web.diagnostics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND site_name = '{{ site_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_hosting_environment_detector_responses

List Hosting Environment Detector Responses. Description for List Hosting Environment Detector Responses.

SELECT
id,
name,
dataProvidersMetadata,
dataset,
kind,
metadata,
status,
suggestedUtterances,
systemData,
type
FROM azure.web.diagnostics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

list_site_diagnostic_categories

Get Diagnostics Categories. Description for Get Diagnostics Categories.

EXEC azure.web.diagnostics.list_site_diagnostic_categories 
@resource_group_name='{{ resource_group_name }}' --required, 
@site_name='{{ site_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_site_diagnostic_categories_slot

Get Diagnostics Categories. Description for Get Diagnostics Categories.

EXEC azure.web.diagnostics.list_site_diagnostic_categories_slot 
@resource_group_name='{{ resource_group_name }}' --required, 
@site_name='{{ site_name }}' --required, 
@slot='{{ slot }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_site_detectors

Get Detectors. Description for Get Detectors.

EXEC azure.web.diagnostics.list_site_detectors 
@resource_group_name='{{ resource_group_name }}' --required, 
@site_name='{{ site_name }}' --required, 
@diagnostic_category='{{ diagnostic_category }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_site_detectors_slot

Get Detectors. Description for Get Detectors.

EXEC azure.web.diagnostics.list_site_detectors_slot 
@resource_group_name='{{ resource_group_name }}' --required, 
@site_name='{{ site_name }}' --required, 
@diagnostic_category='{{ diagnostic_category }}' --required, 
@slot='{{ slot }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_site_diagnostic_category

Get Diagnostics Category. Description for Get Diagnostics Category.

EXEC azure.web.diagnostics.get_site_diagnostic_category 
@resource_group_name='{{ resource_group_name }}' --required, 
@site_name='{{ site_name }}' --required, 
@diagnostic_category='{{ diagnostic_category }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_site_diagnostic_category_slot

Get Diagnostics Category. Description for Get Diagnostics Category.

EXEC azure.web.diagnostics.get_site_diagnostic_category_slot 
@resource_group_name='{{ resource_group_name }}' --required, 
@site_name='{{ site_name }}' --required, 
@diagnostic_category='{{ diagnostic_category }}' --required, 
@slot='{{ slot }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

execute_site_analysis

Execute Analysis. Description for Execute Analysis.

EXEC azure.web.diagnostics.execute_site_analysis 
@resource_group_name='{{ resource_group_name }}' --required, 
@site_name='{{ site_name }}' --required, 
@diagnostic_category='{{ diagnostic_category }}' --required, 
@analysis_name='{{ analysis_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@startTime='{{ startTime }}', 
@endTime='{{ endTime }}', 
@timeGrain='{{ timeGrain }}'
;

execute_site_analysis_slot

Execute Analysis. Description for Execute Analysis.

EXEC azure.web.diagnostics.execute_site_analysis_slot 
@resource_group_name='{{ resource_group_name }}' --required, 
@site_name='{{ site_name }}' --required, 
@diagnostic_category='{{ diagnostic_category }}' --required, 
@analysis_name='{{ analysis_name }}' --required, 
@slot='{{ slot }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@startTime='{{ startTime }}', 
@endTime='{{ endTime }}', 
@timeGrain='{{ timeGrain }}'
;

execute_site_detector

Execute Detector. Description for Execute Detector.

EXEC azure.web.diagnostics.execute_site_detector 
@resource_group_name='{{ resource_group_name }}' --required, 
@site_name='{{ site_name }}' --required, 
@detector_name='{{ detector_name }}' --required, 
@diagnostic_category='{{ diagnostic_category }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@startTime='{{ startTime }}', 
@endTime='{{ endTime }}', 
@timeGrain='{{ timeGrain }}'
;

execute_site_detector_slot

Execute Detector. Description for Execute Detector.

EXEC azure.web.diagnostics.execute_site_detector_slot 
@resource_group_name='{{ resource_group_name }}' --required, 
@site_name='{{ site_name }}' --required, 
@detector_name='{{ detector_name }}' --required, 
@diagnostic_category='{{ diagnostic_category }}' --required, 
@slot='{{ slot }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@startTime='{{ startTime }}', 
@endTime='{{ endTime }}', 
@timeGrain='{{ timeGrain }}'
;