Class VappEntity

Inheritance

System.Object

Resource

CustomResource

VappEntity

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.VSphere

Assembly: Pulumi.VSphere.dll

Syntax

public class VappEntity : CustomResource

Constructors

VappEntity(String, VappEntityArgs, CustomResourceOptions)

Create a VappEntity resource with the given unique name, arguments, and options.

Declaration

public VappEntity(string name, VappEntityArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
VappEntityArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ContainerId

Managed object ID of the vApp container the entity is a member of.

Declaration

public Output<string> ContainerId { get; }

Property Value

Type	Description
Output<System.String>

CustomAttributes

A list of custom attributes to set on this resource.

Declaration

public Output<ImmutableDictionary<string, string>> CustomAttributes { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

StartAction

How to start the entity. Valid settings are none or powerOn. If set to none, then the entity does not participate in auto-start. Default: powerOn

Declaration

public Output<string> StartAction { get; }

Property Value

Type	Description
Output<System.String>

StartDelay

Delay in seconds before continuing with the next entity in the order of entities to be started. Default: 120

Declaration

public Output<int?> StartDelay { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

StartOrder

Order to start and stop target in vApp. Default: 1

Declaration

public Output<int?> StartOrder { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

StopAction

Defines the stop action for the entity. Can be set to none, powerOff, guestShutdown, or suspend. If set to none, then the entity does not participate in auto-stop. Default: powerOff

Declaration

public Output<string> StopAction { get; }

Property Value

Type	Description
Output<System.String>

StopDelay

Delay in seconds before continuing with the next entity in the order sequence. This is only used if the stopAction is guestShutdown. Default: 120

Declaration

public Output<int?> StopDelay { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

Tags

A list of tag IDs to apply to this object.

Declaration

public Output<ImmutableArray<string>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

TargetId

Managed object ID of the entity to power on or power off. This can be a virtual machine or a vApp.

Declaration

public Output<string> TargetId { get; }

Property Value

Type	Description
Output<System.String>

WaitForGuest

Determines if the VM should be marked as being started when VMware Tools are ready instead of waiting for start_delay. This property has no effect for vApps. Default: false

Declaration

public Output<bool?> WaitForGuest { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Methods

Get(String, Input<String>, VappEntityState, CustomResourceOptions)

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

Declaration

public static VappEntity Get(string name, Input<string> id, VappEntityState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
VappEntityState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
VappEntity