nsxt.PolicyUserManagementRoleBinding
Explore with Pulumi AI
Create PolicyUserManagementRoleBinding Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PolicyUserManagementRoleBinding(name: string, args: PolicyUserManagementRoleBindingArgs, opts?: CustomResourceOptions);
@overload
def PolicyUserManagementRoleBinding(resource_name: str,
args: PolicyUserManagementRoleBindingArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PolicyUserManagementRoleBinding(resource_name: str,
opts: Optional[ResourceOptions] = None,
roles_for_paths: Optional[Sequence[PolicyUserManagementRoleBindingRolesForPathArgs]] = None,
type: Optional[str] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
identity_source_id: Optional[str] = None,
identity_source_type: Optional[str] = None,
name: Optional[str] = None,
overwrite_local_user: Optional[bool] = None,
policy_user_management_role_binding_id: Optional[str] = None,
tags: Optional[Sequence[PolicyUserManagementRoleBindingTagArgs]] = None)
func NewPolicyUserManagementRoleBinding(ctx *Context, name string, args PolicyUserManagementRoleBindingArgs, opts ...ResourceOption) (*PolicyUserManagementRoleBinding, error)
public PolicyUserManagementRoleBinding(string name, PolicyUserManagementRoleBindingArgs args, CustomResourceOptions? opts = null)
public PolicyUserManagementRoleBinding(String name, PolicyUserManagementRoleBindingArgs args)
public PolicyUserManagementRoleBinding(String name, PolicyUserManagementRoleBindingArgs args, CustomResourceOptions options)
type: nsxt:PolicyUserManagementRoleBinding
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 PolicyUserManagementRoleBindingArgs
- 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 PolicyUserManagementRoleBindingArgs
- 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 PolicyUserManagementRoleBindingArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PolicyUserManagementRoleBindingArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PolicyUserManagementRoleBindingArgs
- 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 policyUserManagementRoleBindingResource = new Nsxt.PolicyUserManagementRoleBinding("policyUserManagementRoleBindingResource", new()
{
RolesForPaths = new[]
{
new Nsxt.Inputs.PolicyUserManagementRoleBindingRolesForPathArgs
{
Path = "string",
Roles = new[]
{
"string",
},
},
},
Type = "string",
Description = "string",
DisplayName = "string",
IdentitySourceId = "string",
IdentitySourceType = "string",
Name = "string",
OverwriteLocalUser = false,
PolicyUserManagementRoleBindingId = "string",
Tags = new[]
{
new Nsxt.Inputs.PolicyUserManagementRoleBindingTagArgs
{
Scope = "string",
Tag = "string",
},
},
});
example, err := nsxt.NewPolicyUserManagementRoleBinding(ctx, "policyUserManagementRoleBindingResource", &nsxt.PolicyUserManagementRoleBindingArgs{
RolesForPaths: nsxt.PolicyUserManagementRoleBindingRolesForPathArray{
&nsxt.PolicyUserManagementRoleBindingRolesForPathArgs{
Path: pulumi.String("string"),
Roles: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Type: pulumi.String("string"),
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
IdentitySourceId: pulumi.String("string"),
IdentitySourceType: pulumi.String("string"),
Name: pulumi.String("string"),
OverwriteLocalUser: pulumi.Bool(false),
PolicyUserManagementRoleBindingId: pulumi.String("string"),
Tags: nsxt.PolicyUserManagementRoleBindingTagArray{
&nsxt.PolicyUserManagementRoleBindingTagArgs{
Scope: pulumi.String("string"),
Tag: pulumi.String("string"),
},
},
})
var policyUserManagementRoleBindingResource = new PolicyUserManagementRoleBinding("policyUserManagementRoleBindingResource", PolicyUserManagementRoleBindingArgs.builder()
.rolesForPaths(PolicyUserManagementRoleBindingRolesForPathArgs.builder()
.path("string")
.roles("string")
.build())
.type("string")
.description("string")
.displayName("string")
.identitySourceId("string")
.identitySourceType("string")
.name("string")
.overwriteLocalUser(false)
.policyUserManagementRoleBindingId("string")
.tags(PolicyUserManagementRoleBindingTagArgs.builder()
.scope("string")
.tag("string")
.build())
.build());
policy_user_management_role_binding_resource = nsxt.PolicyUserManagementRoleBinding("policyUserManagementRoleBindingResource",
roles_for_paths=[{
"path": "string",
"roles": ["string"],
}],
type="string",
description="string",
display_name="string",
identity_source_id="string",
identity_source_type="string",
name="string",
overwrite_local_user=False,
policy_user_management_role_binding_id="string",
tags=[{
"scope": "string",
"tag": "string",
}])
const policyUserManagementRoleBindingResource = new nsxt.PolicyUserManagementRoleBinding("policyUserManagementRoleBindingResource", {
rolesForPaths: [{
path: "string",
roles: ["string"],
}],
type: "string",
description: "string",
displayName: "string",
identitySourceId: "string",
identitySourceType: "string",
name: "string",
overwriteLocalUser: false,
policyUserManagementRoleBindingId: "string",
tags: [{
scope: "string",
tag: "string",
}],
});
type: nsxt:PolicyUserManagementRoleBinding
properties:
description: string
displayName: string
identitySourceId: string
identitySourceType: string
name: string
overwriteLocalUser: false
policyUserManagementRoleBindingId: string
rolesForPaths:
- path: string
roles:
- string
tags:
- scope: string
tag: string
type: string
PolicyUserManagementRoleBinding 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 PolicyUserManagementRoleBinding resource accepts the following input properties:
- Roles
For List<PolicyPaths User Management Role Binding Roles For Path> - A list of The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere.
- Type string
- Indicates the type of the user. Valid options:
- Description string
- Description of the resource.
- Display
Name string - Display name of the resource.
- Identity
Source stringId - The ID of the external identity source that holds the referenced external entity. Currently, only external
LDAP
andOIDC
servers are allowed. - Identity
Source stringType - Identity source type. Applicable only to
remote_user
andremote_group
user types. Valid options are:VIDM
,LDAP
,OIDC
,CSP
. Defaults toVIDM
when applicable. - Name string
- User/Group's name.
- Overwrite
Local boolUser - Allow overwriting auto-created role binding on NSX for local users
- Policy
User stringManagement Role Binding Id - ID of the resource.
- List<Policy
User Management Role Binding Tag> - A list of scope + tag pairs to associate with this resource.
- Roles
For []PolicyPaths User Management Role Binding Roles For Path Args - A list of The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere.
- Type string
- Indicates the type of the user. Valid options:
- Description string
- Description of the resource.
- Display
Name string - Display name of the resource.
- Identity
Source stringId - The ID of the external identity source that holds the referenced external entity. Currently, only external
LDAP
andOIDC
servers are allowed. - Identity
Source stringType - Identity source type. Applicable only to
remote_user
andremote_group
user types. Valid options are:VIDM
,LDAP
,OIDC
,CSP
. Defaults toVIDM
when applicable. - Name string
- User/Group's name.
- Overwrite
Local boolUser - Allow overwriting auto-created role binding on NSX for local users
- Policy
User stringManagement Role Binding Id - ID of the resource.
- []Policy
User Management Role Binding Tag Args - A list of scope + tag pairs to associate with this resource.
- roles
For List<PolicyPaths User Management Role Binding Roles For Path> - A list of The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere.
- type String
- Indicates the type of the user. Valid options:
- description String
- Description of the resource.
- display
Name String - Display name of the resource.
- identity
Source StringId - The ID of the external identity source that holds the referenced external entity. Currently, only external
LDAP
andOIDC
servers are allowed. - identity
Source StringType - Identity source type. Applicable only to
remote_user
andremote_group
user types. Valid options are:VIDM
,LDAP
,OIDC
,CSP
. Defaults toVIDM
when applicable. - name String
- User/Group's name.
- overwrite
Local BooleanUser - Allow overwriting auto-created role binding on NSX for local users
- policy
User StringManagement Role Binding Id - ID of the resource.
- List<Policy
User Management Role Binding Tag> - A list of scope + tag pairs to associate with this resource.
- roles
For PolicyPaths User Management Role Binding Roles For Path[] - A list of The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere.
- type string
- Indicates the type of the user. Valid options:
- description string
- Description of the resource.
- display
Name string - Display name of the resource.
- identity
Source stringId - The ID of the external identity source that holds the referenced external entity. Currently, only external
LDAP
andOIDC
servers are allowed. - identity
Source stringType - Identity source type. Applicable only to
remote_user
andremote_group
user types. Valid options are:VIDM
,LDAP
,OIDC
,CSP
. Defaults toVIDM
when applicable. - name string
- User/Group's name.
- overwrite
Local booleanUser - Allow overwriting auto-created role binding on NSX for local users
- policy
User stringManagement Role Binding Id - ID of the resource.
- Policy
User Management Role Binding Tag[] - A list of scope + tag pairs to associate with this resource.
- roles_
for_ Sequence[Policypaths User Management Role Binding Roles For Path Args] - A list of The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere.
- type str
- Indicates the type of the user. Valid options:
- description str
- Description of the resource.
- display_
name str - Display name of the resource.
- identity_
source_ strid - The ID of the external identity source that holds the referenced external entity. Currently, only external
LDAP
andOIDC
servers are allowed. - identity_
source_ strtype - Identity source type. Applicable only to
remote_user
andremote_group
user types. Valid options are:VIDM
,LDAP
,OIDC
,CSP
. Defaults toVIDM
when applicable. - name str
- User/Group's name.
- overwrite_
local_ booluser - Allow overwriting auto-created role binding on NSX for local users
- policy_
user_ strmanagement_ role_ binding_ id - ID of the resource.
- Sequence[Policy
User Management Role Binding Tag Args] - A list of scope + tag pairs to associate with this resource.
- roles
For List<Property Map>Paths - A list of The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere.
- type String
- Indicates the type of the user. Valid options:
- description String
- Description of the resource.
- display
Name String - Display name of the resource.
- identity
Source StringId - The ID of the external identity source that holds the referenced external entity. Currently, only external
LDAP
andOIDC
servers are allowed. - identity
Source StringType - Identity source type. Applicable only to
remote_user
andremote_group
user types. Valid options are:VIDM
,LDAP
,OIDC
,CSP
. Defaults toVIDM
when applicable. - name String
- User/Group's name.
- overwrite
Local BooleanUser - Allow overwriting auto-created role binding on NSX for local users
- policy
User StringManagement Role Binding Id - ID of the resource.
- 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 PolicyUserManagementRoleBinding resource produces the following output properties:
Look up Existing PolicyUserManagementRoleBinding Resource
Get an existing PolicyUserManagementRoleBinding 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?: PolicyUserManagementRoleBindingState, opts?: CustomResourceOptions): PolicyUserManagementRoleBinding
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
identity_source_id: Optional[str] = None,
identity_source_type: Optional[str] = None,
name: Optional[str] = None,
overwrite_local_user: Optional[bool] = None,
policy_user_management_role_binding_id: Optional[str] = None,
revision: Optional[float] = None,
roles_for_paths: Optional[Sequence[PolicyUserManagementRoleBindingRolesForPathArgs]] = None,
tags: Optional[Sequence[PolicyUserManagementRoleBindingTagArgs]] = None,
type: Optional[str] = None,
user_id: Optional[str] = None) -> PolicyUserManagementRoleBinding
func GetPolicyUserManagementRoleBinding(ctx *Context, name string, id IDInput, state *PolicyUserManagementRoleBindingState, opts ...ResourceOption) (*PolicyUserManagementRoleBinding, error)
public static PolicyUserManagementRoleBinding Get(string name, Input<string> id, PolicyUserManagementRoleBindingState? state, CustomResourceOptions? opts = null)
public static PolicyUserManagementRoleBinding get(String name, Output<String> id, PolicyUserManagementRoleBindingState state, CustomResourceOptions options)
resources: _: type: nsxt:PolicyUserManagementRoleBinding 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.
- Description string
- Description of the resource.
- Display
Name string - Display name of the resource.
- Identity
Source stringId - The ID of the external identity source that holds the referenced external entity. Currently, only external
LDAP
andOIDC
servers are allowed. - Identity
Source stringType - Identity source type. Applicable only to
remote_user
andremote_group
user types. Valid options are:VIDM
,LDAP
,OIDC
,CSP
. Defaults toVIDM
when applicable. - Name string
- User/Group's name.
- Overwrite
Local boolUser - Allow overwriting auto-created role binding on NSX for local users
- Policy
User stringManagement Role Binding Id - 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.
- Roles
For List<PolicyPaths User Management Role Binding Roles For Path> - A list of The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere.
- List<Policy
User Management Role Binding Tag> - A list of scope + tag pairs to associate with this resource.
- Type string
- Indicates the type of the user. Valid options:
- User
Id string - Local user's numeric id. Only applicable to
local_user
.
- Description string
- Description of the resource.
- Display
Name string - Display name of the resource.
- Identity
Source stringId - The ID of the external identity source that holds the referenced external entity. Currently, only external
LDAP
andOIDC
servers are allowed. - Identity
Source stringType - Identity source type. Applicable only to
remote_user
andremote_group
user types. Valid options are:VIDM
,LDAP
,OIDC
,CSP
. Defaults toVIDM
when applicable. - Name string
- User/Group's name.
- Overwrite
Local boolUser - Allow overwriting auto-created role binding on NSX for local users
- Policy
User stringManagement Role Binding Id - 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.
- Roles
For []PolicyPaths User Management Role Binding Roles For Path Args - A list of The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere.
- []Policy
User Management Role Binding Tag Args - A list of scope + tag pairs to associate with this resource.
- Type string
- Indicates the type of the user. Valid options:
- User
Id string - Local user's numeric id. Only applicable to
local_user
.
- description String
- Description of the resource.
- display
Name String - Display name of the resource.
- identity
Source StringId - The ID of the external identity source that holds the referenced external entity. Currently, only external
LDAP
andOIDC
servers are allowed. - identity
Source StringType - Identity source type. Applicable only to
remote_user
andremote_group
user types. Valid options are:VIDM
,LDAP
,OIDC
,CSP
. Defaults toVIDM
when applicable. - name String
- User/Group's name.
- overwrite
Local BooleanUser - Allow overwriting auto-created role binding on NSX for local users
- policy
User StringManagement Role Binding Id - 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.
- roles
For List<PolicyPaths User Management Role Binding Roles For Path> - A list of The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere.
- List<Policy
User Management Role Binding Tag> - A list of scope + tag pairs to associate with this resource.
- type String
- Indicates the type of the user. Valid options:
- user
Id String - Local user's numeric id. Only applicable to
local_user
.
- description string
- Description of the resource.
- display
Name string - Display name of the resource.
- identity
Source stringId - The ID of the external identity source that holds the referenced external entity. Currently, only external
LDAP
andOIDC
servers are allowed. - identity
Source stringType - Identity source type. Applicable only to
remote_user
andremote_group
user types. Valid options are:VIDM
,LDAP
,OIDC
,CSP
. Defaults toVIDM
when applicable. - name string
- User/Group's name.
- overwrite
Local booleanUser - Allow overwriting auto-created role binding on NSX for local users
- policy
User stringManagement Role Binding Id - 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.
- roles
For PolicyPaths User Management Role Binding Roles For Path[] - A list of The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere.
- Policy
User Management Role Binding Tag[] - A list of scope + tag pairs to associate with this resource.
- type string
- Indicates the type of the user. Valid options:
- user
Id string - Local user's numeric id. Only applicable to
local_user
.
- description str
- Description of the resource.
- display_
name str - Display name of the resource.
- identity_
source_ strid - The ID of the external identity source that holds the referenced external entity. Currently, only external
LDAP
andOIDC
servers are allowed. - identity_
source_ strtype - Identity source type. Applicable only to
remote_user
andremote_group
user types. Valid options are:VIDM
,LDAP
,OIDC
,CSP
. Defaults toVIDM
when applicable. - name str
- User/Group's name.
- overwrite_
local_ booluser - Allow overwriting auto-created role binding on NSX for local users
- policy_
user_ strmanagement_ role_ binding_ id - 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.
- roles_
for_ Sequence[Policypaths User Management Role Binding Roles For Path Args] - A list of The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere.
- Sequence[Policy
User Management Role Binding Tag Args] - A list of scope + tag pairs to associate with this resource.
- type str
- Indicates the type of the user. Valid options:
- user_
id str - Local user's numeric id. Only applicable to
local_user
.
- description String
- Description of the resource.
- display
Name String - Display name of the resource.
- identity
Source StringId - The ID of the external identity source that holds the referenced external entity. Currently, only external
LDAP
andOIDC
servers are allowed. - identity
Source StringType - Identity source type. Applicable only to
remote_user
andremote_group
user types. Valid options are:VIDM
,LDAP
,OIDC
,CSP
. Defaults toVIDM
when applicable. - name String
- User/Group's name.
- overwrite
Local BooleanUser - Allow overwriting auto-created role binding on NSX for local users
- policy
User StringManagement Role Binding Id - 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.
- roles
For List<Property Map>Paths - A list of The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere.
- List<Property Map>
- A list of scope + tag pairs to associate with this resource.
- type String
- Indicates the type of the user. Valid options:
- user
Id String - Local user's numeric id. Only applicable to
local_user
.
Supporting Types
PolicyUserManagementRoleBindingRolesForPath, PolicyUserManagementRoleBindingRolesForPathArgs
PolicyUserManagementRoleBindingTag, PolicyUserManagementRoleBindingTagArgs
Package Details
- Repository
- nsxt vmware/terraform-provider-nsxt
- License
- Notes
- This Pulumi package is based on the
nsxt
Terraform Provider.