Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. security
  5. CustomAssessmentAutomation
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.security.CustomAssessmentAutomation

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Custom Assessment Automation Azure REST API version: 2021-07-01-preview. Prior API version in Azure Native 1.x: 2021-07-01-preview.

Example Usage

Create a Custom Assessment Automation

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var customAssessmentAutomation = new AzureNative.Security.CustomAssessmentAutomation("customAssessmentAutomation", new()
    {
        CompressedQuery = "DQAKAEkAYQBtAF8ARwByAG8AdQBwAA0ACgB8ACAAZQB4AHQAZQBuAGQAIABIAGUAYQBsAHQAaABTAHQAYQB0AHUAcwAgAD0AIABpAGYAZgAoAHQAbwBzAHQAcgBpAG4AZwAoAFIAZQBjAG8AcgBkAC4AVQBzAGUAcgBOAGEAbQBlACkAIABjAG8AbgB0AGEAaQBuAHMAIAAnAHUAcwBlAHIAJwAsACAAJwBVAE4ASABFAEEATABUAEgAWQAnACwAIAAnAEgARQBBAEwAVABIAFkAJwApAA0ACgA=",
        CustomAssessmentAutomationName = "MyCustomAssessmentAutomation",
        Description = "Data should be encrypted",
        DisplayName = "Password Policy",
        RemediationDescription = "Encrypt store by...",
        ResourceGroupName = "TestResourceGroup",
        Severity = AzureNative.Security.SeverityEnum.Medium,
        SupportedCloud = AzureNative.Security.SupportedCloudEnum.AWS,
    });

});
Copy
package main

import (
	security "github.com/pulumi/pulumi-azure-native-sdk/security/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := security.NewCustomAssessmentAutomation(ctx, "customAssessmentAutomation", &security.CustomAssessmentAutomationArgs{
			CompressedQuery:                pulumi.String("DQAKAEkAYQBtAF8ARwByAG8AdQBwAA0ACgB8ACAAZQB4AHQAZQBuAGQAIABIAGUAYQBsAHQAaABTAHQAYQB0AHUAcwAgAD0AIABpAGYAZgAoAHQAbwBzAHQAcgBpAG4AZwAoAFIAZQBjAG8AcgBkAC4AVQBzAGUAcgBOAGEAbQBlACkAIABjAG8AbgB0AGEAaQBuAHMAIAAnAHUAcwBlAHIAJwAsACAAJwBVAE4ASABFAEEATABUAEgAWQAnACwAIAAnAEgARQBBAEwAVABIAFkAJwApAA0ACgA="),
			CustomAssessmentAutomationName: pulumi.String("MyCustomAssessmentAutomation"),
			Description:                    pulumi.String("Data should be encrypted"),
			DisplayName:                    pulumi.String("Password Policy"),
			RemediationDescription:         pulumi.String("Encrypt store by..."),
			ResourceGroupName:              pulumi.String("TestResourceGroup"),
			Severity:                       pulumi.String(security.SeverityEnumMedium),
			SupportedCloud:                 pulumi.String(security.SupportedCloudEnumAWS),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.security.CustomAssessmentAutomation;
import com.pulumi.azurenative.security.CustomAssessmentAutomationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var customAssessmentAutomation = new CustomAssessmentAutomation("customAssessmentAutomation", CustomAssessmentAutomationArgs.builder()
            .compressedQuery("DQAKAEkAYQBtAF8ARwByAG8AdQBwAA0ACgB8ACAAZQB4AHQAZQBuAGQAIABIAGUAYQBsAHQAaABTAHQAYQB0AHUAcwAgAD0AIABpAGYAZgAoAHQAbwBzAHQAcgBpAG4AZwAoAFIAZQBjAG8AcgBkAC4AVQBzAGUAcgBOAGEAbQBlACkAIABjAG8AbgB0AGEAaQBuAHMAIAAnAHUAcwBlAHIAJwAsACAAJwBVAE4ASABFAEEATABUAEgAWQAnACwAIAAnAEgARQBBAEwAVABIAFkAJwApAA0ACgA=")
            .customAssessmentAutomationName("MyCustomAssessmentAutomation")
            .description("Data should be encrypted")
            .displayName("Password Policy")
            .remediationDescription("Encrypt store by...")
            .resourceGroupName("TestResourceGroup")
            .severity("Medium")
            .supportedCloud("AWS")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const customAssessmentAutomation = new azure_native.security.CustomAssessmentAutomation("customAssessmentAutomation", {
    compressedQuery: "DQAKAEkAYQBtAF8ARwByAG8AdQBwAA0ACgB8ACAAZQB4AHQAZQBuAGQAIABIAGUAYQBsAHQAaABTAHQAYQB0AHUAcwAgAD0AIABpAGYAZgAoAHQAbwBzAHQAcgBpAG4AZwAoAFIAZQBjAG8AcgBkAC4AVQBzAGUAcgBOAGEAbQBlACkAIABjAG8AbgB0AGEAaQBuAHMAIAAnAHUAcwBlAHIAJwAsACAAJwBVAE4ASABFAEEATABUAEgAWQAnACwAIAAnAEgARQBBAEwAVABIAFkAJwApAA0ACgA=",
    customAssessmentAutomationName: "MyCustomAssessmentAutomation",
    description: "Data should be encrypted",
    displayName: "Password Policy",
    remediationDescription: "Encrypt store by...",
    resourceGroupName: "TestResourceGroup",
    severity: azure_native.security.SeverityEnum.Medium,
    supportedCloud: azure_native.security.SupportedCloudEnum.AWS,
});
Copy
import pulumi
import pulumi_azure_native as azure_native

custom_assessment_automation = azure_native.security.CustomAssessmentAutomation("customAssessmentAutomation",
    compressed_query="DQAKAEkAYQBtAF8ARwByAG8AdQBwAA0ACgB8ACAAZQB4AHQAZQBuAGQAIABIAGUAYQBsAHQAaABTAHQAYQB0AHUAcwAgAD0AIABpAGYAZgAoAHQAbwBzAHQAcgBpAG4AZwAoAFIAZQBjAG8AcgBkAC4AVQBzAGUAcgBOAGEAbQBlACkAIABjAG8AbgB0AGEAaQBuAHMAIAAnAHUAcwBlAHIAJwAsACAAJwBVAE4ASABFAEEATABUAEgAWQAnACwAIAAnAEgARQBBAEwAVABIAFkAJwApAA0ACgA=",
    custom_assessment_automation_name="MyCustomAssessmentAutomation",
    description="Data should be encrypted",
    display_name="Password Policy",
    remediation_description="Encrypt store by...",
    resource_group_name="TestResourceGroup",
    severity=azure_native.security.SeverityEnum.MEDIUM,
    supported_cloud=azure_native.security.SupportedCloudEnum.AWS)
Copy
resources:
  customAssessmentAutomation:
    type: azure-native:security:CustomAssessmentAutomation
    properties:
      compressedQuery: DQAKAEkAYQBtAF8ARwByAG8AdQBwAA0ACgB8ACAAZQB4AHQAZQBuAGQAIABIAGUAYQBsAHQAaABTAHQAYQB0AHUAcwAgAD0AIABpAGYAZgAoAHQAbwBzAHQAcgBpAG4AZwAoAFIAZQBjAG8AcgBkAC4AVQBzAGUAcgBOAGEAbQBlACkAIABjAG8AbgB0AGEAaQBuAHMAIAAnAHUAcwBlAHIAJwAsACAAJwBVAE4ASABFAEEATABUAEgAWQAnACwAIAAnAEgARQBBAEwAVABIAFkAJwApAA0ACgA=
      customAssessmentAutomationName: MyCustomAssessmentAutomation
      description: Data should be encrypted
      displayName: Password Policy
      remediationDescription: Encrypt store by...
      resourceGroupName: TestResourceGroup
      severity: Medium
      supportedCloud: AWS
Copy

Create CustomAssessmentAutomation Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new CustomAssessmentAutomation(name: string, args: CustomAssessmentAutomationArgs, opts?: CustomResourceOptions);
@overload
def CustomAssessmentAutomation(resource_name: str,
                               args: CustomAssessmentAutomationArgs,
                               opts: Optional[ResourceOptions] = None)

@overload
def CustomAssessmentAutomation(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               resource_group_name: Optional[str] = None,
                               compressed_query: Optional[str] = None,
                               custom_assessment_automation_name: Optional[str] = None,
                               description: Optional[str] = None,
                               display_name: Optional[str] = None,
                               remediation_description: Optional[str] = None,
                               severity: Optional[Union[str, SeverityEnum]] = None,
                               supported_cloud: Optional[Union[str, SupportedCloudEnum]] = None)
func NewCustomAssessmentAutomation(ctx *Context, name string, args CustomAssessmentAutomationArgs, opts ...ResourceOption) (*CustomAssessmentAutomation, error)
public CustomAssessmentAutomation(string name, CustomAssessmentAutomationArgs args, CustomResourceOptions? opts = null)
public CustomAssessmentAutomation(String name, CustomAssessmentAutomationArgs args)
public CustomAssessmentAutomation(String name, CustomAssessmentAutomationArgs args, CustomResourceOptions options)

type: azure-native:security:CustomAssessmentAutomation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. CustomAssessmentAutomationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. CustomAssessmentAutomationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. CustomAssessmentAutomationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CustomAssessmentAutomationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CustomAssessmentAutomationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var customAssessmentAutomationResource = new AzureNative.Security.CustomAssessmentAutomation("customAssessmentAutomationResource", new()
{
    ResourceGroupName = "string",
    CompressedQuery = "string",
    CustomAssessmentAutomationName = "string",
    Description = "string",
    DisplayName = "string",
    RemediationDescription = "string",
    Severity = "string",
    SupportedCloud = "string",
});
Copy
example, err := security.NewCustomAssessmentAutomation(ctx, "customAssessmentAutomationResource", &security.CustomAssessmentAutomationArgs{
	ResourceGroupName:              "string",
	CompressedQuery:                "string",
	CustomAssessmentAutomationName: "string",
	Description:                    "string",
	DisplayName:                    "string",
	RemediationDescription:         "string",
	Severity:                       "string",
	SupportedCloud:                 "string",
})
Copy
var customAssessmentAutomationResource = new CustomAssessmentAutomation("customAssessmentAutomationResource", CustomAssessmentAutomationArgs.builder()
    .resourceGroupName("string")
    .compressedQuery("string")
    .customAssessmentAutomationName("string")
    .description("string")
    .displayName("string")
    .remediationDescription("string")
    .severity("string")
    .supportedCloud("string")
    .build());
Copy
custom_assessment_automation_resource = azure_native.security.CustomAssessmentAutomation("customAssessmentAutomationResource",
    resource_group_name=string,
    compressed_query=string,
    custom_assessment_automation_name=string,
    description=string,
    display_name=string,
    remediation_description=string,
    severity=string,
    supported_cloud=string)
Copy
const customAssessmentAutomationResource = new azure_native.security.CustomAssessmentAutomation("customAssessmentAutomationResource", {
    resourceGroupName: "string",
    compressedQuery: "string",
    customAssessmentAutomationName: "string",
    description: "string",
    displayName: "string",
    remediationDescription: "string",
    severity: "string",
    supportedCloud: "string",
});
Copy
type: azure-native:security:CustomAssessmentAutomation
properties:
    compressedQuery: string
    customAssessmentAutomationName: string
    description: string
    displayName: string
    remediationDescription: string
    resourceGroupName: string
    severity: string
    supportedCloud: string
Copy

CustomAssessmentAutomation Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The CustomAssessmentAutomation resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription. The name is case insensitive.
CompressedQuery string
Base 64 encoded KQL query representing the assessment automation results required.
CustomAssessmentAutomationName Changes to this property will trigger replacement. string
Name of the Custom Assessment Automation.
Description string
The description to relate to the assessments generated by this assessment automation.
DisplayName string
The display name of the assessments generated by this assessment automation.
RemediationDescription string
The remediation description to relate to the assessments generated by this assessment automation.
Severity string | Pulumi.AzureNative.Security.SeverityEnum
The severity to relate to the assessments generated by this assessment automation.
SupportedCloud string | Pulumi.AzureNative.Security.SupportedCloudEnum
Relevant cloud for the custom assessment automation.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription. The name is case insensitive.
CompressedQuery string
Base 64 encoded KQL query representing the assessment automation results required.
CustomAssessmentAutomationName Changes to this property will trigger replacement. string
Name of the Custom Assessment Automation.
Description string
The description to relate to the assessments generated by this assessment automation.
DisplayName string
The display name of the assessments generated by this assessment automation.
RemediationDescription string
The remediation description to relate to the assessments generated by this assessment automation.
Severity string | SeverityEnum
The severity to relate to the assessments generated by this assessment automation.
SupportedCloud string | SupportedCloudEnum
Relevant cloud for the custom assessment automation.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group within the user's subscription. The name is case insensitive.
compressedQuery String
Base 64 encoded KQL query representing the assessment automation results required.
customAssessmentAutomationName Changes to this property will trigger replacement. String
Name of the Custom Assessment Automation.
description String
The description to relate to the assessments generated by this assessment automation.
displayName String
The display name of the assessments generated by this assessment automation.
remediationDescription String
The remediation description to relate to the assessments generated by this assessment automation.
severity String | SeverityEnum
The severity to relate to the assessments generated by this assessment automation.
supportedCloud String | SupportedCloudEnum
Relevant cloud for the custom assessment automation.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription. The name is case insensitive.
compressedQuery string
Base 64 encoded KQL query representing the assessment automation results required.
customAssessmentAutomationName Changes to this property will trigger replacement. string
Name of the Custom Assessment Automation.
description string
The description to relate to the assessments generated by this assessment automation.
displayName string
The display name of the assessments generated by this assessment automation.
remediationDescription string
The remediation description to relate to the assessments generated by this assessment automation.
severity string | SeverityEnum
The severity to relate to the assessments generated by this assessment automation.
supportedCloud string | SupportedCloudEnum
Relevant cloud for the custom assessment automation.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group within the user's subscription. The name is case insensitive.
compressed_query str
Base 64 encoded KQL query representing the assessment automation results required.
custom_assessment_automation_name Changes to this property will trigger replacement. str
Name of the Custom Assessment Automation.
description str
The description to relate to the assessments generated by this assessment automation.
display_name str
The display name of the assessments generated by this assessment automation.
remediation_description str
The remediation description to relate to the assessments generated by this assessment automation.
severity str | SeverityEnum
The severity to relate to the assessments generated by this assessment automation.
supported_cloud str | SupportedCloudEnum
Relevant cloud for the custom assessment automation.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group within the user's subscription. The name is case insensitive.
compressedQuery String
Base 64 encoded KQL query representing the assessment automation results required.
customAssessmentAutomationName Changes to this property will trigger replacement. String
Name of the Custom Assessment Automation.
description String
The description to relate to the assessments generated by this assessment automation.
displayName String
The display name of the assessments generated by this assessment automation.
remediationDescription String
The remediation description to relate to the assessments generated by this assessment automation.
severity String | "High" | "Medium" | "Low"
The severity to relate to the assessments generated by this assessment automation.
supportedCloud String | "AWS" | "GCP"
Relevant cloud for the custom assessment automation.

Outputs

All input properties are implicitly available as output properties. Additionally, the CustomAssessmentAutomation resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name
SystemData Pulumi.AzureNative.Security.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
Resource type
AssessmentKey string
The assessment metadata key used when an assessment is generated for this assessment automation.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
Resource type
AssessmentKey string
The assessment metadata key used when an assessment is generated for this assessment automation.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
Resource type
assessmentKey String
The assessment metadata key used when an assessment is generated for this assessment automation.
id string
The provider-assigned unique ID for this managed resource.
name string
Resource name
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
Resource type
assessmentKey string
The assessment metadata key used when an assessment is generated for this assessment automation.
id str
The provider-assigned unique ID for this managed resource.
name str
Resource name
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
Resource type
assessment_key str
The assessment metadata key used when an assessment is generated for this assessment automation.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
Resource type
assessmentKey String
The assessment metadata key used when an assessment is generated for this assessment automation.

Supporting Types

SeverityEnum
, SeverityEnumArgs

High
High
Medium
Medium
Low
Low
SeverityEnumHigh
High
SeverityEnumMedium
Medium
SeverityEnumLow
Low
High
High
Medium
Medium
Low
Low
High
High
Medium
Medium
Low
Low
HIGH
High
MEDIUM
Medium
LOW
Low
"High"
High
"Medium"
Medium
"Low"
Low

SupportedCloudEnum
, SupportedCloudEnumArgs

AWS
AWS
GCP
GCP
SupportedCloudEnumAWS
AWS
SupportedCloudEnumGCP
GCP
AWS
AWS
GCP
GCP
AWS
AWS
GCP
GCP
AWS
AWS
GCP
GCP
"AWS"
AWS
"GCP"
GCP

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:security:CustomAssessmentAutomation 33e7cc6e-a139-4723-a0e5-76993aee0771 /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Security/customAssessmentAutomations/{customAssessmentAutomationName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native