Microsoft.Security settings

• Latest
• 2022-05-01
• 2021-07-01
• 2021-06-01
• 2019-01-01
• 2017-08-01-preview

Bicep resource definition

The settings resource type can be deployed to:

• Subscriptions - See subscription deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Security/settings resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Security/settings@2022-05-01' = {
  name: 'string'
  kind: 'string'
  // For remaining properties, see settings objects
}

settings objects

Set the kind property to specify the type of object.

For AlertSyncSettings, use:

  kind: 'AlertSyncSettings'
  properties: {
    enabled: bool
  }

For DataExportSettings, use:

  kind: 'DataExportSettings'
  properties: {
    enabled: bool
  }

Property values

settings

Name	Description	Value
name	The resource name	string (required) Character limit: see values Valid characters: Use one of: MCAS Sentinel WDATP WDATP_EXCLUDE_LINUX_PUBLIC_PREVIEW
kind	Set the object type	AlertSyncSettings DataExportSettings (required)

AlertSyncSettings

Name	Description	Value
kind	the kind of the settings string	'AlertSyncSettings' (required)
properties	Alert sync setting data	AlertSyncSettingProperties

AlertSyncSettingProperties

Name	Description	Value
enabled	Is the alert sync setting enabled	bool (required)

DataExportSettings

Name	Description	Value
kind	the kind of the settings string	'DataExportSettings' (required)
properties	Data export setting data	DataExportSettingProperties

DataExportSettingProperties

Name	Description	Value
enabled	Is the data export setting enabled	bool (required)

ARM template resource definition

The settings resource type can be deployed to:

• Subscriptions - See subscription deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Security/settings resource, add the following JSON to your template.

{
  "type": "Microsoft.Security/settings",
  "apiVersion": "2022-05-01",
  "name": "string",
  "kind": "string",
  // For remaining properties, see settings objects
}

settings objects

Set the kind property to specify the type of object.

For AlertSyncSettings, use:

  "kind": "AlertSyncSettings",
  "properties": {
    "enabled": "bool"
  }

For DataExportSettings, use:

  "kind": "DataExportSettings",
  "properties": {
    "enabled": "bool"
  }

Property values

settings

Name	Description	Value
type	The resource type	'Microsoft.Security/settings'
apiVersion	The resource api version	'2022-05-01'
name	The resource name	string (required) Character limit: see values Valid characters: Use one of: MCAS Sentinel WDATP WDATP_EXCLUDE_LINUX_PUBLIC_PREVIEW
kind	Set the object type	AlertSyncSettings DataExportSettings (required)

AlertSyncSettings

Name	Description	Value
kind	the kind of the settings string	'AlertSyncSettings' (required)
properties	Alert sync setting data	AlertSyncSettingProperties

AlertSyncSettingProperties

Name	Description	Value
enabled	Is the alert sync setting enabled	bool (required)

DataExportSettings

Name	Description	Value
kind	the kind of the settings string	'DataExportSettings' (required)
properties	Data export setting data	DataExportSettingProperties

DataExportSettingProperties

Name	Description	Value
enabled	Is the data export setting enabled	bool (required)

Terraform (AzAPI provider) resource definition

The settings resource type can be deployed to:

• Subscriptions

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Security/settings resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Security/settings@2022-05-01"
  name = "string"
  parent_id = "string"
  // For remaining properties, see settings objects
  body = jsonencode({
    kind = "string"
  })
}

settings objects

Set the kind property to specify the type of object.

For AlertSyncSettings, use:

  kind = "AlertSyncSettings"
  properties = {
    enabled = bool
  }

For DataExportSettings, use:

  kind = "DataExportSettings"
  properties = {
    enabled = bool
  }

Property values

settings

Name	Description	Value
type	The resource type	"Microsoft.Security/settings@2022-05-01"
name	The resource name	string (required) Character limit: see values Valid characters: Use one of: MCAS Sentinel WDATP WDATP_EXCLUDE_LINUX_PUBLIC_PREVIEW
parent_id	To deploy to a subscription, use the ID of that subscription.	string (required)
kind	Set the object type	AlertSyncSettings DataExportSettings (required)

AlertSyncSettings

Name	Description	Value
kind	the kind of the settings string	"AlertSyncSettings" (required)
properties	Alert sync setting data	AlertSyncSettingProperties

AlertSyncSettingProperties

Name	Description	Value
enabled	Is the alert sync setting enabled	bool (required)

DataExportSettings

Name	Description	Value
kind	the kind of the settings string	"DataExportSettings" (required)
properties	Data export setting data	DataExportSettingProperties

DataExportSettingProperties

Name	Description	Value
enabled	Is the data export setting enabled	bool (required)