Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vsphere Provider
  3. API Docs
  4. EntityPermissions
vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-vsphere

vsphere.EntityPermissions

Explore with Pulumi AI

vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-vsphere

Create EntityPermissions Resource

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

Constructor syntax

new EntityPermissions(name: string, args: EntityPermissionsArgs, opts?: CustomResourceOptions);
@overload
def EntityPermissions(resource_name: str,
                      args: EntityPermissionsArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def EntityPermissions(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      entity_id: Optional[str] = None,
                      entity_type: Optional[str] = None,
                      permissions: Optional[Sequence[EntityPermissionsPermissionArgs]] = None)
func NewEntityPermissions(ctx *Context, name string, args EntityPermissionsArgs, opts ...ResourceOption) (*EntityPermissions, error)
public EntityPermissions(string name, EntityPermissionsArgs args, CustomResourceOptions? opts = null)
public EntityPermissions(String name, EntityPermissionsArgs args)
public EntityPermissions(String name, EntityPermissionsArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. EntityPermissionsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. EntityPermissionsArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. EntityPermissionsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. EntityPermissionsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. EntityPermissionsArgs
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 entityPermissionsResource = new VSphere.EntityPermissions("entityPermissionsResource", new()
{
    EntityId = "string",
    EntityType = "string",
    Permissions = new[]
    {
        new VSphere.Inputs.EntityPermissionsPermissionArgs
        {
            IsGroup = false,
            Propagate = false,
            RoleId = "string",
            UserOrGroup = "string",
        },
    },
});
Copy
example, err := vsphere.NewEntityPermissions(ctx, "entityPermissionsResource", &vsphere.EntityPermissionsArgs{
	EntityId:   pulumi.String("string"),
	EntityType: pulumi.String("string"),
	Permissions: vsphere.EntityPermissionsPermissionArray{
		&vsphere.EntityPermissionsPermissionArgs{
			IsGroup:     pulumi.Bool(false),
			Propagate:   pulumi.Bool(false),
			RoleId:      pulumi.String("string"),
			UserOrGroup: pulumi.String("string"),
		},
	},
})
Copy
var entityPermissionsResource = new EntityPermissions("entityPermissionsResource", EntityPermissionsArgs.builder()
    .entityId("string")
    .entityType("string")
    .permissions(EntityPermissionsPermissionArgs.builder()
        .isGroup(false)
        .propagate(false)
        .roleId("string")
        .userOrGroup("string")
        .build())
    .build());
Copy
entity_permissions_resource = vsphere.EntityPermissions("entityPermissionsResource",
    entity_id="string",
    entity_type="string",
    permissions=[{
        "is_group": False,
        "propagate": False,
        "role_id": "string",
        "user_or_group": "string",
    }])
Copy
const entityPermissionsResource = new vsphere.EntityPermissions("entityPermissionsResource", {
    entityId: "string",
    entityType: "string",
    permissions: [{
        isGroup: false,
        propagate: false,
        roleId: "string",
        userOrGroup: "string",
    }],
});
Copy
type: vsphere:EntityPermissions
properties:
    entityId: string
    entityType: string
    permissions:
        - isGroup: false
          propagate: false
          roleId: string
          userOrGroup: string
Copy

EntityPermissions 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 EntityPermissions resource accepts the following input properties:

EntityId This property is required. string
The managed object id (uuid for some entities) on which permissions are to be created.
EntityType This property is required. string
The managed object type, types can be found in the managed object type section here.
Permissions This property is required. List<Pulumi.VSphere.Inputs.EntityPermissionsPermission>
The permissions to be given on this entity. Keep the permissions sorted alphabetically on user_or_group for a better user experience.
EntityId This property is required. string
The managed object id (uuid for some entities) on which permissions are to be created.
EntityType This property is required. string
The managed object type, types can be found in the managed object type section here.
Permissions This property is required. []EntityPermissionsPermissionArgs
The permissions to be given on this entity. Keep the permissions sorted alphabetically on user_or_group for a better user experience.
entityId This property is required. String
The managed object id (uuid for some entities) on which permissions are to be created.
entityType This property is required. String
The managed object type, types can be found in the managed object type section here.
permissions This property is required. List<EntityPermissionsPermission>
The permissions to be given on this entity. Keep the permissions sorted alphabetically on user_or_group for a better user experience.
entityId This property is required. string
The managed object id (uuid for some entities) on which permissions are to be created.
entityType This property is required. string
The managed object type, types can be found in the managed object type section here.
permissions This property is required. EntityPermissionsPermission[]
The permissions to be given on this entity. Keep the permissions sorted alphabetically on user_or_group for a better user experience.
entity_id This property is required. str
The managed object id (uuid for some entities) on which permissions are to be created.
entity_type This property is required. str
The managed object type, types can be found in the managed object type section here.
permissions This property is required. Sequence[EntityPermissionsPermissionArgs]
The permissions to be given on this entity. Keep the permissions sorted alphabetically on user_or_group for a better user experience.
entityId This property is required. String
The managed object id (uuid for some entities) on which permissions are to be created.
entityType This property is required. String
The managed object type, types can be found in the managed object type section here.
permissions This property is required. List<Property Map>
The permissions to be given on this entity. Keep the permissions sorted alphabetically on user_or_group for a better user experience.

Outputs

All input properties are implicitly available as output properties. Additionally, the EntityPermissions 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 EntityPermissions Resource

Get an existing EntityPermissions 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?: EntityPermissionsState, opts?: CustomResourceOptions): EntityPermissions
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        entity_id: Optional[str] = None,
        entity_type: Optional[str] = None,
        permissions: Optional[Sequence[EntityPermissionsPermissionArgs]] = None) -> EntityPermissions
func GetEntityPermissions(ctx *Context, name string, id IDInput, state *EntityPermissionsState, opts ...ResourceOption) (*EntityPermissions, error)
public static EntityPermissions Get(string name, Input<string> id, EntityPermissionsState? state, CustomResourceOptions? opts = null)
public static EntityPermissions get(String name, Output<String> id, EntityPermissionsState state, CustomResourceOptions options)
resources:  _:    type: vsphere:EntityPermissions    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
EntityId string
The managed object id (uuid for some entities) on which permissions are to be created.
EntityType string
The managed object type, types can be found in the managed object type section here.
Permissions List<Pulumi.VSphere.Inputs.EntityPermissionsPermission>
The permissions to be given on this entity. Keep the permissions sorted alphabetically on user_or_group for a better user experience.
EntityId string
The managed object id (uuid for some entities) on which permissions are to be created.
EntityType string
The managed object type, types can be found in the managed object type section here.
Permissions []EntityPermissionsPermissionArgs
The permissions to be given on this entity. Keep the permissions sorted alphabetically on user_or_group for a better user experience.
entityId String
The managed object id (uuid for some entities) on which permissions are to be created.
entityType String
The managed object type, types can be found in the managed object type section here.
permissions List<EntityPermissionsPermission>
The permissions to be given on this entity. Keep the permissions sorted alphabetically on user_or_group for a better user experience.
entityId string
The managed object id (uuid for some entities) on which permissions are to be created.
entityType string
The managed object type, types can be found in the managed object type section here.
permissions EntityPermissionsPermission[]
The permissions to be given on this entity. Keep the permissions sorted alphabetically on user_or_group for a better user experience.
entity_id str
The managed object id (uuid for some entities) on which permissions are to be created.
entity_type str
The managed object type, types can be found in the managed object type section here.
permissions Sequence[EntityPermissionsPermissionArgs]
The permissions to be given on this entity. Keep the permissions sorted alphabetically on user_or_group for a better user experience.
entityId String
The managed object id (uuid for some entities) on which permissions are to be created.
entityType String
The managed object type, types can be found in the managed object type section here.
permissions List<Property Map>
The permissions to be given on this entity. Keep the permissions sorted alphabetically on user_or_group for a better user experience.

Supporting Types

EntityPermissionsPermission
, EntityPermissionsPermissionArgs

IsGroup This property is required. bool
Whether user_or_group field refers to a user or a group. True for a group and false for a user.
Propagate This property is required. bool
Whether or not this permission propagates down the hierarchy to sub-entities.
RoleId This property is required. string
The role id of the role to be given to the user on the specified entity.
UserOrGroup This property is required. string
The user/group getting the permission.
IsGroup This property is required. bool
Whether user_or_group field refers to a user or a group. True for a group and false for a user.
Propagate This property is required. bool
Whether or not this permission propagates down the hierarchy to sub-entities.
RoleId This property is required. string
The role id of the role to be given to the user on the specified entity.
UserOrGroup This property is required. string
The user/group getting the permission.
isGroup This property is required. Boolean
Whether user_or_group field refers to a user or a group. True for a group and false for a user.
propagate This property is required. Boolean
Whether or not this permission propagates down the hierarchy to sub-entities.
roleId This property is required. String
The role id of the role to be given to the user on the specified entity.
userOrGroup This property is required. String
The user/group getting the permission.
isGroup This property is required. boolean
Whether user_or_group field refers to a user or a group. True for a group and false for a user.
propagate This property is required. boolean
Whether or not this permission propagates down the hierarchy to sub-entities.
roleId This property is required. string
The role id of the role to be given to the user on the specified entity.
userOrGroup This property is required. string
The user/group getting the permission.
is_group This property is required. bool
Whether user_or_group field refers to a user or a group. True for a group and false for a user.
propagate This property is required. bool
Whether or not this permission propagates down the hierarchy to sub-entities.
role_id This property is required. str
The role id of the role to be given to the user on the specified entity.
user_or_group This property is required. str
The user/group getting the permission.
isGroup This property is required. Boolean
Whether user_or_group field refers to a user or a group. True for a group and false for a user.
propagate This property is required. Boolean
Whether or not this permission propagates down the hierarchy to sub-entities.
roleId This property is required. String
The role id of the role to be given to the user on the specified entity.
userOrGroup This property is required. String
The user/group getting the permission.

Package Details

Repository
vSphere pulumi/pulumi-vsphere
License
Apache-2.0
Notes
This Pulumi package is based on the vsphere Terraform Provider.
vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-vsphere