创建 macOSEndpointProtectionConfiguration
命名空间:microsoft.graph
重要: Microsoft /beta 版本下的 Graph API 可能会发生更改;不支持生产使用。
注意:适用于 Intune 的 Microsoft Graph API 需要适用于租户的活动 Intune 许可证。
创建新的 macOSEndpointProtectionConfiguration 对象。
此 API 可用于以下国家级云部署。
全局服务 | 美国政府 L4 | 美国政府 L5 (DOD) | 由世纪互联运营的中国 |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
权限
要调用此 API,需要以下权限之一。 若要了解详细信息,包括如何选择权限的信息,请参阅权限。
权限类型 | 权限(从最低特权到最高特权) |
---|---|
委派(工作或学校帐户) | DeviceManagementConfiguration.ReadWrite.All |
委派(个人 Microsoft 帐户) | 不支持。 |
应用程序 | DeviceManagementConfiguration.ReadWrite.All |
HTTP 请求
POST /deviceManagement/deviceConfigurations
POST /deviceManagement/deviceConfigurations/{deviceConfigurationId}/microsoft.graph.windowsDomainJoinConfiguration/networkAccessConfigurations
请求标头
标头 | 值 |
---|---|
Authorization | 持有者 {token}。 必填。 详细了解 身份验证和授权。 |
接受 | application/json |
请求正文
在请求正文中,提供 macOSEndpointProtectionConfiguration 对象的 JSON 表示形式。
下表显示了创建 macOSEndpointProtectionConfiguration 时所需的属性。
属性 | 类型 | 说明 |
---|---|---|
id | String | 实体的键。 继承自 deviceConfiguration |
lastModifiedDateTime | DateTimeOffset | 上次修改对象的日期/时间。 继承自 deviceConfiguration |
roleScopeTagIds | 字符串集合 | 此实体实例的范围标记列表。 继承自 deviceConfiguration |
supportsScopeTags | 布尔值 | 指示基础设备配置是否支持分配范围标记。 如果此值为 false,并且实体对限定范围的用户不可见,则不允许向 ScopeTags 属性分配。 这发生在 Silverlight 中创建的旧策略,可以通过在 Azure 门户中删除并重新创建策略来解决。 此属性是只读的。 继承自 deviceConfiguration |
deviceManagementApplicabilityRuleOsEdition | deviceManagementApplicabilityRuleOsEdition | 此策略的 OS 版本适用性。 继承自 deviceConfiguration |
deviceManagementApplicabilityRuleOsVersion | deviceManagementApplicabilityRuleOsVersion | 此策略的 OS 版本适用性规则。 继承自 deviceConfiguration |
deviceManagementApplicabilityRuleDeviceMode | deviceManagementApplicabilityRuleDeviceMode | 此策略的设备模式适用性规则。 继承自 deviceConfiguration |
createdDateTime | DateTimeOffset | 创建对象的日期/时间。 继承自 deviceConfiguration |
description | String | 管理员提供的设备配置的说明。 继承自 deviceConfiguration |
displayName | String | 管理员提供的设备配置的名称。 继承自 deviceConfiguration |
version | Int32 | 设备配置的版本。 继承自 deviceConfiguration |
gatekeeperAllowedAppSource | macOSGatekeeperAppSources | 确定应用可在 macOS 设备上从哪些下载位置运行的系统和隐私设置。 可取值为:notConfigured 、macAppStore 、macAppStoreAndIdentifiedDevelopers 、anywhere 。 |
gatekeeperBlockOverride | 布尔值 | 如果设置为 true,则将禁用 Gatekeeper 的用户替代。 |
firewallEnabled | 布尔值 | 是否应启用防火墙。 |
firewallBlockAllIncoming | 布尔值 | 对应于“阻止所有传入连接”选项。 |
firewallEnableStealthMode | 布尔值 | 对应于“启用隐藏模式”。 |
firewallApplications | macOSFirewallApplication 集合 | 具有防火墙设置的应用程序列表。 不在此列表上的应用程序的防火墙设置由用户确定。 该集合最多可包含 500 个元素。 |
fileVaultEnabled | 布尔值 | 是否应启用 FileVault。 |
fileVaultSelectedRecoveryKeyTypes | macOSFileVaultRecoveryKeyTypes | 如果启用了 FileVault,则需要确定要使用的恢复密钥的类型 () 。 . 可取值为:notConfigured 、institutionalRecoveryKey 、personalRecoveryKey 。 |
fileVaultInstitutionalRecoveryKeyCertificate | Binary | 如果所选恢复密钥类型 () 包括 InstitutionalRecoveryKey,则是必需的。 用于设置机构恢复密钥的 DER 编码证书文件。 |
fileVaultInstitutionalRecoveryKeyCertificateFileName | String | 要显示在 UI 中的机构恢复密钥证书的文件名。 (*.der) 。 |
fileVaultPersonalRecoveryKeyHelpMessage | String | 如果所选恢复密钥类型 () 包括 PersonalRecoveryKey,则是必需的。 向用户显示的简短消息,说明他们如何检索其个人恢复密钥。 |
fileVaultAllowDeferralUntilSignOut | 布尔值 | 可选。 如果设置为 true,用户可以延迟启用 FileVault,直到注销。 |
fileVaultNumberOfTimesUserCanIgnore | Int32 | 可选。 使用“延迟”选项时,这是用户在需要 FileVault 登录之前可以忽略启用 FileVault 的提示的最大次数。 如果设置为 -1,它将始终提示启用 FileVault,直到启用 FileVault,不过它将允许用户绕过启用 FileVault。 将此设置为 0 将禁用该功能。 |
fileVaultDisablePromptAtSignOut | 布尔值 | 可选。 使用“延迟”选项时,如果设置为 true,则不会提示用户在注销时启用 FileVault。 |
fileVaultPersonalRecoveryKeyRotationInMonths | Int32 | 可选。 如果所选恢复密钥类型 () 包括 PersonalRecoveryKey,则轮换该密钥的频率(以月为单位)。 |
fileVaultHidePersonalRecoveryKey | 布尔值 | 可选。 在 FileVault 加密期间,隐藏的个人恢复密钥不会出现在用户的屏幕上,从而降低它最终落入错误之手的风险。 |
advancedThreatProtectionRealTime | 支持 | 确定是否在 macOS 上为Microsoft Defender高级威胁防护启用实时保护。 可取值为:notConfigured 、enabled 、disabled 。 |
advancedThreatProtectionCloudDelivered | 支持 | 确定是否为 macOS 上的Microsoft Defender高级威胁防护启用云提供的保护。 可取值为:notConfigured 、enabled 、disabled 。 |
advancedThreatProtectionAutomaticSampleSubmission | 支持 | 确定是否在 macOS 上为Microsoft Defender高级威胁防护启用自动文件示例提交。 可取值为:notConfigured 、enabled 、disabled 。 |
advancedThreatProtectionDiagnosticDataCollection | 支持 | 确定是否为 macOS 上的Microsoft Defender高级威胁防护启用诊断和使用情况数据收集。 可取值为:notConfigured 、enabled 、disabled 。 |
advancedThreatProtectionExcludedFolders | 字符串集合 | 要从Microsoft Defender macOS 上的高级威胁防护的防病毒扫描中排除的文件夹的路径列表。 |
advancedThreatProtectionExcludedFiles | 字符串集合 | 要从防病毒扫描中排除的文件的路径列表,用于 macOS 上的高级威胁防护Microsoft Defender。 |
advancedThreatProtectionExcludedExtensions | 字符串集合 | 要从防病毒扫描中排除Microsoft Defender macOS 高级威胁防护的文件扩展名列表。 |
advancedThreatProtectionExcludedProcesses | 字符串集合 | 要从防病毒扫描中排除的进程名称列表Microsoft Defender macOS 上的高级威胁防护。 |
响应
如果成功,此方法在 201 Created
响应正文中返回响应代码和 macOSEndpointProtectionConfiguration 对象。
示例
请求
下面是一个请求示例。
POST https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations
Content-type: application/json
Content-length: 2786
{
"@odata.type": "#microsoft.graph.macOSEndpointProtectionConfiguration",
"roleScopeTagIds": [
"Role Scope Tag Ids value"
],
"supportsScopeTags": true,
"deviceManagementApplicabilityRuleOsEdition": {
"@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition",
"osEditionTypes": [
"windows10EnterpriseN"
],
"name": "Name value",
"ruleType": "exclude"
},
"deviceManagementApplicabilityRuleOsVersion": {
"@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion",
"minOSVersion": "Min OSVersion value",
"maxOSVersion": "Max OSVersion value",
"name": "Name value",
"ruleType": "exclude"
},
"deviceManagementApplicabilityRuleDeviceMode": {
"@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode",
"deviceMode": "sModeConfiguration",
"name": "Name value",
"ruleType": "exclude"
},
"description": "Description value",
"displayName": "Display Name value",
"version": 7,
"gatekeeperAllowedAppSource": "macAppStore",
"gatekeeperBlockOverride": true,
"firewallEnabled": true,
"firewallBlockAllIncoming": true,
"firewallEnableStealthMode": true,
"firewallApplications": [
{
"@odata.type": "microsoft.graph.macOSFirewallApplication",
"bundleId": "Bundle Id value",
"allowsIncomingConnections": true
}
],
"fileVaultEnabled": true,
"fileVaultSelectedRecoveryKeyTypes": "institutionalRecoveryKey",
"fileVaultInstitutionalRecoveryKeyCertificate": "ZmlsZVZhdWx0SW5zdGl0dXRpb25hbFJlY292ZXJ5S2V5Q2VydGlmaWNhdGU=",
"fileVaultInstitutionalRecoveryKeyCertificateFileName": "File Vault Institutional Recovery Key Certificate File Name value",
"fileVaultPersonalRecoveryKeyHelpMessage": "File Vault Personal Recovery Key Help Message value",
"fileVaultAllowDeferralUntilSignOut": true,
"fileVaultNumberOfTimesUserCanIgnore": 3,
"fileVaultDisablePromptAtSignOut": true,
"fileVaultPersonalRecoveryKeyRotationInMonths": 12,
"fileVaultHidePersonalRecoveryKey": true,
"advancedThreatProtectionRealTime": "enabled",
"advancedThreatProtectionCloudDelivered": "enabled",
"advancedThreatProtectionAutomaticSampleSubmission": "enabled",
"advancedThreatProtectionDiagnosticDataCollection": "enabled",
"advancedThreatProtectionExcludedFolders": [
"Advanced Threat Protection Excluded Folders value"
],
"advancedThreatProtectionExcludedFiles": [
"Advanced Threat Protection Excluded Files value"
],
"advancedThreatProtectionExcludedExtensions": [
"Advanced Threat Protection Excluded Extensions value"
],
"advancedThreatProtectionExcludedProcesses": [
"Advanced Threat Protection Excluded Processes value"
]
}
响应
下面是一个响应示例。 注意:为简洁起见,可能会截断此处显示的响应对象。 将从实际调用中返回所有属性。
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 2958
{
"@odata.type": "#microsoft.graph.macOSEndpointProtectionConfiguration",
"id": "7bf7f3ca-f3ca-7bf7-caf3-f77bcaf3f77b",
"lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
"roleScopeTagIds": [
"Role Scope Tag Ids value"
],
"supportsScopeTags": true,
"deviceManagementApplicabilityRuleOsEdition": {
"@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition",
"osEditionTypes": [
"windows10EnterpriseN"
],
"name": "Name value",
"ruleType": "exclude"
},
"deviceManagementApplicabilityRuleOsVersion": {
"@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion",
"minOSVersion": "Min OSVersion value",
"maxOSVersion": "Max OSVersion value",
"name": "Name value",
"ruleType": "exclude"
},
"deviceManagementApplicabilityRuleDeviceMode": {
"@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode",
"deviceMode": "sModeConfiguration",
"name": "Name value",
"ruleType": "exclude"
},
"createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
"description": "Description value",
"displayName": "Display Name value",
"version": 7,
"gatekeeperAllowedAppSource": "macAppStore",
"gatekeeperBlockOverride": true,
"firewallEnabled": true,
"firewallBlockAllIncoming": true,
"firewallEnableStealthMode": true,
"firewallApplications": [
{
"@odata.type": "microsoft.graph.macOSFirewallApplication",
"bundleId": "Bundle Id value",
"allowsIncomingConnections": true
}
],
"fileVaultEnabled": true,
"fileVaultSelectedRecoveryKeyTypes": "institutionalRecoveryKey",
"fileVaultInstitutionalRecoveryKeyCertificate": "ZmlsZVZhdWx0SW5zdGl0dXRpb25hbFJlY292ZXJ5S2V5Q2VydGlmaWNhdGU=",
"fileVaultInstitutionalRecoveryKeyCertificateFileName": "File Vault Institutional Recovery Key Certificate File Name value",
"fileVaultPersonalRecoveryKeyHelpMessage": "File Vault Personal Recovery Key Help Message value",
"fileVaultAllowDeferralUntilSignOut": true,
"fileVaultNumberOfTimesUserCanIgnore": 3,
"fileVaultDisablePromptAtSignOut": true,
"fileVaultPersonalRecoveryKeyRotationInMonths": 12,
"fileVaultHidePersonalRecoveryKey": true,
"advancedThreatProtectionRealTime": "enabled",
"advancedThreatProtectionCloudDelivered": "enabled",
"advancedThreatProtectionAutomaticSampleSubmission": "enabled",
"advancedThreatProtectionDiagnosticDataCollection": "enabled",
"advancedThreatProtectionExcludedFolders": [
"Advanced Threat Protection Excluded Folders value"
],
"advancedThreatProtectionExcludedFiles": [
"Advanced Threat Protection Excluded Files value"
],
"advancedThreatProtectionExcludedExtensions": [
"Advanced Threat Protection Excluded Extensions value"
],
"advancedThreatProtectionExcludedProcesses": [
"Advanced Threat Protection Excluded Processes value"
]
}