newrelic logo
New Relic v5.2.0, Dec 8 22

newrelic.getEntity

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

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 VIZ. 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, and WORKLOAD.

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 VIZ. 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, and WORKLOAD.

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 VIZ. 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, and WORKLOAD.

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 VIZ. 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, and WORKLOAD.

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 VIZ. 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, and WORKLOAD.

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 VIZ. 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, and WORKLOAD.

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.