Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The customAssessmentAutomations resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Security/customAssessmentAutomations resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Security/customAssessmentAutomations@2021-07-01-preview' = {
name: 'string'
properties: {
compressedQuery: 'string'
description: 'string'
displayName: 'string'
remediationDescription: 'string'
severity: 'string'
supportedCloud: 'string'
}
}
Property Values
Microsoft.Security/customAssessmentAutomations
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| properties | describes Custom Assessment Automation request properties. | CustomAssessmentAutomationRequestPropertiesOrCustomAssessmentAutomationProperties |
CustomAssessmentAutomationRequestPropertiesOrCustomAssessmentAutomationProperties
| Name | Description | Value |
|---|---|---|
| compressedQuery | Base 64 encoded KQL query representing the assessment automation results required. | string |
| description | The description to relate to the assessments generated by this assessment automation. | string |
| displayName | The display name of the assessments generated by this assessment automation. | string |
| remediationDescription | The remediation description to relate to the assessments generated by this assessment automation. | string |
| severity | The severity to relate to the assessments generated by this assessment automation. | 'High' 'Low' 'Medium' |
| supportedCloud | Relevant cloud for the custom assessment automation. | 'AWS' 'GCP' |
ARM template resource definition
The customAssessmentAutomations resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Security/customAssessmentAutomations resource, add the following JSON to your template.
{
"type": "Microsoft.Security/customAssessmentAutomations",
"apiVersion": "2021-07-01-preview",
"name": "string",
"properties": {
"compressedQuery": "string",
"description": "string",
"displayName": "string",
"remediationDescription": "string",
"severity": "string",
"supportedCloud": "string"
}
}
Property Values
Microsoft.Security/customAssessmentAutomations
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2021-07-01-preview' |
| name | The resource name | string (required) |
| properties | describes Custom Assessment Automation request properties. | CustomAssessmentAutomationRequestPropertiesOrCustomAssessmentAutomationProperties |
| type | The resource type | 'Microsoft.Security/customAssessmentAutomations' |
CustomAssessmentAutomationRequestPropertiesOrCustomAssessmentAutomationProperties
| Name | Description | Value |
|---|---|---|
| compressedQuery | Base 64 encoded KQL query representing the assessment automation results required. | string |
| description | The description to relate to the assessments generated by this assessment automation. | string |
| displayName | The display name of the assessments generated by this assessment automation. | string |
| remediationDescription | The remediation description to relate to the assessments generated by this assessment automation. | string |
| severity | The severity to relate to the assessments generated by this assessment automation. | 'High' 'Low' 'Medium' |
| supportedCloud | Relevant cloud for the custom assessment automation. | 'AWS' 'GCP' |
Usage Examples
Terraform (AzAPI provider) resource definition
The customAssessmentAutomations resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Security/customAssessmentAutomations resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Security/customAssessmentAutomations@2021-07-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
compressedQuery = "string"
description = "string"
displayName = "string"
remediationDescription = "string"
severity = "string"
supportedCloud = "string"
}
}
}
Property Values
Microsoft.Security/customAssessmentAutomations
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| properties | describes Custom Assessment Automation request properties. | CustomAssessmentAutomationRequestPropertiesOrCustomAssessmentAutomationProperties |
| type | The resource type | "Microsoft.Security/customAssessmentAutomations@2021-07-01-preview" |
CustomAssessmentAutomationRequestPropertiesOrCustomAssessmentAutomationProperties
| Name | Description | Value |
|---|---|---|
| compressedQuery | Base 64 encoded KQL query representing the assessment automation results required. | string |
| description | The description to relate to the assessments generated by this assessment automation. | string |
| displayName | The display name of the assessments generated by this assessment automation. | string |
| remediationDescription | The remediation description to relate to the assessments generated by this assessment automation. | string |
| severity | The severity to relate to the assessments generated by this assessment automation. | 'High' 'Low' 'Medium' |
| supportedCloud | Relevant cloud for the custom assessment automation. | 'AWS' 'GCP' |