1. Packages
  2. Packages
  3. Newrelic Provider
  4. API Docs
  5. getEntity
Viewing docs for New Relic v4.20.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-newrelic

newrelic.getEntity

newrelic logo
Viewing docs for New Relic v4.20.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-newrelic

    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,
               tag: Optional[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,
               tag: Optional[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)
public static Output<GetEntityResult> getEntity(GetEntityArgs args, InvokeOptions options)

    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.
    Tag Pulumi.NewRelic.Inputs.GetEntityTag
    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.
    Tag GetEntityTag
    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.
    tag GetEntityTag
    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.
    tag GetEntityTag
    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.
    tag GetEntityTag
    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.
    tag Property Map
    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
    Type string
    IgnoreCase bool
    Tag 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
    Type string
    IgnoreCase bool
    Tag 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
    type String
    ignoreCase Boolean
    tag 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
    type string
    ignoreCase boolean
    tag 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
    type str
    ignore_case bool
    tag 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
    type String
    ignoreCase Boolean
    tag Property Map

    Supporting Types

    GetEntityTag

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    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
    Viewing docs for New Relic v4.20.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-newrelic
      Try Pulumi Cloud free. Your team will thank you.