Assessments - Create Or Update

Referens

Tjänst:: Defender for Cloud

API-version:: 2021-06-01

Skapa en säkerhetsbedömning av resursen. En utvärderingsmetadata som beskriver den här utvärderingen måste vara fördefinierad med samma namn innan utvärderingsresultatet infogas

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
assessmentName	path	True	string	Utvärderingsnyckeln – unik nyckel för utvärderingstypen
resourceId	path	True	string	Resursens identifierare.
api-version	query	True	string	API-version för åtgärden

Begärandetext

Name	Obligatorisk	Typ	Description
properties.resourceDetails	True	ResourceDetails: OnPremiseResourceDetails AzureResourceDetails OnPremiseSqlResourceDetails	Information om resursen som utvärderades
properties.status	True	AssessmentStatus	Resultatet av utvärderingen
properties.additionalData		object	Ytterligare data om utvärderingen
properties.metadata		SecurityAssessmentMetadataProperties	Beskriver egenskaperna för en utvärderingsmetadata.
properties.partnersData		SecurityAssessmentPartnerData	Data om partnerintegrering från tredje part

Svar

Name	Typ	Description
200 OK	SecurityAssessmentResponse	OK – Uppdaterad
201 Created	SecurityAssessmentResponse	Skapad
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Create security recommendation task on a resource

Exempelbegäran

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

Exempelsvar

Statuskod:: 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"
    }
  }
}

Statuskod:: 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"
    }
  }
}

Definitioner

Name	Description
AssessmentLinks	Länkar som är relevanta för utvärderingen
AssessmentStatus	Resultatet av utvärderingen
AssessmentStatusCode	Programmatisk kod för utvärderingens status
AssessmentStatusResponse	Resultatet av utvärderingen
assessmentType	BuiltIn om utvärderingen baseras på inbyggd Azure Policy-definition, Anpassad om utvärderingen baseras på anpassad Azure Policy-definition
AzureResourceDetails	Information om Den Azure-resurs som utvärderades
categories
CloudError	Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).
CloudErrorBody	Felinformationen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
implementationEffort	Den implementeringsinsats som krävs för att åtgärda den här utvärderingen
OnPremiseResourceDetails	Information om den lokala resurs som utvärderades
OnPremiseSqlResourceDetails	Information om den lokala Sql-resursen som utvärderades
SecurityAssessment	Säkerhetsbedömning på en resurs
SecurityAssessmentMetadataPartnerData	Beskriver partnern som skapade utvärderingen
SecurityAssessmentMetadataProperties	Beskriver egenskaperna för en utvärderingsmetadata.
SecurityAssessmentPartnerData	Data om partnerintegrering från tredje part
SecurityAssessmentResponse	Säkerhetsbedömning för en resurs – svarsformat
severity	Utvärderingens allvarlighetsgrad
threats
userImpact	Utvärderingens användarpåverkan

AssessmentLinks

Länkar som är relevanta för utvärderingen

Name	Typ	Description
azurePortalUri	string	Länk till utvärdering i Azure-portalen

AssessmentStatus

Resultatet av utvärderingen

Name	Typ	Description
cause	string	Programmatisk kod för orsaken till utvärderingsstatusen
code	AssessmentStatusCode	Programmatisk kod för utvärderingens status
description	string	Mänsklig läsbar beskrivning av utvärderingsstatusen

AssessmentStatusCode

Programmatisk kod för utvärderingens status

Name	Typ	Description
Healthy	string	Resursen är felfri
NotApplicable	string	Utvärdering för den här resursen har inte skett
Unhealthy	string	Resursen har ett säkerhetsproblem som måste åtgärdas

AssessmentStatusResponse

Resultatet av utvärderingen

Name	Typ	Description
cause	string	Programmatisk kod för orsaken till utvärderingsstatusen
code	AssessmentStatusCode	Programmatisk kod för utvärderingens status
description	string	Mänsklig läsbar beskrivning av utvärderingsstatusen
firstEvaluationDate	string	Den tid då utvärderingen skapades och först utvärderades. Returneras som UTC-tid i ISO 8601-format
statusChangeDate	string	Den tid då utvärderingens status senast ändrades. Returneras som UTC-tid i ISO 8601-format

assessmentType

BuiltIn om utvärderingen baseras på inbyggd Azure Policy-definition, Anpassad om utvärderingen baseras på anpassad Azure Policy-definition

Name	Typ	Description
BuiltIn	string	Hanterade utvärderingar i Microsoft Defender för molnet
CustomPolicy	string	Användardefinierade principer som matas in automatiskt från Azure Policy till Microsoft Defender för molnet
CustomerManaged	string	Användarutvärderingar som skickas direkt av användaren eller någon annan tredje part till Microsoft Defender för molnet
VerifiedPartner	string	En utvärdering som skapades av en verifierad tredje part om användaren anslöt den till ASC

AzureResourceDetails

Information om Den Azure-resurs som utvärderades

Name	Typ	Description
id	string	Azure-resurs-ID för den utvärderade resursen
source	string: Azure	Plattformen där den utvärderade resursen finns

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

CloudError

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).

Name	Typ	Description
error.additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
error.code	string	Felkoden.
error.details	CloudErrorBody[]	Felinformationen.
error.message	string	Felmeddelandet.
error.target	string	Felmålet.

CloudErrorBody

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	CloudErrorBody[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

implementationEffort

Den implementeringsinsats som krävs för att åtgärda den här utvärderingen

Name	Typ	Description
High	string
Low	string
Moderate	string

OnPremiseResourceDetails

Information om den lokala resurs som utvärderades

Name	Typ	Description
machineName	string	Namnet på datorn
source	string: OnPremise	Plattformen där den utvärderade resursen finns
sourceComputerId	string	Oms-agent-ID:t som är installerat på datorn
vmuuid	string	Datorns unika ID
workspaceId	string	Azure-resurs-ID för arbetsytan som datorn är ansluten till

OnPremiseSqlResourceDetails

Information om den lokala Sql-resursen som utvärderades

Name	Typ	Description
databaseName	string	Sql-databasnamnet som är installerat på datorn
machineName	string	Namnet på datorn
serverName	string	Sql Server-namnet installerat på datorn
source	string: OnPremiseSql	Plattformen där den utvärderade resursen finns
sourceComputerId	string	Oms-agent-ID:t som är installerat på datorn
vmuuid	string	Datorns unika ID
workspaceId	string	Azure-resurs-ID för arbetsytan som datorn är ansluten till

SecurityAssessment

Säkerhetsbedömning på en resurs

Name	Typ	Description
id	string	Resurs-ID
name	string	Resursnamn
properties.additionalData	object	Ytterligare data om utvärderingen
properties.displayName	string	Användarvänligt visningsnamn för utvärderingen
properties.links	AssessmentLinks	Länkar som är relevanta för utvärderingen
properties.metadata	SecurityAssessmentMetadataProperties	Beskriver egenskaperna för en utvärderingsmetadata.
properties.partnersData	SecurityAssessmentPartnerData	Data om partnerintegrering från tredje part
properties.resourceDetails	ResourceDetails: AzureResourceDetails OnPremiseResourceDetails OnPremiseSqlResourceDetails	Information om resursen som utvärderades
properties.status	AssessmentStatus	Resultatet av utvärderingen
type	string	Resurstyp

SecurityAssessmentMetadataPartnerData

Beskriver partnern som skapade utvärderingen

Name	Typ	Description
partnerName	string	Namnet på partnerns företag
productName	string	Namnet på produkten för partnern som skapade utvärderingen
secret	string	Hemlighet för att autentisera partnern och verifiera att den skapade utvärderingen – skriv endast

SecurityAssessmentMetadataProperties

Beskriver egenskaperna för en utvärderingsmetadata.

Name	Typ	Description
assessmentType	assessmentType	BuiltIn om utvärderingen baseras på inbyggd Azure Policy-definition, Anpassad om utvärderingen baseras på anpassad Azure Policy-definition
categories	categories[]	De resurskategorier som är i riskzonen när utvärderingen inte är felfri
description	string	Mänsklig läsbar beskrivning av utvärderingen
displayName	string	Användarvänligt visningsnamn för utvärderingen
implementationEffort	implementationEffort	Den implementeringsinsats som krävs för att åtgärda den här utvärderingen
partnerData	SecurityAssessmentMetadataPartnerData	Beskriver partnern som skapade utvärderingen
policyDefinitionId	string	Azure-resurs-ID för principdefinitionen som aktiverar den här utvärderingsberäkningen
preview	boolean	Sant om den här utvärderingen är i förhandsversionsstatus
remediationDescription	string	Mänsklig läsbar beskrivning av vad du bör göra för att åtgärda det här säkerhetsproblemet
severity	severity	Utvärderingens allvarlighetsgrad
threats	threats[]	Hotpåverkan av utvärderingen
userImpact	userImpact	Utvärderingens användarpåverkan

SecurityAssessmentPartnerData

Data om partnerintegrering från tredje part

Name	Typ	Description
partnerName	string	Namnet på partnerns företag
secret	string	hemlighet för att autentisera partnern – skriv endast

SecurityAssessmentResponse

Säkerhetsbedömning för en resurs – svarsformat

Name	Typ	Description
id	string	Resurs-ID
name	string	Resursnamn
properties.additionalData	object	Ytterligare data om utvärderingen
properties.displayName	string	Användarvänligt visningsnamn för utvärderingen
properties.links	AssessmentLinks	Länkar som är relevanta för utvärderingen
properties.metadata	SecurityAssessmentMetadataProperties	Beskriver egenskaperna för en utvärderingsmetadata.
properties.partnersData	SecurityAssessmentPartnerData	Data om partnerintegrering från tredje part
properties.resourceDetails	ResourceDetails: AzureResourceDetails OnPremiseResourceDetails OnPremiseSqlResourceDetails	Information om resursen som utvärderades
properties.status	AssessmentStatusResponse	Resultatet av utvärderingen
type	string	Resurstyp

severity

Utvärderingens allvarlighetsgrad

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

Utvärderingens användarpåverkan

Name	Typ	Description
High	string
Low	string
Moderate	string

Dela via

Assessments - Create Or Update

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

Create security recommendation task on a resource

Exempelbegäran

Exempelsvar

Definitioner

AssessmentLinks

AssessmentStatus

AssessmentStatusCode

AssessmentStatusResponse

assessmentType

AzureResourceDetails

categories

CloudError

CloudErrorBody

ErrorAdditionalInfo

implementationEffort

OnPremiseResourceDetails

OnPremiseSqlResourceDetails

SecurityAssessment

SecurityAssessmentMetadataPartnerData

SecurityAssessmentMetadataProperties

SecurityAssessmentPartnerData

SecurityAssessmentResponse

severity

threats

userImpact

Ytterligare resurser