Assessments - Create Or Update

Reference

Služba:: Defender for Cloud

Verze rozhraní API:: 2021-06-01

Vytvořte pro prostředek posouzení zabezpečení. Před vložením výsledku posouzení musí být předdefinována metadata posouzení popisující toto posouzení se stejným názvem.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
assessmentName	path	True	string	Klíč posouzení – jedinečný klíč pro typ posouzení
resourceId	path	True	string	Identifikátor prostředku.
api-version	query	True	string	Verze rozhraní API pro operaci

Text požadavku

Name	Vyžadováno	Typ	Description
properties.resourceDetails	True	ResourceDetails: OnPremiseResourceDetails AzureResourceDetails OnPremiseSqlResourceDetails	Podrobnosti o prostředku, který byl vyhodnocen
properties.status	True	AssessmentStatus	Výsledek posouzení
properties.additionalData		object	Další údaje týkající se posouzení
properties.metadata		SecurityAssessmentMetadataProperties	Popisuje vlastnosti metadat posouzení.
properties.partnersData		SecurityAssessmentPartnerData	Data týkající se integrace partnerů třetích stran

Odpovědi

Name	Typ	Description
200 OK	SecurityAssessmentResponse	OK – aktualizováno
201 Created	SecurityAssessmentResponse	Vytvořil
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Create security recommendation task on a resource

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
    }
  }
}

Stavový kód:: 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"
    }
  }
}

Definice

Name	Description
AssessmentLinks	Odkazy relevantní na posouzení
AssessmentStatus	Výsledek posouzení
AssessmentStatusCode	Programový kód pro stav posouzení
AssessmentStatusResponse	Výsledek posouzení
assessmentType	BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition
AzureResourceDetails	Podrobnosti o prostředku Azure, který byl vyhodnocen
categories
CloudError	Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)
CloudErrorBody	Podrobnosti o chybě.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
implementationEffort	Úsilí o implementaci potřebné k nápravě tohoto posouzení
OnPremiseResourceDetails	Podrobnosti o místním prostředku, který byl vyhodnocen
OnPremiseSqlResourceDetails	Podrobnosti o místním prostředku SQL, který byl vyhodnocen
SecurityAssessment	Posouzení zabezpečení prostředku
SecurityAssessmentMetadataPartnerData	Popisuje partnera, který vytvořil posouzení.
SecurityAssessmentMetadataProperties	Popisuje vlastnosti metadat posouzení.
SecurityAssessmentPartnerData	Data týkající se integrace partnerů třetích stran
SecurityAssessmentResponse	Posouzení zabezpečení prostředku – formát odpovědi
severity	Úroveň závažnosti posouzení
threats
userImpact	Dopad posouzení na uživatele

AssessmentLinks

Odkazy relevantní na posouzení

Name	Typ	Description
azurePortalUri	string	Odkaz na posouzení na webu Azure Portal

AssessmentStatus

Výsledek posouzení

Name	Typ	Description
cause	string	Programový kód pro příčinu stavu posouzení
code	AssessmentStatusCode	Programový kód pro stav posouzení
description	string	Human readable description of the assessment status

AssessmentStatusCode

Programový kód pro stav posouzení

Name	Typ	Description
Healthy	string	Prostředek je v pořádku.
NotApplicable	string	Posouzení pro tento prostředek se nestalo.
Unhealthy	string	Prostředek má problém se zabezpečením, který je potřeba vyřešit.

AssessmentStatusResponse

Výsledek posouzení

Name	Typ	Description
cause	string	Programový kód pro příčinu stavu posouzení
code	AssessmentStatusCode	Programový kód pro stav posouzení
description	string	Human readable description of the assessment status
firstEvaluationDate	string	Čas vytvoření posouzení a jeho první vyhodnocení. Vráceno jako čas UTC ve formátu ISO 8601
statusChangeDate	string	Čas poslední změny stavu posouzení. Vráceno jako čas UTC ve formátu ISO 8601

assessmentType

BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition

Name	Typ	Description
BuiltIn	string	Posouzení spravovaná v programu Microsoft Defender pro cloud
CustomPolicy	string	Uživatelem definované zásady, které se automaticky ingestují ze služby Azure Policy do Microsoft Defenderu pro cloud
CustomerManaged	string	Hodnocení uživatelů nabízená přímo uživatelem nebo jinou třetí stranou do programu Microsoft Defender for Cloud
VerifiedPartner	string	Posouzení vytvořené ověřenou třetí stranou, pokud ho uživatel připojil k ASC

AzureResourceDetails

Podrobnosti o prostředku Azure, který byl vyhodnocen

Name	Typ	Description
id	string	ID prostředku Azure pro vyhodnocený prostředek
source	string: Azure	Platforma, ve které se nachází hodnocený prostředek

Name	Typ	Description
Compute	string
Data	string
IdentityAndAccess	string
IoT	string
Networking	string

CloudError

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

Name	Typ	Description
error.additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
error.code	string	Kód chyby.
error.details	CloudErrorBody[]	Podrobnosti o chybě.
error.message	string	Chybová zpráva.
error.target	string	Cíl chyby.

CloudErrorBody

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	CloudErrorBody[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

implementationEffort

Úsilí o implementaci potřebné k nápravě tohoto posouzení

Name	Typ	Description
High	string
Low	string
Moderate	string

OnPremiseResourceDetails

Podrobnosti o místním prostředku, který byl vyhodnocen

Name	Typ	Description
machineName	string	Název počítače
source	string: OnPremise	Platforma, ve které se nachází hodnocený prostředek
sourceComputerId	string	ID agenta oms nainstalovaného na počítači
vmuuid	string	Jedinečné ID počítače
workspaceId	string	ID prostředku Azure pracovního prostoru, ke kterému je počítač připojený

OnPremiseSqlResourceDetails

Podrobnosti o místním prostředku SQL, který byl vyhodnocen

Name	Typ	Description
databaseName	string	Název databáze SQL nainstalovaný na počítači
machineName	string	Název počítače
serverName	string	Název sql serveru nainstalovaný na počítači
source	string: OnPremiseSql	Platforma, ve které se nachází hodnocený prostředek
sourceComputerId	string	ID agenta oms nainstalovaného na počítači
vmuuid	string	Jedinečné ID počítače
workspaceId	string	ID prostředku Azure pracovního prostoru, ke kterému je počítač připojený

SecurityAssessment

Posouzení zabezpečení prostředku

Name	Typ	Description
id	string	ID prostředku
name	string	Název prostředku
properties.additionalData	object	Další údaje týkající se posouzení
properties.displayName	string	Uživatelsky přívětivý zobrazovaný název posouzení
properties.links	AssessmentLinks	Odkazy relevantní na posouzení
properties.metadata	SecurityAssessmentMetadataProperties	Popisuje vlastnosti metadat posouzení.
properties.partnersData	SecurityAssessmentPartnerData	Data týkající se integrace partnerů třetích stran
properties.resourceDetails	ResourceDetails: AzureResourceDetails OnPremiseResourceDetails OnPremiseSqlResourceDetails	Podrobnosti o prostředku, který byl vyhodnocen
properties.status	AssessmentStatus	Výsledek posouzení
type	string	Typ prostředku

SecurityAssessmentMetadataPartnerData

Popisuje partnera, který vytvořil posouzení.

Name	Typ	Description
partnerName	string	Název společnosti partnera
productName	string	Název produktu partnera, který posouzení vytvořil
secret	string	Tajný kód pro ověření partnera a ověření vytvoření posouzení – pouze zápis

SecurityAssessmentMetadataProperties

Popisuje vlastnosti metadat posouzení.

Name	Typ	Description
assessmentType	assessmentType	BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition
categories	categories[]	Kategorie prostředků, které jsou ohroženy, když posouzení není v pořádku
description	string	Human readable description of the assessment
displayName	string	Uživatelsky přívětivý zobrazovaný název posouzení
implementationEffort	implementationEffort	Úsilí o implementaci potřebné k nápravě tohoto posouzení
partnerData	SecurityAssessmentMetadataPartnerData	Popisuje partnera, který vytvořil posouzení.
policyDefinitionId	string	ID prostředku Azure definice zásady, která tento výpočet posouzení zapne
preview	boolean	Hodnota True, pokud je toto posouzení ve stavu verze Preview
remediationDescription	string	Popis toho, co byste měli udělat pro zmírnění tohoto problému se zabezpečením, je čitelný pro člověka
severity	severity	Úroveň závažnosti posouzení
threats	threats[]	Dopad posouzení na hrozby
userImpact	userImpact	Dopad posouzení na uživatele

SecurityAssessmentPartnerData

Data týkající se integrace partnerů třetích stran

Name	Typ	Description
partnerName	string	Název společnosti partnera
secret	string	tajný kód pro ověření partnera – pouze zápis

SecurityAssessmentResponse

Posouzení zabezpečení prostředku – formát odpovědi

Name	Typ	Description
id	string	ID prostředku
name	string	Název prostředku
properties.additionalData	object	Další údaje týkající se posouzení
properties.displayName	string	Uživatelsky přívětivý zobrazovaný název posouzení
properties.links	AssessmentLinks	Odkazy relevantní na posouzení
properties.metadata	SecurityAssessmentMetadataProperties	Popisuje vlastnosti metadat posouzení.
properties.partnersData	SecurityAssessmentPartnerData	Data týkající se integrace partnerů třetích stran
properties.resourceDetails	ResourceDetails: AzureResourceDetails OnPremiseResourceDetails OnPremiseSqlResourceDetails	Podrobnosti o prostředku, který byl vyhodnocen
properties.status	AssessmentStatusResponse	Výsledek posouzení
type	string	Typ prostředku

severity

Úroveň závažnosti posouzení

Name	Typ	Description
High	string
Low	string
Medium	string

threats

Name	Typ	Description
accountBreach	string
dataExfiltration	string
dataSpillage	string
denialOfService	string
elevationOfPrivilege	string
maliciousInsider	string
missingCoverage	string
threatResistance	string

userImpact

Dopad posouzení na uživatele

Name	Typ	Description
High	string
Low	string
Moderate	string

Sdílet prostřednictvím

Assessments - Create Or Update

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

Create security recommendation task on a resource

Ukázkový požadavek

Ukázková odpověď

Definice

AssessmentLinks

AssessmentStatus

AssessmentStatusCode

AssessmentStatusResponse

assessmentType

AzureResourceDetails

categories

CloudError

CloudErrorBody

ErrorAdditionalInfo

implementationEffort

OnPremiseResourceDetails

OnPremiseSqlResourceDetails

SecurityAssessment

SecurityAssessmentMetadataPartnerData

SecurityAssessmentMetadataProperties

SecurityAssessmentPartnerData

SecurityAssessmentResponse

severity

threats

userImpact

Další materiály