settings

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

Overview

Name	settings
Type	Resource
Id	azure.security.settings

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
kind	string	the kind of the settings string
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

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
kind	string	the kind of the settings string
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	select	subscriptionId, settingName	api-version	Settings of different configurations in Microsoft Defender for Cloud
list	select	subscriptionId	api-version	Settings about different configurations in Microsoft Defender for Cloud
update	replace	subscriptionId, settingName, data__kind	api-version	updating settings about different configurations in Microsoft Defender for Cloud

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
settingName	string	The name of the setting
subscriptionId	string	Azure subscription ID
api-version	string	API version for the operation

SELECT examples

get

Settings of different configurations in Microsoft Defender for Cloud

SELECT
id,
name,
kind,
systemData,
type
FROM azure.security.settings
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND settingName = '{{ settingName }}' -- required
AND api-version = '{{ api-version }}'
;

list

Settings about different configurations in Microsoft Defender for Cloud

SELECT
id,
name,
kind,
systemData,
type
FROM azure.security.settings
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
;

REPLACE examples

update

updating settings about different configurations in Microsoft Defender for Cloud

REPLACE azure.security.settings
SET 
data__kind = '{{ kind }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND settingName = '{{ settingName }}' --required
AND data__kind = '{{ kind }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
kind,
systemData,
type;