Microsoft.Security settings 2021-06-01

• 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 with operations that target:

• Subscription - 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@2021-06-01' = {
  name: 'string'
  kind: 'string'
  // For remaining properties, see Microsoft.Security/settings objects
}

Microsoft.Security/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

Microsoft.Security/settings

Name	Description	Value
kind	Set to 'AlertSyncSettings' for type AlertSyncSettings. Set to 'DataExportSettings' for type DataExportSettings.	'AlertSyncSettings' 'DataExportSettings' (required)
name	The resource name	'MCAS' 'Sentinel' 'WDATP' (required)

AlertSyncSettingProperties

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

AlertSyncSettings

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

DataExportSettingProperties

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

DataExportSettings

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

ARM template resource definition

The settings resource type can be deployed with operations that target:

• Subscription - 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.

{
  "name": "string",
  "kind": "string"
  // For remaining properties, see Microsoft.Security/settings objects
}

Microsoft.Security/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

Microsoft.Security/settings

Name	Description	Value
apiVersion	The api version	'2021-06-01'
kind	Set to 'AlertSyncSettings' for type AlertSyncSettings. Set to 'DataExportSettings' for type DataExportSettings.	'AlertSyncSettings' 'DataExportSettings' (required)
name	The resource name	'MCAS' 'Sentinel' 'WDATP' (required)
type	The resource type	'Microsoft.Security/settings'

AlertSyncSettingProperties

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

AlertSyncSettings

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

DataExportSettingProperties

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

DataExportSettings

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

Usage Examples

Terraform (AzAPI provider) resource definition

The settings resource type can be deployed with operations that target:

• Subscription

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" {
  name = "string"
  kind = "string"
  // For remaining properties, see Microsoft.Security/settings objects
}

Microsoft.Security/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

Microsoft.Security/settings

Name	Description	Value
kind	Set to 'AlertSyncSettings' for type AlertSyncSettings. Set to 'DataExportSettings' for type DataExportSettings.	'AlertSyncSettings' 'DataExportSettings' (required)
name	The resource name	'MCAS' 'Sentinel' 'WDATP' (required)
type	The resource type	"Microsoft.Security/settings@2021-06-01"

AlertSyncSettingProperties

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

AlertSyncSettings

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

DataExportSettingProperties

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

DataExportSettings

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