@pulumiverse/dynatrace/getEntity.d.ts

A Pulumi package for creating and managing Dynatrace cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * The entity data source allows the entity ID to be retrieved by its name and type.
 *
 * - `name` (String) Display name of the entity
 * - `type` (String) Type of the entity, e.g. SERVICE. All available entity types can be retrieved with [/api/v2/entityTypes](https://www.dynatrace.com/support/help/dynatrace-api/environment-api/entity-v2/get-all-entity-types).
 *
 * If multiple services match the given criteria, the first result will be retrieved.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as dynatrace from "@pulumi/dynatrace";
 *
 * const test = dynatrace.getEntity({
 *     type: "SERVICE",
 *     name: "BookingService",
 * });
 * export const id = test.then(test => test.id);
 * ```
 */
export declare function getEntity(args?: GetEntityArgs, opts?: pulumi.InvokeOptions): Promise<GetEntityResult>;
/**
 * A collection of arguments for invoking getEntity.
 */
export interface GetEntityArgs {
    entitySelector?: string;
    from?: string;
    name?: string;
    to?: string;
    type?: string;
}
/**
 * A collection of values returned by getEntity.
 */
export interface GetEntityResult {
    readonly entitySelector?: string;
    readonly from?: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly name?: string;
    readonly properties: {
        [key: string]: string;
    };
    readonly to?: string;
    readonly type?: string;
}
/**
 * The entity data source allows the entity ID to be retrieved by its name and type.
 *
 * - `name` (String) Display name of the entity
 * - `type` (String) Type of the entity, e.g. SERVICE. All available entity types can be retrieved with [/api/v2/entityTypes](https://www.dynatrace.com/support/help/dynatrace-api/environment-api/entity-v2/get-all-entity-types).
 *
 * If multiple services match the given criteria, the first result will be retrieved.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as dynatrace from "@pulumi/dynatrace";
 *
 * const test = dynatrace.getEntity({
 *     type: "SERVICE",
 *     name: "BookingService",
 * });
 * export const id = test.then(test => test.id);
 * ```
 */
export declare function getEntityOutput(args?: GetEntityOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetEntityResult>;
/**
 * A collection of arguments for invoking getEntity.
 */
export interface GetEntityOutputArgs {
    entitySelector?: pulumi.Input<string>;
    from?: pulumi.Input<string>;
    name?: pulumi.Input<string>;
    to?: pulumi.Input<string>;
    type?: pulumi.Input<string>;
}