1. Packages
  2. Azure Classic
  3. API Docs
  4. securitycenter
  5. AssessmentPolicy

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi

azure.securitycenter.AssessmentPolicy

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Manages the Security Center Assessment Metadata for Azure Security Center.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.securitycenter.AssessmentPolicy("example", {
        displayName: "Test Display Name",
        severity: "Medium",
        description: "Test Description",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.securitycenter.AssessmentPolicy("example",
        display_name="Test Display Name",
        severity="Medium",
        description="Test Description")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/securitycenter"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := securitycenter.NewAssessmentPolicy(ctx, "example", &securitycenter.AssessmentPolicyArgs{
    			DisplayName: pulumi.String("Test Display Name"),
    			Severity:    pulumi.String("Medium"),
    			Description: pulumi.String("Test Description"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.SecurityCenter.AssessmentPolicy("example", new()
        {
            DisplayName = "Test Display Name",
            Severity = "Medium",
            Description = "Test Description",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.securitycenter.AssessmentPolicy;
    import com.pulumi.azure.securitycenter.AssessmentPolicyArgs;
    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 example = new AssessmentPolicy("example", AssessmentPolicyArgs.builder()
                .displayName("Test Display Name")
                .severity("Medium")
                .description("Test Description")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:securitycenter:AssessmentPolicy
        properties:
          displayName: Test Display Name
          severity: Medium
          description: Test Description
    

    Create AssessmentPolicy Resource

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

    Constructor syntax

    new AssessmentPolicy(name: string, args: AssessmentPolicyArgs, opts?: CustomResourceOptions);
    @overload
    def AssessmentPolicy(resource_name: str,
                         args: AssessmentPolicyArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def AssessmentPolicy(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         description: Optional[str] = None,
                         display_name: Optional[str] = None,
                         categories: Optional[Sequence[str]] = None,
                         implementation_effort: Optional[str] = None,
                         remediation_description: Optional[str] = None,
                         severity: Optional[str] = None,
                         threats: Optional[Sequence[str]] = None,
                         user_impact: Optional[str] = None)
    func NewAssessmentPolicy(ctx *Context, name string, args AssessmentPolicyArgs, opts ...ResourceOption) (*AssessmentPolicy, error)
    public AssessmentPolicy(string name, AssessmentPolicyArgs args, CustomResourceOptions? opts = null)
    public AssessmentPolicy(String name, AssessmentPolicyArgs args)
    public AssessmentPolicy(String name, AssessmentPolicyArgs args, CustomResourceOptions options)
    
    type: azure:securitycenter:AssessmentPolicy
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args AssessmentPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AssessmentPolicyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AssessmentPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AssessmentPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AssessmentPolicyArgs
    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 assessmentPolicyResource = new Azure.SecurityCenter.AssessmentPolicy("assessmentPolicyResource", new()
    {
        Description = "string",
        DisplayName = "string",
        Categories = new[]
        {
            "string",
        },
        ImplementationEffort = "string",
        RemediationDescription = "string",
        Severity = "string",
        Threats = new[]
        {
            "string",
        },
        UserImpact = "string",
    });
    
    example, err := securitycenter.NewAssessmentPolicy(ctx, "assessmentPolicyResource", &securitycenter.AssessmentPolicyArgs{
    	Description: pulumi.String("string"),
    	DisplayName: pulumi.String("string"),
    	Categories: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ImplementationEffort:   pulumi.String("string"),
    	RemediationDescription: pulumi.String("string"),
    	Severity:               pulumi.String("string"),
    	Threats: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	UserImpact: pulumi.String("string"),
    })
    
    var assessmentPolicyResource = new AssessmentPolicy("assessmentPolicyResource", AssessmentPolicyArgs.builder()
        .description("string")
        .displayName("string")
        .categories("string")
        .implementationEffort("string")
        .remediationDescription("string")
        .severity("string")
        .threats("string")
        .userImpact("string")
        .build());
    
    assessment_policy_resource = azure.securitycenter.AssessmentPolicy("assessmentPolicyResource",
        description="string",
        display_name="string",
        categories=["string"],
        implementation_effort="string",
        remediation_description="string",
        severity="string",
        threats=["string"],
        user_impact="string")
    
    const assessmentPolicyResource = new azure.securitycenter.AssessmentPolicy("assessmentPolicyResource", {
        description: "string",
        displayName: "string",
        categories: ["string"],
        implementationEffort: "string",
        remediationDescription: "string",
        severity: "string",
        threats: ["string"],
        userImpact: "string",
    });
    
    type: azure:securitycenter:AssessmentPolicy
    properties:
        categories:
            - string
        description: string
        displayName: string
        implementationEffort: string
        remediationDescription: string
        severity: string
        threats:
            - string
        userImpact: string
    

    AssessmentPolicy 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 AssessmentPolicy resource accepts the following input properties:

    Description string
    The description of the Security Center Assessment.
    DisplayName string
    The user-friendly display name of the Security Center Assessment.
    Categories List<string>
    A list of the categories of resource that is at risk when the Security Center Assessment is unhealthy. Possible values are Unknown, Compute, Data, IdentityAndAccess, IoT and Networking.
    ImplementationEffort string
    The implementation effort which is used to remediate the Security Center Assessment. Possible values are Low, Moderate and High.
    RemediationDescription string
    The description which is used to mitigate the security issue.
    Severity string
    The severity level of the Security Center Assessment. Possible values are Low, Medium and High. Defaults to Medium.
    Threats List<string>
    A list of the threat impacts for the Security Center Assessment. Possible values are AccountBreach, DataExfiltration, DataSpillage, DenialOfService, ElevationOfPrivilege, MaliciousInsider, MissingCoverage and ThreatResistance.
    UserImpact string
    The user impact of the Security Center Assessment. Possible values are Low, Moderate and High.
    Description string
    The description of the Security Center Assessment.
    DisplayName string
    The user-friendly display name of the Security Center Assessment.
    Categories []string
    A list of the categories of resource that is at risk when the Security Center Assessment is unhealthy. Possible values are Unknown, Compute, Data, IdentityAndAccess, IoT and Networking.
    ImplementationEffort string
    The implementation effort which is used to remediate the Security Center Assessment. Possible values are Low, Moderate and High.
    RemediationDescription string
    The description which is used to mitigate the security issue.
    Severity string
    The severity level of the Security Center Assessment. Possible values are Low, Medium and High. Defaults to Medium.
    Threats []string
    A list of the threat impacts for the Security Center Assessment. Possible values are AccountBreach, DataExfiltration, DataSpillage, DenialOfService, ElevationOfPrivilege, MaliciousInsider, MissingCoverage and ThreatResistance.
    UserImpact string
    The user impact of the Security Center Assessment. Possible values are Low, Moderate and High.
    description String
    The description of the Security Center Assessment.
    displayName String
    The user-friendly display name of the Security Center Assessment.
    categories List<String>
    A list of the categories of resource that is at risk when the Security Center Assessment is unhealthy. Possible values are Unknown, Compute, Data, IdentityAndAccess, IoT and Networking.
    implementationEffort String
    The implementation effort which is used to remediate the Security Center Assessment. Possible values are Low, Moderate and High.
    remediationDescription String
    The description which is used to mitigate the security issue.
    severity String
    The severity level of the Security Center Assessment. Possible values are Low, Medium and High. Defaults to Medium.
    threats List<String>
    A list of the threat impacts for the Security Center Assessment. Possible values are AccountBreach, DataExfiltration, DataSpillage, DenialOfService, ElevationOfPrivilege, MaliciousInsider, MissingCoverage and ThreatResistance.
    userImpact String
    The user impact of the Security Center Assessment. Possible values are Low, Moderate and High.
    description string
    The description of the Security Center Assessment.
    displayName string
    The user-friendly display name of the Security Center Assessment.
    categories string[]
    A list of the categories of resource that is at risk when the Security Center Assessment is unhealthy. Possible values are Unknown, Compute, Data, IdentityAndAccess, IoT and Networking.
    implementationEffort string
    The implementation effort which is used to remediate the Security Center Assessment. Possible values are Low, Moderate and High.
    remediationDescription string
    The description which is used to mitigate the security issue.
    severity string
    The severity level of the Security Center Assessment. Possible values are Low, Medium and High. Defaults to Medium.
    threats string[]
    A list of the threat impacts for the Security Center Assessment. Possible values are AccountBreach, DataExfiltration, DataSpillage, DenialOfService, ElevationOfPrivilege, MaliciousInsider, MissingCoverage and ThreatResistance.
    userImpact string
    The user impact of the Security Center Assessment. Possible values are Low, Moderate and High.
    description str
    The description of the Security Center Assessment.
    display_name str
    The user-friendly display name of the Security Center Assessment.
    categories Sequence[str]
    A list of the categories of resource that is at risk when the Security Center Assessment is unhealthy. Possible values are Unknown, Compute, Data, IdentityAndAccess, IoT and Networking.
    implementation_effort str
    The implementation effort which is used to remediate the Security Center Assessment. Possible values are Low, Moderate and High.
    remediation_description str
    The description which is used to mitigate the security issue.
    severity str
    The severity level of the Security Center Assessment. Possible values are Low, Medium and High. Defaults to Medium.
    threats Sequence[str]
    A list of the threat impacts for the Security Center Assessment. Possible values are AccountBreach, DataExfiltration, DataSpillage, DenialOfService, ElevationOfPrivilege, MaliciousInsider, MissingCoverage and ThreatResistance.
    user_impact str
    The user impact of the Security Center Assessment. Possible values are Low, Moderate and High.
    description String
    The description of the Security Center Assessment.
    displayName String
    The user-friendly display name of the Security Center Assessment.
    categories List<String>
    A list of the categories of resource that is at risk when the Security Center Assessment is unhealthy. Possible values are Unknown, Compute, Data, IdentityAndAccess, IoT and Networking.
    implementationEffort String
    The implementation effort which is used to remediate the Security Center Assessment. Possible values are Low, Moderate and High.
    remediationDescription String
    The description which is used to mitigate the security issue.
    severity String
    The severity level of the Security Center Assessment. Possible values are Low, Medium and High. Defaults to Medium.
    threats List<String>
    A list of the threat impacts for the Security Center Assessment. Possible values are AccountBreach, DataExfiltration, DataSpillage, DenialOfService, ElevationOfPrivilege, MaliciousInsider, MissingCoverage and ThreatResistance.
    userImpact String
    The user impact of the Security Center Assessment. Possible values are Low, Moderate and High.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The GUID as the name of the Security Center Assessment Policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The GUID as the name of the Security Center Assessment Policy.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The GUID as the name of the Security Center Assessment Policy.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The GUID as the name of the Security Center Assessment Policy.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The GUID as the name of the Security Center Assessment Policy.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The GUID as the name of the Security Center Assessment Policy.

    Look up Existing AssessmentPolicy Resource

    Get an existing AssessmentPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AssessmentPolicyState, opts?: CustomResourceOptions): AssessmentPolicy
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            categories: Optional[Sequence[str]] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            implementation_effort: Optional[str] = None,
            name: Optional[str] = None,
            remediation_description: Optional[str] = None,
            severity: Optional[str] = None,
            threats: Optional[Sequence[str]] = None,
            user_impact: Optional[str] = None) -> AssessmentPolicy
    func GetAssessmentPolicy(ctx *Context, name string, id IDInput, state *AssessmentPolicyState, opts ...ResourceOption) (*AssessmentPolicy, error)
    public static AssessmentPolicy Get(string name, Input<string> id, AssessmentPolicyState? state, CustomResourceOptions? opts = null)
    public static AssessmentPolicy get(String name, Output<String> id, AssessmentPolicyState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Categories List<string>
    A list of the categories of resource that is at risk when the Security Center Assessment is unhealthy. Possible values are Unknown, Compute, Data, IdentityAndAccess, IoT and Networking.
    Description string
    The description of the Security Center Assessment.
    DisplayName string
    The user-friendly display name of the Security Center Assessment.
    ImplementationEffort string
    The implementation effort which is used to remediate the Security Center Assessment. Possible values are Low, Moderate and High.
    Name string
    The GUID as the name of the Security Center Assessment Policy.
    RemediationDescription string
    The description which is used to mitigate the security issue.
    Severity string
    The severity level of the Security Center Assessment. Possible values are Low, Medium and High. Defaults to Medium.
    Threats List<string>
    A list of the threat impacts for the Security Center Assessment. Possible values are AccountBreach, DataExfiltration, DataSpillage, DenialOfService, ElevationOfPrivilege, MaliciousInsider, MissingCoverage and ThreatResistance.
    UserImpact string
    The user impact of the Security Center Assessment. Possible values are Low, Moderate and High.
    Categories []string
    A list of the categories of resource that is at risk when the Security Center Assessment is unhealthy. Possible values are Unknown, Compute, Data, IdentityAndAccess, IoT and Networking.
    Description string
    The description of the Security Center Assessment.
    DisplayName string
    The user-friendly display name of the Security Center Assessment.
    ImplementationEffort string
    The implementation effort which is used to remediate the Security Center Assessment. Possible values are Low, Moderate and High.
    Name string
    The GUID as the name of the Security Center Assessment Policy.
    RemediationDescription string
    The description which is used to mitigate the security issue.
    Severity string
    The severity level of the Security Center Assessment. Possible values are Low, Medium and High. Defaults to Medium.
    Threats []string
    A list of the threat impacts for the Security Center Assessment. Possible values are AccountBreach, DataExfiltration, DataSpillage, DenialOfService, ElevationOfPrivilege, MaliciousInsider, MissingCoverage and ThreatResistance.
    UserImpact string
    The user impact of the Security Center Assessment. Possible values are Low, Moderate and High.
    categories List<String>
    A list of the categories of resource that is at risk when the Security Center Assessment is unhealthy. Possible values are Unknown, Compute, Data, IdentityAndAccess, IoT and Networking.
    description String
    The description of the Security Center Assessment.
    displayName String
    The user-friendly display name of the Security Center Assessment.
    implementationEffort String
    The implementation effort which is used to remediate the Security Center Assessment. Possible values are Low, Moderate and High.
    name String
    The GUID as the name of the Security Center Assessment Policy.
    remediationDescription String
    The description which is used to mitigate the security issue.
    severity String
    The severity level of the Security Center Assessment. Possible values are Low, Medium and High. Defaults to Medium.
    threats List<String>
    A list of the threat impacts for the Security Center Assessment. Possible values are AccountBreach, DataExfiltration, DataSpillage, DenialOfService, ElevationOfPrivilege, MaliciousInsider, MissingCoverage and ThreatResistance.
    userImpact String
    The user impact of the Security Center Assessment. Possible values are Low, Moderate and High.
    categories string[]
    A list of the categories of resource that is at risk when the Security Center Assessment is unhealthy. Possible values are Unknown, Compute, Data, IdentityAndAccess, IoT and Networking.
    description string
    The description of the Security Center Assessment.
    displayName string
    The user-friendly display name of the Security Center Assessment.
    implementationEffort string
    The implementation effort which is used to remediate the Security Center Assessment. Possible values are Low, Moderate and High.
    name string
    The GUID as the name of the Security Center Assessment Policy.
    remediationDescription string
    The description which is used to mitigate the security issue.
    severity string
    The severity level of the Security Center Assessment. Possible values are Low, Medium and High. Defaults to Medium.
    threats string[]
    A list of the threat impacts for the Security Center Assessment. Possible values are AccountBreach, DataExfiltration, DataSpillage, DenialOfService, ElevationOfPrivilege, MaliciousInsider, MissingCoverage and ThreatResistance.
    userImpact string
    The user impact of the Security Center Assessment. Possible values are Low, Moderate and High.
    categories Sequence[str]
    A list of the categories of resource that is at risk when the Security Center Assessment is unhealthy. Possible values are Unknown, Compute, Data, IdentityAndAccess, IoT and Networking.
    description str
    The description of the Security Center Assessment.
    display_name str
    The user-friendly display name of the Security Center Assessment.
    implementation_effort str
    The implementation effort which is used to remediate the Security Center Assessment. Possible values are Low, Moderate and High.
    name str
    The GUID as the name of the Security Center Assessment Policy.
    remediation_description str
    The description which is used to mitigate the security issue.
    severity str
    The severity level of the Security Center Assessment. Possible values are Low, Medium and High. Defaults to Medium.
    threats Sequence[str]
    A list of the threat impacts for the Security Center Assessment. Possible values are AccountBreach, DataExfiltration, DataSpillage, DenialOfService, ElevationOfPrivilege, MaliciousInsider, MissingCoverage and ThreatResistance.
    user_impact str
    The user impact of the Security Center Assessment. Possible values are Low, Moderate and High.
    categories List<String>
    A list of the categories of resource that is at risk when the Security Center Assessment is unhealthy. Possible values are Unknown, Compute, Data, IdentityAndAccess, IoT and Networking.
    description String
    The description of the Security Center Assessment.
    displayName String
    The user-friendly display name of the Security Center Assessment.
    implementationEffort String
    The implementation effort which is used to remediate the Security Center Assessment. Possible values are Low, Moderate and High.
    name String
    The GUID as the name of the Security Center Assessment Policy.
    remediationDescription String
    The description which is used to mitigate the security issue.
    severity String
    The severity level of the Security Center Assessment. Possible values are Low, Medium and High. Defaults to Medium.
    threats List<String>
    A list of the threat impacts for the Security Center Assessment. Possible values are AccountBreach, DataExfiltration, DataSpillage, DenialOfService, ElevationOfPrivilege, MaliciousInsider, MissingCoverage and ThreatResistance.
    userImpact String
    The user impact of the Security Center Assessment. Possible values are Low, Moderate and High.

    Import

    Security Assessments Policy can be imported using the resource id, e.g.

    $ pulumi import azure:securitycenter/assessmentPolicy:AssessmentPolicy example /subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Security/assessmentMetadata/metadata1
    

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi