PayloadKit

Microsoft Defender for Endpoint

com.microsoft.wdav

Microsoft Defender for Endpoint settings

macOS

Configuration Keys (10)

Showing 10 of 10 keys

KeyTypeDescriptionDefaultRange

Antivirus engine

dictManages the preferences of the antivirus component of Microsoft Defender for Endpoint.Default: —Range: —

Behavior Monitoring

stringDetermines whether behavior monitoring and blocking capability is enabled on the device or not.Default: "enabled"Range: Disabled (disabled), Enabled (enabled)

Enforcement level for antivirus engine

stringEnforcement level of antivirus engine. On-demand: Files are scanned only on demand; Passive: Same as on-demand, but also security intelligence updates are enabled, and the status menu icon is hidden; Real-time: Scan files as they are accessed.

Depends on: antivirusEngine.behaviorMonitoring ∈ [enabled]

Default: "real_time"Range: Passive (passive), On-demand (on_demand), Real-time (real_time)

Enable file hash computation

booleanEnables or disables file hash computation feature. When this feature is enabled Defender will compute hashes for files it scans. This will help in improving the accuracy of Custom Indicator matches. However, enabling EnableFileHashComputation may impact device performance.Default: falseRange: —

Run a scan after definitions are updated

booleanSpecifies whether to start a process scan after new security intelligence updates are downloaded on the device. Enabling this setting will trigger an antivirus scan on the running processes of the device.Default: trueRange: —

Scanning inside archive files

booleanIf true, Defender will unpack archives and scan files inside them. Otherwise archive content will be skipped, that will improve scanning performance.Default: trueRange: —

Degree of parallelism for on-demand scans

integerSpecifies the degree of parallelism for on-demand scans. This corresponds to the number of threads used to perform the scan and impacts the CPU usage, as well as the duration of the on-demand scan.Default: 2Range: 1 – 64

Exclusions merge

stringSpecify the merge policy for exclusions. This can be a combination of administrator-defined and user-defined exclusions (merge) or only administrator-defined exclusions (admin_only). This setting can be used to restrict local users from defining their own exclusions.Default: "merge"Range: Merge (merge), Admin Only (admin_only)

Scan exclusions

arrayEntities that have been excluded from the scan. Exclusions can be specified by full paths, extensions, or file names.Default: —Range: —
dict

Exclusions

dict—Default: —Range: —
$typestring

Type

stringSpecify content excluded from being scanned by type.Default: "excludedPath"Range: Path (excludedPath), File extension (excludedFileExtension), Process name (excludedFileName)
pathstring

Path

stringPath to exclude, wildcards are supportedDefault: —Range: 1 – —

Is directory

booleanDirectory if selected, or file if not selectedDefault: falseRange: —
extensionstring

File extension

stringSpecify content excluded from being scanned by file extension.Default: —Range: 1 – —
namestring

Process name

stringProcess name, either or full path or file name, wildcards supportedDefault: —Range: 1 – —

Allowed threats

arrayList of threats (identified by their name) that are not blocked by the product and are instead allowed to run.Default: —Range: —
string

Threat

string—Default: —Range: —

Disallowed threat actions

arrayRestricts the actions that the local user of a device can take when threats are detected. The actions included in this list are not displayed in the user interface. Use unique values.Default: —Range: —
string

Action

string—Default: —Range: Allow Threats (restricts users from allowing threats) (allow), Restore Threats (restricts users from restoring threats from the quarantine) (restore)

Threat type settings

arrayThe threatTypeSettings preference in the antivirus engine is used to control how certain threat types are handled by the product.Default: —Range: —
dict

Setting

dict—Default: —Range: —
keystring

Threat type

stringType of the threat for which the behavior is configured.Default: —Range: Potentially Unwanted Application (potentially_unwanted_application), Archive Bomb (archive_bomb)
valuestring

Action to take

stringAction to take when coming across a threat of the type specified in the preceding section.Default: "audit"Range: Audit (audit), Block (block), Off (off)

Threat type settings merge

stringSpecify the merge policy for threat type settings. This can be a combination of administrator-defined and user-defined settings (merge) or only administrator-defined settings (admin_only). This setting can be used to restrict local users from defining their own settings for different threat types.Default: "merge"Range: Merge (merge), Admin Only (admin_only)

Scan results retention

integerSpecify the number of days that results are retained in the scan history on the device. Old scan results are removed from the history. Old quarantined files that are also removed from the disk.Default: 90Range: 1 – 180

Scan history size

integerSpecify the maximum number of entries to keep in the scan history. Entries include all on-demand scans performed in the past and all antivirus detections.Default: 10000Range: 5000 – 15000

Real-time protection

booleanLocates and stops malware from installing or running on your device. You can turn off this setting for a short time before it turns back on automatically.Default: trueRange: —

Passive mode

booleanWhether the antivirus engine runs in passive mode or not.Default: falseRange: —

Cloud delivered protection preferences

dictConfigure the cloud-driven protection features of Microsoft Defender for Endpoint.Default: —Range: —
enabledboolean

Cloud delivered protection

booleanProvides increased, faster protection with access to the latest protection data in the cloud. Works best with automatic sample submission turned onDefault: trueRange: —

Diagnostic data collection

stringWe encourage you to share your diagnostic and usage data with us to help improve Microsoft products and services.Default: "optional"Range: Optional (optional), Required (required)

Cloud Block Level

stringDetermines how aggressive Defender for Endpoint will be in blocking and scanning suspicious files.Default: "normal"Range: Normal: The default blocking level (normal), Moderate: Delivers verdict only for high confidence detections (moderate), High: Aggressively blocks unknown files while optimizing for performance (greater chance of blocking non-harmful files) (high), High Plus: Aggressively blocks unknown files and applies additional protection measures (might impact client device performance) (high_plus), Zero Tolerance: Blocks all unknown programs (zero_tolerance)

Enable / disable automatic sample submissions

booleanDetermines whether suspicious samples are sent to Microsoft.Default: trueRange: —

Automatic security intelligence updates

booleanDetermines whether security intelligence updates are installed automatically:Default: trueRange: —

Automatic sample submission Consent

stringSends sample files to Microsoft to help protect device users and your organization from potential threatsDefault: "safe"Range: None (none), Safe (safe), All (all)

User interface preferences

dictManage the preferences for the user interface.Default: —Range: —

Hide status menu icon

booleanWhether the status menu icon (shown in the top-right corner of the screen) is hidden or not.Default: falseRange: —

User initiated feedback

stringSpecify whether users can submit feedback to Microsoft by going to Help > Send Feedback.Default: "enabled"Range: Enabled (enabled), Disabled (disabled)

Control sign-in to consumer version

stringSpecify whether users can sign into the consumer version of Microsoft DefenderDefault: "enabled"Range: Enabled (enabled), Disabled (disabled)
edrdict

EDR preferences

dictManage the preferences of the endpoint detection and response (EDR) component.Default: —Range: —
tagsarray

Device tags

array—Default: —Range: — – 1
dict

Tag

dict—Default: —Range: —
keystring

Type of tag

stringSpecifies the type of tagDefault: —Range: Group (GROUP)
valuestring

Value of tag

stringSpecifies the value of tagDefault: —Range: —
groupIdsstring

Group identifier

string—Default: —Range: —

Tamper protection

dictTamper protection helps prevent unauthorized removal of Microsoft Defender for Endpoint.Default: —Range: —

Enforcement level

stringSpecifies if tamper protection is disabled, in audit mode, or enforcedDefault: "block"Range: Disabled: Tamper protection is completely off (disabled), Audit: Tampering operations are logged, but not blocked (audit), Block: Tamper protection is on, tampering operations are blocked (block)

Process exclusions

arrayDefines process that can interfere with Defender without considering it tamperingDefault: —Range: —
dict

Process identity

dict—Default: —Range: —
pathstring

Process path

stringFull and exact path to the process binaryDefault: —Range: —
teamIdstring

Process's TeamIdentifier

stringCode signature TeamIdentifierDefault: —Range: —
signingIdstring

Process's Signing Identifier

stringCode signature IdentifierDefault: —Range: —
argsarray

Process's arguments

arrayCommand line argumentsDefault: —Range: —
string

Argument

string—Default: —Range: —

Device Control

dictDevice control can be used to customize the URL target for notifications raised by device control, and allow or block removable devices.Default: —Range: —

Customize URL target for notifications raised by device control

stringConfigure the URL that is opened when end users click the notification shown when a device control policy is enforced.Default: —Range: —

Allow or block removable devices

dictRestrict access to removable media.Default: —Range: —

Policy enforcement level

stringSet the removable media enforcement level.Default: —Range: Audit: A notification is displayed to the user, however the device can still be used. (audit), Block: A notification is displayed to the user, and the device cannot be used. (block)

Default permission level

arrayThe default permission level for devices that do not match anything else in the policy.Default: —Range: —
string

Permissions

string—Default: —Range: None (none), Read (read), Write (write), Execute (execute)

Vendors

dictRestrict removable media by vendor.Default: —Range: —
{{key}}string

Vendor ID

string—Default: —Range: —

Vendor Details

dict—Default: —Range: —

Permission level

array—Default: —Range: —
string

Permissions

string—Default: —Range: None (none), Read (read), Write (write), Execute (execute)

Products

dict—Default: —Range: —
{{key}}string

Product ID

string—Default: —Range: —

Product Details

dict—Default: —Range: —

Permission level

array—Default: —Range: —
string

Permissions

string—Default: —Range: None (none), Read (read), Write (write), Execute (execute)

Serial Numbers

dict—Default: —Range: —
{{key}}string

Serial Number

string—Default: —Range: —

Serial Number Details

array—Default: —Range: —
string

Permissions

string—Default: —Range: None (none), Read (read), Write (write), Execute (execute)
policystring

Device Control Policy

stringJSON string representing the device control policyDefault: —Range: —

Features

dict—Default: —Range: —

Use Data Loss Prevention

stringWhether data loss prevention enforcement is enabled on the machine.Default: "disabled"Range: enabled, disabled

Scheduled Scan

stringSchedule scans with Microsoft Defender for Endpoint.Default: "enabled"Range: enabled, disabled

Network protection

dict—Default: —Range: —

Enforcement level

stringSpecifies if network protection is disabled, in audit mode, or enforcedDefault: "audit"Range: disabled, audit, block
dlpdict

Data Loss Prevention

dict—Default: —Range: —

Exclusions

array—Default: —Range: —
dict

Exclusion

dict—Default: —Range: —
signingIdstring

Signing ID

stringThe signing id of the application to exclude from data loss prevention.Default: —Range: —
flaginteger

Flag

integerBit flags to control the type of exclusion(s) to apply. EPS=0x1, AX=0x2.Default: —Range: —

Features

array—Default: —Range: —
dict

Feature

dict—Default: —Range: —
namestring

Feature Name

stringThe name of a DLP feature to enable or disable.Default: —Range: —
statestring

State

stringEnable a feature up to a deployment ring (default production), or force disable a feature for all rings.Default: "enabled"Range: enabled, disabled
ringstring

Release Ring

stringLimit enabling the feature to a specific deployment ring.Default: "production"Range: insiderFast, external, production

Scheduled scan configuration

dict—Default: —Range: —

Check for definitions update

booleanCheck for definitions update before initiating a scheduled scanDefault: falseRange: —

Daily and Hourly quick scan configuration

dictCheck for definitions update before initiating a scheduled scanDefault: —Range: —
timeOfDayinteger

Time of day

integerSpecifies the time of day, as the number of minutes after midnight, to perform a daily quick scan.Default: 0Range: 0 – 1440
intervalinteger

Start time

integerSpecify how many hours should elapse before the next hourly quick scan. 0 indicates no hourly quick scan. 1 indicates a scan every hour. 24 indicates a scan once a day.Default: 0Range: 0 – 24

Ignore exclusions

booleanShould exclusions be ignored during a scheduled scanDefault: falseRange: —

Low priority scheduled scan

booleanShould scheduled scan be run with low priority. (Scan might take longer to complete).Default: falseRange: —

Run scheduled scan when idle

booleanRun scheduled scan when the device is idle. Only applicable for weekly full scans.Default: falseRange: —

Weekly scheduled scan configuration

dictShould scheduled scan be run with low priority. (Scan might take longer to complete).Default: —Range: —
scanTypestring

Scan type

stringSpecifies the type of scan to perform.Default: "quick"Range: quick, full
dayOfWeekinteger

Day of week

integerSpecifies the day of the week to perform a weekly scan. 0 indicates never. 1-7 indicates Sunday - Saturday. 8 indicates every day.Default: 0Range: 0 – 8
timeOfDayinteger

Time of day

integerSpecifies the time of day, as the number of minutes after midnight, to perform a weekly scan.Default: 0Range: 0 – 1440

Randomize scheduled scan start time

integerRandomize the start time of a daily and weekly scheduled scan to any interval from 0 to 23 hours.Default: 0Range: 0 – 23