Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Sonarqube Provider
  3. API Docs
  4. QualityprofileActivateRule
sonarqube 0.16.14 published on Monday, Apr 14, 2025 by jdamata
jdamata/terraform-provider-sonarqube

sonarqube.QualityprofileActivateRule

Explore with Pulumi AI

sonarqube 0.16.14 published on Monday, Apr 14, 2025 by jdamata
jdamata/terraform-provider-sonarqube

Provides a Sonarqube Rules resource. This can be used to manage Sonarqube rules.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as sonarqube from "@pulumi/sonarqube";

const allowedMavenDependencies = new sonarqube.Rule("allowedMavenDependencies", {
    customKey: "Only_use_allowed_Maven_dependencies",
    markdownDescription: "Description",
    params: "FilePattern=**/pom.xml",
    severity: "BLOCKER",
    status: "READY",
    templateKey: "xml:XPathCheck",
    type: "VULNERABILITY",
});
const xml = new sonarqube.Qualityprofile("xml", {
    language: "xml",
    isDefault: false,
    parent: "Sonar way",
});
const xmlRule = new sonarqube.QualityprofileActivateRule("xmlRule", {
    key: xml.key,
    rule: allowedMavenDependencies.ruleId,
    severity: "BLOCKER",
});
Copy
import pulumi
import pulumi_sonarqube as sonarqube

allowed_maven_dependencies = sonarqube.Rule("allowedMavenDependencies",
    custom_key="Only_use_allowed_Maven_dependencies",
    markdown_description="Description",
    params="FilePattern=**/pom.xml",
    severity="BLOCKER",
    status="READY",
    template_key="xml:XPathCheck",
    type="VULNERABILITY")
xml = sonarqube.Qualityprofile("xml",
    language="xml",
    is_default=False,
    parent="Sonar way")
xml_rule = sonarqube.QualityprofileActivateRule("xmlRule",
    key=xml.key,
    rule=allowed_maven_dependencies.rule_id,
    severity="BLOCKER")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/sonarqube/sonarqube"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		allowedMavenDependencies, err := sonarqube.NewRule(ctx, "allowedMavenDependencies", &sonarqube.RuleArgs{
			CustomKey:           pulumi.String("Only_use_allowed_Maven_dependencies"),
			MarkdownDescription: pulumi.String("Description"),
			Params:              pulumi.String("FilePattern=**/pom.xml"),
			Severity:            pulumi.String("BLOCKER"),
			Status:              pulumi.String("READY"),
			TemplateKey:         pulumi.String("xml:XPathCheck"),
			Type:                pulumi.String("VULNERABILITY"),
		})
		if err != nil {
			return err
		}
		xml, err := sonarqube.NewQualityprofile(ctx, "xml", &sonarqube.QualityprofileArgs{
			Language:  pulumi.String("xml"),
			IsDefault: pulumi.Bool(false),
			Parent:    pulumi.String("Sonar way"),
		})
		if err != nil {
			return err
		}
		_, err = sonarqube.NewQualityprofileActivateRule(ctx, "xmlRule", &sonarqube.QualityprofileActivateRuleArgs{
			Key:      xml.Key,
			Rule:     allowedMavenDependencies.RuleId,
			Severity: pulumi.String("BLOCKER"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Sonarqube = Pulumi.Sonarqube;

return await Deployment.RunAsync(() => 
{
    var allowedMavenDependencies = new Sonarqube.Rule("allowedMavenDependencies", new()
    {
        CustomKey = "Only_use_allowed_Maven_dependencies",
        MarkdownDescription = "Description",
        Params = "FilePattern=**/pom.xml",
        Severity = "BLOCKER",
        Status = "READY",
        TemplateKey = "xml:XPathCheck",
        Type = "VULNERABILITY",
    });

    var xml = new Sonarqube.Qualityprofile("xml", new()
    {
        Language = "xml",
        IsDefault = false,
        Parent = "Sonar way",
    });

    var xmlRule = new Sonarqube.QualityprofileActivateRule("xmlRule", new()
    {
        Key = xml.Key,
        Rule = allowedMavenDependencies.RuleId,
        Severity = "BLOCKER",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sonarqube.Rule;
import com.pulumi.sonarqube.RuleArgs;
import com.pulumi.sonarqube.Qualityprofile;
import com.pulumi.sonarqube.QualityprofileArgs;
import com.pulumi.sonarqube.QualityprofileActivateRule;
import com.pulumi.sonarqube.QualityprofileActivateRuleArgs;
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 allowedMavenDependencies = new Rule("allowedMavenDependencies", RuleArgs.builder()
            .customKey("Only_use_allowed_Maven_dependencies")
            .markdownDescription("Description")
            .params("FilePattern=**/pom.xml")
            .severity("BLOCKER")
            .status("READY")
            .templateKey("xml:XPathCheck")
            .type("VULNERABILITY")
            .build());

        var xml = new Qualityprofile("xml", QualityprofileArgs.builder()
            .language("xml")
            .isDefault("false")
            .parent("Sonar way")
            .build());

        var xmlRule = new QualityprofileActivateRule("xmlRule", QualityprofileActivateRuleArgs.builder()
            .key(xml.key())
            .rule(allowedMavenDependencies.ruleId())
            .severity("BLOCKER")
            .build());

    }
}
Copy
resources:
  allowedMavenDependencies:
    type: sonarqube:Rule
    properties:
      customKey: Only_use_allowed_Maven_dependencies
      markdownDescription: Description
      params: FilePattern=**/pom.xml
      severity: BLOCKER
      status: READY
      templateKey: xml:XPathCheck
      type: VULNERABILITY
  xml:
    type: sonarqube:Qualityprofile
    properties:
      language: xml
      isDefault: 'false'
      parent: Sonar way
  xmlRule:
    type: sonarqube:QualityprofileActivateRule
    properties:
      key: ${xml.key}
      # .id also works
      rule: ${allowedMavenDependencies.ruleId}
      severity: BLOCKER
Copy

Create QualityprofileActivateRule Resource

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

Constructor syntax

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

@overload
def QualityprofileActivateRule(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               key: Optional[str] = None,
                               rule: Optional[str] = None,
                               params: Optional[str] = None,
                               qualityprofile_activate_rule_id: Optional[str] = None,
                               reset: Optional[str] = None,
                               severity: Optional[str] = None)
func NewQualityprofileActivateRule(ctx *Context, name string, args QualityprofileActivateRuleArgs, opts ...ResourceOption) (*QualityprofileActivateRule, error)
public QualityprofileActivateRule(string name, QualityprofileActivateRuleArgs args, CustomResourceOptions? opts = null)
public QualityprofileActivateRule(String name, QualityprofileActivateRuleArgs args)
public QualityprofileActivateRule(String name, QualityprofileActivateRuleArgs args, CustomResourceOptions options)

type: sonarqube:QualityprofileActivateRule
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. QualityprofileActivateRuleArgs
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. QualityprofileActivateRuleArgs
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. QualityprofileActivateRuleArgs
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. QualityprofileActivateRuleArgs
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. QualityprofileActivateRuleArgs
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 qualityprofileActivateRuleResource = new Sonarqube.QualityprofileActivateRule("qualityprofileActivateRuleResource", new()
{
    Key = "string",
    Rule = "string",
    Params = "string",
    QualityprofileActivateRuleId = "string",
    Reset = "string",
    Severity = "string",
});
Copy
example, err := sonarqube.NewQualityprofileActivateRule(ctx, "qualityprofileActivateRuleResource", &sonarqube.QualityprofileActivateRuleArgs{
Key: pulumi.String("string"),
Rule: pulumi.String("string"),
Params: pulumi.String("string"),
QualityprofileActivateRuleId: pulumi.String("string"),
Reset: pulumi.String("string"),
Severity: pulumi.String("string"),
})
Copy
var qualityprofileActivateRuleResource = new QualityprofileActivateRule("qualityprofileActivateRuleResource", QualityprofileActivateRuleArgs.builder()
    .key("string")
    .rule("string")
    .params("string")
    .qualityprofileActivateRuleId("string")
    .reset("string")
    .severity("string")
    .build());
Copy
qualityprofile_activate_rule_resource = sonarqube.QualityprofileActivateRule("qualityprofileActivateRuleResource",
    key="string",
    rule="string",
    params="string",
    qualityprofile_activate_rule_id="string",
    reset="string",
    severity="string")
Copy
const qualityprofileActivateRuleResource = new sonarqube.QualityprofileActivateRule("qualityprofileActivateRuleResource", {
    key: "string",
    rule: "string",
    params: "string",
    qualityprofileActivateRuleId: "string",
    reset: "string",
    severity: "string",
});
Copy
type: sonarqube:QualityprofileActivateRule
properties:
    key: string
    params: string
    qualityprofileActivateRuleId: string
    reset: string
    rule: string
    severity: string
Copy

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

Key This property is required. string
Quality Profile key. Can be obtained through api/qualityprofiles/search
Rule This property is required. string
Rule key
Params string
Parameters as semi-colon list of =, for example 'params=key1=v1;key2=v2' (Only for custom rule)
QualityprofileActivateRuleId string
Reset string
Reset severity and parameters of activated rule. Set the values defined on parent profile or from rule default values. - Possible values true false yes no (Default false)
Severity string
Severity. Ignored if parameter reset is true. - Possible values - INFO, MINOR, MAJOR, CRITICAL, BLOCKER
Key This property is required. string
Quality Profile key. Can be obtained through api/qualityprofiles/search
Rule This property is required. string
Rule key
Params string
Parameters as semi-colon list of =, for example 'params=key1=v1;key2=v2' (Only for custom rule)
QualityprofileActivateRuleId string
Reset string
Reset severity and parameters of activated rule. Set the values defined on parent profile or from rule default values. - Possible values true false yes no (Default false)
Severity string
Severity. Ignored if parameter reset is true. - Possible values - INFO, MINOR, MAJOR, CRITICAL, BLOCKER
key This property is required. String
Quality Profile key. Can be obtained through api/qualityprofiles/search
rule This property is required. String
Rule key
params String
Parameters as semi-colon list of =, for example 'params=key1=v1;key2=v2' (Only for custom rule)
qualityprofileActivateRuleId String
reset String
Reset severity and parameters of activated rule. Set the values defined on parent profile or from rule default values. - Possible values true false yes no (Default false)
severity String
Severity. Ignored if parameter reset is true. - Possible values - INFO, MINOR, MAJOR, CRITICAL, BLOCKER
key This property is required. string
Quality Profile key. Can be obtained through api/qualityprofiles/search
rule This property is required. string
Rule key
params string
Parameters as semi-colon list of =, for example 'params=key1=v1;key2=v2' (Only for custom rule)
qualityprofileActivateRuleId string
reset string
Reset severity and parameters of activated rule. Set the values defined on parent profile or from rule default values. - Possible values true false yes no (Default false)
severity string
Severity. Ignored if parameter reset is true. - Possible values - INFO, MINOR, MAJOR, CRITICAL, BLOCKER
key This property is required. str
Quality Profile key. Can be obtained through api/qualityprofiles/search
rule This property is required. str
Rule key
params str
Parameters as semi-colon list of =, for example 'params=key1=v1;key2=v2' (Only for custom rule)
qualityprofile_activate_rule_id str
reset str
Reset severity and parameters of activated rule. Set the values defined on parent profile or from rule default values. - Possible values true false yes no (Default false)
severity str
Severity. Ignored if parameter reset is true. - Possible values - INFO, MINOR, MAJOR, CRITICAL, BLOCKER
key This property is required. String
Quality Profile key. Can be obtained through api/qualityprofiles/search
rule This property is required. String
Rule key
params String
Parameters as semi-colon list of =, for example 'params=key1=v1;key2=v2' (Only for custom rule)
qualityprofileActivateRuleId String
reset String
Reset severity and parameters of activated rule. Set the values defined on parent profile or from rule default values. - Possible values true false yes no (Default false)
severity String
Severity. Ignored if parameter reset is true. - Possible values - INFO, MINOR, MAJOR, CRITICAL, BLOCKER

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing QualityprofileActivateRule Resource

Get an existing QualityprofileActivateRule 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?: QualityprofileActivateRuleState, opts?: CustomResourceOptions): QualityprofileActivateRule
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        key: Optional[str] = None,
        params: Optional[str] = None,
        qualityprofile_activate_rule_id: Optional[str] = None,
        reset: Optional[str] = None,
        rule: Optional[str] = None,
        severity: Optional[str] = None) -> QualityprofileActivateRule
func GetQualityprofileActivateRule(ctx *Context, name string, id IDInput, state *QualityprofileActivateRuleState, opts ...ResourceOption) (*QualityprofileActivateRule, error)
public static QualityprofileActivateRule Get(string name, Input<string> id, QualityprofileActivateRuleState? state, CustomResourceOptions? opts = null)
public static QualityprofileActivateRule get(String name, Output<String> id, QualityprofileActivateRuleState state, CustomResourceOptions options)
resources:  _:    type: sonarqube:QualityprofileActivateRule    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Key string
Quality Profile key. Can be obtained through api/qualityprofiles/search
Params string
Parameters as semi-colon list of =, for example 'params=key1=v1;key2=v2' (Only for custom rule)
QualityprofileActivateRuleId string
Reset string
Reset severity and parameters of activated rule. Set the values defined on parent profile or from rule default values. - Possible values true false yes no (Default false)
Rule string
Rule key
Severity string
Severity. Ignored if parameter reset is true. - Possible values - INFO, MINOR, MAJOR, CRITICAL, BLOCKER
Key string
Quality Profile key. Can be obtained through api/qualityprofiles/search
Params string
Parameters as semi-colon list of =, for example 'params=key1=v1;key2=v2' (Only for custom rule)
QualityprofileActivateRuleId string
Reset string
Reset severity and parameters of activated rule. Set the values defined on parent profile or from rule default values. - Possible values true false yes no (Default false)
Rule string
Rule key
Severity string
Severity. Ignored if parameter reset is true. - Possible values - INFO, MINOR, MAJOR, CRITICAL, BLOCKER
key String
Quality Profile key. Can be obtained through api/qualityprofiles/search
params String
Parameters as semi-colon list of =, for example 'params=key1=v1;key2=v2' (Only for custom rule)
qualityprofileActivateRuleId String
reset String
Reset severity and parameters of activated rule. Set the values defined on parent profile or from rule default values. - Possible values true false yes no (Default false)
rule String
Rule key
severity String
Severity. Ignored if parameter reset is true. - Possible values - INFO, MINOR, MAJOR, CRITICAL, BLOCKER
key string
Quality Profile key. Can be obtained through api/qualityprofiles/search
params string
Parameters as semi-colon list of =, for example 'params=key1=v1;key2=v2' (Only for custom rule)
qualityprofileActivateRuleId string
reset string
Reset severity and parameters of activated rule. Set the values defined on parent profile or from rule default values. - Possible values true false yes no (Default false)
rule string
Rule key
severity string
Severity. Ignored if parameter reset is true. - Possible values - INFO, MINOR, MAJOR, CRITICAL, BLOCKER
key str
Quality Profile key. Can be obtained through api/qualityprofiles/search
params str
Parameters as semi-colon list of =, for example 'params=key1=v1;key2=v2' (Only for custom rule)
qualityprofile_activate_rule_id str
reset str
Reset severity and parameters of activated rule. Set the values defined on parent profile or from rule default values. - Possible values true false yes no (Default false)
rule str
Rule key
severity str
Severity. Ignored if parameter reset is true. - Possible values - INFO, MINOR, MAJOR, CRITICAL, BLOCKER
key String
Quality Profile key. Can be obtained through api/qualityprofiles/search
params String
Parameters as semi-colon list of =, for example 'params=key1=v1;key2=v2' (Only for custom rule)
qualityprofileActivateRuleId String
reset String
Reset severity and parameters of activated rule. Set the values defined on parent profile or from rule default values. - Possible values true false yes no (Default false)
rule String
Rule key
severity String
Severity. Ignored if parameter reset is true. - Possible values - INFO, MINOR, MAJOR, CRITICAL, BLOCKER

Package Details

Repository
sonarqube jdamata/terraform-provider-sonarqube
License
Notes
This Pulumi package is based on the sonarqube Terraform Provider.
sonarqube 0.16.14 published on Monday, Apr 14, 2025 by jdamata
jdamata/terraform-provider-sonarqube