security_ml_analytics_settings

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

Overview

Name	security_ml_analytics_settings
Type	Resource
Id	azure.sentinel.security_ml_analytics_settings

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
etag	string	Etag of the azure resource
kind	string	The kind of security ML Analytics Settings

list

Name	Datatype	Description
etag	string	Etag of the azure resource
kind	string	The kind of security ML Analytics Settings

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, settingsResourceName		Gets the Security ML Analytics Settings.
list	select	subscriptionId, resourceGroupName, workspaceName		Gets all Security ML Analytics Settings.
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, settingsResourceName, data__kind		Creates or updates the Security ML Analytics Settings.
delete	delete	subscriptionId, resourceGroupName, workspaceName, settingsResourceName		Delete the Security ML Analytics Settings.

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
settingsResourceName	string	Security ML Analytics Settings resource name
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of the workspace.

SELECT examples

get

Gets the Security ML Analytics Settings.

SELECT
etag,
kind
FROM azure.sentinel.security_ml_analytics_settings
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND settingsResourceName = '{{ settingsResourceName }}' -- required
;

list

Gets all Security ML Analytics Settings.

SELECT
etag,
kind
FROM azure.sentinel.security_ml_analytics_settings
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
;

INSERT examples

create_or_update

Creates or updates the Security ML Analytics Settings.

INSERT INTO azure.sentinel.security_ml_analytics_settings (
data__etag,
data__kind,
subscriptionId,
resourceGroupName,
workspaceName,
settingsResourceName
)
SELECT 
'{{ etag }}',
'{{ kind }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ settingsResourceName }}'
RETURNING
etag,
kind
;

Manifest

# Description fields are for documentation purposes
- name: security_ml_analytics_settings
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the security_ml_analytics_settings resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the security_ml_analytics_settings resource.
    - name: workspaceName
      value: string
      description: Required parameter for the security_ml_analytics_settings resource.
    - name: settingsResourceName
      value: string
      description: Required parameter for the security_ml_analytics_settings resource.
    - name: etag
      value: string
      description: |
        Etag of the azure resource
    - name: kind
      value: string
      description: |
        The kind of security ML Analytics Settings
      valid_values: ['Anomaly']

DELETE examples

delete

Delete the Security ML Analytics Settings.

DELETE FROM azure.sentinel.security_ml_analytics_settings
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND settingsResourceName = '{{ settingsResourceName }}' --required
;