Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Newrelic Provider
  3. API Docs
  4. plugins
  5. Workload
New Relic v5.44.0 published on Saturday, Mar 29, 2025 by Pulumi
pulumi/pulumi-newrelic

newrelic.plugins.Workload

Explore with Pulumi AI

New Relic v5.44.0 published on Saturday, Mar 29, 2025 by Pulumi
pulumi/pulumi-newrelic

Use this resource to create, update, and delete a New Relic One workload.

A New Relic User API key is required to provision this resource. Set the api_key attribute in the provider block or the NEW_RELIC_API_KEY environment variable with your User API key.

Example Usage

Include entities with a certain string on the name.

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

const foo = new newrelic.plugins.Workload("foo", {
    name: "Example workload",
    accountId: "12345678",
    entityGuids: ["MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1"],
    entitySearchQueries: [{
        query: "name like '%Example application%'",
    }],
    scopeAccountIds: ["12345678"],
});
Copy
import pulumi
import pulumi_newrelic as newrelic

foo = newrelic.plugins.Workload("foo",
    name="Example workload",
    account_id="12345678",
    entity_guids=["MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1"],
    entity_search_queries=[{
        "query": "name like '%Example application%'",
    }],
    scope_account_ids=["12345678"])
Copy
package main

import (
	"github.com/pulumi/pulumi-newrelic/sdk/v5/go/newrelic/plugins"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := plugins.NewWorkload(ctx, "foo", &plugins.WorkloadArgs{
			Name:      pulumi.String("Example workload"),
			AccountId: pulumi.String("12345678"),
			EntityGuids: pulumi.StringArray{
				pulumi.String("MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1"),
			},
			EntitySearchQueries: plugins.WorkloadEntitySearchQueryArray{
				&plugins.WorkloadEntitySearchQueryArgs{
					Query: pulumi.String("name like '%Example application%'"),
				},
			},
			ScopeAccountIds: pulumi.StringArray{
				pulumi.String("12345678"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using NewRelic = Pulumi.NewRelic;

return await Deployment.RunAsync(() => 
{
    var foo = new NewRelic.Plugins.Workload("foo", new()
    {
        Name = "Example workload",
        AccountId = "12345678",
        EntityGuids = new[]
        {
            "MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1",
        },
        EntitySearchQueries = new[]
        {
            new NewRelic.Plugins.Inputs.WorkloadEntitySearchQueryArgs
            {
                Query = "name like '%Example application%'",
            },
        },
        ScopeAccountIds = new[]
        {
            "12345678",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.newrelic.plugins.Workload;
import com.pulumi.newrelic.plugins.WorkloadArgs;
import com.pulumi.newrelic.plugins.inputs.WorkloadEntitySearchQueryArgs;
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 foo = new Workload("foo", WorkloadArgs.builder()
            .name("Example workload")
            .accountId(12345678)
            .entityGuids("MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1")
            .entitySearchQueries(WorkloadEntitySearchQueryArgs.builder()
                .query("name like '%Example application%'")
                .build())
            .scopeAccountIds(12345678)
            .build());

    }
}
Copy
resources:
  foo:
    type: newrelic:plugins:Workload
    properties:
      name: Example workload
      accountId: 1.2345678e+07
      entityGuids:
        - MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1
      entitySearchQueries:
        - query: name like '%Example application%'
      scopeAccountIds:
        - 1.2345678e+07
Copy

Include entities with a set of tags.

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

const foo = new newrelic.plugins.Workload("foo", {
    name: "Example workload with tags",
    accountId: "12345678",
    entityGuids: ["MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1"],
    entitySearchQueries: [{
        query: "tags.accountId = '12345678' AND tags.environment='production' AND tags.language='java'",
    }],
    scopeAccountIds: ["12345678"],
});
Copy
import pulumi
import pulumi_newrelic as newrelic

foo = newrelic.plugins.Workload("foo",
    name="Example workload with tags",
    account_id="12345678",
    entity_guids=["MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1"],
    entity_search_queries=[{
        "query": "tags.accountId = '12345678' AND tags.environment='production' AND tags.language='java'",
    }],
    scope_account_ids=["12345678"])
Copy
package main

import (
	"github.com/pulumi/pulumi-newrelic/sdk/v5/go/newrelic/plugins"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := plugins.NewWorkload(ctx, "foo", &plugins.WorkloadArgs{
			Name:      pulumi.String("Example workload with tags"),
			AccountId: pulumi.String("12345678"),
			EntityGuids: pulumi.StringArray{
				pulumi.String("MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1"),
			},
			EntitySearchQueries: plugins.WorkloadEntitySearchQueryArray{
				&plugins.WorkloadEntitySearchQueryArgs{
					Query: pulumi.String("tags.accountId = '12345678' AND tags.environment='production' AND tags.language='java'"),
				},
			},
			ScopeAccountIds: pulumi.StringArray{
				pulumi.String("12345678"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using NewRelic = Pulumi.NewRelic;

return await Deployment.RunAsync(() => 
{
    var foo = new NewRelic.Plugins.Workload("foo", new()
    {
        Name = "Example workload with tags",
        AccountId = "12345678",
        EntityGuids = new[]
        {
            "MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1",
        },
        EntitySearchQueries = new[]
        {
            new NewRelic.Plugins.Inputs.WorkloadEntitySearchQueryArgs
            {
                Query = "tags.accountId = '12345678' AND tags.environment='production' AND tags.language='java'",
            },
        },
        ScopeAccountIds = new[]
        {
            "12345678",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.newrelic.plugins.Workload;
import com.pulumi.newrelic.plugins.WorkloadArgs;
import com.pulumi.newrelic.plugins.inputs.WorkloadEntitySearchQueryArgs;
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 foo = new Workload("foo", WorkloadArgs.builder()
            .name("Example workload with tags")
            .accountId(12345678)
            .entityGuids("MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1")
            .entitySearchQueries(WorkloadEntitySearchQueryArgs.builder()
                .query("tags.accountId = '12345678' AND tags.environment='production' AND tags.language='java'")
                .build())
            .scopeAccountIds(12345678)
            .build());

    }
}
Copy
resources:
  foo:
    type: newrelic:plugins:Workload
    properties:
      name: Example workload with tags
      accountId: 1.2345678e+07
      entityGuids:
        - MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1
      entitySearchQueries:
        - query: tags.accountId = '12345678' AND tags.environment='production' AND tags.language='java'
      scopeAccountIds:
        - 1.2345678e+07
Copy

Include entities with a set of tags.

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

const foo = new newrelic.plugins.Workload("foo", {
    name: "Example workload with tags",
    accountId: "12345678",
    entityGuids: ["MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1"],
    entitySearchQueries: [{
        query: "tags.accountId = '12345678' AND tags.environment='production' AND tags.language='java'",
    }],
    scopeAccountIds: ["12345678"],
});
Copy
import pulumi
import pulumi_newrelic as newrelic

foo = newrelic.plugins.Workload("foo",
    name="Example workload with tags",
    account_id="12345678",
    entity_guids=["MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1"],
    entity_search_queries=[{
        "query": "tags.accountId = '12345678' AND tags.environment='production' AND tags.language='java'",
    }],
    scope_account_ids=["12345678"])
Copy
package main

import (
	"github.com/pulumi/pulumi-newrelic/sdk/v5/go/newrelic/plugins"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := plugins.NewWorkload(ctx, "foo", &plugins.WorkloadArgs{
			Name:      pulumi.String("Example workload with tags"),
			AccountId: pulumi.String("12345678"),
			EntityGuids: pulumi.StringArray{
				pulumi.String("MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1"),
			},
			EntitySearchQueries: plugins.WorkloadEntitySearchQueryArray{
				&plugins.WorkloadEntitySearchQueryArgs{
					Query: pulumi.String("tags.accountId = '12345678' AND tags.environment='production' AND tags.language='java'"),
				},
			},
			ScopeAccountIds: pulumi.StringArray{
				pulumi.String("12345678"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using NewRelic = Pulumi.NewRelic;

return await Deployment.RunAsync(() => 
{
    var foo = new NewRelic.Plugins.Workload("foo", new()
    {
        Name = "Example workload with tags",
        AccountId = "12345678",
        EntityGuids = new[]
        {
            "MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1",
        },
        EntitySearchQueries = new[]
        {
            new NewRelic.Plugins.Inputs.WorkloadEntitySearchQueryArgs
            {
                Query = "tags.accountId = '12345678' AND tags.environment='production' AND tags.language='java'",
            },
        },
        ScopeAccountIds = new[]
        {
            "12345678",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.newrelic.plugins.Workload;
import com.pulumi.newrelic.plugins.WorkloadArgs;
import com.pulumi.newrelic.plugins.inputs.WorkloadEntitySearchQueryArgs;
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 foo = new Workload("foo", WorkloadArgs.builder()
            .name("Example workload with tags")
            .accountId(12345678)
            .entityGuids("MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1")
            .entitySearchQueries(WorkloadEntitySearchQueryArgs.builder()
                .query("tags.accountId = '12345678' AND tags.environment='production' AND tags.language='java'")
                .build())
            .scopeAccountIds(12345678)
            .build());

    }
}
Copy
resources:
  foo:
    type: newrelic:plugins:Workload
    properties:
      name: Example workload with tags
      accountId: 1.2345678e+07
      entityGuids:
        - MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1
      entitySearchQueries:
        - query: tags.accountId = '12345678' AND tags.environment='production' AND tags.language='java'
      scopeAccountIds:
        - 1.2345678e+07
Copy

Include automatic status

The global status of your workload is a quick indicator of the workload health. You can configure it to be calculated automatically, and you can also set an alert and get a notification whenever the workload stops being operational. Alternatively, you can communicate a certain status of the workload by setting up a static value and a description. See our docs

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

const foo = new newrelic.plugins.Workload("foo", {
    name: "Example workload",
    accountId: "12345678",
    entityGuids: ["MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1"],
    entitySearchQueries: [{
        query: "name like '%Example application%'",
    }],
    scopeAccountIds: ["12345678"],
    description: "Description",
    statusConfigAutomatic: {
        enabled: true,
        remainingEntitiesRule: {
            remainingEntitiesRuleRollup: {
                strategy: "BEST_STATUS_WINS",
                thresholdType: "FIXED",
                thresholdValue: 100,
                groupBy: "ENTITY_TYPE",
            },
        },
        rules: [{
            entityGuids: ["MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1"],
            nrqlQueries: [{
                query: "name like '%Example application2%'",
            }],
            rollup: {
                strategy: "BEST_STATUS_WINS",
                thresholdType: "FIXED",
                thresholdValue: 100,
            },
        }],
    },
});
Copy
import pulumi
import pulumi_newrelic as newrelic

foo = newrelic.plugins.Workload("foo",
    name="Example workload",
    account_id="12345678",
    entity_guids=["MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1"],
    entity_search_queries=[{
        "query": "name like '%Example application%'",
    }],
    scope_account_ids=["12345678"],
    description="Description",
    status_config_automatic={
        "enabled": True,
        "remaining_entities_rule": {
            "remaining_entities_rule_rollup": {
                "strategy": "BEST_STATUS_WINS",
                "threshold_type": "FIXED",
                "threshold_value": 100,
                "group_by": "ENTITY_TYPE",
            },
        },
        "rules": [{
            "entity_guids": ["MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1"],
            "nrql_queries": [{
                "query": "name like '%Example application2%'",
            }],
            "rollup": {
                "strategy": "BEST_STATUS_WINS",
                "threshold_type": "FIXED",
                "threshold_value": 100,
            },
        }],
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-newrelic/sdk/v5/go/newrelic/plugins"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := plugins.NewWorkload(ctx, "foo", &plugins.WorkloadArgs{
			Name:      pulumi.String("Example workload"),
			AccountId: pulumi.String("12345678"),
			EntityGuids: pulumi.StringArray{
				pulumi.String("MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1"),
			},
			EntitySearchQueries: plugins.WorkloadEntitySearchQueryArray{
				&plugins.WorkloadEntitySearchQueryArgs{
					Query: pulumi.String("name like '%Example application%'"),
				},
			},
			ScopeAccountIds: pulumi.StringArray{
				pulumi.String("12345678"),
			},
			Description: pulumi.String("Description"),
			StatusConfigAutomatic: &plugins.WorkloadStatusConfigAutomaticArgs{
				Enabled: pulumi.Bool(true),
				RemainingEntitiesRule: &plugins.WorkloadStatusConfigAutomaticRemainingEntitiesRuleArgs{
					RemainingEntitiesRuleRollup: &plugins.WorkloadStatusConfigAutomaticRemainingEntitiesRuleRemainingEntitiesRuleRollupArgs{
						Strategy:       pulumi.String("BEST_STATUS_WINS"),
						ThresholdType:  pulumi.String("FIXED"),
						ThresholdValue: pulumi.Int(100),
						GroupBy:        pulumi.String("ENTITY_TYPE"),
					},
				},
				Rules: plugins.WorkloadStatusConfigAutomaticRuleArray{
					&plugins.WorkloadStatusConfigAutomaticRuleArgs{
						EntityGuids: pulumi.StringArray{
							pulumi.String("MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1"),
						},
						NrqlQueries: plugins.WorkloadStatusConfigAutomaticRuleNrqlQueryArray{
							&plugins.WorkloadStatusConfigAutomaticRuleNrqlQueryArgs{
								Query: pulumi.String("name like '%Example application2%'"),
							},
						},
						Rollup: &plugins.WorkloadStatusConfigAutomaticRuleRollupArgs{
							Strategy:       pulumi.String("BEST_STATUS_WINS"),
							ThresholdType:  pulumi.String("FIXED"),
							ThresholdValue: pulumi.Int(100),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using NewRelic = Pulumi.NewRelic;

return await Deployment.RunAsync(() => 
{
    var foo = new NewRelic.Plugins.Workload("foo", new()
    {
        Name = "Example workload",
        AccountId = "12345678",
        EntityGuids = new[]
        {
            "MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1",
        },
        EntitySearchQueries = new[]
        {
            new NewRelic.Plugins.Inputs.WorkloadEntitySearchQueryArgs
            {
                Query = "name like '%Example application%'",
            },
        },
        ScopeAccountIds = new[]
        {
            "12345678",
        },
        Description = "Description",
        StatusConfigAutomatic = new NewRelic.Plugins.Inputs.WorkloadStatusConfigAutomaticArgs
        {
            Enabled = true,
            RemainingEntitiesRule = new NewRelic.Plugins.Inputs.WorkloadStatusConfigAutomaticRemainingEntitiesRuleArgs
            {
                RemainingEntitiesRuleRollup = new NewRelic.Plugins.Inputs.WorkloadStatusConfigAutomaticRemainingEntitiesRuleRemainingEntitiesRuleRollupArgs
                {
                    Strategy = "BEST_STATUS_WINS",
                    ThresholdType = "FIXED",
                    ThresholdValue = 100,
                    GroupBy = "ENTITY_TYPE",
                },
            },
            Rules = new[]
            {
                new NewRelic.Plugins.Inputs.WorkloadStatusConfigAutomaticRuleArgs
                {
                    EntityGuids = new[]
                    {
                        "MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1",
                    },
                    NrqlQueries = new[]
                    {
                        new NewRelic.Plugins.Inputs.WorkloadStatusConfigAutomaticRuleNrqlQueryArgs
                        {
                            Query = "name like '%Example application2%'",
                        },
                    },
                    Rollup = new NewRelic.Plugins.Inputs.WorkloadStatusConfigAutomaticRuleRollupArgs
                    {
                        Strategy = "BEST_STATUS_WINS",
                        ThresholdType = "FIXED",
                        ThresholdValue = 100,
                    },
                },
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.newrelic.plugins.Workload;
import com.pulumi.newrelic.plugins.WorkloadArgs;
import com.pulumi.newrelic.plugins.inputs.WorkloadEntitySearchQueryArgs;
import com.pulumi.newrelic.plugins.inputs.WorkloadStatusConfigAutomaticArgs;
import com.pulumi.newrelic.plugins.inputs.WorkloadStatusConfigAutomaticRemainingEntitiesRuleArgs;
import com.pulumi.newrelic.plugins.inputs.WorkloadStatusConfigAutomaticRemainingEntitiesRuleRemainingEntitiesRuleRollupArgs;
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 foo = new Workload("foo", WorkloadArgs.builder()
            .name("Example workload")
            .accountId(12345678)
            .entityGuids("MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1")
            .entitySearchQueries(WorkloadEntitySearchQueryArgs.builder()
                .query("name like '%Example application%'")
                .build())
            .scopeAccountIds(12345678)
            .description("Description")
            .statusConfigAutomatic(WorkloadStatusConfigAutomaticArgs.builder()
                .enabled(true)
                .remainingEntitiesRule(WorkloadStatusConfigAutomaticRemainingEntitiesRuleArgs.builder()
                    .remainingEntitiesRuleRollup(WorkloadStatusConfigAutomaticRemainingEntitiesRuleRemainingEntitiesRuleRollupArgs.builder()
                        .strategy("BEST_STATUS_WINS")
                        .thresholdType("FIXED")
                        .thresholdValue(100)
                        .groupBy("ENTITY_TYPE")
                        .build())
                    .build())
                .rules(WorkloadStatusConfigAutomaticRuleArgs.builder()
                    .entityGuids("MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1")
                    .nrqlQueries(WorkloadStatusConfigAutomaticRuleNrqlQueryArgs.builder()
                        .query("name like '%Example application2%'")
                        .build())
                    .rollup(WorkloadStatusConfigAutomaticRuleRollupArgs.builder()
                        .strategy("BEST_STATUS_WINS")
                        .thresholdType("FIXED")
                        .thresholdValue(100)
                        .build())
                    .build())
                .build())
            .build());

    }
}
Copy
resources:
  foo:
    type: newrelic:plugins:Workload
    properties:
      name: Example workload
      accountId: 1.2345678e+07
      entityGuids:
        - MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1
      entitySearchQueries:
        - query: name like '%Example application%'
      scopeAccountIds:
        - 1.2345678e+07
      description: Description
      statusConfigAutomatic:
        enabled: true
        remainingEntitiesRule:
          remainingEntitiesRuleRollup:
            strategy: BEST_STATUS_WINS
            thresholdType: FIXED
            thresholdValue: 100
            groupBy: ENTITY_TYPE
        rules:
          - entityGuids:
              - MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1
            nrqlQueries:
              - query: name like '%Example application2%'
            rollup:
              strategy: BEST_STATUS_WINS
              thresholdType: FIXED
              thresholdValue: 100
Copy

Include static status

You can use this during maintenance tasks or any other time you want to provide a fixed status for your workload. This overrides all automatic rules. See our docs

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

const foo = new newrelic.plugins.Workload("foo", {
    name: "Example workload",
    accountId: "12345678",
    entityGuids: ["MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1"],
    entitySearchQueries: [{
        query: "name like '%Example application%'",
    }],
    scopeAccountIds: ["12345678"],
    description: "Description",
    statusConfigStatic: {
        description: "test",
        enabled: true,
        status: "OPERATIONAL",
        summary: "summary of the status",
    },
});
Copy
import pulumi
import pulumi_newrelic as newrelic

foo = newrelic.plugins.Workload("foo",
    name="Example workload",
    account_id="12345678",
    entity_guids=["MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1"],
    entity_search_queries=[{
        "query": "name like '%Example application%'",
    }],
    scope_account_ids=["12345678"],
    description="Description",
    status_config_static={
        "description": "test",
        "enabled": True,
        "status": "OPERATIONAL",
        "summary": "summary of the status",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-newrelic/sdk/v5/go/newrelic/plugins"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := plugins.NewWorkload(ctx, "foo", &plugins.WorkloadArgs{
			Name:      pulumi.String("Example workload"),
			AccountId: pulumi.String("12345678"),
			EntityGuids: pulumi.StringArray{
				pulumi.String("MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1"),
			},
			EntitySearchQueries: plugins.WorkloadEntitySearchQueryArray{
				&plugins.WorkloadEntitySearchQueryArgs{
					Query: pulumi.String("name like '%Example application%'"),
				},
			},
			ScopeAccountIds: pulumi.StringArray{
				pulumi.String("12345678"),
			},
			Description: pulumi.String("Description"),
			StatusConfigStatic: &plugins.WorkloadStatusConfigStaticArgs{
				Description: pulumi.String("test"),
				Enabled:     pulumi.Bool(true),
				Status:      pulumi.String("OPERATIONAL"),
				Summary:     pulumi.String("summary of the status"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using NewRelic = Pulumi.NewRelic;

return await Deployment.RunAsync(() => 
{
    var foo = new NewRelic.Plugins.Workload("foo", new()
    {
        Name = "Example workload",
        AccountId = "12345678",
        EntityGuids = new[]
        {
            "MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1",
        },
        EntitySearchQueries = new[]
        {
            new NewRelic.Plugins.Inputs.WorkloadEntitySearchQueryArgs
            {
                Query = "name like '%Example application%'",
            },
        },
        ScopeAccountIds = new[]
        {
            "12345678",
        },
        Description = "Description",
        StatusConfigStatic = new NewRelic.Plugins.Inputs.WorkloadStatusConfigStaticArgs
        {
            Description = "test",
            Enabled = true,
            Status = "OPERATIONAL",
            Summary = "summary of the status",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.newrelic.plugins.Workload;
import com.pulumi.newrelic.plugins.WorkloadArgs;
import com.pulumi.newrelic.plugins.inputs.WorkloadEntitySearchQueryArgs;
import com.pulumi.newrelic.plugins.inputs.WorkloadStatusConfigStaticArgs;
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 foo = new Workload("foo", WorkloadArgs.builder()
            .name("Example workload")
            .accountId(12345678)
            .entityGuids("MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1")
            .entitySearchQueries(WorkloadEntitySearchQueryArgs.builder()
                .query("name like '%Example application%'")
                .build())
            .scopeAccountIds(12345678)
            .description("Description")
            .statusConfigStatic(WorkloadStatusConfigStaticArgs.builder()
                .description("test")
                .enabled(true)
                .status("OPERATIONAL")
                .summary("summary of the status")
                .build())
            .build());

    }
}
Copy
resources:
  foo:
    type: newrelic:plugins:Workload
    properties:
      name: Example workload
      accountId: 1.2345678e+07
      entityGuids:
        - MjUyMDUyOHxBUE18QVBQTElDQVRJT058MjE1MDM3Nzk1
      entitySearchQueries:
        - query: name like '%Example application%'
      scopeAccountIds:
        - 1.2345678e+07
      description: Description
      statusConfigStatic:
        description: test
        enabled: true
        status: OPERATIONAL
        summary: summary of the status
Copy

Create Workload Resource

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

Constructor syntax

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

@overload
def Workload(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             account_id: Optional[str] = None,
             description: Optional[str] = None,
             entity_guids: Optional[Sequence[str]] = None,
             entity_search_queries: Optional[Sequence[WorkloadEntitySearchQueryArgs]] = None,
             name: Optional[str] = None,
             scope_account_ids: Optional[Sequence[str]] = None,
             status_config_automatic: Optional[WorkloadStatusConfigAutomaticArgs] = None,
             status_config_static: Optional[WorkloadStatusConfigStaticArgs] = None)
func NewWorkload(ctx *Context, name string, args *WorkloadArgs, opts ...ResourceOption) (*Workload, error)
public Workload(string name, WorkloadArgs? args = null, CustomResourceOptions? opts = null)
public Workload(String name, WorkloadArgs args)
public Workload(String name, WorkloadArgs args, CustomResourceOptions options)

type: newrelic:plugins:Workload
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 WorkloadArgs
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 WorkloadArgs
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 WorkloadArgs
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 WorkloadArgs
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. WorkloadArgs
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 workloadResource = new NewRelic.Plugins.Workload("workloadResource", new()
{
    AccountId = "string",
    Description = "string",
    EntityGuids = new[]
    {
        "string",
    },
    EntitySearchQueries = new[]
    {
        new NewRelic.Plugins.Inputs.WorkloadEntitySearchQueryArgs
        {
            Query = "string",
        },
    },
    Name = "string",
    ScopeAccountIds = new[]
    {
        "string",
    },
    StatusConfigAutomatic = new NewRelic.Plugins.Inputs.WorkloadStatusConfigAutomaticArgs
    {
        Enabled = false,
        RemainingEntitiesRule = new NewRelic.Plugins.Inputs.WorkloadStatusConfigAutomaticRemainingEntitiesRuleArgs
        {
            RemainingEntitiesRuleRollup = new NewRelic.Plugins.Inputs.WorkloadStatusConfigAutomaticRemainingEntitiesRuleRemainingEntitiesRuleRollupArgs
            {
                GroupBy = "string",
                Strategy = "string",
                ThresholdType = "string",
                ThresholdValue = 0,
            },
        },
        Rules = new[]
        {
            new NewRelic.Plugins.Inputs.WorkloadStatusConfigAutomaticRuleArgs
            {
                Rollup = new NewRelic.Plugins.Inputs.WorkloadStatusConfigAutomaticRuleRollupArgs
                {
                    Strategy = "string",
                    ThresholdType = "string",
                    ThresholdValue = 0,
                },
                EntityGuids = new[]
                {
                    "string",
                },
                NrqlQueries = new[]
                {
                    new NewRelic.Plugins.Inputs.WorkloadStatusConfigAutomaticRuleNrqlQueryArgs
                    {
                        Query = "string",
                    },
                },
            },
        },
    },
    StatusConfigStatic = new NewRelic.Plugins.Inputs.WorkloadStatusConfigStaticArgs
    {
        Enabled = false,
        Status = "string",
        Description = "string",
        Summary = "string",
    },
});
Copy
example, err := plugins.NewWorkload(ctx, "workloadResource", &plugins.WorkloadArgs{
	AccountId:   pulumi.String("string"),
	Description: pulumi.String("string"),
	EntityGuids: pulumi.StringArray{
		pulumi.String("string"),
	},
	EntitySearchQueries: plugins.WorkloadEntitySearchQueryArray{
		&plugins.WorkloadEntitySearchQueryArgs{
			Query: pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
	ScopeAccountIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	StatusConfigAutomatic: &plugins.WorkloadStatusConfigAutomaticArgs{
		Enabled: pulumi.Bool(false),
		RemainingEntitiesRule: &plugins.WorkloadStatusConfigAutomaticRemainingEntitiesRuleArgs{
			RemainingEntitiesRuleRollup: &plugins.WorkloadStatusConfigAutomaticRemainingEntitiesRuleRemainingEntitiesRuleRollupArgs{
				GroupBy:        pulumi.String("string"),
				Strategy:       pulumi.String("string"),
				ThresholdType:  pulumi.String("string"),
				ThresholdValue: pulumi.Int(0),
			},
		},
		Rules: plugins.WorkloadStatusConfigAutomaticRuleArray{
			&plugins.WorkloadStatusConfigAutomaticRuleArgs{
				Rollup: &plugins.WorkloadStatusConfigAutomaticRuleRollupArgs{
					Strategy:       pulumi.String("string"),
					ThresholdType:  pulumi.String("string"),
					ThresholdValue: pulumi.Int(0),
				},
				EntityGuids: pulumi.StringArray{
					pulumi.String("string"),
				},
				NrqlQueries: plugins.WorkloadStatusConfigAutomaticRuleNrqlQueryArray{
					&plugins.WorkloadStatusConfigAutomaticRuleNrqlQueryArgs{
						Query: pulumi.String("string"),
					},
				},
			},
		},
	},
	StatusConfigStatic: &plugins.WorkloadStatusConfigStaticArgs{
		Enabled:     pulumi.Bool(false),
		Status:      pulumi.String("string"),
		Description: pulumi.String("string"),
		Summary:     pulumi.String("string"),
	},
})
Copy
var workloadResource = new Workload("workloadResource", WorkloadArgs.builder()
    .accountId("string")
    .description("string")
    .entityGuids("string")
    .entitySearchQueries(WorkloadEntitySearchQueryArgs.builder()
        .query("string")
        .build())
    .name("string")
    .scopeAccountIds("string")
    .statusConfigAutomatic(WorkloadStatusConfigAutomaticArgs.builder()
        .enabled(false)
        .remainingEntitiesRule(WorkloadStatusConfigAutomaticRemainingEntitiesRuleArgs.builder()
            .remainingEntitiesRuleRollup(WorkloadStatusConfigAutomaticRemainingEntitiesRuleRemainingEntitiesRuleRollupArgs.builder()
                .groupBy("string")
                .strategy("string")
                .thresholdType("string")
                .thresholdValue(0)
                .build())
            .build())
        .rules(WorkloadStatusConfigAutomaticRuleArgs.builder()
            .rollup(WorkloadStatusConfigAutomaticRuleRollupArgs.builder()
                .strategy("string")
                .thresholdType("string")
                .thresholdValue(0)
                .build())
            .entityGuids("string")
            .nrqlQueries(WorkloadStatusConfigAutomaticRuleNrqlQueryArgs.builder()
                .query("string")
                .build())
            .build())
        .build())
    .statusConfigStatic(WorkloadStatusConfigStaticArgs.builder()
        .enabled(false)
        .status("string")
        .description("string")
        .summary("string")
        .build())
    .build());
Copy
workload_resource = newrelic.plugins.Workload("workloadResource",
    account_id="string",
    description="string",
    entity_guids=["string"],
    entity_search_queries=[{
        "query": "string",
    }],
    name="string",
    scope_account_ids=["string"],
    status_config_automatic={
        "enabled": False,
        "remaining_entities_rule": {
            "remaining_entities_rule_rollup": {
                "group_by": "string",
                "strategy": "string",
                "threshold_type": "string",
                "threshold_value": 0,
            },
        },
        "rules": [{
            "rollup": {
                "strategy": "string",
                "threshold_type": "string",
                "threshold_value": 0,
            },
            "entity_guids": ["string"],
            "nrql_queries": [{
                "query": "string",
            }],
        }],
    },
    status_config_static={
        "enabled": False,
        "status": "string",
        "description": "string",
        "summary": "string",
    })
Copy
const workloadResource = new newrelic.plugins.Workload("workloadResource", {
    accountId: "string",
    description: "string",
    entityGuids: ["string"],
    entitySearchQueries: [{
        query: "string",
    }],
    name: "string",
    scopeAccountIds: ["string"],
    statusConfigAutomatic: {
        enabled: false,
        remainingEntitiesRule: {
            remainingEntitiesRuleRollup: {
                groupBy: "string",
                strategy: "string",
                thresholdType: "string",
                thresholdValue: 0,
            },
        },
        rules: [{
            rollup: {
                strategy: "string",
                thresholdType: "string",
                thresholdValue: 0,
            },
            entityGuids: ["string"],
            nrqlQueries: [{
                query: "string",
            }],
        }],
    },
    statusConfigStatic: {
        enabled: false,
        status: "string",
        description: "string",
        summary: "string",
    },
});
Copy
type: newrelic:plugins:Workload
properties:
    accountId: string
    description: string
    entityGuids:
        - string
    entitySearchQueries:
        - query: string
    name: string
    scopeAccountIds:
        - string
    statusConfigAutomatic:
        enabled: false
        remainingEntitiesRule:
            remainingEntitiesRuleRollup:
                groupBy: string
                strategy: string
                thresholdType: string
                thresholdValue: 0
        rules:
            - entityGuids:
                - string
              nrqlQueries:
                - query: string
              rollup:
                strategy: string
                thresholdType: string
                thresholdValue: 0
    statusConfigStatic:
        description: string
        enabled: false
        status: string
        summary: string
Copy

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

AccountId string
The New Relic account ID where you want to create the workload.
Description string
Relevant information about the workload.
EntityGuids List<string>
A list of entity GUIDs manually assigned to this workload. At least one of either entity_guids or entity_search_query is required.
EntitySearchQueries List<Pulumi.NewRelic.Plugins.Inputs.WorkloadEntitySearchQuery>
A list of search queries that define a dynamic workload. At least one of either entity_guids or entity_search_query is required. See Nested entity_search_query blocks below for details.
Name string
The workload's name.
ScopeAccountIds List<string>
A list of account IDs that will be used to get entities from.
StatusConfigAutomatic Pulumi.NewRelic.Plugins.Inputs.WorkloadStatusConfigAutomatic
An input object used to represent an automatic status configuration.See Nested status_config_automatic blocks below for details.
StatusConfigStatic Pulumi.NewRelic.Plugins.Inputs.WorkloadStatusConfigStatic
A list of static status configurations. You can only configure one static status for a workload.See Nested status_config_static blocks below for details.
AccountId string
The New Relic account ID where you want to create the workload.
Description string
Relevant information about the workload.
EntityGuids []string
A list of entity GUIDs manually assigned to this workload. At least one of either entity_guids or entity_search_query is required.
EntitySearchQueries []WorkloadEntitySearchQueryArgs
A list of search queries that define a dynamic workload. At least one of either entity_guids or entity_search_query is required. See Nested entity_search_query blocks below for details.
Name string
The workload's name.
ScopeAccountIds []string
A list of account IDs that will be used to get entities from.
StatusConfigAutomatic WorkloadStatusConfigAutomaticArgs
An input object used to represent an automatic status configuration.See Nested status_config_automatic blocks below for details.
StatusConfigStatic WorkloadStatusConfigStaticArgs
A list of static status configurations. You can only configure one static status for a workload.See Nested status_config_static blocks below for details.
accountId String
The New Relic account ID where you want to create the workload.
description String
Relevant information about the workload.
entityGuids List<String>
A list of entity GUIDs manually assigned to this workload. At least one of either entity_guids or entity_search_query is required.
entitySearchQueries List<WorkloadEntitySearchQuery>
A list of search queries that define a dynamic workload. At least one of either entity_guids or entity_search_query is required. See Nested entity_search_query blocks below for details.
name String
The workload's name.
scopeAccountIds List<String>
A list of account IDs that will be used to get entities from.
statusConfigAutomatic WorkloadStatusConfigAutomatic
An input object used to represent an automatic status configuration.See Nested status_config_automatic blocks below for details.
statusConfigStatic WorkloadStatusConfigStatic
A list of static status configurations. You can only configure one static status for a workload.See Nested status_config_static blocks below for details.
accountId string
The New Relic account ID where you want to create the workload.
description string
Relevant information about the workload.
entityGuids string[]
A list of entity GUIDs manually assigned to this workload. At least one of either entity_guids or entity_search_query is required.
entitySearchQueries WorkloadEntitySearchQuery[]
A list of search queries that define a dynamic workload. At least one of either entity_guids or entity_search_query is required. See Nested entity_search_query blocks below for details.
name string
The workload's name.
scopeAccountIds string[]
A list of account IDs that will be used to get entities from.
statusConfigAutomatic WorkloadStatusConfigAutomatic
An input object used to represent an automatic status configuration.See Nested status_config_automatic blocks below for details.
statusConfigStatic WorkloadStatusConfigStatic
A list of static status configurations. You can only configure one static status for a workload.See Nested status_config_static blocks below for details.
account_id str
The New Relic account ID where you want to create the workload.
description str
Relevant information about the workload.
entity_guids Sequence[str]
A list of entity GUIDs manually assigned to this workload. At least one of either entity_guids or entity_search_query is required.
entity_search_queries Sequence[WorkloadEntitySearchQueryArgs]
A list of search queries that define a dynamic workload. At least one of either entity_guids or entity_search_query is required. See Nested entity_search_query blocks below for details.
name str
The workload's name.
scope_account_ids Sequence[str]
A list of account IDs that will be used to get entities from.
status_config_automatic WorkloadStatusConfigAutomaticArgs
An input object used to represent an automatic status configuration.See Nested status_config_automatic blocks below for details.
status_config_static WorkloadStatusConfigStaticArgs
A list of static status configurations. You can only configure one static status for a workload.See Nested status_config_static blocks below for details.
accountId String
The New Relic account ID where you want to create the workload.
description String
Relevant information about the workload.
entityGuids List<String>
A list of entity GUIDs manually assigned to this workload. At least one of either entity_guids or entity_search_query is required.
entitySearchQueries List<Property Map>
A list of search queries that define a dynamic workload. At least one of either entity_guids or entity_search_query is required. See Nested entity_search_query blocks below for details.
name String
The workload's name.
scopeAccountIds List<String>
A list of account IDs that will be used to get entities from.
statusConfigAutomatic Property Map
An input object used to represent an automatic status configuration.See Nested status_config_automatic blocks below for details.
statusConfigStatic Property Map
A list of static status configurations. You can only configure one static status for a workload.See Nested status_config_static blocks below for details.

Outputs

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

CompositeEntitySearchQuery string
The composite query used to compose a dynamic workload.
Guid string
The unique entity identifier of the workload in New Relic.
Id string
The provider-assigned unique ID for this managed resource.
Permalink string
The URL of the workload.
WorkloadId string
The unique entity identifier of the workload.
CompositeEntitySearchQuery string
The composite query used to compose a dynamic workload.
Guid string
The unique entity identifier of the workload in New Relic.
Id string
The provider-assigned unique ID for this managed resource.
Permalink string
The URL of the workload.
WorkloadId string
The unique entity identifier of the workload.
compositeEntitySearchQuery String
The composite query used to compose a dynamic workload.
guid String
The unique entity identifier of the workload in New Relic.
id String
The provider-assigned unique ID for this managed resource.
permalink String
The URL of the workload.
workloadId String
The unique entity identifier of the workload.
compositeEntitySearchQuery string
The composite query used to compose a dynamic workload.
guid string
The unique entity identifier of the workload in New Relic.
id string
The provider-assigned unique ID for this managed resource.
permalink string
The URL of the workload.
workloadId string
The unique entity identifier of the workload.
composite_entity_search_query str
The composite query used to compose a dynamic workload.
guid str
The unique entity identifier of the workload in New Relic.
id str
The provider-assigned unique ID for this managed resource.
permalink str
The URL of the workload.
workload_id str
The unique entity identifier of the workload.
compositeEntitySearchQuery String
The composite query used to compose a dynamic workload.
guid String
The unique entity identifier of the workload in New Relic.
id String
The provider-assigned unique ID for this managed resource.
permalink String
The URL of the workload.
workloadId String
The unique entity identifier of the workload.

Look up Existing Workload Resource

Get an existing Workload 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?: WorkloadState, opts?: CustomResourceOptions): Workload
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        composite_entity_search_query: Optional[str] = None,
        description: Optional[str] = None,
        entity_guids: Optional[Sequence[str]] = None,
        entity_search_queries: Optional[Sequence[WorkloadEntitySearchQueryArgs]] = None,
        guid: Optional[str] = None,
        name: Optional[str] = None,
        permalink: Optional[str] = None,
        scope_account_ids: Optional[Sequence[str]] = None,
        status_config_automatic: Optional[WorkloadStatusConfigAutomaticArgs] = None,
        status_config_static: Optional[WorkloadStatusConfigStaticArgs] = None,
        workload_id: Optional[str] = None) -> Workload
func GetWorkload(ctx *Context, name string, id IDInput, state *WorkloadState, opts ...ResourceOption) (*Workload, error)
public static Workload Get(string name, Input<string> id, WorkloadState? state, CustomResourceOptions? opts = null)
public static Workload get(String name, Output<String> id, WorkloadState state, CustomResourceOptions options)
resources:  _:    type: newrelic:plugins:Workload    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:
AccountId string
The New Relic account ID where you want to create the workload.
CompositeEntitySearchQuery string
The composite query used to compose a dynamic workload.
Description string
Relevant information about the workload.
EntityGuids List<string>
A list of entity GUIDs manually assigned to this workload. At least one of either entity_guids or entity_search_query is required.
EntitySearchQueries List<Pulumi.NewRelic.Plugins.Inputs.WorkloadEntitySearchQuery>
A list of search queries that define a dynamic workload. At least one of either entity_guids or entity_search_query is required. See Nested entity_search_query blocks below for details.
Guid string
The unique entity identifier of the workload in New Relic.
Name string
The workload's name.
Permalink string
The URL of the workload.
ScopeAccountIds List<string>
A list of account IDs that will be used to get entities from.
StatusConfigAutomatic Pulumi.NewRelic.Plugins.Inputs.WorkloadStatusConfigAutomatic
An input object used to represent an automatic status configuration.See Nested status_config_automatic blocks below for details.
StatusConfigStatic Pulumi.NewRelic.Plugins.Inputs.WorkloadStatusConfigStatic
A list of static status configurations. You can only configure one static status for a workload.See Nested status_config_static blocks below for details.
WorkloadId string
The unique entity identifier of the workload.
AccountId string
The New Relic account ID where you want to create the workload.
CompositeEntitySearchQuery string
The composite query used to compose a dynamic workload.
Description string
Relevant information about the workload.
EntityGuids []string
A list of entity GUIDs manually assigned to this workload. At least one of either entity_guids or entity_search_query is required.
EntitySearchQueries []WorkloadEntitySearchQueryArgs
A list of search queries that define a dynamic workload. At least one of either entity_guids or entity_search_query is required. See Nested entity_search_query blocks below for details.
Guid string
The unique entity identifier of the workload in New Relic.
Name string
The workload's name.
Permalink string
The URL of the workload.
ScopeAccountIds []string
A list of account IDs that will be used to get entities from.
StatusConfigAutomatic WorkloadStatusConfigAutomaticArgs
An input object used to represent an automatic status configuration.See Nested status_config_automatic blocks below for details.
StatusConfigStatic WorkloadStatusConfigStaticArgs
A list of static status configurations. You can only configure one static status for a workload.See Nested status_config_static blocks below for details.
WorkloadId string
The unique entity identifier of the workload.
accountId String
The New Relic account ID where you want to create the workload.
compositeEntitySearchQuery String
The composite query used to compose a dynamic workload.
description String
Relevant information about the workload.
entityGuids List<String>
A list of entity GUIDs manually assigned to this workload. At least one of either entity_guids or entity_search_query is required.
entitySearchQueries List<WorkloadEntitySearchQuery>
A list of search queries that define a dynamic workload. At least one of either entity_guids or entity_search_query is required. See Nested entity_search_query blocks below for details.
guid String
The unique entity identifier of the workload in New Relic.
name String
The workload's name.
permalink String
The URL of the workload.
scopeAccountIds List<String>
A list of account IDs that will be used to get entities from.
statusConfigAutomatic WorkloadStatusConfigAutomatic
An input object used to represent an automatic status configuration.See Nested status_config_automatic blocks below for details.
statusConfigStatic WorkloadStatusConfigStatic
A list of static status configurations. You can only configure one static status for a workload.See Nested status_config_static blocks below for details.
workloadId String
The unique entity identifier of the workload.
accountId string
The New Relic account ID where you want to create the workload.
compositeEntitySearchQuery string
The composite query used to compose a dynamic workload.
description string
Relevant information about the workload.
entityGuids string[]
A list of entity GUIDs manually assigned to this workload. At least one of either entity_guids or entity_search_query is required.
entitySearchQueries WorkloadEntitySearchQuery[]
A list of search queries that define a dynamic workload. At least one of either entity_guids or entity_search_query is required. See Nested entity_search_query blocks below for details.
guid string
The unique entity identifier of the workload in New Relic.
name string
The workload's name.
permalink string
The URL of the workload.
scopeAccountIds string[]
A list of account IDs that will be used to get entities from.
statusConfigAutomatic WorkloadStatusConfigAutomatic
An input object used to represent an automatic status configuration.See Nested status_config_automatic blocks below for details.
statusConfigStatic WorkloadStatusConfigStatic
A list of static status configurations. You can only configure one static status for a workload.See Nested status_config_static blocks below for details.
workloadId string
The unique entity identifier of the workload.
account_id str
The New Relic account ID where you want to create the workload.
composite_entity_search_query str
The composite query used to compose a dynamic workload.
description str
Relevant information about the workload.
entity_guids Sequence[str]
A list of entity GUIDs manually assigned to this workload. At least one of either entity_guids or entity_search_query is required.
entity_search_queries Sequence[WorkloadEntitySearchQueryArgs]
A list of search queries that define a dynamic workload. At least one of either entity_guids or entity_search_query is required. See Nested entity_search_query blocks below for details.
guid str
The unique entity identifier of the workload in New Relic.
name str
The workload's name.
permalink str
The URL of the workload.
scope_account_ids Sequence[str]
A list of account IDs that will be used to get entities from.
status_config_automatic WorkloadStatusConfigAutomaticArgs
An input object used to represent an automatic status configuration.See Nested status_config_automatic blocks below for details.
status_config_static WorkloadStatusConfigStaticArgs
A list of static status configurations. You can only configure one static status for a workload.See Nested status_config_static blocks below for details.
workload_id str
The unique entity identifier of the workload.
accountId String
The New Relic account ID where you want to create the workload.
compositeEntitySearchQuery String
The composite query used to compose a dynamic workload.
description String
Relevant information about the workload.
entityGuids List<String>
A list of entity GUIDs manually assigned to this workload. At least one of either entity_guids or entity_search_query is required.
entitySearchQueries List<Property Map>
A list of search queries that define a dynamic workload. At least one of either entity_guids or entity_search_query is required. See Nested entity_search_query blocks below for details.
guid String
The unique entity identifier of the workload in New Relic.
name String
The workload's name.
permalink String
The URL of the workload.
scopeAccountIds List<String>
A list of account IDs that will be used to get entities from.
statusConfigAutomatic Property Map
An input object used to represent an automatic status configuration.See Nested status_config_automatic blocks below for details.
statusConfigStatic Property Map
A list of static status configurations. You can only configure one static status for a workload.See Nested status_config_static blocks below for details.
workloadId String
The unique entity identifier of the workload.

Supporting Types

WorkloadEntitySearchQuery
, WorkloadEntitySearchQueryArgs

Query This property is required. string
A valid entity search query; empty, and null values are considered invalid.
Query This property is required. string
A valid entity search query; empty, and null values are considered invalid.
query This property is required. String
A valid entity search query; empty, and null values are considered invalid.
query This property is required. string
A valid entity search query; empty, and null values are considered invalid.
query This property is required. str
A valid entity search query; empty, and null values are considered invalid.
query This property is required. String
A valid entity search query; empty, and null values are considered invalid.

WorkloadStatusConfigAutomatic
, WorkloadStatusConfigAutomaticArgs

Enabled This property is required. bool
Whether the automatic status configuration is enabled or not.
RemainingEntitiesRule Pulumi.NewRelic.Plugins.Inputs.WorkloadStatusConfigAutomaticRemainingEntitiesRule
An additional meta-rule that can consider all entities that haven't been evaluated by any other rule.
Rules List<Pulumi.NewRelic.Plugins.Inputs.WorkloadStatusConfigAutomaticRule>
A list of rules.
Enabled This property is required. bool
Whether the automatic status configuration is enabled or not.
RemainingEntitiesRule WorkloadStatusConfigAutomaticRemainingEntitiesRule
An additional meta-rule that can consider all entities that haven't been evaluated by any other rule.
Rules []WorkloadStatusConfigAutomaticRule
A list of rules.
enabled This property is required. Boolean
Whether the automatic status configuration is enabled or not.
remainingEntitiesRule WorkloadStatusConfigAutomaticRemainingEntitiesRule
An additional meta-rule that can consider all entities that haven't been evaluated by any other rule.
rules List<WorkloadStatusConfigAutomaticRule>
A list of rules.
enabled This property is required. boolean
Whether the automatic status configuration is enabled or not.
remainingEntitiesRule WorkloadStatusConfigAutomaticRemainingEntitiesRule
An additional meta-rule that can consider all entities that haven't been evaluated by any other rule.
rules WorkloadStatusConfigAutomaticRule[]
A list of rules.
enabled This property is required. bool
Whether the automatic status configuration is enabled or not.
remaining_entities_rule WorkloadStatusConfigAutomaticRemainingEntitiesRule
An additional meta-rule that can consider all entities that haven't been evaluated by any other rule.
rules Sequence[WorkloadStatusConfigAutomaticRule]
A list of rules.
enabled This property is required. Boolean
Whether the automatic status configuration is enabled or not.
remainingEntitiesRule Property Map
An additional meta-rule that can consider all entities that haven't been evaluated by any other rule.
rules List<Property Map>
A list of rules.

WorkloadStatusConfigAutomaticRemainingEntitiesRule
, WorkloadStatusConfigAutomaticRemainingEntitiesRuleArgs

RemainingEntitiesRuleRollup This property is required. WorkloadStatusConfigAutomaticRemainingEntitiesRuleRemainingEntitiesRuleRollup
The input object used to represent a rollup strategy.
remainingEntitiesRuleRollup This property is required. WorkloadStatusConfigAutomaticRemainingEntitiesRuleRemainingEntitiesRuleRollup
The input object used to represent a rollup strategy.
remainingEntitiesRuleRollup This property is required. WorkloadStatusConfigAutomaticRemainingEntitiesRuleRemainingEntitiesRuleRollup
The input object used to represent a rollup strategy.
remaining_entities_rule_rollup This property is required. WorkloadStatusConfigAutomaticRemainingEntitiesRuleRemainingEntitiesRuleRollup
The input object used to represent a rollup strategy.
remainingEntitiesRuleRollup This property is required. Property Map
The input object used to represent a rollup strategy.

WorkloadStatusConfigAutomaticRemainingEntitiesRuleRemainingEntitiesRuleRollup
, WorkloadStatusConfigAutomaticRemainingEntitiesRuleRemainingEntitiesRuleRollupArgs

GroupBy This property is required. string
The grouping to be applied to the remaining entities.
Strategy This property is required. string
The rollup strategy that is applied to a group of entities.
ThresholdType string
Type of threshold defined for the rule. This is an optional field that only applies when strategy is WORST_STATUS_WINS. Use a threshold to roll up the worst status only after a certain amount of entities are not operational.
ThresholdValue int
Threshold value defined for the rule. This optional field is used in combination with thresholdType. If the threshold type is null, the threshold value will be ignored.
GroupBy This property is required. string
The grouping to be applied to the remaining entities.
Strategy This property is required. string
The rollup strategy that is applied to a group of entities.
ThresholdType string
Type of threshold defined for the rule. This is an optional field that only applies when strategy is WORST_STATUS_WINS. Use a threshold to roll up the worst status only after a certain amount of entities are not operational.
ThresholdValue int
Threshold value defined for the rule. This optional field is used in combination with thresholdType. If the threshold type is null, the threshold value will be ignored.
groupBy This property is required. String
The grouping to be applied to the remaining entities.
strategy This property is required. String
The rollup strategy that is applied to a group of entities.
thresholdType String
Type of threshold defined for the rule. This is an optional field that only applies when strategy is WORST_STATUS_WINS. Use a threshold to roll up the worst status only after a certain amount of entities are not operational.
thresholdValue Integer
Threshold value defined for the rule. This optional field is used in combination with thresholdType. If the threshold type is null, the threshold value will be ignored.
groupBy This property is required. string
The grouping to be applied to the remaining entities.
strategy This property is required. string
The rollup strategy that is applied to a group of entities.
thresholdType string
Type of threshold defined for the rule. This is an optional field that only applies when strategy is WORST_STATUS_WINS. Use a threshold to roll up the worst status only after a certain amount of entities are not operational.
thresholdValue number
Threshold value defined for the rule. This optional field is used in combination with thresholdType. If the threshold type is null, the threshold value will be ignored.
group_by This property is required. str
The grouping to be applied to the remaining entities.
strategy This property is required. str
The rollup strategy that is applied to a group of entities.
threshold_type str
Type of threshold defined for the rule. This is an optional field that only applies when strategy is WORST_STATUS_WINS. Use a threshold to roll up the worst status only after a certain amount of entities are not operational.
threshold_value int
Threshold value defined for the rule. This optional field is used in combination with thresholdType. If the threshold type is null, the threshold value will be ignored.
groupBy This property is required. String
The grouping to be applied to the remaining entities.
strategy This property is required. String
The rollup strategy that is applied to a group of entities.
thresholdType String
Type of threshold defined for the rule. This is an optional field that only applies when strategy is WORST_STATUS_WINS. Use a threshold to roll up the worst status only after a certain amount of entities are not operational.
thresholdValue Number
Threshold value defined for the rule. This optional field is used in combination with thresholdType. If the threshold type is null, the threshold value will be ignored.

WorkloadStatusConfigAutomaticRule
, WorkloadStatusConfigAutomaticRuleArgs

Rollup This property is required. Pulumi.NewRelic.Plugins.Inputs.WorkloadStatusConfigAutomaticRuleRollup
The input object used to represent a rollup strategy. See Nested rollup blocks below for details.
EntityGuids List<string>
A list of entity GUIDs composing the rule. At least one of entity_guids or nrql_query must be defined.
NrqlQueries List<Pulumi.NewRelic.Plugins.Inputs.WorkloadStatusConfigAutomaticRuleNrqlQuery>
A list of entity search queries used to retrieve the entities that compose the rule. See Nested nrql_query blocks below for details. At least one of entity_guids or nrql_query must be defined.
Rollup This property is required. WorkloadStatusConfigAutomaticRuleRollup
The input object used to represent a rollup strategy. See Nested rollup blocks below for details.
EntityGuids []string
A list of entity GUIDs composing the rule. At least one of entity_guids or nrql_query must be defined.
NrqlQueries []WorkloadStatusConfigAutomaticRuleNrqlQuery
A list of entity search queries used to retrieve the entities that compose the rule. See Nested nrql_query blocks below for details. At least one of entity_guids or nrql_query must be defined.
rollup This property is required. WorkloadStatusConfigAutomaticRuleRollup
The input object used to represent a rollup strategy. See Nested rollup blocks below for details.
entityGuids List<String>
A list of entity GUIDs composing the rule. At least one of entity_guids or nrql_query must be defined.
nrqlQueries List<WorkloadStatusConfigAutomaticRuleNrqlQuery>
A list of entity search queries used to retrieve the entities that compose the rule. See Nested nrql_query blocks below for details. At least one of entity_guids or nrql_query must be defined.
rollup This property is required. WorkloadStatusConfigAutomaticRuleRollup
The input object used to represent a rollup strategy. See Nested rollup blocks below for details.
entityGuids string[]
A list of entity GUIDs composing the rule. At least one of entity_guids or nrql_query must be defined.
nrqlQueries WorkloadStatusConfigAutomaticRuleNrqlQuery[]
A list of entity search queries used to retrieve the entities that compose the rule. See Nested nrql_query blocks below for details. At least one of entity_guids or nrql_query must be defined.
rollup This property is required. WorkloadStatusConfigAutomaticRuleRollup
The input object used to represent a rollup strategy. See Nested rollup blocks below for details.
entity_guids Sequence[str]
A list of entity GUIDs composing the rule. At least one of entity_guids or nrql_query must be defined.
nrql_queries Sequence[WorkloadStatusConfigAutomaticRuleNrqlQuery]
A list of entity search queries used to retrieve the entities that compose the rule. See Nested nrql_query blocks below for details. At least one of entity_guids or nrql_query must be defined.
rollup This property is required. Property Map
The input object used to represent a rollup strategy. See Nested rollup blocks below for details.
entityGuids List<String>
A list of entity GUIDs composing the rule. At least one of entity_guids or nrql_query must be defined.
nrqlQueries List<Property Map>
A list of entity search queries used to retrieve the entities that compose the rule. See Nested nrql_query blocks below for details. At least one of entity_guids or nrql_query must be defined.

WorkloadStatusConfigAutomaticRuleNrqlQuery
, WorkloadStatusConfigAutomaticRuleNrqlQueryArgs

Query This property is required. string
The entity search query that is used to perform the search of a group of entities.
Query This property is required. string
The entity search query that is used to perform the search of a group of entities.
query This property is required. String
The entity search query that is used to perform the search of a group of entities.
query This property is required. string
The entity search query that is used to perform the search of a group of entities.
query This property is required. str
The entity search query that is used to perform the search of a group of entities.
query This property is required. String
The entity search query that is used to perform the search of a group of entities.

WorkloadStatusConfigAutomaticRuleRollup
, WorkloadStatusConfigAutomaticRuleRollupArgs

Strategy This property is required. string
The rollup strategy that is applied to a group of entities.
ThresholdType string
Type of threshold defined for the rule. This is an optional field that only applies when strategy is WORST_STATUS_WINS. Use a threshold to roll up the worst status only after a certain amount of entities are not operational.
ThresholdValue int
Threshold value defined for the rule. This optional field is used in combination with thresholdType. If the threshold type is null, the threshold value will be ignored.
Strategy This property is required. string
The rollup strategy that is applied to a group of entities.
ThresholdType string
Type of threshold defined for the rule. This is an optional field that only applies when strategy is WORST_STATUS_WINS. Use a threshold to roll up the worst status only after a certain amount of entities are not operational.
ThresholdValue int
Threshold value defined for the rule. This optional field is used in combination with thresholdType. If the threshold type is null, the threshold value will be ignored.
strategy This property is required. String
The rollup strategy that is applied to a group of entities.
thresholdType String
Type of threshold defined for the rule. This is an optional field that only applies when strategy is WORST_STATUS_WINS. Use a threshold to roll up the worst status only after a certain amount of entities are not operational.
thresholdValue Integer
Threshold value defined for the rule. This optional field is used in combination with thresholdType. If the threshold type is null, the threshold value will be ignored.
strategy This property is required. string
The rollup strategy that is applied to a group of entities.
thresholdType string
Type of threshold defined for the rule. This is an optional field that only applies when strategy is WORST_STATUS_WINS. Use a threshold to roll up the worst status only after a certain amount of entities are not operational.
thresholdValue number
Threshold value defined for the rule. This optional field is used in combination with thresholdType. If the threshold type is null, the threshold value will be ignored.
strategy This property is required. str
The rollup strategy that is applied to a group of entities.
threshold_type str
Type of threshold defined for the rule. This is an optional field that only applies when strategy is WORST_STATUS_WINS. Use a threshold to roll up the worst status only after a certain amount of entities are not operational.
threshold_value int
Threshold value defined for the rule. This optional field is used in combination with thresholdType. If the threshold type is null, the threshold value will be ignored.
strategy This property is required. String
The rollup strategy that is applied to a group of entities.
thresholdType String
Type of threshold defined for the rule. This is an optional field that only applies when strategy is WORST_STATUS_WINS. Use a threshold to roll up the worst status only after a certain amount of entities are not operational.
thresholdValue Number
Threshold value defined for the rule. This optional field is used in combination with thresholdType. If the threshold type is null, the threshold value will be ignored.

WorkloadStatusConfigStatic
, WorkloadStatusConfigStaticArgs

Enabled This property is required. bool
Whether the static status configuration is enabled or not.
Status This property is required. string
The status of the workload.
Description string
Relevant information about the workload.
Summary string
A short description of the status of the workload.
Enabled This property is required. bool
Whether the static status configuration is enabled or not.
Status This property is required. string
The status of the workload.
Description string
Relevant information about the workload.
Summary string
A short description of the status of the workload.
enabled This property is required. Boolean
Whether the static status configuration is enabled or not.
status This property is required. String
The status of the workload.
description String
Relevant information about the workload.
summary String
A short description of the status of the workload.
enabled This property is required. boolean
Whether the static status configuration is enabled or not.
status This property is required. string
The status of the workload.
description string
Relevant information about the workload.
summary string
A short description of the status of the workload.
enabled This property is required. bool
Whether the static status configuration is enabled or not.
status This property is required. str
The status of the workload.
description str
Relevant information about the workload.
summary str
A short description of the status of the workload.
enabled This property is required. Boolean
Whether the static status configuration is enabled or not.
status This property is required. String
The status of the workload.
description String
Relevant information about the workload.
summary String
A short description of the status of the workload.

Import

New Relic workloads can be imported using a concatenated string of the format

<account_id>:<workload_id>:<guid>, e.g.

bash

$ pulumi import newrelic:plugins/workload:Workload foo 12345678:1456:MjUyMDUyOHxBUE18QVBRTElDQVRJT058MjE1MDM3Nzk1
Copy

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

Package Details

Repository
New Relic pulumi/pulumi-newrelic
License
Apache-2.0
Notes
This Pulumi package is based on the newrelic Terraform Provider.
New Relic v5.44.0 published on Saturday, Mar 29, 2025 by Pulumi
pulumi/pulumi-newrelic