macOSEndpointProtectionConfiguration resource type

Important: Microsoft Graph APIs under the /beta version are subject to change; production use is not supported.

Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.

MacOS endpoint protection configuration profile.

Inherits from deviceConfiguration

Methods

Method Return Type Description
List macOSEndpointProtectionConfigurations macOSEndpointProtectionConfiguration collection List properties and relationships of the macOSEndpointProtectionConfiguration objects.
Get macOSEndpointProtectionConfiguration macOSEndpointProtectionConfiguration Read properties and relationships of the macOSEndpointProtectionConfiguration object.
Create macOSEndpointProtectionConfiguration macOSEndpointProtectionConfiguration Create a new macOSEndpointProtectionConfiguration object.
Delete macOSEndpointProtectionConfiguration None Deletes a macOSEndpointProtectionConfiguration.
Update macOSEndpointProtectionConfiguration macOSEndpointProtectionConfiguration Update the properties of a macOSEndpointProtectionConfiguration object.

Properties

Property Type Description
id String Key of the entity. Inherited from deviceConfiguration
lastModifiedDateTime DateTimeOffset DateTime the object was last modified. Inherited from deviceConfiguration
roleScopeTagIds String collection List of Scope Tags for this Entity instance. Inherited from deviceConfiguration
supportsScopeTags Boolean Indicates whether or not the underlying Device Configuration supports the assignment of scope tags. Assigning to the ScopeTags property is not allowed when this value is false and entities will not be visible to scoped users. This occurs for Legacy policies created in Silverlight and can be resolved by deleting and recreating the policy in the Azure Portal. This property is read-only. Inherited from deviceConfiguration
deviceManagementApplicabilityRuleOsEdition deviceManagementApplicabilityRuleOsEdition The OS edition applicability for this Policy. Inherited from deviceConfiguration
deviceManagementApplicabilityRuleOsVersion deviceManagementApplicabilityRuleOsVersion The OS version applicability rule for this Policy. Inherited from deviceConfiguration
deviceManagementApplicabilityRuleDeviceMode deviceManagementApplicabilityRuleDeviceMode The device mode applicability rule for this Policy. Inherited from deviceConfiguration
createdDateTime DateTimeOffset DateTime the object was created. Inherited from deviceConfiguration
description String Admin provided description of the Device Configuration. Inherited from deviceConfiguration
displayName String Admin provided name of the device configuration. Inherited from deviceConfiguration
version Int32 Version of the device configuration. Inherited from deviceConfiguration
gatekeeperAllowedAppSource macOSGatekeeperAppSources System and Privacy setting that determines which download locations apps can be run from on a macOS device. Possible values are: notConfigured, macAppStore, macAppStoreAndIdentifiedDevelopers, anywhere.
gatekeeperBlockOverride Boolean If set to true, the user override for Gatekeeper will be disabled.
firewallEnabled Boolean Whether the firewall should be enabled or not.
firewallBlockAllIncoming Boolean Corresponds to the “Block all incoming connections” option.
firewallEnableStealthMode Boolean Corresponds to “Enable stealth mode.”
firewallApplications macOSFirewallApplication collection List of applications with firewall settings. Firewall settings for applications not on this list are determined by the user. This collection can contain a maximum of 500 elements.
fileVaultEnabled Boolean Whether FileVault should be enabled or not.
fileVaultSelectedRecoveryKeyTypes macOSFileVaultRecoveryKeyTypes Required if FileVault is enabled, determines the type(s) of recovery key to use. . Possible values are: notConfigured, institutionalRecoveryKey, personalRecoveryKey.
fileVaultInstitutionalRecoveryKeyCertificate Binary Required if selected recovery key type(s) include InstitutionalRecoveryKey. The DER Encoded certificate file used to set an institutional recovery key.
fileVaultInstitutionalRecoveryKeyCertificateFileName String File name of the institutional recovery key certificate to display in UI. (*.der).
fileVaultPersonalRecoveryKeyHelpMessage String Required if selected recovery key type(s) include PersonalRecoveryKey. A short message displayed to the user that explains how they can retrieve their personal recovery key.
fileVaultAllowDeferralUntilSignOut Boolean Optional. If set to true, the user can defer the enabling of FileVault until they sign out.
fileVaultNumberOfTimesUserCanIgnore Int32 Optional. When using the Defer option, this is the maximum number of times the user can ignore prompts to enable FileVault before FileVault will be required for the user to sign in. If set to -1, it will always prompt to enable FileVault until FileVault is enabled, though it will allow the user to bypass enabling FileVault. Setting this to 0 will disable the feature.
fileVaultDisablePromptAtSignOut Boolean Optional. When using the Defer option, if set to true, the user is not prompted to enable FileVault at sign-out.
fileVaultPersonalRecoveryKeyRotationInMonths Int32 Optional. If selected recovery key type(s) include PersonalRecoveryKey, the frequency to rotate that key, in months.
fileVaultHidePersonalRecoveryKey Boolean Optional. A hidden personal recovery key does not appear on the user's screen during FileVault encryption, reducing the risk of it ending up in the wrong hands.
advancedThreatProtectionRealTime enablement Determines whether or not to enable real-time protection for Microsoft Defender Advanced Threat Protection on macOS. Possible values are: notConfigured, enabled, disabled.
advancedThreatProtectionCloudDelivered enablement Determines whether or not to enable cloud-delivered protection for Microsoft Defender Advanced Threat Protection on macOS. Possible values are: notConfigured, enabled, disabled.
advancedThreatProtectionAutomaticSampleSubmission enablement Determines whether or not to enable automatic file sample submission for Microsoft Defender Advanced Threat Protection on macOS. Possible values are: notConfigured, enabled, disabled.
advancedThreatProtectionDiagnosticDataCollection enablement Determines whether or not to enable diagnostic and usage data collection for Microsoft Defender Advanced Threat Protection on macOS. Possible values are: notConfigured, enabled, disabled.
advancedThreatProtectionExcludedFolders String collection A list of paths to folders to exclude from antivirus scanning for Microsoft Defender Advanced Threat Protection on macOS.
advancedThreatProtectionExcludedFiles String collection A list of paths to files to exclude from antivirus scanning for Microsoft Defender Advanced Threat Protection on macOS.
advancedThreatProtectionExcludedExtensions String collection A list of file extensions to exclude from antivirus scanning for Microsoft Defender Advanced Threat Protection on macOS.
advancedThreatProtectionExcludedProcesses String collection A list of process names to exclude from antivirus scanning for Microsoft Defender Advanced Threat Protection on macOS.

Relationships

Relationship Type Description
groupAssignments deviceConfigurationGroupAssignment collection The list of group assignments for the device configuration profile. Inherited from deviceConfiguration
assignments deviceConfigurationAssignment collection The list of assignments for the device configuration profile. Inherited from deviceConfiguration
deviceStatuses deviceConfigurationDeviceStatus collection Device configuration installation status by device. Inherited from deviceConfiguration
userStatuses deviceConfigurationUserStatus collection Device configuration installation status by user. Inherited from deviceConfiguration
deviceStatusOverview deviceConfigurationDeviceOverview Device Configuration devices status overview Inherited from deviceConfiguration
userStatusOverview deviceConfigurationUserOverview Device Configuration users status overview Inherited from deviceConfiguration
deviceSettingStateSummaries settingStateDeviceSummary collection Device Configuration Setting State Device Summary Inherited from deviceConfiguration

JSON Representation

Here is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.macOSEndpointProtectionConfiguration",
  "id": "String (identifier)",
  "lastModifiedDateTime": "String (timestamp)",
  "roleScopeTagIds": [
    "String"
  ],
  "supportsScopeTags": true,
  "deviceManagementApplicabilityRuleOsEdition": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition",
    "osEditionTypes": [
      "String"
    ],
    "name": "String",
    "ruleType": "String"
  },
  "deviceManagementApplicabilityRuleOsVersion": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion",
    "minOSVersion": "String",
    "maxOSVersion": "String",
    "name": "String",
    "ruleType": "String"
  },
  "deviceManagementApplicabilityRuleDeviceMode": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode",
    "deviceMode": "String",
    "name": "String",
    "ruleType": "String"
  },
  "createdDateTime": "String (timestamp)",
  "description": "String",
  "displayName": "String",
  "version": 1024,
  "gatekeeperAllowedAppSource": "String",
  "gatekeeperBlockOverride": true,
  "firewallEnabled": true,
  "firewallBlockAllIncoming": true,
  "firewallEnableStealthMode": true,
  "firewallApplications": [
    {
      "@odata.type": "microsoft.graph.macOSFirewallApplication",
      "bundleId": "String",
      "allowsIncomingConnections": true
    }
  ],
  "fileVaultEnabled": true,
  "fileVaultSelectedRecoveryKeyTypes": "String",
  "fileVaultInstitutionalRecoveryKeyCertificate": "binary",
  "fileVaultInstitutionalRecoveryKeyCertificateFileName": "String",
  "fileVaultPersonalRecoveryKeyHelpMessage": "String",
  "fileVaultAllowDeferralUntilSignOut": true,
  "fileVaultNumberOfTimesUserCanIgnore": 1024,
  "fileVaultDisablePromptAtSignOut": true,
  "fileVaultPersonalRecoveryKeyRotationInMonths": 1024,
  "fileVaultHidePersonalRecoveryKey": true,
  "advancedThreatProtectionRealTime": "String",
  "advancedThreatProtectionCloudDelivered": "String",
  "advancedThreatProtectionAutomaticSampleSubmission": "String",
  "advancedThreatProtectionDiagnosticDataCollection": "String",
  "advancedThreatProtectionExcludedFolders": [
    "String"
  ],
  "advancedThreatProtectionExcludedFiles": [
    "String"
  ],
  "advancedThreatProtectionExcludedExtensions": [
    "String"
  ],
  "advancedThreatProtectionExcludedProcesses": [
    "String"
  ]
}