经过身份验证的扫描方法和属性
适用于：
- Microsoft Defender for Endpoint 计划 1
- Microsoft Defender for Endpoint
- Microsoft Defender 漏洞管理
- Microsoft Defender XDR
希望体验 Microsoft Defender for Endpoint？ 注册免费试用版。
想要体验 Microsoft Defender 漏洞管理？ 详细了解如何注册 Microsoft Defender 漏洞管理公共预览版试用版。
重要
本文中的某些信息与预发行的产品有关，该产品在商业发布之前可能有重大修改。 Microsoft 对此处所提供的信息不作任何明示或默示的保证。
注意
如果你是美国政府客户，请使用 适用于美国政府客户的 Microsoft Defender for Endpoint 中列出的 URI。
提示
为了提高性能，可以使用离地理位置更近的服务器：
- us.api.security.microsoft.com
- eu.api.security.microsoft.com
- uk.api.security.microsoft.com
- au.api.security.microsoft.com
- swa.api.security.microsoft.com
- ina.api.security.microsoft.com
方法
| 方法 | 说明 |
|---|---|
| 获取所有扫描定义 | 列出所有扫描定义。 |
| 添加、删除或更新扫描定义 | 添加、删除或更新新的扫描定义。 |
| 获取所有扫描代理 | 列出所有扫描代理。 |
| 按 ID 获取扫描代理 | 按 ID 检索指定代理的详细信息。 |
| 按定义获取扫描历史记录 | 列出扫描定义历史记录。 |
| 按会话获取扫描历史记录 | 列出会话的扫描历史记录。 |
详细了解 Windows 身份验证扫描 和 网络身份验证扫描。
属性
| 属性 | 数据类型 | 说明 |
|---|---|---|
| id | String | 扫描 ID。 |
| scanType | 枚举 | 扫描的类型。 可取值为：Windows、Network。 |
| scanName | String | 扫描的名称。 |
| isActive | 布尔值 | 扫描是否主动运行的状态。 |
| orgId | String | 相关组织 ID。 |
| intervalInHours | Int | 扫描的运行间隔。 |
| createdBy | String | 创建扫描的用户的唯一标识。 |
| targetType | String | 目标字段中的目标类型。 可能的类型为 IP Address 或 Hostname。 默认值为“IP 地址”。 |
| target | String | 要扫描的目标（IP 地址或主机名）的逗号分隔列表。 |
| scanAuthenticationParams | Object | 表示身份验证参数的对象，请参阅预期字段的 身份验证参数对象属性 。 此属性在创建新扫描时是必需的，在更新扫描时是可选的。 |
| scannerAgent | Object | 表示扫描程序代理的对象包含扫描设备的计算机 ID。 |
身份验证参数对象属性
| 属性 | 数据类型 | 说明 |
|---|---|---|
| @odata.type | 枚举 | 扫描类型身份验证参数。 可能的值为： #microsoft.windowsDefenderATP.api.SnmpAuthParams 用于 Network 扫描类型，以及 #microsoft.windowsDefenderATP.api.WindowsAuthParams 扫描 Windows 类型。 |
| type | 枚举 | 身份验证方法。 可能的值因属性而异 @odata.type 。 - 如果 @odata.type 为 SnmpAuthParams，则可能的值为 CommunityString、 NoAuthNoPriv、 AuthNoPriv、 AuthPriv。 - 如果 @odata.type 为 WindowsAuthParams ，则可能的值为 Kerberos 或 Negotiate。 |
| KeyVaultUrl | 字符串 (可选) | 一个可选属性，指定扫描程序应从哪个 KeyVault 检索凭据。 如果指定了 KeyVault，则无需指定用户名、密码。 |
| KeyVaultSecretName | 字符串 (可选) | 一个可选属性，指定扫描程序应从中检索凭据的 KeyVault 机密名称。 如果指定了 KeyVault，则无需指定用户名、密码。 |
| Domain | 字符串 (可选) | 使用 WindowsAuthParams时的域名。 |
| 用户名 | 字符串 (可选) | 使用 WindowsAuthParams 时的用户名或选择 SnmpAuthParams 除 CommunityString以外的任何类型时使用的用户名。 |
| IsGMSAUser | 布尔 (可选) | 选择 WindowsAuthParams时，必须设置为 true。 |
| CommunityString | 字符串 (可选) | 选择 SnmpAuthParams 时要使用的社区字符串 CommunityString |
| AuthProtocol | 字符串 (可选) | 用于 SnmpAuthParams 和 AuthNoPriv 或 AuthPriv的身份验证协议。 可能的值为 MD5、 SHA1。 |
| AuthPassword | 字符串 (可选) | 用于 和 AuthNoPriv 或 AuthPriv的身份验证密码SnmpAuthParams。 |
| PrivProtocol | 字符串 (可选) | 与 和 AuthPriv一起使用的 SnmpAuthParams Priv 协议。 可取值为 DES、3DES、AES。 |
| PrivPassword | 字符串 (可选) | 与 和 AuthPriv一起使用SnmpAuthParams的专用密码。 |
提示
想要了解更多信息？ 在技术社区中与 Microsoft 安全社区互动： Microsoft Defender for Endpoint 技术社区。