你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Get Recommendations - List
获取所有建议的列表。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/recommendations?api-version=2025-01-01-preview
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
resource
|
path | True |
string |
资源组的名称。 名称不区分大小写。 |
subscription
|
path | True |
string uuid |
目标订阅的 ID。 该值必须是 UUID。 |
workspace
|
path | True |
string |
工作区的名称。 正则表达式模式: |
api-version
|
query | True |
string |
用于此作的 API 版本。 |
名称 | 类型 | 说明 |
---|---|---|
200 OK |
还行 |
|
Other Status Codes |
描述作失败的原因的错误响应。 |
Azure Active Directory OAuth2 Flow
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例请求
GET https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/recommendations?api-version=2025-01-01-preview
示例响应
{
"value": [
{
"id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Recommendations/ceea048e-923e-4eeb-8fcb-6cb0c06b101f",
"name": "ceea048e-923e-4eeb-8fcb-6cb0c06b101f",
"type": "Microsoft.SecurityInsights/Recommendations",
"properties": {
"recommendationTypeId": "ThreatIntelligence_Example",
"state": "CompletedBySystem",
"title": "someText",
"description": "someText",
"creationTimeUtc": "2022-02-19T03:09:03.4888396+00:00",
"lastEvaluatedTimeUtc": "2022-02-19T03:09:03.4888396+00:00",
"lastModifiedTimeUtc": "2022-02-19T03:57:31.7964447+00:00",
"suggestions": [
{
"suggestionTypeId": "ThreatIntelligence_Example_Suggestion_Example",
"title": "someText",
"description": "someText",
"action": "someText",
"additionalProperties": {
"someKey": "someValue"
}
}
],
"resourceId": "someId",
"additionalProperties": {
"someKey": "someValue"
}
}
}
]
}
名称 | 说明 |
---|---|
Cloud |
错误响应结构。 |
Cloud |
错误详细信息。 |
created |
创建资源的标识的类型。 |
Recommendation |
建议对象。 |
Recommendation |
建议列表 |
Recommended |
应采取哪些建议来完成建议。 |
State |
建议的状态。 |
system |
与创建和上次修改资源相关的元数据。 |
错误响应结构。
名称 | 类型 | 说明 |
---|---|---|
error |
错误数据 |
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误的标识符。 代码是固定的,旨在以编程方式使用。 |
message |
string |
描述错误的消息,旨在适合在用户界面中显示。 |
创建资源的标识的类型。
名称 | 类型 | 说明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
建议对象。
名称 | 类型 | 说明 |
---|---|---|
etag |
string |
Azure 资源的 Etag |
id |
string |
资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” |
name |
string |
资源的名称 |
properties.additionalProperties |
object |
建议的其他属性的集合。 |
properties.creationTimeUtc |
string |
创建建议时的时间戳(UTC)。 |
properties.description |
string |
建议的说明。 |
properties.lastEvaluatedTimeUtc |
string |
上次评估建议时的时间戳(UTC)。 |
properties.lastModifiedTimeUtc |
string |
上次修改建议时的时间戳(UTC)。 |
properties.recommendationTypeId |
string |
建议类型的 ID。 |
properties.resourceId |
string |
此建议引用的资源的 ID。 |
properties.state |
建议的状态。 |
|
properties.suggestions |
要为此建议采取的建议列表。 |
|
properties.title |
string |
建议的标题。 |
systemData |
包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 |
|
type |
string |
资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
建议列表
名称 | 类型 | 说明 |
---|---|---|
nextLink |
string |
链接到下一页的资源。 |
value |
建议列表 |
应采取哪些建议来完成建议。
名称 | 类型 | 说明 |
---|---|---|
action |
string |
建议的作。 |
additionalProperties |
object |
建议的其他属性的集合。 |
description |
string |
建议的说明。 |
suggestionTypeId |
string |
建议类型的 ID。 |
title |
string |
建议的标题。 |
建议的状态。
名称 | 类型 | 说明 |
---|---|---|
Active |
string |
建议处于活动状态。 |
CompletedBySystem |
string |
系统已完成建议。 |
CompletedByUser |
string |
用户已完成建议。 |
Dismissed |
string |
建议已被驳回。 |
InProgress |
string |
建议正在进行中。 |
与创建和上次修改资源相关的元数据。
名称 | 类型 | 说明 |
---|---|---|
createdAt |
string |
资源创建时间戳(UTC)。 |
createdBy |
string |
创建资源的标识。 |
createdByType |
创建资源的标识的类型。 |
|
lastModifiedAt |
string |
上次修改的资源时间戳(UTC) |
lastModifiedBy |
string |
上次修改资源的标识。 |
lastModifiedByType |
上次修改资源的标识的类型。 |