1. Packages
  2. New Relic
  3. API Docs
  4. getEntity
New Relic v5.12.1 published on Thursday, Jun 8, 2023 by Pulumi

newrelic.getEntity

Explore with Pulumi AI

newrelic logo
New Relic v5.12.1 published on Thursday, Jun 8, 2023 by Pulumi

    Use this data source to get information about a specific entity in New Relic One that already exists.

    Additional Examples

    If the entities are not found please try again without providing the types field.

    Query for an OTEL entity

    import * as pulumi from "@pulumi/pulumi";
    import * as newrelic from "@pulumi/newrelic";
    
    const app = newrelic.getEntity({
        domain: "EXT",
        name: "my-otel-app",
        tags: [{
            key: "accountID",
            value: "12345",
        }],
        type: "SERVICE",
    });
    
    import pulumi
    import pulumi_newrelic as newrelic
    
    app = newrelic.get_entity(domain="EXT",
        name="my-otel-app",
        tags=[newrelic.GetEntityTagArgs(
            key="accountID",
            value="12345",
        )],
        type="SERVICE")
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using NewRelic = Pulumi.NewRelic;
    
    return await Deployment.RunAsync(() => 
    {
        var app = NewRelic.GetEntity.Invoke(new()
        {
            Domain = "EXT",
            Name = "my-otel-app",
            Tags = new[]
            {
                new NewRelic.Inputs.GetEntityTagInputArgs
                {
                    Key = "accountID",
                    Value = "12345",
                },
            },
            Type = "SERVICE",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-newrelic/sdk/v5/go/newrelic"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := newrelic.GetEntity(ctx, &newrelic.GetEntityArgs{
    			Domain: pulumi.StringRef("EXT"),
    			Name:   "my-otel-app",
    			Tags: []newrelic.GetEntityTag{
    				{
    					Key:   "accountID",
    					Value: "12345",
    				},
    			},
    			Type: pulumi.StringRef("SERVICE"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.newrelic.NewrelicFunctions;
    import com.pulumi.newrelic.inputs.GetEntityArgs;
    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) {
            final var app = NewrelicFunctions.getEntity(GetEntityArgs.builder()
                .domain("EXT")
                .name("my-otel-app")
                .tags(GetEntityTagArgs.builder()
                    .key("accountID")
                    .value("12345")
                    .build())
                .type("SERVICE")
                .build());
    
        }
    }
    
    variables:
      app:
        fn::invoke:
          Function: newrelic:getEntity
          Arguments:
            domain: EXT
            name: my-otel-app
            tags:
              - key: accountID
                value: '12345'
            type: SERVICE
    

    Query for an entity by type (AWS Lambda entity in this example)

    import * as pulumi from "@pulumi/pulumi";
    import * as newrelic from "@pulumi/newrelic";
    
    const app = newrelic.getEntity({
        name: "my_lambda_trace",
        type: "AWSLAMBDAFUNCTION",
    });
    
    import pulumi
    import pulumi_newrelic as newrelic
    
    app = newrelic.get_entity(name="my_lambda_trace",
        type="AWSLAMBDAFUNCTION")
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using NewRelic = Pulumi.NewRelic;
    
    return await Deployment.RunAsync(() => 
    {
        var app = NewRelic.GetEntity.Invoke(new()
        {
            Name = "my_lambda_trace",
            Type = "AWSLAMBDAFUNCTION",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-newrelic/sdk/v5/go/newrelic"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := newrelic.GetEntity(ctx, &newrelic.GetEntityArgs{
    			Name: "my_lambda_trace",
    			Type: pulumi.StringRef("AWSLAMBDAFUNCTION"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.newrelic.NewrelicFunctions;
    import com.pulumi.newrelic.inputs.GetEntityArgs;
    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) {
            final var app = NewrelicFunctions.getEntity(GetEntityArgs.builder()
                .name("my_lambda_trace")
                .type("AWSLAMBDAFUNCTION")
                .build());
    
        }
    }
    
    variables:
      app:
        fn::invoke:
          Function: newrelic:getEntity
          Arguments:
            name: my_lambda_trace
            type: AWSLAMBDAFUNCTION
    

    Using getEntity

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEntity(args: GetEntityArgs, opts?: InvokeOptions): Promise<GetEntityResult>
    function getEntityOutput(args: GetEntityOutputArgs, opts?: InvokeOptions): Output<GetEntityResult>
    def get_entity(domain: Optional[str] = None,
                   ignore_case: Optional[bool] = None,
                   name: Optional[str] = None,
                   tags: Optional[Sequence[GetEntityTag]] = None,
                   type: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetEntityResult
    def get_entity_output(domain: Optional[pulumi.Input[str]] = None,
                   ignore_case: Optional[pulumi.Input[bool]] = None,
                   name: Optional[pulumi.Input[str]] = None,
                   tags: Optional[pulumi.Input[Sequence[pulumi.Input[GetEntityTagArgs]]]] = None,
                   type: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetEntityResult]
    func GetEntity(ctx *Context, args *GetEntityArgs, opts ...InvokeOption) (*GetEntityResult, error)
    func GetEntityOutput(ctx *Context, args *GetEntityOutputArgs, opts ...InvokeOption) GetEntityResultOutput

    > Note: This function is named GetEntity in the Go SDK.

    public static class GetEntity 
    {
        public static Task<GetEntityResult> InvokeAsync(GetEntityArgs args, InvokeOptions? opts = null)
        public static Output<GetEntityResult> Invoke(GetEntityInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEntityResult> getEntity(GetEntityArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: newrelic:index/getEntity:getEntity
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string

    The name of the entity in New Relic One. The first entity matching this name for the given search parameters will be returned.

    Domain string

    The entity's domain. Valid values are APM, BROWSER, INFRA, MOBILE, SYNTH, and EXT. If not specified, all domains are searched.

    IgnoreCase bool

    Ignore case of the name when searching for the entity. Defaults to false.

    Tags List<Pulumi.NewRelic.Inputs.GetEntityTag>

    A tag applied to the entity. See Nested tag blocks below for details.

    Type string

    The entity's type. Valid values are APPLICATION, DASHBOARD, HOST, MONITOR, WORKLOAD, AWSLAMBDAFUNCTION, SERVICE_LEVEL, and KEY_TRANSACTION. Note: Other entity types may also be queryable as the list of entity types may fluctuate over time.

    Name string

    The name of the entity in New Relic One. The first entity matching this name for the given search parameters will be returned.

    Domain string

    The entity's domain. Valid values are APM, BROWSER, INFRA, MOBILE, SYNTH, and EXT. If not specified, all domains are searched.

    IgnoreCase bool

    Ignore case of the name when searching for the entity. Defaults to false.

    Tags []GetEntityTag

    A tag applied to the entity. See Nested tag blocks below for details.

    Type string

    The entity's type. Valid values are APPLICATION, DASHBOARD, HOST, MONITOR, WORKLOAD, AWSLAMBDAFUNCTION, SERVICE_LEVEL, and KEY_TRANSACTION. Note: Other entity types may also be queryable as the list of entity types may fluctuate over time.

    name String

    The name of the entity in New Relic One. The first entity matching this name for the given search parameters will be returned.

    domain String

    The entity's domain. Valid values are APM, BROWSER, INFRA, MOBILE, SYNTH, and EXT. If not specified, all domains are searched.

    ignoreCase Boolean

    Ignore case of the name when searching for the entity. Defaults to false.

    tags List<GetEntityTag>

    A tag applied to the entity. See Nested tag blocks below for details.

    type String

    The entity's type. Valid values are APPLICATION, DASHBOARD, HOST, MONITOR, WORKLOAD, AWSLAMBDAFUNCTION, SERVICE_LEVEL, and KEY_TRANSACTION. Note: Other entity types may also be queryable as the list of entity types may fluctuate over time.

    name string

    The name of the entity in New Relic One. The first entity matching this name for the given search parameters will be returned.

    domain string

    The entity's domain. Valid values are APM, BROWSER, INFRA, MOBILE, SYNTH, and EXT. If not specified, all domains are searched.

    ignoreCase boolean

    Ignore case of the name when searching for the entity. Defaults to false.

    tags GetEntityTag[]

    A tag applied to the entity. See Nested tag blocks below for details.

    type string

    The entity's type. Valid values are APPLICATION, DASHBOARD, HOST, MONITOR, WORKLOAD, AWSLAMBDAFUNCTION, SERVICE_LEVEL, and KEY_TRANSACTION. Note: Other entity types may also be queryable as the list of entity types may fluctuate over time.

    name str

    The name of the entity in New Relic One. The first entity matching this name for the given search parameters will be returned.

    domain str

    The entity's domain. Valid values are APM, BROWSER, INFRA, MOBILE, SYNTH, and EXT. If not specified, all domains are searched.

    ignore_case bool

    Ignore case of the name when searching for the entity. Defaults to false.

    tags Sequence[GetEntityTag]

    A tag applied to the entity. See Nested tag blocks below for details.

    type str

    The entity's type. Valid values are APPLICATION, DASHBOARD, HOST, MONITOR, WORKLOAD, AWSLAMBDAFUNCTION, SERVICE_LEVEL, and KEY_TRANSACTION. Note: Other entity types may also be queryable as the list of entity types may fluctuate over time.

    name String

    The name of the entity in New Relic One. The first entity matching this name for the given search parameters will be returned.

    domain String

    The entity's domain. Valid values are APM, BROWSER, INFRA, MOBILE, SYNTH, and EXT. If not specified, all domains are searched.

    ignoreCase Boolean

    Ignore case of the name when searching for the entity. Defaults to false.

    tags List<Property Map>

    A tag applied to the entity. See Nested tag blocks below for details.

    type String

    The entity's type. Valid values are APPLICATION, DASHBOARD, HOST, MONITOR, WORKLOAD, AWSLAMBDAFUNCTION, SERVICE_LEVEL, and KEY_TRANSACTION. Note: Other entity types may also be queryable as the list of entity types may fluctuate over time.

    getEntity Result

    The following output properties are available:

    AccountId int

    The New Relic account ID associated with this entity.

    ApplicationId int

    The domain-specific application ID of the entity. Only returned for APM and Browser applications.

    Domain string
    Guid string

    The unique GUID of the entity.

    Id string

    The provider-assigned unique ID for this managed resource.

    Name string
    ServingApmApplicationId int

    The browser-specific ID of the backing APM entity. Only returned for Browser applications.

    Type string
    IgnoreCase bool
    Tags List<Pulumi.NewRelic.Outputs.GetEntityTag>
    AccountId int

    The New Relic account ID associated with this entity.

    ApplicationId int

    The domain-specific application ID of the entity. Only returned for APM and Browser applications.

    Domain string
    Guid string

    The unique GUID of the entity.

    Id string

    The provider-assigned unique ID for this managed resource.

    Name string
    ServingApmApplicationId int

    The browser-specific ID of the backing APM entity. Only returned for Browser applications.

    Type string
    IgnoreCase bool
    Tags []GetEntityTag
    accountId Integer

    The New Relic account ID associated with this entity.

    applicationId Integer

    The domain-specific application ID of the entity. Only returned for APM and Browser applications.

    domain String
    guid String

    The unique GUID of the entity.

    id String

    The provider-assigned unique ID for this managed resource.

    name String
    servingApmApplicationId Integer

    The browser-specific ID of the backing APM entity. Only returned for Browser applications.

    type String
    ignoreCase Boolean
    tags List<GetEntityTag>
    accountId number

    The New Relic account ID associated with this entity.

    applicationId number

    The domain-specific application ID of the entity. Only returned for APM and Browser applications.

    domain string
    guid string

    The unique GUID of the entity.

    id string

    The provider-assigned unique ID for this managed resource.

    name string
    servingApmApplicationId number

    The browser-specific ID of the backing APM entity. Only returned for Browser applications.

    type string
    ignoreCase boolean
    tags GetEntityTag[]
    account_id int

    The New Relic account ID associated with this entity.

    application_id int

    The domain-specific application ID of the entity. Only returned for APM and Browser applications.

    domain str
    guid str

    The unique GUID of the entity.

    id str

    The provider-assigned unique ID for this managed resource.

    name str
    serving_apm_application_id int

    The browser-specific ID of the backing APM entity. Only returned for Browser applications.

    type str
    ignore_case bool
    tags Sequence[GetEntityTag]
    accountId Number

    The New Relic account ID associated with this entity.

    applicationId Number

    The domain-specific application ID of the entity. Only returned for APM and Browser applications.

    domain String
    guid String

    The unique GUID of the entity.

    id String

    The provider-assigned unique ID for this managed resource.

    name String
    servingApmApplicationId Number

    The browser-specific ID of the backing APM entity. Only returned for Browser applications.

    type String
    ignoreCase Boolean
    tags List<Property Map>

    Supporting Types

    GetEntityTag

    Key string

    The tag key.

    Value string

    The tag value.

    Key string

    The tag key.

    Value string

    The tag value.

    key String

    The tag key.

    value String

    The tag value.

    key string

    The tag key.

    value string

    The tag value.

    key str

    The tag key.

    value str

    The tag value.

    key String

    The tag key.

    value String

    The tag value.

    Package Details

    Repository
    New Relic pulumi/pulumi-newrelic
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the newrelic Terraform Provider.

    newrelic logo
    New Relic v5.12.1 published on Thursday, Jun 8, 2023 by Pulumi