Discovery Groups - Create Or Replace Disco Group

服务:

Defender EASM (preview)

API 版本:

2024-10-01-preview

使用给定的 groupName 创建发现组。

PUT {endpoint}/discoGroups/{groupName}?api-version=2024-10-01-preview

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string	托管所请求资源的终结点。 例如，https://{region}.easm.defender.microsoft.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}
groupName	path	True	string	调用方为资源提供了唯一名称。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

请求正文

名称	类型	说明
description	string	迪斯科组的说明。
excludes	DiscoSource[]	用于迪斯科组运行的排除列表，即要从发现算法中排除的资产。
frequencyMilliseconds	integer (int64)	迪斯科组应以毫秒为单位重新运行的频率。
name	string	迪斯科组的名称。
names	string[]	用于迪斯科组运行的名称列表。
seeds	DiscoSource[]	用于迪斯科组运行的种子列表。
templateId	string	用于创建迪斯科组的迪斯科模板的唯一标识符。
tier	string	迪斯科组的层，这将影响此组中用于迪斯科运行的算法。

响应

名称	类型	说明
200 OK	DiscoGroup	请求已成功。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	意外的错误响应。 标头 x-ms-error-code: string

安全性

OAuth2Auth

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
https://easm.defender.microsoft.com/.default

示例

DiscoveryGroups_CreateOrReplaceDiscoGroup

示例请求

HTTP

PUT {endpoint}/discoGroups/ThisisaDiscoGroup?api-version=2024-10-01-preview

{
  "description": "This is a disco group",
  "frequencyMilliseconds": 604800000,
  "tier": "advanced",
  "seeds": [
    {
      "name": "thisisatest.microsoft.com",
      "kind": "host"
    }
  ]
}

示例响应

状态代码:

200

{
  "id": "ThisisaDiscoGroup",
  "name": "ThisisaDiscoGroup",
  "displayName": "ThisisaDiscoGroup",
  "description": "This is a disco group",
  "tier": "advanced",
  "frequencyMilliseconds": 604800000,
  "seeds": [
    {
      "name": "thisisatest.microsoft.com",
      "kind": "host"
    }
  ],
  "excludes": [],
  "latestRun": null,
  "createdDate": "2022-05-02T19:30:14.432+00:00"
}

定义

名称	说明
Azure.Core.Foundations.Error	错误对象。
Azure.Core.Foundations.ErrorResponse	包含错误详细信息的响应。
Azure.Core.Foundations.InnerError	包含有关错误的更具体信息的对象。 根据Microsoft一个 API 指南 - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。
DiscoGroup
DiscoGroupData	用于创建发现组的请求正文。
DiscoRunResult	此迪斯科组的最新运行，其中包含一些有限的信息，如果组从未运行过，则为 null。
DiscoRunState	迪斯科运行的状态。
DiscoSource	用于驱动发现的源实体。
DiscoSourceKind	迪斯科源的类型。

Azure.Core.Foundations.Error

Object

错误对象。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
details	Azure.Core.Foundations.Error[]	导致此报告错误的特定错误的详细信息数组。
innererror	Azure.Core.Foundations.InnerError	包含与当前对象有关错误的更具体信息的对象。
message	string	错误的人工可读表示形式。
target	string	错误的目标。

Azure.Core.Foundations.ErrorResponse

Object

包含错误详细信息的响应。

名称	类型	说明
error	Azure.Core.Foundations.Error	错误对象。

Azure.Core.Foundations.InnerError

Object

包含有关错误的更具体信息的对象。 根据Microsoft一个 API 指南 - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
innererror	Azure.Core.Foundations.InnerError	内部错误。

DiscoGroup

Object

名称	类型	说明
createdDate	string (date-time)	创建迪斯科组的日期。
description	string	迪斯科组的说明。
displayName	string	可用于显示的名称。
excludes	DiscoSource[]	用于迪斯科组运行的排除列表，即要从发现算法中排除的资产。
frequencyMilliseconds	integer (int64)	迪斯科组应以毫秒为单位重新运行的频率。
id	string	这通常与名称相同，但对于不同的模型可能不同。
latestRun	DiscoRunResult	此迪斯科组的最新运行，其中包含一些有限的信息，如果组从未运行过，则为 null。
name	string	调用方为资源提供了唯一名称。
names	string[]	用于迪斯科组运行的名称列表。
seeds	DiscoSource[]	用于迪斯科组运行的种子列表。
templateId	string	用于创建迪斯科组的迪斯科模板的唯一标识符。
tier	string	迪斯科组的层，这将影响此组中用于迪斯科运行的算法。

DiscoGroupData

Object

用于创建发现组的请求正文。

名称	类型	说明
description	string	迪斯科组的说明。
excludes	DiscoSource[]	用于迪斯科组运行的排除列表，即要从发现算法中排除的资产。
frequencyMilliseconds	integer (int64)	迪斯科组应以毫秒为单位重新运行的频率。
name	string	迪斯科组的名称。
names	string[]	用于迪斯科组运行的名称列表。
seeds	DiscoSource[]	用于迪斯科组运行的种子列表。
templateId	string	用于创建迪斯科组的迪斯科模板的唯一标识符。
tier	string	迪斯科组的层，这将影响此组中用于迪斯科运行的算法。

DiscoRunResult

Object

此迪斯科组的最新运行，其中包含一些有限的信息，如果组从未运行过，则为 null。

名称	类型	说明
completedDate	string (date-time)	迪斯科运行由系统完成的日期。
excludes	DiscoSource[]	用于迪斯科运行的排除列表，即要从发现算法中排除的资产。
names	string[]	用于迪斯科运行的名称列表。
seeds	DiscoSource[]	用于迪斯科运行的种子列表。
startedDate	string (date-time)	迪斯科运行实际上由系统启动的日期。
state	DiscoRunState	迪斯科运行的状态。
submittedDate	string (date-time)	在系统中创建迪斯科运行的日期。
tier	string	会影响用于迪斯科运行的算法的层。
totalAssetsFoundCount	integer (int64)	找到此迪斯科运行的资产总数。

DiscoRunState

枚举

迪斯科运行的状态。

值	说明
completed
failed
pending
running

DiscoSource

Object

用于驱动发现的源实体。

名称	类型	说明
kind	DiscoSourceKind	迪斯科源的类型。
name	string	迪斯科源的名称。

DiscoSourceKind

枚举

迪斯科源的类型。

值	说明
as
attribute
contact
domain
host
ipBlock