1. Packages
  2. Mso Provider
  3. API Docs
  4. getRole
mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet

mso.getRole

Explore with Pulumi AI

mso logo
mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet

    Data source for MSO Role. Not supported on ND-based MSO/NDO.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as mso from "@pulumi/mso";
    
    const example = mso.getRole({
        name: "UserManager",
    });
    
    import pulumi
    import pulumi_mso as mso
    
    example = mso.get_role(name="UserManager")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/mso/mso"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := mso.GetRole(ctx, &mso.GetRoleArgs{
    			Name: "UserManager",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Mso = Pulumi.Mso;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Mso.GetRole.Invoke(new()
        {
            Name = "UserManager",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.mso.MsoFunctions;
    import com.pulumi.mso.inputs.GetRoleArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = MsoFunctions.getRole(GetRoleArgs.builder()
                .name("UserManager")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: mso:getRole
          arguments:
            name: UserManager
    

    Argument Reference

    • name - (Required) The name of the Role.

    Attribute Reference

    • description - (Read-Only) The description of the Role.
    • display_name - (Read-Only) The name of the Role as displayed on the MSO UI.
    • read_permissions - (Read-Only) The read permissions assigned to the Role.
    • write_permissions - (Read-Only) The write permissions assigned to the Role.

    Using getRole

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRole(args: GetRoleArgs, opts?: InvokeOptions): Promise<GetRoleResult>
    function getRoleOutput(args: GetRoleOutputArgs, opts?: InvokeOptions): Output<GetRoleResult>
    def get_role(id: Optional[str] = None,
                 name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetRoleResult
    def get_role_output(id: Optional[pulumi.Input[str]] = None,
                 name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetRoleResult]
    func GetRole(ctx *Context, args *GetRoleArgs, opts ...InvokeOption) (*GetRoleResult, error)
    func GetRoleOutput(ctx *Context, args *GetRoleOutputArgs, opts ...InvokeOption) GetRoleResultOutput

    > Note: This function is named GetRole in the Go SDK.

    public static class GetRole 
    {
        public static Task<GetRoleResult> InvokeAsync(GetRoleArgs args, InvokeOptions? opts = null)
        public static Output<GetRoleResult> Invoke(GetRoleInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRoleResult> getRole(GetRoleArgs args, InvokeOptions options)
    public static Output<GetRoleResult> getRole(GetRoleArgs args, InvokeOptions options)
    
    fn::invoke:
      function: mso:index/getRole:getRole
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Id string
    Name string
    Id string
    name String
    id String
    name string
    id string
    name str
    id str
    name String
    id String

    getRole Result

    The following output properties are available:

    Description string
    DisplayName string
    Id string
    Name string
    ReadPermissions List<string>
    WritePermissions List<string>
    Description string
    DisplayName string
    Id string
    Name string
    ReadPermissions []string
    WritePermissions []string
    description String
    displayName String
    id String
    name String
    readPermissions List<String>
    writePermissions List<String>
    description string
    displayName string
    id string
    name string
    readPermissions string[]
    writePermissions string[]
    description str
    display_name str
    id str
    name str
    read_permissions Sequence[str]
    write_permissions Sequence[str]
    description String
    displayName String
    id String
    name String
    readPermissions List<String>
    writePermissions List<String>

    Package Details

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