monitoring_settings

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

Overview

Name	monitoring_settings
Type	Resource
Id	azure_extras.app_platform.monitoring_settings

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
appInsightsAgentVersions	object	Indicates the versions of application insight agent.
appInsightsInstrumentationKey	string	Target application insight instrumentation key, null or whitespace include empty will disable monitoringSettings.
appInsightsSamplingRate	number	Indicates the sampling rate of application insight agent, should be in range [0.0, 100.0].
error	object	Error when apply Monitoring Setting changes.
provisioningState	string	State of the Monitoring Setting. Known values are: "NotAvailable", "Failed", "Succeeded", and "Updating".
systemData	object	Metadata pertaining to creation and last modification of the resource.
traceEnabled	boolean	Indicates whether enable the trace functionality, which will be deprecated since api version 2020-11-01-preview. Please leverage appInsightsInstrumentationKey to indicate if monitoringSettings enabled or not.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, subscription_id		Get the Monitoring Setting and its properties.
update_put	exec	resource_group_name, service_name, subscription_id		Update the Monitoring Setting.
update_patch	exec	resource_group_name, service_name, subscription_id		Update the Monitoring Setting.

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
resource_group_name	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
service_name	string	The name of the Service resource. Required.
subscription_id	string

SELECT examples

get

Get the Monitoring Setting and its properties.

SELECT
id,
name,
appInsightsAgentVersions,
appInsightsInstrumentationKey,
appInsightsSamplingRate,
error,
provisioningState,
systemData,
traceEnabled,
type
FROM azure_extras.app_platform.monitoring_settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

update_put

Update the Monitoring Setting.

EXEC azure_extras.app_platform.monitoring_settings.update_put 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

update_patch

Update the Monitoring Setting.

EXEC azure_extras.app_platform.monitoring_settings.update_patch 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;