getEntity

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";
const entity = vault.identity.getEntity({
entityName: "entity_12345",
});
import pulumi
import pulumi_vault as vault
entity = vault.identity.get_entity(entity_name="entity_12345")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vault = Pulumi.Vault;
return await Deployment.RunAsync(() =>
{
var entity = Vault.Identity.GetEntity.Invoke(new()
{
EntityName = "entity_12345",
});
});
package main
import (
"github.com/pulumi/pulumi-vault/sdk/v6/go/vault/identity"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := identity.LookupEntity(ctx, &identity.LookupEntityArgs{
EntityName: pulumi.StringRef("entity_12345"),
}, 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.vault.identity.IdentityFunctions;
import com.pulumi.vault.identity.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 entity = IdentityFunctions.getEntity(GetEntityArgs.builder()
.entityName("entity_12345")
.build());
}
}
variables:
entity:
fn::invoke:
function: vault:identity:getEntity
arguments:
entityName: entity_12345

Required Vault Capabilities

Use of this resource requires the update capability on /identity/lookup/entity.

Return

A collection of values returned by getEntity.

Parameters

argument

A collection of arguments for invoking getEntity.


suspend fun getEntity(aliasId: String? = null, aliasMountAccessor: String? = null, aliasName: String? = null, entityId: String? = null, entityName: String? = null, namespace: String? = null): GetEntityResult

Return

A collection of values returned by getEntity.

Parameters

aliasId

ID of the alias.

aliasMountAccessor

Accessor of the mount to which the alias belongs to. This should be supplied in conjunction with alias_name. The lookup criteria can be entity_name, entity_id, alias_id, or a combination of alias_name and alias_mount_accessor.

aliasName

Name of the alias. This should be supplied in conjunction with alias_mount_accessor.

entityId

ID of the entity.

entityName

Name of the entity.

namespace

The namespace of the target resource. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

See also


suspend fun getEntity(argument: suspend GetEntityPlainArgsBuilder.() -> Unit): GetEntityResult

Return

A collection of values returned by getEntity.

Parameters

argument

Builder for com.pulumi.vault.identity.kotlin.inputs.GetEntityPlainArgs.

See also