Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. New Relic
  3. API Docs
  4. getEntity
New Relic v5.36.1 published on Tuesday, Nov 12, 2024 by Pulumi
pulumi/pulumi-newrelic

newrelic.getEntity

Explore with Pulumi AI

newrelic logo
New Relic v5.36.1 published on Tuesday, Nov 12, 2024 by Pulumi
pulumi/pulumi-newrelic

    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(account_id: Optional[str] = None,
               domain: Optional[str] = None,
               entity_tags: Optional[str] = None,
               ignore_case: Optional[bool] = None,
               ignore_not_found: 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(account_id: Optional[pulumi.Input[str]] = None,
               domain: Optional[pulumi.Input[str]] = None,
               entity_tags: Optional[pulumi.Input[str]] = None,
               ignore_case: Optional[pulumi.Input[bool]] = None,
               ignore_not_found: 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.
    AccountId string
    The New Relic account ID the entity to be returned would be associated with, i.e. if specified, the data source would filter matching entities received by account_id and return the first match. If not, matching entities are filtered by the account ID specified in the configuration of the provider. See the Example: Filter By Account ID section above for more details.
    Domain string
    The entity's domain. Valid values are APM, BROWSER, INFRA, MOBILE, SYNTH, and EXT. If not specified, all domains are searched.
    EntityTags string
    A JSON-encoded string, comprising tags associated with the entity fetched.

    • See the Additional Examples section below, for an illustration depicting the usage of jsondecode with the attribute entity_tags, to get the tags associated with the entity fetched.
    IgnoreCase bool
    Ignore case of the name when searching for the entity. Defaults to false.
    IgnoreNotFound bool

    A boolean argument that, when set to true, prevents an error from being thrown when the queried entity is not found. Instead, a warning is displayed. Defaults to false.

    WARNING: Setting the ignore_not_found argument to true will display an 'entity not found' warning instead of throwing an error. This can lead to downstream errors if the values of attributes exported by this data source are used elsewhere, as all of these values would be null. Please use this argument at your own risk.

    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.
    AccountId string
    The New Relic account ID the entity to be returned would be associated with, i.e. if specified, the data source would filter matching entities received by account_id and return the first match. If not, matching entities are filtered by the account ID specified in the configuration of the provider. See the Example: Filter By Account ID section above for more details.
    Domain string
    The entity's domain. Valid values are APM, BROWSER, INFRA, MOBILE, SYNTH, and EXT. If not specified, all domains are searched.
    EntityTags string
    A JSON-encoded string, comprising tags associated with the entity fetched.

    • See the Additional Examples section below, for an illustration depicting the usage of jsondecode with the attribute entity_tags, to get the tags associated with the entity fetched.
    IgnoreCase bool
    Ignore case of the name when searching for the entity. Defaults to false.
    IgnoreNotFound bool

    A boolean argument that, when set to true, prevents an error from being thrown when the queried entity is not found. Instead, a warning is displayed. Defaults to false.

    WARNING: Setting the ignore_not_found argument to true will display an 'entity not found' warning instead of throwing an error. This can lead to downstream errors if the values of attributes exported by this data source are used elsewhere, as all of these values would be null. Please use this argument at your own risk.

    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.
    accountId String
    The New Relic account ID the entity to be returned would be associated with, i.e. if specified, the data source would filter matching entities received by account_id and return the first match. If not, matching entities are filtered by the account ID specified in the configuration of the provider. See the Example: Filter By Account ID section above for more details.
    domain String
    The entity's domain. Valid values are APM, BROWSER, INFRA, MOBILE, SYNTH, and EXT. If not specified, all domains are searched.
    entityTags String
    A JSON-encoded string, comprising tags associated with the entity fetched.

    • See the Additional Examples section below, for an illustration depicting the usage of jsondecode with the attribute entity_tags, to get the tags associated with the entity fetched.
    ignoreCase Boolean
    Ignore case of the name when searching for the entity. Defaults to false.
    ignoreNotFound Boolean

    A boolean argument that, when set to true, prevents an error from being thrown when the queried entity is not found. Instead, a warning is displayed. Defaults to false.

    WARNING: Setting the ignore_not_found argument to true will display an 'entity not found' warning instead of throwing an error. This can lead to downstream errors if the values of attributes exported by this data source are used elsewhere, as all of these values would be null. Please use this argument at your own risk.

    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.
    accountId string
    The New Relic account ID the entity to be returned would be associated with, i.e. if specified, the data source would filter matching entities received by account_id and return the first match. If not, matching entities are filtered by the account ID specified in the configuration of the provider. See the Example: Filter By Account ID section above for more details.
    domain string
    The entity's domain. Valid values are APM, BROWSER, INFRA, MOBILE, SYNTH, and EXT. If not specified, all domains are searched.
    entityTags string
    A JSON-encoded string, comprising tags associated with the entity fetched.

    • See the Additional Examples section below, for an illustration depicting the usage of jsondecode with the attribute entity_tags, to get the tags associated with the entity fetched.
    ignoreCase boolean
    Ignore case of the name when searching for the entity. Defaults to false.
    ignoreNotFound boolean

    A boolean argument that, when set to true, prevents an error from being thrown when the queried entity is not found. Instead, a warning is displayed. Defaults to false.

    WARNING: Setting the ignore_not_found argument to true will display an 'entity not found' warning instead of throwing an error. This can lead to downstream errors if the values of attributes exported by this data source are used elsewhere, as all of these values would be null. Please use this argument at your own risk.

    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.
    account_id str
    The New Relic account ID the entity to be returned would be associated with, i.e. if specified, the data source would filter matching entities received by account_id and return the first match. If not, matching entities are filtered by the account ID specified in the configuration of the provider. See the Example: Filter By Account ID section above for more details.
    domain str
    The entity's domain. Valid values are APM, BROWSER, INFRA, MOBILE, SYNTH, and EXT. If not specified, all domains are searched.
    entity_tags str
    A JSON-encoded string, comprising tags associated with the entity fetched.

    • See the Additional Examples section below, for an illustration depicting the usage of jsondecode with the attribute entity_tags, to get the tags associated with the entity fetched.
    ignore_case bool
    Ignore case of the name when searching for the entity. Defaults to false.
    ignore_not_found bool

    A boolean argument that, when set to true, prevents an error from being thrown when the queried entity is not found. Instead, a warning is displayed. Defaults to false.

    WARNING: Setting the ignore_not_found argument to true will display an 'entity not found' warning instead of throwing an error. This can lead to downstream errors if the values of attributes exported by this data source are used elsewhere, as all of these values would be null. Please use this argument at your own risk.

    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.
    accountId String
    The New Relic account ID the entity to be returned would be associated with, i.e. if specified, the data source would filter matching entities received by account_id and return the first match. If not, matching entities are filtered by the account ID specified in the configuration of the provider. See the Example: Filter By Account ID section above for more details.
    domain String
    The entity's domain. Valid values are APM, BROWSER, INFRA, MOBILE, SYNTH, and EXT. If not specified, all domains are searched.
    entityTags String
    A JSON-encoded string, comprising tags associated with the entity fetched.

    • See the Additional Examples section below, for an illustration depicting the usage of jsondecode with the attribute entity_tags, to get the tags associated with the entity fetched.
    ignoreCase Boolean
    Ignore case of the name when searching for the entity. Defaults to false.
    ignoreNotFound Boolean

    A boolean argument that, when set to true, prevents an error from being thrown when the queried entity is not found. Instead, a warning is displayed. Defaults to false.

    WARNING: Setting the ignore_not_found argument to true will display an 'entity not found' warning instead of throwing an error. This can lead to downstream errors if the values of attributes exported by this data source are used elsewhere, as all of these values would be null. Please use this argument at your own risk.

    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 string
    ApplicationId string
    The domain-specific application ID of the entity. Only returned for APM and Browser applications.
    Domain string
    EntityTags string
    A JSON-encoded string, comprising tags associated with the entity fetched.

    • See the Additional Examples section below, for an illustration depicting the usage of jsondecode with the attribute entity_tags, to get the tags associated with the entity fetched.
    Guid string
    The unique GUID of the entity.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    ServingApmApplicationId string
    The browser-specific ID of the backing APM entity. Only returned for Browser applications.
    Type string
    IgnoreCase bool
    IgnoreNotFound bool
    Tags List<Pulumi.NewRelic.Outputs.GetEntityTag>
    AccountId string
    ApplicationId string
    The domain-specific application ID of the entity. Only returned for APM and Browser applications.
    Domain string
    EntityTags string
    A JSON-encoded string, comprising tags associated with the entity fetched.

    • See the Additional Examples section below, for an illustration depicting the usage of jsondecode with the attribute entity_tags, to get the tags associated with the entity fetched.
    Guid string
    The unique GUID of the entity.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    ServingApmApplicationId string
    The browser-specific ID of the backing APM entity. Only returned for Browser applications.
    Type string
    IgnoreCase bool
    IgnoreNotFound bool
    Tags []GetEntityTag
    accountId String
    applicationId String
    The domain-specific application ID of the entity. Only returned for APM and Browser applications.
    domain String
    entityTags String
    A JSON-encoded string, comprising tags associated with the entity fetched.

    • See the Additional Examples section below, for an illustration depicting the usage of jsondecode with the attribute entity_tags, to get the tags associated with the entity fetched.
    guid String
    The unique GUID of the entity.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    servingApmApplicationId String
    The browser-specific ID of the backing APM entity. Only returned for Browser applications.
    type String
    ignoreCase Boolean
    ignoreNotFound Boolean
    tags List<GetEntityTag>
    accountId string
    applicationId string
    The domain-specific application ID of the entity. Only returned for APM and Browser applications.
    domain string
    entityTags string
    A JSON-encoded string, comprising tags associated with the entity fetched.

    • See the Additional Examples section below, for an illustration depicting the usage of jsondecode with the attribute entity_tags, to get the tags associated with the entity fetched.
    guid string
    The unique GUID of the entity.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    servingApmApplicationId string
    The browser-specific ID of the backing APM entity. Only returned for Browser applications.
    type string
    ignoreCase boolean
    ignoreNotFound boolean
    tags GetEntityTag[]
    account_id str
    application_id str
    The domain-specific application ID of the entity. Only returned for APM and Browser applications.
    domain str
    entity_tags str
    A JSON-encoded string, comprising tags associated with the entity fetched.

    • See the Additional Examples section below, for an illustration depicting the usage of jsondecode with the attribute entity_tags, to get the tags associated with the entity fetched.
    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 str
    The browser-specific ID of the backing APM entity. Only returned for Browser applications.
    type str
    ignore_case bool
    ignore_not_found bool
    tags Sequence[GetEntityTag]
    accountId String
    applicationId String
    The domain-specific application ID of the entity. Only returned for APM and Browser applications.
    domain String
    entityTags String
    A JSON-encoded string, comprising tags associated with the entity fetched.

    • See the Additional Examples section below, for an illustration depicting the usage of jsondecode with the attribute entity_tags, to get the tags associated with the entity fetched.
    guid String
    The unique GUID of the entity.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    servingApmApplicationId String
    The browser-specific ID of the backing APM entity. Only returned for Browser applications.
    type String
    ignoreCase Boolean
    ignoreNotFound 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.36.1 published on Tuesday, Nov 12, 2024 by Pulumi
    pulumi/pulumi-newrelic