Microsoft.Security assessmentMetadata 2020-01-01

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

Bicep resource definition

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

• Tenant - See tenant deployment commands* Subscription - See subscription deployment commands

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

Resource format

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

resource symbolicname 'Microsoft.Security/assessmentMetadata@2020-01-01' = {
  name: 'string'
  properties: {
    assessmentType: 'string'
    categories: [
      'string'
    ]
    description: 'string'
    displayName: 'string'
    implementationEffort: 'string'
    partnerData: {
      partnerName: 'string'
      productName: 'string'
      secret: 'string'
    }
    preview: bool
    remediationDescription: 'string'
    severity: 'string'
    threats: [
      'string'
    ]
    userImpact: 'string'
  }
}

Property values

Microsoft.Security/assessmentMetadata

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

SecurityAssessmentMetadataPartnerData

Name	Description	Value
partnerName	Name of the company of the partner	string (required)
productName	Name of the product of the partner that created the assessment	string
secret	Secret to authenticate the partner and verify it created the assessment - write only	string Constraints: Sensitive value. Pass in as a secure parameter. (required)

SecurityAssessmentMetadataProperties

Name	Description	Value
assessmentType	BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition	'BuiltIn' 'CustomerManaged' 'CustomPolicy' 'VerifiedPartner' (required)
categories		String array containing any of: 'Compute' 'Data' 'IdentityAndAccess' 'IoT' 'Networking'
description	Human readable description of the assessment	string
displayName	User friendly display name of the assessment	string (required)
implementationEffort	The implementation effort required to remediate this assessment	'High' 'Low' 'Moderate'
partnerData	Describes the partner that created the assessment	SecurityAssessmentMetadataPartnerData
preview	True if this assessment is in preview release status	bool
remediationDescription	Human readable description of what you should do to mitigate this security issue	string
severity	The severity level of the assessment	'High' 'Low' 'Medium' (required)
threats		String array containing any of: 'accountBreach' 'dataExfiltration' 'dataSpillage' 'denialOfService' 'elevationOfPrivilege' 'maliciousInsider' 'missingCoverage' 'threatResistance'
userImpact	The user impact of the assessment	'High' 'Low' 'Moderate'

ARM template resource definition

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

• Tenant - See tenant deployment commands* Subscription - See subscription deployment commands

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

Resource format

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

{
  "type": "Microsoft.Security/assessmentMetadata",
  "apiVersion": "2020-01-01",
  "name": "string",
  "properties": {
    "assessmentType": "string",
    "categories": [ "string" ],
    "description": "string",
    "displayName": "string",
    "implementationEffort": "string",
    "partnerData": {
      "partnerName": "string",
      "productName": "string",
      "secret": "string"
    },
    "preview": "bool",
    "remediationDescription": "string",
    "severity": "string",
    "threats": [ "string" ],
    "userImpact": "string"
  }
}

Property values

Microsoft.Security/assessmentMetadata

Name	Description	Value
apiVersion	The api version	'2020-01-01'
name	The resource name	string (required)
properties	Describes properties of an assessment metadata.	SecurityAssessmentMetadataProperties
type	The resource type	'Microsoft.Security/assessmentMetadata'

SecurityAssessmentMetadataPartnerData

Name	Description	Value
partnerName	Name of the company of the partner	string (required)
productName	Name of the product of the partner that created the assessment	string
secret	Secret to authenticate the partner and verify it created the assessment - write only	string Constraints: Sensitive value. Pass in as a secure parameter. (required)

SecurityAssessmentMetadataProperties

Name	Description	Value
assessmentType	BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition	'BuiltIn' 'CustomerManaged' 'CustomPolicy' 'VerifiedPartner' (required)
categories		String array containing any of: 'Compute' 'Data' 'IdentityAndAccess' 'IoT' 'Networking'
description	Human readable description of the assessment	string
displayName	User friendly display name of the assessment	string (required)
implementationEffort	The implementation effort required to remediate this assessment	'High' 'Low' 'Moderate'
partnerData	Describes the partner that created the assessment	SecurityAssessmentMetadataPartnerData
preview	True if this assessment is in preview release status	bool
remediationDescription	Human readable description of what you should do to mitigate this security issue	string
severity	The severity level of the assessment	'High' 'Low' 'Medium' (required)
threats		String array containing any of: 'accountBreach' 'dataExfiltration' 'dataSpillage' 'denialOfService' 'elevationOfPrivilege' 'maliciousInsider' 'missingCoverage' 'threatResistance'
userImpact	The user impact of the assessment	'High' 'Low' 'Moderate'

Terraform (AzAPI provider) resource definition

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

• Tenant* Subscription

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

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Security/assessmentMetadata@2020-01-01"
  name = "string"
  body = jsonencode({
    properties = {
      assessmentType = "string"
      categories = [
        "string"
      ]
      description = "string"
      displayName = "string"
      implementationEffort = "string"
      partnerData = {
        partnerName = "string"
        productName = "string"
        secret = "string"
      }
      preview = bool
      remediationDescription = "string"
      severity = "string"
      threats = [
        "string"
      ]
      userImpact = "string"
    }
  })
}

Property values

Microsoft.Security/assessmentMetadata

Name	Description	Value
name	The resource name	string (required)
properties	Describes properties of an assessment metadata.	SecurityAssessmentMetadataProperties
type	The resource type	"Microsoft.Security/assessmentMetadata@2020-01-01"

SecurityAssessmentMetadataPartnerData

Name	Description	Value
partnerName	Name of the company of the partner	string (required)
productName	Name of the product of the partner that created the assessment	string
secret	Secret to authenticate the partner and verify it created the assessment - write only	string Constraints: Sensitive value. Pass in as a secure parameter. (required)

SecurityAssessmentMetadataProperties

Name	Description	Value
assessmentType	BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition	'BuiltIn' 'CustomerManaged' 'CustomPolicy' 'VerifiedPartner' (required)
categories		String array containing any of: 'Compute' 'Data' 'IdentityAndAccess' 'IoT' 'Networking'
description	Human readable description of the assessment	string
displayName	User friendly display name of the assessment	string (required)
implementationEffort	The implementation effort required to remediate this assessment	'High' 'Low' 'Moderate'
partnerData	Describes the partner that created the assessment	SecurityAssessmentMetadataPartnerData
preview	True if this assessment is in preview release status	bool
remediationDescription	Human readable description of what you should do to mitigate this security issue	string
severity	The severity level of the assessment	'High' 'Low' 'Medium' (required)
threats		String array containing any of: 'accountBreach' 'dataExfiltration' 'dataSpillage' 'denialOfService' 'elevationOfPrivilege' 'maliciousInsider' 'missingCoverage' 'threatResistance'
userImpact	The user impact of the assessment	'High' 'Low' 'Moderate'