Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Prefect Provider
  3. API Docs
  4. getServiceAccount
prefect 2.22.4 published on Wednesday, Mar 26, 2025 by prefecthq
prefecthq/terraform-provider-prefect

prefect.getServiceAccount

Explore with Pulumi AI

prefect logo
prefect 2.22.4 published on Wednesday, Mar 26, 2025 by prefecthq
prefecthq/terraform-provider-prefect

    Get information about an existing Service Account, by name or ID.
    Use this data source to obtain service account-level attributes, such as ID.
    For more information, see manage service accounts.

    This feature is available in the following product plan(s): Prefect Cloud (Pro), Prefect Cloud (Enterprise).

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as prefect from "@pulumi/prefect";

const bot = prefect.getServiceAccount({
    name: "my-bot-name",
});

    import pulumi
import pulumi_prefect as prefect

bot = prefect.get_service_account(name="my-bot-name")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/prefect/v2/prefect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := prefect.LookupServiceAccount(ctx, &prefect.LookupServiceAccountArgs{
			Name: pulumi.StringRef("my-bot-name"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Prefect = Pulumi.Prefect;

return await Deployment.RunAsync(() => 
{
    var bot = Prefect.GetServiceAccount.Invoke(new()
    {
        Name = "my-bot-name",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.prefect.PrefectFunctions;
import com.pulumi.prefect.inputs.GetServiceAccountArgs;
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 bot = PrefectFunctions.getServiceAccount(GetServiceAccountArgs.builder()
            .name("my-bot-name")
            .build());

    }
}

    variables:
  bot:
    fn::invoke:
      function: prefect:getServiceAccount
      arguments:
        name: my-bot-name

    Using getServiceAccount

    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 getServiceAccount(args: GetServiceAccountArgs, opts?: InvokeOptions): Promise<GetServiceAccountResult>
function getServiceAccountOutput(args: GetServiceAccountOutputArgs, opts?: InvokeOptions): Output<GetServiceAccountResult>
    def get_service_account(account_id: Optional[str] = None,
                        id: Optional[str] = None,
                        name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetServiceAccountResult
def get_service_account_output(account_id: Optional[pulumi.Input[str]] = None,
                        id: Optional[pulumi.Input[str]] = None,
                        name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetServiceAccountResult]
    func LookupServiceAccount(ctx *Context, args *LookupServiceAccountArgs, opts ...InvokeOption) (*LookupServiceAccountResult, error)
func LookupServiceAccountOutput(ctx *Context, args *LookupServiceAccountOutputArgs, opts ...InvokeOption) LookupServiceAccountResultOutput

    > Note: This function is named LookupServiceAccount in the Go SDK.

    public static class GetServiceAccount 
{
    public static Task<GetServiceAccountResult> InvokeAsync(GetServiceAccountArgs args, InvokeOptions? opts = null)
    public static Output<GetServiceAccountResult> Invoke(GetServiceAccountInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetServiceAccountResult> getServiceAccount(GetServiceAccountArgs args, InvokeOptions options)
public static Output<GetServiceAccountResult> getServiceAccount(GetServiceAccountArgs args, InvokeOptions options)

    fn::invoke:
  function: prefect:index/getServiceAccount:getServiceAccount
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AccountId string
    Account ID (UUID), defaults to the account set in the provider
    Id string
    Service Account ID (UUID)
    Name string
    Name of the service account
    AccountId string
    Account ID (UUID), defaults to the account set in the provider
    Id string
    Service Account ID (UUID)
    Name string
    Name of the service account
    accountId String
    Account ID (UUID), defaults to the account set in the provider
    id String
    Service Account ID (UUID)
    name String
    Name of the service account
    accountId string
    Account ID (UUID), defaults to the account set in the provider
    id string
    Service Account ID (UUID)
    name string
    Name of the service account
    account_id str
    Account ID (UUID), defaults to the account set in the provider
    id str
    Service Account ID (UUID)
    name str
    Name of the service account
    accountId String
    Account ID (UUID), defaults to the account set in the provider
    id String
    Service Account ID (UUID)
    name String
    Name of the service account

    getServiceAccount Result

    The following output properties are available:

    AccountRoleName string
    Account Role name of the service account
    ActorId string
    Actor ID (UUID), used for granting access to resources like Blocks and Deployments
    ApiKey string
    API Key associated with the service account
    ApiKeyCreated string
    Date and time that the API Key was created in RFC 3339 format
    ApiKeyExpiration string
    Date and time that the API Key expires in RFC 3339 format
    ApiKeyId string
    API Key ID associated with the service account. NOTE: this is always null for reads. If you need the API Key ID, use the prefect.ServiceAccount resource instead.
    ApiKeyName string
    API Key Name associated with the service account
    Created string
    Timestamp of when the resource was created (RFC3339)
    Id string
    Service Account ID (UUID)
    Name string
    Name of the service account
    Updated string
    Timestamp of when the resource was updated (RFC3339)
    AccountId string
    Account ID (UUID), defaults to the account set in the provider
    AccountRoleName string
    Account Role name of the service account
    ActorId string
    Actor ID (UUID), used for granting access to resources like Blocks and Deployments
    ApiKey string
    API Key associated with the service account
    ApiKeyCreated string
    Date and time that the API Key was created in RFC 3339 format
    ApiKeyExpiration string
    Date and time that the API Key expires in RFC 3339 format
    ApiKeyId string
    API Key ID associated with the service account. NOTE: this is always null for reads. If you need the API Key ID, use the prefect.ServiceAccount resource instead.
    ApiKeyName string
    API Key Name associated with the service account
    Created string
    Timestamp of when the resource was created (RFC3339)
    Id string
    Service Account ID (UUID)
    Name string
    Name of the service account
    Updated string
    Timestamp of when the resource was updated (RFC3339)
    AccountId string
    Account ID (UUID), defaults to the account set in the provider
    accountRoleName String
    Account Role name of the service account
    actorId String
    Actor ID (UUID), used for granting access to resources like Blocks and Deployments
    apiKey String
    API Key associated with the service account
    apiKeyCreated String
    Date and time that the API Key was created in RFC 3339 format
    apiKeyExpiration String
    Date and time that the API Key expires in RFC 3339 format
    apiKeyId String
    API Key ID associated with the service account. NOTE: this is always null for reads. If you need the API Key ID, use the prefect.ServiceAccount resource instead.
    apiKeyName String
    API Key Name associated with the service account
    created String
    Timestamp of when the resource was created (RFC3339)
    id String
    Service Account ID (UUID)
    name String
    Name of the service account
    updated String
    Timestamp of when the resource was updated (RFC3339)
    accountId String
    Account ID (UUID), defaults to the account set in the provider
    accountRoleName string
    Account Role name of the service account
    actorId string
    Actor ID (UUID), used for granting access to resources like Blocks and Deployments
    apiKey string
    API Key associated with the service account
    apiKeyCreated string
    Date and time that the API Key was created in RFC 3339 format
    apiKeyExpiration string
    Date and time that the API Key expires in RFC 3339 format
    apiKeyId string
    API Key ID associated with the service account. NOTE: this is always null for reads. If you need the API Key ID, use the prefect.ServiceAccount resource instead.
    apiKeyName string
    API Key Name associated with the service account
    created string
    Timestamp of when the resource was created (RFC3339)
    id string
    Service Account ID (UUID)
    name string
    Name of the service account
    updated string
    Timestamp of when the resource was updated (RFC3339)
    accountId string
    Account ID (UUID), defaults to the account set in the provider
    account_role_name str
    Account Role name of the service account
    actor_id str
    Actor ID (UUID), used for granting access to resources like Blocks and Deployments
    api_key str
    API Key associated with the service account
    api_key_created str
    Date and time that the API Key was created in RFC 3339 format
    api_key_expiration str
    Date and time that the API Key expires in RFC 3339 format
    api_key_id str
    API Key ID associated with the service account. NOTE: this is always null for reads. If you need the API Key ID, use the prefect.ServiceAccount resource instead.
    api_key_name str
    API Key Name associated with the service account
    created str
    Timestamp of when the resource was created (RFC3339)
    id str
    Service Account ID (UUID)
    name str
    Name of the service account
    updated str
    Timestamp of when the resource was updated (RFC3339)
    account_id str
    Account ID (UUID), defaults to the account set in the provider
    accountRoleName String
    Account Role name of the service account
    actorId String
    Actor ID (UUID), used for granting access to resources like Blocks and Deployments
    apiKey String
    API Key associated with the service account
    apiKeyCreated String
    Date and time that the API Key was created in RFC 3339 format
    apiKeyExpiration String
    Date and time that the API Key expires in RFC 3339 format
    apiKeyId String
    API Key ID associated with the service account. NOTE: this is always null for reads. If you need the API Key ID, use the prefect.ServiceAccount resource instead.
    apiKeyName String
    API Key Name associated with the service account
    created String
    Timestamp of when the resource was created (RFC3339)
    id String
    Service Account ID (UUID)
    name String
    Name of the service account
    updated String
    Timestamp of when the resource was updated (RFC3339)
    accountId String
    Account ID (UUID), defaults to the account set in the provider

    Package Details

    Repository
    prefect prefecthq/terraform-provider-prefect
    License
    Notes
    This Pulumi package is based on the prefect Terraform Provider.
    prefect logo
    prefect 2.22.4 published on Wednesday, Mar 26, 2025 by prefecthq
    prefecthq/terraform-provider-prefect