1. Packages
  2. Nsxt Provider
  3. API Docs
  4. PolicyUserManagementRole
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware

nsxt.PolicyUserManagementRole

Explore with Pulumi AI

Create PolicyUserManagementRole Resource

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

Constructor syntax

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

@overload
def PolicyUserManagementRole(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             features: Optional[Sequence[PolicyUserManagementRoleFeatureArgs]] = None,
                             role: Optional[str] = None,
                             description: Optional[str] = None,
                             display_name: Optional[str] = None,
                             policy_user_management_role_id: Optional[str] = None,
                             tags: Optional[Sequence[PolicyUserManagementRoleTagArgs]] = None)
func NewPolicyUserManagementRole(ctx *Context, name string, args PolicyUserManagementRoleArgs, opts ...ResourceOption) (*PolicyUserManagementRole, error)
public PolicyUserManagementRole(string name, PolicyUserManagementRoleArgs args, CustomResourceOptions? opts = null)
public PolicyUserManagementRole(String name, PolicyUserManagementRoleArgs args)
public PolicyUserManagementRole(String name, PolicyUserManagementRoleArgs args, CustomResourceOptions options)
type: nsxt:PolicyUserManagementRole
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. PolicyUserManagementRoleArgs
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. PolicyUserManagementRoleArgs
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. PolicyUserManagementRoleArgs
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. PolicyUserManagementRoleArgs
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. PolicyUserManagementRoleArgs
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 policyUserManagementRoleResource = new Nsxt.PolicyUserManagementRole("policyUserManagementRoleResource", new()
{
    Features = new[]
    {
        new Nsxt.Inputs.PolicyUserManagementRoleFeatureArgs
        {
            Feature = "string",
            Permission = "string",
            FeatureDescription = "string",
            FeatureName = "string",
        },
    },
    Role = "string",
    Description = "string",
    DisplayName = "string",
    PolicyUserManagementRoleId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyUserManagementRoleTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});
Copy
example, err := nsxt.NewPolicyUserManagementRole(ctx, "policyUserManagementRoleResource", &nsxt.PolicyUserManagementRoleArgs{
Features: .PolicyUserManagementRoleFeatureArray{
&.PolicyUserManagementRoleFeatureArgs{
Feature: pulumi.String("string"),
Permission: pulumi.String("string"),
FeatureDescription: pulumi.String("string"),
FeatureName: pulumi.String("string"),
},
},
Role: pulumi.String("string"),
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
PolicyUserManagementRoleId: pulumi.String("string"),
Tags: .PolicyUserManagementRoleTagArray{
&.PolicyUserManagementRoleTagArgs{
Scope: pulumi.String("string"),
Tag: pulumi.String("string"),
},
},
})
Copy
var policyUserManagementRoleResource = new PolicyUserManagementRole("policyUserManagementRoleResource", PolicyUserManagementRoleArgs.builder()
    .features(PolicyUserManagementRoleFeatureArgs.builder()
        .feature("string")
        .permission("string")
        .featureDescription("string")
        .featureName("string")
        .build())
    .role("string")
    .description("string")
    .displayName("string")
    .policyUserManagementRoleId("string")
    .tags(PolicyUserManagementRoleTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());
Copy
policy_user_management_role_resource = nsxt.PolicyUserManagementRole("policyUserManagementRoleResource",
    features=[{
        "feature": "string",
        "permission": "string",
        "feature_description": "string",
        "feature_name": "string",
    }],
    role="string",
    description="string",
    display_name="string",
    policy_user_management_role_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])
Copy
const policyUserManagementRoleResource = new nsxt.PolicyUserManagementRole("policyUserManagementRoleResource", {
    features: [{
        feature: "string",
        permission: "string",
        featureDescription: "string",
        featureName: "string",
    }],
    role: "string",
    description: "string",
    displayName: "string",
    policyUserManagementRoleId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});
Copy
type: nsxt:PolicyUserManagementRole
properties:
    description: string
    displayName: string
    features:
        - feature: string
          featureDescription: string
          featureName: string
          permission: string
    policyUserManagementRoleId: string
    role: string
    tags:
        - scope: string
          tag: string
Copy

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

Features This property is required. List<PolicyUserManagementRoleFeature>
A list of permissions for features to be granted with this role.
Role This property is required. string
Short identifier for the role. Must be all lower case with no spaces. This will also be the NSX ID of this resource.
Description string
Description of the resource.
DisplayName string
Display name of the resource.
PolicyUserManagementRoleId string
ID of the resource.
Tags List<PolicyUserManagementRoleTag>
A list of scope + tag pairs to associate with this resource.
Features This property is required. []PolicyUserManagementRoleFeatureArgs
A list of permissions for features to be granted with this role.
Role This property is required. string
Short identifier for the role. Must be all lower case with no spaces. This will also be the NSX ID of this resource.
Description string
Description of the resource.
DisplayName string
Display name of the resource.
PolicyUserManagementRoleId string
ID of the resource.
Tags []PolicyUserManagementRoleTagArgs
A list of scope + tag pairs to associate with this resource.
features This property is required. List<PolicyUserManagementRoleFeature>
A list of permissions for features to be granted with this role.
role This property is required. String
Short identifier for the role. Must be all lower case with no spaces. This will also be the NSX ID of this resource.
description String
Description of the resource.
displayName String
Display name of the resource.
policyUserManagementRoleId String
ID of the resource.
tags List<PolicyUserManagementRoleTag>
A list of scope + tag pairs to associate with this resource.
features This property is required. PolicyUserManagementRoleFeature[]
A list of permissions for features to be granted with this role.
role This property is required. string
Short identifier for the role. Must be all lower case with no spaces. This will also be the NSX ID of this resource.
description string
Description of the resource.
displayName string
Display name of the resource.
policyUserManagementRoleId string
ID of the resource.
tags PolicyUserManagementRoleTag[]
A list of scope + tag pairs to associate with this resource.
features This property is required. Sequence[PolicyUserManagementRoleFeatureArgs]
A list of permissions for features to be granted with this role.
role This property is required. str
Short identifier for the role. Must be all lower case with no spaces. This will also be the NSX ID of this resource.
description str
Description of the resource.
display_name str
Display name of the resource.
policy_user_management_role_id str
ID of the resource.
tags Sequence[PolicyUserManagementRoleTagArgs]
A list of scope + tag pairs to associate with this resource.
features This property is required. List<Property Map>
A list of permissions for features to be granted with this role.
role This property is required. String
Short identifier for the role. Must be all lower case with no spaces. This will also be the NSX ID of this resource.
description String
Description of the resource.
displayName String
Display name of the resource.
policyUserManagementRoleId String
ID of the resource.
tags List<Property Map>
A list of scope + tag pairs to associate with this resource.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Revision double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
Id string
The provider-assigned unique ID for this managed resource.
Revision float64
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
id String
The provider-assigned unique ID for this managed resource.
revision Double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
id string
The provider-assigned unique ID for this managed resource.
revision number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
id str
The provider-assigned unique ID for this managed resource.
revision float
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
id String
The provider-assigned unique ID for this managed resource.
revision Number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.

Look up Existing PolicyUserManagementRole Resource

Get an existing PolicyUserManagementRole 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?: PolicyUserManagementRoleState, opts?: CustomResourceOptions): PolicyUserManagementRole
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        features: Optional[Sequence[PolicyUserManagementRoleFeatureArgs]] = None,
        policy_user_management_role_id: Optional[str] = None,
        revision: Optional[float] = None,
        role: Optional[str] = None,
        tags: Optional[Sequence[PolicyUserManagementRoleTagArgs]] = None) -> PolicyUserManagementRole
func GetPolicyUserManagementRole(ctx *Context, name string, id IDInput, state *PolicyUserManagementRoleState, opts ...ResourceOption) (*PolicyUserManagementRole, error)
public static PolicyUserManagementRole Get(string name, Input<string> id, PolicyUserManagementRoleState? state, CustomResourceOptions? opts = null)
public static PolicyUserManagementRole get(String name, Output<String> id, PolicyUserManagementRoleState state, CustomResourceOptions options)
resources:  _:    type: nsxt:PolicyUserManagementRole    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:
Description string
Description of the resource.
DisplayName string
Display name of the resource.
Features List<PolicyUserManagementRoleFeature>
A list of permissions for features to be granted with this role.
PolicyUserManagementRoleId string
ID of the resource.
Revision double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
Role string
Short identifier for the role. Must be all lower case with no spaces. This will also be the NSX ID of this resource.
Tags List<PolicyUserManagementRoleTag>
A list of scope + tag pairs to associate with this resource.
Description string
Description of the resource.
DisplayName string
Display name of the resource.
Features []PolicyUserManagementRoleFeatureArgs
A list of permissions for features to be granted with this role.
PolicyUserManagementRoleId string
ID of the resource.
Revision float64
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
Role string
Short identifier for the role. Must be all lower case with no spaces. This will also be the NSX ID of this resource.
Tags []PolicyUserManagementRoleTagArgs
A list of scope + tag pairs to associate with this resource.
description String
Description of the resource.
displayName String
Display name of the resource.
features List<PolicyUserManagementRoleFeature>
A list of permissions for features to be granted with this role.
policyUserManagementRoleId String
ID of the resource.
revision Double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
role String
Short identifier for the role. Must be all lower case with no spaces. This will also be the NSX ID of this resource.
tags List<PolicyUserManagementRoleTag>
A list of scope + tag pairs to associate with this resource.
description string
Description of the resource.
displayName string
Display name of the resource.
features PolicyUserManagementRoleFeature[]
A list of permissions for features to be granted with this role.
policyUserManagementRoleId string
ID of the resource.
revision number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
role string
Short identifier for the role. Must be all lower case with no spaces. This will also be the NSX ID of this resource.
tags PolicyUserManagementRoleTag[]
A list of scope + tag pairs to associate with this resource.
description str
Description of the resource.
display_name str
Display name of the resource.
features Sequence[PolicyUserManagementRoleFeatureArgs]
A list of permissions for features to be granted with this role.
policy_user_management_role_id str
ID of the resource.
revision float
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
role str
Short identifier for the role. Must be all lower case with no spaces. This will also be the NSX ID of this resource.
tags Sequence[PolicyUserManagementRoleTagArgs]
A list of scope + tag pairs to associate with this resource.
description String
Description of the resource.
displayName String
Display name of the resource.
features List<Property Map>
A list of permissions for features to be granted with this role.
policyUserManagementRoleId String
ID of the resource.
revision Number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
role String
Short identifier for the role. Must be all lower case with no spaces. This will also be the NSX ID of this resource.
tags List<Property Map>
A list of scope + tag pairs to associate with this resource.

Supporting Types

PolicyUserManagementRoleFeature
, PolicyUserManagementRoleFeatureArgs

Feature This property is required. string
The ID of feature to grant permission.
Permission This property is required. string
Type of permission to grant. Valid values are crud, read, execute.
FeatureDescription string
Description of the feature.
FeatureName string
Name of the feature.
Feature This property is required. string
The ID of feature to grant permission.
Permission This property is required. string
Type of permission to grant. Valid values are crud, read, execute.
FeatureDescription string
Description of the feature.
FeatureName string
Name of the feature.
feature This property is required. String
The ID of feature to grant permission.
permission This property is required. String
Type of permission to grant. Valid values are crud, read, execute.
featureDescription String
Description of the feature.
featureName String
Name of the feature.
feature This property is required. string
The ID of feature to grant permission.
permission This property is required. string
Type of permission to grant. Valid values are crud, read, execute.
featureDescription string
Description of the feature.
featureName string
Name of the feature.
feature This property is required. str
The ID of feature to grant permission.
permission This property is required. str
Type of permission to grant. Valid values are crud, read, execute.
feature_description str
Description of the feature.
feature_name str
Name of the feature.
feature This property is required. String
The ID of feature to grant permission.
permission This property is required. String
Type of permission to grant. Valid values are crud, read, execute.
featureDescription String
Description of the feature.
featureName String
Name of the feature.

PolicyUserManagementRoleTag
, PolicyUserManagementRoleTagArgs

Scope string
Tag string
A list of scope + tag pairs to associate with this resource.
Scope string
Tag string
A list of scope + tag pairs to associate with this resource.
scope String
tag String
A list of scope + tag pairs to associate with this resource.
scope string
tag string
A list of scope + tag pairs to associate with this resource.
scope str
tag str
A list of scope + tag pairs to associate with this resource.
scope String
tag String
A list of scope + tag pairs to associate with this resource.

Package Details

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