Microsoft.Security assessments 2019-01-01-preview

• Latest
• 2021-06-01
• 2020-01-01
• 2019-01-01-preview

Bicep resource definition

The assessments resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Security/assessments resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Security/assessments@2019-01-01-preview' = {
  name: 'string'
  properties: {
    additionalData: {
      {customized property}: 'string'
    }
    resourceDetails: {
      source: 'string'
      // For remaining properties, see ResourceDetails objects
    }
    status: {
      cause: 'string'
      code: 'string'
      description: 'string'
    }
  }
}

ResourceDetails objects

Set the source property to specify the type of object.

For Azure, use:

{
  source: 'Azure'
}

For OnPremiseSql, use:

{
  databaseName: 'string'
  machineName: 'string'
  serverName: 'string'
  source: 'OnPremiseSql'
  sourceComputerId: 'string'
  vmuuid: 'string'
  workspaceId: 'string'
}

Property values

AssessmentStatus

Name	Description	Value
cause	Programmatic code for the cause of the assessment status	string
code	Programmatic code for the status of the assessment	'Healthy' 'NotApplicable' 'Unhealthy' (required)
description	Human readable description of the assessment status	string

AzureResourceDetails

Name	Description	Value
source	The platform where the assessed resource resides	'Azure' (required)

Microsoft.Security/assessments

Name	Description	Value
name	The resource name	string (required)
properties	Describes properties of an assessment.	SecurityAssessmentProperties

OnPremiseSqlResourceDetails

Name	Description	Value
databaseName	The Sql database name installed on the machine	string (required)
machineName	The name of the machine	string (required)
serverName	The Sql server name installed on the machine	string (required)
source	The platform where the assessed resource resides	'OnPremiseSql' (required)
sourceComputerId	The oms agent Id installed on the machine	string (required)
vmuuid	The unique Id of the machine	string (required)
workspaceId	Azure resource Id of the workspace the machine is attached to	string (required)

ResourceDetails

Name	Description	Value
source	Set to 'Azure' for type AzureResourceDetails. Set to 'OnPremiseSql' for type OnPremiseSqlResourceDetails.	'Azure' 'OnPremiseSql' (required)

SecurityAssessmentProperties

Name	Description	Value
additionalData	Additional data regarding the assessment	SecurityAssessmentPropertiesAdditionalData
resourceDetails	Details of the resource that was assessed	ResourceDetails (required)
status	The result of the assessment	AssessmentStatus (required)

SecurityAssessmentPropertiesAdditionalData

Name	Description	Value

ARM template resource definition

The assessments resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Security/assessments resource, add the following JSON to your template.

{
  "type": "Microsoft.Security/assessments",
  "apiVersion": "2019-01-01-preview",
  "name": "string",
  "properties": {
    "additionalData": {
      "{customized property}": "string"
    },
    "resourceDetails": {
      "source": "string"
      // For remaining properties, see ResourceDetails objects
    },
    "status": {
      "cause": "string",
      "code": "string",
      "description": "string"
    }
  }
}

ResourceDetails objects

Set the source property to specify the type of object.

For Azure, use:

{
  "source": "Azure"
}

For OnPremiseSql, use:

{
  "databaseName": "string",
  "machineName": "string",
  "serverName": "string",
  "source": "OnPremiseSql",
  "sourceComputerId": "string",
  "vmuuid": "string",
  "workspaceId": "string"
}

Property values

AssessmentStatus

Name	Description	Value
cause	Programmatic code for the cause of the assessment status	string
code	Programmatic code for the status of the assessment	'Healthy' 'NotApplicable' 'Unhealthy' (required)
description	Human readable description of the assessment status	string

AzureResourceDetails

Name	Description	Value
source	The platform where the assessed resource resides	'Azure' (required)

Microsoft.Security/assessments

Name	Description	Value
apiVersion	The api version	'2019-01-01-preview'
name	The resource name	string (required)
properties	Describes properties of an assessment.	SecurityAssessmentProperties
type	The resource type	'Microsoft.Security/assessments'

OnPremiseSqlResourceDetails

Name	Description	Value
databaseName	The Sql database name installed on the machine	string (required)
machineName	The name of the machine	string (required)
serverName	The Sql server name installed on the machine	string (required)
source	The platform where the assessed resource resides	'OnPremiseSql' (required)
sourceComputerId	The oms agent Id installed on the machine	string (required)
vmuuid	The unique Id of the machine	string (required)
workspaceId	Azure resource Id of the workspace the machine is attached to	string (required)

ResourceDetails

Name	Description	Value
source	Set to 'Azure' for type AzureResourceDetails. Set to 'OnPremiseSql' for type OnPremiseSqlResourceDetails.	'Azure' 'OnPremiseSql' (required)

SecurityAssessmentProperties

Name	Description	Value
additionalData	Additional data regarding the assessment	SecurityAssessmentPropertiesAdditionalData
resourceDetails	Details of the resource that was assessed	ResourceDetails (required)
status	The result of the assessment	AssessmentStatus (required)

SecurityAssessmentPropertiesAdditionalData

Name	Description	Value

Terraform (AzAPI provider) resource definition

The assessments resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Security/assessments resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Security/assessments@2019-01-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      additionalData = {
        {customized property} = "string"
      }
      resourceDetails = {
        source = "string"
        // For remaining properties, see ResourceDetails objects
      }
      status = {
        cause = "string"
        code = "string"
        description = "string"
      }
    }
  })
}

ResourceDetails objects

Set the source property to specify the type of object.

For Azure, use:

{
  source = "Azure"
}

For OnPremiseSql, use:

{
  databaseName = "string"
  machineName = "string"
  serverName = "string"
  source = "OnPremiseSql"
  sourceComputerId = "string"
  vmuuid = "string"
  workspaceId = "string"
}

Property values

AssessmentStatus

Name	Description	Value
cause	Programmatic code for the cause of the assessment status	string
code	Programmatic code for the status of the assessment	'Healthy' 'NotApplicable' 'Unhealthy' (required)
description	Human readable description of the assessment status	string

AzureResourceDetails

Name	Description	Value
source	The platform where the assessed resource resides	'Azure' (required)

Microsoft.Security/assessments

Name	Description	Value
name	The resource name	string (required)
properties	Describes properties of an assessment.	SecurityAssessmentProperties
type	The resource type	"Microsoft.Security/assessments@2019-01-01-preview"

OnPremiseSqlResourceDetails

Name	Description	Value
databaseName	The Sql database name installed on the machine	string (required)
machineName	The name of the machine	string (required)
serverName	The Sql server name installed on the machine	string (required)
source	The platform where the assessed resource resides	'OnPremiseSql' (required)
sourceComputerId	The oms agent Id installed on the machine	string (required)
vmuuid	The unique Id of the machine	string (required)
workspaceId	Azure resource Id of the workspace the machine is attached to	string (required)

ResourceDetails

Name	Description	Value
source	Set to 'Azure' for type AzureResourceDetails. Set to 'OnPremiseSql' for type OnPremiseSqlResourceDetails.	'Azure' 'OnPremiseSql' (required)

SecurityAssessmentProperties

Name	Description	Value
additionalData	Additional data regarding the assessment	SecurityAssessmentPropertiesAdditionalData
resourceDetails	Details of the resource that was assessed	ResourceDetails (required)
status	The result of the assessment	AssessmentStatus (required)

SecurityAssessmentPropertiesAdditionalData

Name	Description	Value