Assessments - Create Or Update

Ссылка

Служба:: Defender for Cloud

Версия API:: 2021-06-01

Создайте оценку безопасности в ресурсе. Метаданные оценки, описывающие эту оценку, должны быть предопределены с тем же именем перед вставкой результата оценки.

PUT https://management.azure.com/{resourceId}/providers/Microsoft.Security/assessments/{assessmentName}?api-version=2021-06-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
assessmentName	path	True	string	Ключ оценки — уникальный ключ для типа оценки
resourceId	path	True	string	Идентификатор ресурса.
api-version	query	True	string	Версия API для операции

Текст запроса

Имя	Обязательно	Тип	Описание
properties.resourceDetails	True	ResourceDetails: OnPremiseResourceDetails AzureResourceDetails OnPremiseSqlResourceDetails	Сведения о ресурсе, который был оценен
properties.status	True	AssessmentStatus	Результат оценки
properties.additionalData		object	Дополнительные данные об оценке
properties.metadata		SecurityAssessmentMetadataProperties	Описывает свойства метаданных оценки.
properties.partnersData		SecurityAssessmentPartnerData	Данные о 3-сторонней интеграции партнеров

Ответы

Имя	Тип	Описание
200 OK	SecurityAssessmentResponse	ОК — обновлено
201 Created	SecurityAssessmentResponse	Созданный
Other Status Codes	CloudError	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Create security recommendation task on a resource

Образец запроса

PUT https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2/providers/Microsoft.Security/assessments/8bb8be0a-6010-4789-812f-e4d661c4ed0e?api-version=2021-06-01

{
  "properties": {
    "resourceDetails": {
      "source": "Azure"
    },
    "status": {
      "code": "Healthy"
    }
  }
}


import com.azure.resourcemanager.security.models.AssessmentStatus;
import com.azure.resourcemanager.security.models.AssessmentStatusCode;
import com.azure.resourcemanager.security.models.AzureResourceDetails;

/**
 * Samples for Assessments CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2021-06-01/examples/Assessments/
     * PutAssessment_example.json
     */
    /**
     * Sample code: Create security recommendation task on a resource.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void
        createSecurityRecommendationTaskOnAResource(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.assessments().define("8bb8be0a-6010-4789-812f-e4d661c4ed0e").withExistingResourceId(
            "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2")
            .withStatus(new AssessmentStatus().withCode(AssessmentStatusCode.HEALTHY))
            .withResourceDetails(new AzureResourceDetails()).create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armsecurity_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/security/armsecurity"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ac34f238dd6b9071f486b57e9f9f1a0c43ec6f6/specification/security/resource-manager/Microsoft.Security/stable/2021-06-01/examples/Assessments/PutAssessment_example.json
func ExampleAssessmentsClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsecurity.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAssessmentsClient().CreateOrUpdate(ctx, "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2", "8bb8be0a-6010-4789-812f-e4d661c4ed0e", armsecurity.Assessment{
		Properties: &armsecurity.AssessmentProperties{
			ResourceDetails: &armsecurity.AzureResourceDetails{
				Source: to.Ptr(armsecurity.SourceAzure),
			},
			Status: &armsecurity.AssessmentStatus{
				Code: to.Ptr(armsecurity.AssessmentStatusCodeHealthy),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AssessmentResponse = armsecurity.AssessmentResponse{
	// 	Name: to.Ptr("8bb8be0a-6010-4789-812f-e4d661c4ed0e"),
	// 	Type: to.Ptr("Microsoft.Security/assessments"),
	// 	ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/providers/Microsoft.Security/assessments/8bb8be0a-6010-4789-812f-e4d661c4ed0e"),
	// 	Properties: &armsecurity.AssessmentPropertiesResponse{
	// 		DisplayName: to.Ptr("Install internal agent on VM"),
	// 		ResourceDetails: &armsecurity.AzureResourceDetails{
	// 			Source: to.Ptr(armsecurity.SourceAzure),
	// 			ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/providers/Microsoft.Security/assessments/8bb8be0a-6010-4789-812f-e4d661c4ed0e"),
	// 		},
	// 		Status: &armsecurity.AssessmentStatusResponse{
	// 			Code: to.Ptr(armsecurity.AssessmentStatusCodeHealthy),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SecurityCenter } = require("@azure/arm-security");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Create a security assessment on your resource. An assessment metadata that describes this assessment must be predefined with the same name before inserting the assessment result
 *
 * @summary Create a security assessment on your resource. An assessment metadata that describes this assessment must be predefined with the same name before inserting the assessment result
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2021-06-01/examples/Assessments/PutAssessment_example.json
 */
async function createSecurityRecommendationTaskOnAResource() {
  const resourceId =
    "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2";
  const assessmentName = "8bb8be0a-6010-4789-812f-e4d661c4ed0e";
  const assessment = {
    resourceDetails: { source: "Azure" },
    status: { code: "Healthy" },
  };
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential);
  const result = await client.assessments.createOrUpdate(resourceId, assessmentName, assessment);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.SecurityCenter;
using Azure.ResourceManager.SecurityCenter.Models;

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/stable/2021-06-01/examples/Assessments/PutAssessment_example.json
// this example is just showing the usage of "Assessments_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SecurityAssessmentResource created on azure
// for more information of creating SecurityAssessmentResource, please refer to the document of SecurityAssessmentResource
string resourceId = "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2";
string assessmentName = "8bb8be0a-6010-4789-812f-e4d661c4ed0e";
ResourceIdentifier securityAssessmentResourceId = SecurityAssessmentResource.CreateResourceIdentifier(resourceId, assessmentName);
SecurityAssessmentResource securityAssessment = client.GetSecurityAssessmentResource(securityAssessmentResourceId);

// invoke the operation
SecurityAssessmentCreateOrUpdateContent content = new SecurityAssessmentCreateOrUpdateContent()
{
    ResourceDetails = new AzureResourceDetails(),
    Status = new SecurityAssessmentStatus(SecurityAssessmentStatusCode.Healthy),
};
ArmOperation<SecurityAssessmentResource> lro = await securityAssessment.UpdateAsync(WaitUntil.Completed, content);
SecurityAssessmentResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SecurityAssessmentData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Пример ответа

Код состояния:: 200

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/providers/Microsoft.Security/assessments/8bb8be0a-6010-4789-812f-e4d661c4ed0e",
  "name": "8bb8be0a-6010-4789-812f-e4d661c4ed0e",
  "type": "Microsoft.Security/assessments",
  "properties": {
    "resourceDetails": {
      "source": "Azure",
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/providers/Microsoft.Security/assessments/8bb8be0a-6010-4789-812f-e4d661c4ed0e"
    },
    "displayName": "Install internal agent on VM",
    "status": {
      "code": "Healthy"
    }
  }
}

Код состояния:: 201

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/providers/Microsoft.Security/assessments/8bb8be0a-6010-4789-812f-e4d661c4ed0e",
  "name": "8bb8be0a-6010-4789-812f-e4d661c4ed0e",
  "type": "Microsoft.Security/assessments",
  "properties": {
    "resourceDetails": {
      "source": "Azure",
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/providers/Microsoft.Security/assessments/8bb8be0a-6010-4789-812f-e4d661c4ed0e"
    },
    "displayName": "Install internal agent on VM",
    "status": {
      "code": "Healthy"
    }
  }
}

Определения

Имя	Описание
AssessmentLinks	Ссылки, относящиеся к оценке
AssessmentStatus	Результат оценки
AssessmentStatusCode	Программный код для состояния оценки
AssessmentStatusResponse	Результат оценки
assessmentType	Встроенная оценка, основанная на встроенном определении политики Azure, настраиваемая, если оценка основана на пользовательском определении политики Azure.
AzureResourceDetails	Сведения о ресурсе Azure, который был оценен
categories
CloudError	Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).
CloudErrorBody	Сведения об ошибке.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
implementationEffort	Усилия по реализации, необходимые для устранения этой оценки
OnPremiseResourceDetails	Сведения о локальном ресурсе, который был оценен
OnPremiseSqlResourceDetails	Сведения о ресурсе Локального SQL, который был оценен
SecurityAssessment	Оценка безопасности ресурса
SecurityAssessmentMetadataPartnerData	Описание партнера, создавшего оценку
SecurityAssessmentMetadataProperties	Описывает свойства метаданных оценки.
SecurityAssessmentPartnerData	Данные о 3-сторонней интеграции партнеров
SecurityAssessmentResponse	Оценка безопасности ресурса — формат ответа
severity	Уровень серьезности оценки
threats
userImpact	Влияние пользователя на оценку

AssessmentLinks

Ссылки, относящиеся к оценке

Имя	Тип	Описание
azurePortalUri	string	Ссылка на оценку на портале Azure

AssessmentStatus

Результат оценки

Имя	Тип	Описание
cause	string	Программный код для причины состояния оценки
code	AssessmentStatusCode	Программный код для состояния оценки
description	string	Удобочитаемое описание состояния оценки

AssessmentStatusCode

Программный код для состояния оценки

Имя	Тип	Описание
Healthy	string	Ресурс работоспособный
NotApplicable	string	Оценка этого ресурса не произошла
Unhealthy	string	Ресурс имеет проблему безопасности, которую необходимо устранить

AssessmentStatusResponse

Результат оценки

Имя	Тип	Описание
cause	string	Программный код для причины состояния оценки
code	AssessmentStatusCode	Программный код для состояния оценки
description	string	Удобочитаемое описание состояния оценки
firstEvaluationDate	string	Время создания и первого вычисления оценки. Возвращается в формате UTC в формате ISO 8601
statusChangeDate	string	Время последнего изменения состояния оценки. Возвращается в формате UTC в формате ISO 8601

assessmentType

Встроенная оценка, основанная на встроенном определении политики Azure, настраиваемая, если оценка основана на пользовательском определении политики Azure.

Имя	Тип	Описание
BuiltIn	string	Оценки, управляемые в Microsoft Defender для облака
CustomPolicy	string	Определяемые пользователем политики, которые автоматически получаются из политики Azure в Microsoft Defender для облака
CustomerManaged	string	Оценки пользователей, отправленные непосредственно пользователем или другим сторонним поставщиком в Microsoft Defender для Облака
VerifiedPartner	string	Оценка, созданная проверенной стороной, если пользователь подключил его к ASC

AzureResourceDetails

Сведения о ресурсе Azure, который был оценен

Имя	Тип	Описание
id	string	Идентификатор ресурса Azure для оцененного ресурса
source	string: Azure	Платформа, на которой находится оцененный ресурс

Имя	Тип	Описание
Compute	string
Data	string
IdentityAndAccess	string
IoT	string
Networking	string

CloudError

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).

Имя	Тип	Описание
error.additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
error.code	string	Код ошибки.
error.details	CloudErrorBody[]	Сведения об ошибке.
error.message	string	Сообщение об ошибке.
error.target	string	Целевой объект ошибки.

CloudErrorBody

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	CloudErrorBody[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

implementationEffort

Усилия по реализации, необходимые для устранения этой оценки

Имя	Тип	Описание
High	string
Low	string
Moderate	string

OnPremiseResourceDetails

Сведения о локальном ресурсе, который был оценен

Имя	Тип	Описание
machineName	string	Имя компьютера
source	string: OnPremise	Платформа, на которой находится оцененный ресурс
sourceComputerId	string	Идентификатор агента oms, установленный на компьютере
vmuuid	string	Уникальный идентификатор компьютера
workspaceId	string	Идентификатор ресурса Azure рабочей области, к которому подключен компьютер

OnPremiseSqlResourceDetails

Сведения о ресурсе Локального SQL, который был оценен

Имя	Тип	Описание
databaseName	string	Имя базы данных Sql, установленное на компьютере
machineName	string	Имя компьютера
serverName	string	Имя sql server, установленное на компьютере
source	string: OnPremiseSql	Платформа, на которой находится оцененный ресурс
sourceComputerId	string	Идентификатор агента oms, установленный на компьютере
vmuuid	string	Уникальный идентификатор компьютера
workspaceId	string	Идентификатор ресурса Azure рабочей области, к которому подключен компьютер

SecurityAssessment

Оценка безопасности ресурса

Имя	Тип	Описание
id	string	Идентификатор ресурса
name	string	Имя ресурса
properties.additionalData	object	Дополнительные данные об оценке
properties.displayName	string	Понятное отображаемое имя оценки
properties.links	AssessmentLinks	Ссылки, относящиеся к оценке
properties.metadata	SecurityAssessmentMetadataProperties	Описывает свойства метаданных оценки.
properties.partnersData	SecurityAssessmentPartnerData	Данные о 3-сторонней интеграции партнеров
properties.resourceDetails	ResourceDetails: AzureResourceDetails OnPremiseResourceDetails OnPremiseSqlResourceDetails	Сведения о ресурсе, который был оценен
properties.status	AssessmentStatus	Результат оценки
type	string	Тип ресурса

SecurityAssessmentMetadataPartnerData

Описание партнера, создавшего оценку

Имя	Тип	Описание
partnerName	string	Имя компании партнера
productName	string	Имя продукта партнера, создавшего оценку
secret	string	Секрет проверки подлинности партнера и проверка его создания — только запись

SecurityAssessmentMetadataProperties

Описывает свойства метаданных оценки.

Имя	Тип	Описание
assessmentType	assessmentType	Встроенная оценка, основанная на встроенном определении политики Azure, настраиваемая, если оценка основана на пользовательском определении политики Azure.
categories	categories[]	Категории ресурсов, которые подвергаются риску, когда оценка неработоспособна
description	string	Удобочитаемое описание оценки
displayName	string	Понятное отображаемое имя оценки
implementationEffort	implementationEffort	Усилия по реализации, необходимые для устранения этой оценки
partnerData	SecurityAssessmentMetadataPartnerData	Описание партнера, создавшего оценку
policyDefinitionId	string	Идентификатор ресурса Azure определения политики, включающего этот расчет оценки
preview	boolean	Значение true, если эта оценка находится в состоянии предварительной версии выпуска
remediationDescription	string	Читаемое человеком описание того, что следует сделать для устранения этой проблемы безопасности
severity	severity	Уровень серьезности оценки
threats	threats[]	Влияние угроз на оценку
userImpact	userImpact	Влияние пользователя на оценку

SecurityAssessmentPartnerData

Данные о 3-сторонней интеграции партнеров

Имя	Тип	Описание
partnerName	string	Имя компании партнера
secret	string	секрет для проверки подлинности партнера — только запись

SecurityAssessmentResponse

Оценка безопасности ресурса — формат ответа

Имя	Тип	Описание
id	string	Идентификатор ресурса
name	string	Имя ресурса
properties.additionalData	object	Дополнительные данные об оценке
properties.displayName	string	Понятное отображаемое имя оценки
properties.links	AssessmentLinks	Ссылки, относящиеся к оценке
properties.metadata	SecurityAssessmentMetadataProperties	Описывает свойства метаданных оценки.
properties.partnersData	SecurityAssessmentPartnerData	Данные о 3-сторонней интеграции партнеров
properties.resourceDetails	ResourceDetails: AzureResourceDetails OnPremiseResourceDetails OnPremiseSqlResourceDetails	Сведения о ресурсе, который был оценен
properties.status	AssessmentStatusResponse	Результат оценки
type	string	Тип ресурса

severity

Уровень серьезности оценки

Имя	Тип	Описание
High	string
Low	string
Medium	string

threats

Имя	Тип	Описание
accountBreach	string
dataExfiltration	string
dataSpillage	string
denialOfService	string
elevationOfPrivilege	string
maliciousInsider	string
missingCoverage	string
threatResistance	string

userImpact

Влияние пользователя на оценку

Имя	Тип	Описание
High	string
Low	string
Moderate	string

Поделиться через

Assessments - Create Or Update

Параметры URI

Текст запроса

Ответы

Безопасность

azure_auth

Области

Примеры

Create security recommendation task on a resource

Образец запроса

Пример ответа

Определения

AssessmentLinks

AssessmentStatus

AssessmentStatusCode

AssessmentStatusResponse

assessmentType

AzureResourceDetails

categories

CloudError

CloudErrorBody

ErrorAdditionalInfo

implementationEffort

OnPremiseResourceDetails

OnPremiseSqlResourceDetails

SecurityAssessment

SecurityAssessmentMetadataPartnerData

SecurityAssessmentMetadataProperties

SecurityAssessmentPartnerData

SecurityAssessmentResponse

severity

threats

userImpact

Дополнительные ресурсы