vcd 3.14.1, Apr 14 25

vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

vcd.ServiceAccount

Explore with Pulumi AI

vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

Create ServiceAccount Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ServiceAccount(name: string, args: ServiceAccountArgs, opts?: CustomResourceOptions);

@overload
def ServiceAccount(resource_name: str,
                   args: ServiceAccountArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def ServiceAccount(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   role_id: Optional[str] = None,
                   software_id: Optional[str] = None,
                   active: Optional[bool] = None,
                   allow_token_file: Optional[bool] = None,
                   file_name: Optional[str] = None,
                   name: Optional[str] = None,
                   org: Optional[str] = None,
                   service_account_id: Optional[str] = None,
                   software_version: Optional[str] = None,
                   uri: Optional[str] = None)

func NewServiceAccount(ctx *Context, name string, args ServiceAccountArgs, opts ...ResourceOption) (*ServiceAccount, error)

public ServiceAccount(string name, ServiceAccountArgs args, CustomResourceOptions? opts = null)

public ServiceAccount(String name, ServiceAccountArgs args)
public ServiceAccount(String name, ServiceAccountArgs args, CustomResourceOptions options)

type: vcd:ServiceAccount
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args ServiceAccountArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ServiceAccountArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ServiceAccountArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ServiceAccountArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ServiceAccountArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var serviceAccountResource = new Vcd.ServiceAccount("serviceAccountResource", new()
{
    RoleId = "string",
    SoftwareId = "string",
    Active = false,
    AllowTokenFile = false,
    FileName = "string",
    Name = "string",
    Org = "string",
    ServiceAccountId = "string",
    SoftwareVersion = "string",
    Uri = "string",
});

example, err := vcd.NewServiceAccount(ctx, "serviceAccountResource", &vcd.ServiceAccountArgs{
	RoleId:           pulumi.String("string"),
	SoftwareId:       pulumi.String("string"),
	Active:           pulumi.Bool(false),
	AllowTokenFile:   pulumi.Bool(false),
	FileName:         pulumi.String("string"),
	Name:             pulumi.String("string"),
	Org:              pulumi.String("string"),
	ServiceAccountId: pulumi.String("string"),
	SoftwareVersion:  pulumi.String("string"),
	Uri:              pulumi.String("string"),
})

var serviceAccountResource = new ServiceAccount("serviceAccountResource", ServiceAccountArgs.builder()
    .roleId("string")
    .softwareId("string")
    .active(false)
    .allowTokenFile(false)
    .fileName("string")
    .name("string")
    .org("string")
    .serviceAccountId("string")
    .softwareVersion("string")
    .uri("string")
    .build());

service_account_resource = vcd.ServiceAccount("serviceAccountResource",
    role_id="string",
    software_id="string",
    active=False,
    allow_token_file=False,
    file_name="string",
    name="string",
    org="string",
    service_account_id="string",
    software_version="string",
    uri="string")

const serviceAccountResource = new vcd.ServiceAccount("serviceAccountResource", {
    roleId: "string",
    softwareId: "string",
    active: false,
    allowTokenFile: false,
    fileName: "string",
    name: "string",
    org: "string",
    serviceAccountId: "string",
    softwareVersion: "string",
    uri: "string",
});

type: vcd:ServiceAccount
properties:
    active: false
    allowTokenFile: false
    fileName: string
    name: string
    org: string
    roleId: string
    serviceAccountId: string
    softwareId: string
    softwareVersion: string
    uri: string

ServiceAccount Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ServiceAccount resource accepts the following input properties:

RoleId string: Role ID of service account
SoftwareId string: UUID of the Service Account.
Active bool: Status of the Service Account. Can be set to false and back to true if the access token was lost to get a new one.
AllowTokenFile bool: If set to false, will output a warning about the service account file containing sensitive information.
FileName string: Required only when active is set to true. Contains the access token that can be used for authenticating to VCD.
Name string: A unique name for the Service Account in an organisation.
Org string: The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
ServiceAccountId string
SoftwareVersion string: Version of the service using the Service Account
Uri string: URI of the service using the Service Account

RoleId string: Role ID of service account
SoftwareId string: UUID of the Service Account.
Active bool: Status of the Service Account. Can be set to false and back to true if the access token was lost to get a new one.
AllowTokenFile bool: If set to false, will output a warning about the service account file containing sensitive information.
FileName string: Required only when active is set to true. Contains the access token that can be used for authenticating to VCD.
Name string: A unique name for the Service Account in an organisation.
Org string: The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
ServiceAccountId string
SoftwareVersion string: Version of the service using the Service Account
Uri string: URI of the service using the Service Account

roleId String: Role ID of service account
softwareId String: UUID of the Service Account.
active Boolean: Status of the Service Account. Can be set to false and back to true if the access token was lost to get a new one.
allowTokenFile Boolean: If set to false, will output a warning about the service account file containing sensitive information.
fileName String: Required only when active is set to true. Contains the access token that can be used for authenticating to VCD.
name String: A unique name for the Service Account in an organisation.
org String: The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
serviceAccountId String
softwareVersion String: Version of the service using the Service Account
uri String: URI of the service using the Service Account

roleId string: Role ID of service account
softwareId string: UUID of the Service Account.
active boolean: Status of the Service Account. Can be set to false and back to true if the access token was lost to get a new one.
allowTokenFile boolean: If set to false, will output a warning about the service account file containing sensitive information.
fileName string: Required only when active is set to true. Contains the access token that can be used for authenticating to VCD.
name string: A unique name for the Service Account in an organisation.
org string: The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
serviceAccountId string
softwareVersion string: Version of the service using the Service Account
uri string: URI of the service using the Service Account

role_id str: Role ID of service account
software_id str: UUID of the Service Account.
active bool: Status of the Service Account. Can be set to false and back to true if the access token was lost to get a new one.
allow_token_file bool: If set to false, will output a warning about the service account file containing sensitive information.
file_name str: Required only when active is set to true. Contains the access token that can be used for authenticating to VCD.
name str: A unique name for the Service Account in an organisation.
org str: The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
service_account_id str
software_version str: Version of the service using the Service Account
uri str: URI of the service using the Service Account

roleId String: Role ID of service account
softwareId String: UUID of the Service Account.
active Boolean: Status of the Service Account. Can be set to false and back to true if the access token was lost to get a new one.
allowTokenFile Boolean: If set to false, will output a warning about the service account file containing sensitive information.
fileName String: Required only when active is set to true. Contains the access token that can be used for authenticating to VCD.
name String: A unique name for the Service Account in an organisation.
org String: The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
serviceAccountId String
softwareVersion String: Version of the service using the Service Account
uri String: URI of the service using the Service Account

Outputs

All input properties are implicitly available as output properties. Additionally, the ServiceAccount resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing ServiceAccount Resource

Get an existing ServiceAccount resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ServiceAccountState, opts?: CustomResourceOptions): ServiceAccount

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        allow_token_file: Optional[bool] = None,
        file_name: Optional[str] = None,
        name: Optional[str] = None,
        org: Optional[str] = None,
        role_id: Optional[str] = None,
        service_account_id: Optional[str] = None,
        software_id: Optional[str] = None,
        software_version: Optional[str] = None,
        uri: Optional[str] = None) -> ServiceAccount

func GetServiceAccount(ctx *Context, name string, id IDInput, state *ServiceAccountState, opts ...ResourceOption) (*ServiceAccount, error)

public static ServiceAccount Get(string name, Input<string> id, ServiceAccountState? state, CustomResourceOptions? opts = null)

public static ServiceAccount get(String name, Output<String> id, ServiceAccountState state, CustomResourceOptions options)

resources:  _:    type: vcd:ServiceAccount    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Active bool: Status of the Service Account. Can be set to false and back to true if the access token was lost to get a new one.
AllowTokenFile bool: If set to false, will output a warning about the service account file containing sensitive information.
FileName string: Required only when active is set to true. Contains the access token that can be used for authenticating to VCD.
Name string: A unique name for the Service Account in an organisation.
Org string: The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
RoleId string: Role ID of service account
ServiceAccountId string
SoftwareId string: UUID of the Service Account.
SoftwareVersion string: Version of the service using the Service Account
Uri string: URI of the service using the Service Account

Active bool: Status of the Service Account. Can be set to false and back to true if the access token was lost to get a new one.
AllowTokenFile bool: If set to false, will output a warning about the service account file containing sensitive information.
FileName string: Required only when active is set to true. Contains the access token that can be used for authenticating to VCD.
Name string: A unique name for the Service Account in an organisation.
Org string: The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
RoleId string: Role ID of service account
ServiceAccountId string
SoftwareId string: UUID of the Service Account.
SoftwareVersion string: Version of the service using the Service Account
Uri string: URI of the service using the Service Account

active Boolean: Status of the Service Account. Can be set to false and back to true if the access token was lost to get a new one.
allowTokenFile Boolean: If set to false, will output a warning about the service account file containing sensitive information.
fileName String: Required only when active is set to true. Contains the access token that can be used for authenticating to VCD.
name String: A unique name for the Service Account in an organisation.
org String: The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
roleId String: Role ID of service account
serviceAccountId String
softwareId String: UUID of the Service Account.
softwareVersion String: Version of the service using the Service Account
uri String: URI of the service using the Service Account

active boolean: Status of the Service Account. Can be set to false and back to true if the access token was lost to get a new one.
allowTokenFile boolean: If set to false, will output a warning about the service account file containing sensitive information.
fileName string: Required only when active is set to true. Contains the access token that can be used for authenticating to VCD.
name string: A unique name for the Service Account in an organisation.
org string: The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
roleId string: Role ID of service account
serviceAccountId string
softwareId string: UUID of the Service Account.
softwareVersion string: Version of the service using the Service Account
uri string: URI of the service using the Service Account

active bool: Status of the Service Account. Can be set to false and back to true if the access token was lost to get a new one.
allow_token_file bool: If set to false, will output a warning about the service account file containing sensitive information.
file_name str: Required only when active is set to true. Contains the access token that can be used for authenticating to VCD.
name str: A unique name for the Service Account in an organisation.
org str: The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
role_id str: Role ID of service account
service_account_id str
software_id str: UUID of the Service Account.
software_version str: Version of the service using the Service Account
uri str: URI of the service using the Service Account

active Boolean: Status of the Service Account. Can be set to false and back to true if the access token was lost to get a new one.
allowTokenFile Boolean: If set to false, will output a warning about the service account file containing sensitive information.
fileName String: Required only when active is set to true. Contains the access token that can be used for authenticating to VCD.
name String: A unique name for the Service Account in an organisation.
org String: The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
roleId String: Role ID of service account
serviceAccountId String
softwareId String: UUID of the Service Account.
softwareVersion String: Version of the service using the Service Account
uri String: URI of the service using the Service Account

Package Details

Repository: vcd vmware/terraform-provider-vcd
License
Notes: This Pulumi package is based on the vcd Terraform Provider.

vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

vmware/terraform-provider-vcd

vcd.ServiceAccount

On this page

On this page

Create ServiceAccount Resource

Constructor syntax

Parameters

Constructor example

ServiceAccount Resource Properties

Inputs

Outputs

Look up Existing ServiceAccount Resource

Package Details

On this page

On this page