Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vcd Provider
  3. API Docs
  4. GlobalRole
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

vcd.GlobalRole

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

    Create GlobalRole Resource

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

    Constructor syntax

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

@overload
def GlobalRole(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               description: Optional[str] = None,
               publish_to_all_tenants: Optional[bool] = None,
               global_role_id: Optional[str] = None,
               name: Optional[str] = None,
               rights: Optional[Sequence[str]] = None,
               tenants: Optional[Sequence[str]] = None)
    func NewGlobalRole(ctx *Context, name string, args GlobalRoleArgs, opts ...ResourceOption) (*GlobalRole, error)
    public GlobalRole(string name, GlobalRoleArgs args, CustomResourceOptions? opts = null)
    public GlobalRole(String name, GlobalRoleArgs args)
public GlobalRole(String name, GlobalRoleArgs args, CustomResourceOptions options)

    type: vcd:GlobalRole
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 GlobalRoleArgs
    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 GlobalRoleArgs
    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 GlobalRoleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GlobalRoleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GlobalRoleArgs
    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 globalRoleResource = new Vcd.GlobalRole("globalRoleResource", new()
{
    Description = "string",
    PublishToAllTenants = false,
    GlobalRoleId = "string",
    Name = "string",
    Rights = new[]
    {
        "string",
    },
    Tenants = new[]
    {
        "string",
    },
});

    example, err := vcd.NewGlobalRole(ctx, "globalRoleResource", &vcd.GlobalRoleArgs{
	Description:         pulumi.String("string"),
	PublishToAllTenants: pulumi.Bool(false),
	GlobalRoleId:        pulumi.String("string"),
	Name:                pulumi.String("string"),
	Rights: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tenants: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var globalRoleResource = new GlobalRole("globalRoleResource", GlobalRoleArgs.builder()
    .description("string")
    .publishToAllTenants(false)
    .globalRoleId("string")
    .name("string")
    .rights("string")
    .tenants("string")
    .build());

    global_role_resource = vcd.GlobalRole("globalRoleResource",
    description="string",
    publish_to_all_tenants=False,
    global_role_id="string",
    name="string",
    rights=["string"],
    tenants=["string"])

    const globalRoleResource = new vcd.GlobalRole("globalRoleResource", {
    description: "string",
    publishToAllTenants: false,
    globalRoleId: "string",
    name: "string",
    rights: ["string"],
    tenants: ["string"],
});

    type: vcd:GlobalRole
properties:
    description: string
    globalRoleId: string
    name: string
    publishToAllTenants: false
    rights:
        - string
    tenants:
        - string

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

    Description string
    A description of the global role
    PublishToAllTenants bool
    When true, publishes the global role to all tenants
    GlobalRoleId string
    Name string
    The name of the global role.
    Rights List<string>
    List of rights assigned to this role
    Tenants List<string>
    List of tenants to which this global role gets published. Ignored if publish_to_all_tenants is true.
    Description string
    A description of the global role
    PublishToAllTenants bool
    When true, publishes the global role to all tenants
    GlobalRoleId string
    Name string
    The name of the global role.
    Rights []string
    List of rights assigned to this role
    Tenants []string
    List of tenants to which this global role gets published. Ignored if publish_to_all_tenants is true.
    description String
    A description of the global role
    publishToAllTenants Boolean
    When true, publishes the global role to all tenants
    globalRoleId String
    name String
    The name of the global role.
    rights List<String>
    List of rights assigned to this role
    tenants List<String>
    List of tenants to which this global role gets published. Ignored if publish_to_all_tenants is true.
    description string
    A description of the global role
    publishToAllTenants boolean
    When true, publishes the global role to all tenants
    globalRoleId string
    name string
    The name of the global role.
    rights string[]
    List of rights assigned to this role
    tenants string[]
    List of tenants to which this global role gets published. Ignored if publish_to_all_tenants is true.
    description str
    A description of the global role
    publish_to_all_tenants bool
    When true, publishes the global role to all tenants
    global_role_id str
    name str
    The name of the global role.
    rights Sequence[str]
    List of rights assigned to this role
    tenants Sequence[str]
    List of tenants to which this global role gets published. Ignored if publish_to_all_tenants is true.
    description String
    A description of the global role
    publishToAllTenants Boolean
    When true, publishes the global role to all tenants
    globalRoleId String
    name String
    The name of the global role.
    rights List<String>
    List of rights assigned to this role
    tenants List<String>
    List of tenants to which this global role gets published. Ignored if publish_to_all_tenants is true.

    Outputs

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

    BundleKey string
    Key used for internationalization
    Id string
    The provider-assigned unique ID for this managed resource.
    ReadOnly bool
    Whether this global role is read-only
    BundleKey string
    Key used for internationalization
    Id string
    The provider-assigned unique ID for this managed resource.
    ReadOnly bool
    Whether this global role is read-only
    bundleKey String
    Key used for internationalization
    id String
    The provider-assigned unique ID for this managed resource.
    readOnly Boolean
    Whether this global role is read-only
    bundleKey string
    Key used for internationalization
    id string
    The provider-assigned unique ID for this managed resource.
    readOnly boolean
    Whether this global role is read-only
    bundle_key str
    Key used for internationalization
    id str
    The provider-assigned unique ID for this managed resource.
    read_only bool
    Whether this global role is read-only
    bundleKey String
    Key used for internationalization
    id String
    The provider-assigned unique ID for this managed resource.
    readOnly Boolean
    Whether this global role is read-only

    Look up Existing GlobalRole Resource

    Get an existing GlobalRole 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?: GlobalRoleState, opts?: CustomResourceOptions): GlobalRole
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bundle_key: Optional[str] = None,
        description: Optional[str] = None,
        global_role_id: Optional[str] = None,
        name: Optional[str] = None,
        publish_to_all_tenants: Optional[bool] = None,
        read_only: Optional[bool] = None,
        rights: Optional[Sequence[str]] = None,
        tenants: Optional[Sequence[str]] = None) -> GlobalRole
    func GetGlobalRole(ctx *Context, name string, id IDInput, state *GlobalRoleState, opts ...ResourceOption) (*GlobalRole, error)
    public static GlobalRole Get(string name, Input<string> id, GlobalRoleState? state, CustomResourceOptions? opts = null)
    public static GlobalRole get(String name, Output<String> id, GlobalRoleState state, CustomResourceOptions options)
    resources:  _:    type: vcd:GlobalRole    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:
    BundleKey string
    Key used for internationalization
    Description string
    A description of the global role
    GlobalRoleId string
    Name string
    The name of the global role.
    PublishToAllTenants bool
    When true, publishes the global role to all tenants
    ReadOnly bool
    Whether this global role is read-only
    Rights List<string>
    List of rights assigned to this role
    Tenants List<string>
    List of tenants to which this global role gets published. Ignored if publish_to_all_tenants is true.
    BundleKey string
    Key used for internationalization
    Description string
    A description of the global role
    GlobalRoleId string
    Name string
    The name of the global role.
    PublishToAllTenants bool
    When true, publishes the global role to all tenants
    ReadOnly bool
    Whether this global role is read-only
    Rights []string
    List of rights assigned to this role
    Tenants []string
    List of tenants to which this global role gets published. Ignored if publish_to_all_tenants is true.
    bundleKey String
    Key used for internationalization
    description String
    A description of the global role
    globalRoleId String
    name String
    The name of the global role.
    publishToAllTenants Boolean
    When true, publishes the global role to all tenants
    readOnly Boolean
    Whether this global role is read-only
    rights List<String>
    List of rights assigned to this role
    tenants List<String>
    List of tenants to which this global role gets published. Ignored if publish_to_all_tenants is true.
    bundleKey string
    Key used for internationalization
    description string
    A description of the global role
    globalRoleId string
    name string
    The name of the global role.
    publishToAllTenants boolean
    When true, publishes the global role to all tenants
    readOnly boolean
    Whether this global role is read-only
    rights string[]
    List of rights assigned to this role
    tenants string[]
    List of tenants to which this global role gets published. Ignored if publish_to_all_tenants is true.
    bundle_key str
    Key used for internationalization
    description str
    A description of the global role
    global_role_id str
    name str
    The name of the global role.
    publish_to_all_tenants bool
    When true, publishes the global role to all tenants
    read_only bool
    Whether this global role is read-only
    rights Sequence[str]
    List of rights assigned to this role
    tenants Sequence[str]
    List of tenants to which this global role gets published. Ignored if publish_to_all_tenants is true.
    bundleKey String
    Key used for internationalization
    description String
    A description of the global role
    globalRoleId String
    name String
    The name of the global role.
    publishToAllTenants Boolean
    When true, publishes the global role to all tenants
    readOnly Boolean
    Whether this global role is read-only
    rights List<String>
    List of rights assigned to this role
    tenants List<String>
    List of tenants to which this global role gets published. Ignored if publish_to_all_tenants is true.

    Package Details

    Repository
    vcd vmware/terraform-provider-vcd
    License
    Notes
    This Pulumi package is based on the vcd Terraform Provider.
    vcd logo
    vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
    vmware/terraform-provider-vcd