product_settings

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

Overview

Name	product_settings
Type	Resource
Id	azure.security_insight.product_settings

Fields

The following fields are returned by SELECT queries:

get

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.
etag	string	Etag of the azure resource.
kind	string	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. Required. Known values are: "Anomalies", "EyesOn", "EntityAnalytics", and "Ueba".
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	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
etag	string	Etag of the azure resource.
kind	string	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. Required. Known values are: "Anomalies", "EyesOn", "EntityAnalytics", and "Ueba".
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	resource_group_name, workspace_name, settings_name, subscription_id		Gets a setting.
list	select	resource_group_name, workspace_name, subscription_id		List of all the settings.
update	update	resource_group_name, workspace_name, settings_name, subscription_id, kind		Updates setting.
delete	delete	resource_group_name, workspace_name, settings_name, subscription_id		Delete setting of the product.

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. The name is case insensitive. Required.
settings_name	string	The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.

SELECT examples

get

Gets a setting.

SELECT
id,
name,
etag,
kind,
systemData,
type
FROM azure.security_insight.product_settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND settings_name = '{{ settings_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List of all the settings.

SELECT
id,
name,
etag,
kind,
systemData,
type
FROM azure.security_insight.product_settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

UPDATE examples

update

Updates setting.

UPDATE azure.security_insight.product_settings
SET 
kind = '{{ kind }}',
etag = '{{ etag }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND settings_name = '{{ settings_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND kind = '{{ kind }}' --required
RETURNING
id,
name,
etag,
kind,
systemData,
type;

DELETE examples

delete

Delete setting of the product.

DELETE FROM azure.security_insight.product_settings
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND settings_name = '{{ settings_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;