Microsoft.Security assessmentMetadata 2020-01-01
Bicep resource definition
The assessmentMetadata resource type is an extension resource, which means you can apply it to another resource.
Use the scope
property on this resource to set the scope for this resource. See Set scope on extension resources in Bicep.
The assessmentMetadata resource type can be deployed with operations that target:
- Subscriptions - See subscription deployment commands
You can reference this resource type as a read-only resource at level of: Tenants
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'
scope: resourceSymbolicName
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
assessmentMetadata
Name | Description | Value |
---|---|---|
name | The resource name | string (required) Character limit: 1-260 Valid characters: Alphanumerics, underscores, and hyphens. |
scope | Use when creating an extension resource at a scope that is different than the deployment scope. | Target resource For Bicep, set this property to the symbolic name of the resource to apply the extension resource. |
properties | Describes properties of an assessment metadata. | SecurityAssessmentMetadataProperties |
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' 'CustomPolicy' 'CustomerManaged' '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' |
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 (required) Constraints: Sensitive value. Pass in as a secure parameter. |
ARM template resource definition
The assessmentMetadata resource type is an extension resource, which means you can apply it to another resource.
Use the scope
property on this resource to set the scope for this resource. See Set scope on extension resources in ARM templates.
The assessmentMetadata resource type can be deployed with operations that target:
- Subscriptions - See subscription deployment commands
You can reference this resource type as a read-only resource at level of: Tenants
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",
"scope": "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
assessmentMetadata
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.Security/assessmentMetadata' |
apiVersion | The resource api version | '2020-01-01' |
name | The resource name | string (required) Character limit: 1-260 Valid characters: Alphanumerics, underscores, and hyphens. |
scope | Use when creating an extension resource at a scope that is different than the deployment scope. | Target resource For JSON, set the value to the full name of the resource to apply the extension resource to. |
properties | Describes properties of an assessment metadata. | SecurityAssessmentMetadataProperties |
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' 'CustomPolicy' 'CustomerManaged' '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' |
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 (required) Constraints: Sensitive value. Pass in as a secure parameter. |
Terraform (AzAPI provider) resource definition
The assessmentMetadata resource type is an extension resource, which means you can apply it to another resource.
Use the parent_id
property on this resource to set the scope for this resource.
The assessmentMetadata resource type can be deployed with operations that target:
- Subscriptions
You can reference this resource type as a read-only resource at level of: Tenants
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"
parent_id = "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
assessmentMetadata
Name | Description | Value |
---|---|---|
type | The resource type | "Microsoft.Security/assessmentMetadata@2020-01-01" |
name | The resource name | string (required) Character limit: 1-260 Valid characters: Alphanumerics, underscores, and hyphens. |
parent_id | The ID of the resource to apply this extension resource to. | string (required) |
properties | Describes properties of an assessment metadata. | SecurityAssessmentMetadataProperties |
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" "CustomPolicy" "CustomerManaged" "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" |
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 (required) Constraints: Sensitive value. Pass in as a secure parameter. |