1. Packages
  2. Powerscale Provider
  3. API Docs
  4. getUserMappingRules
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell

powerscale.getUserMappingRules

Explore with Pulumi AI

powerscale logo
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell

    This datasource is used to query the User Mapping Rules from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. PowerScale User Mapping Rules combines user identities from different directory services into a single access token and then modifies it according to configured rules.

    Using getUserMappingRules

    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 getUserMappingRules(args: GetUserMappingRulesArgs, opts?: InvokeOptions): Promise<GetUserMappingRulesResult>
    function getUserMappingRulesOutput(args: GetUserMappingRulesOutputArgs, opts?: InvokeOptions): Output<GetUserMappingRulesResult>
    def get_user_mapping_rules(filter: Optional[GetUserMappingRulesFilter] = None,
                               opts: Optional[InvokeOptions] = None) -> GetUserMappingRulesResult
    def get_user_mapping_rules_output(filter: Optional[pulumi.Input[GetUserMappingRulesFilterArgs]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetUserMappingRulesResult]
    func LookupUserMappingRules(ctx *Context, args *LookupUserMappingRulesArgs, opts ...InvokeOption) (*LookupUserMappingRulesResult, error)
    func LookupUserMappingRulesOutput(ctx *Context, args *LookupUserMappingRulesOutputArgs, opts ...InvokeOption) LookupUserMappingRulesResultOutput

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

    public static class GetUserMappingRules 
    {
        public static Task<GetUserMappingRulesResult> InvokeAsync(GetUserMappingRulesArgs args, InvokeOptions? opts = null)
        public static Output<GetUserMappingRulesResult> Invoke(GetUserMappingRulesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetUserMappingRulesResult> getUserMappingRules(GetUserMappingRulesArgs args, InvokeOptions options)
    public static Output<GetUserMappingRulesResult> getUserMappingRules(GetUserMappingRulesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: powerscale:index/getUserMappingRules:getUserMappingRules
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getUserMappingRules Result

    The following output properties are available:

    Id string
    User Mapping Rules ID.
    UserMappingRules List<GetUserMappingRulesUserMappingRule>
    Specifies the list of user mapping rules.
    UserMappingRulesParameters GetUserMappingRulesUserMappingRulesParameters
    Specifies the parameters for user mapping rules.
    Filter GetUserMappingRulesFilter
    Id string
    User Mapping Rules ID.
    UserMappingRules []GetUserMappingRulesUserMappingRule
    Specifies the list of user mapping rules.
    UserMappingRulesParameters GetUserMappingRulesUserMappingRulesParameters
    Specifies the parameters for user mapping rules.
    Filter GetUserMappingRulesFilter
    id String
    User Mapping Rules ID.
    userMappingRules List<GetUserMappingRulesUserMappingRule>
    Specifies the list of user mapping rules.
    userMappingRulesParameters GetUserMappingRulesUserMappingRulesParameters
    Specifies the parameters for user mapping rules.
    filter GetUserMappingRulesFilter
    id string
    User Mapping Rules ID.
    userMappingRules GetUserMappingRulesUserMappingRule[]
    Specifies the list of user mapping rules.
    userMappingRulesParameters GetUserMappingRulesUserMappingRulesParameters
    Specifies the parameters for user mapping rules.
    filter GetUserMappingRulesFilter
    id str
    User Mapping Rules ID.
    user_mapping_rules Sequence[GetUserMappingRulesUserMappingRule]
    Specifies the list of user mapping rules.
    user_mapping_rules_parameters GetUserMappingRulesUserMappingRulesParameters
    Specifies the parameters for user mapping rules.
    filter GetUserMappingRulesFilter
    id String
    User Mapping Rules ID.
    userMappingRules List<Property Map>
    Specifies the list of user mapping rules.
    userMappingRulesParameters Property Map
    Specifies the parameters for user mapping rules.
    filter Property Map

    Supporting Types

    GetUserMappingRulesFilter

    Names List<string>
    Names filter for source user name or target user name.
    Operators List<string>
    Operators filter for user mapping rules.
    Zone string
    The zone to which the user mapping applies. Defaults to System.
    Names []string
    Names filter for source user name or target user name.
    Operators []string
    Operators filter for user mapping rules.
    Zone string
    The zone to which the user mapping applies. Defaults to System.
    names List<String>
    Names filter for source user name or target user name.
    operators List<String>
    Operators filter for user mapping rules.
    zone String
    The zone to which the user mapping applies. Defaults to System.
    names string[]
    Names filter for source user name or target user name.
    operators string[]
    Operators filter for user mapping rules.
    zone string
    The zone to which the user mapping applies. Defaults to System.
    names Sequence[str]
    Names filter for source user name or target user name.
    operators Sequence[str]
    Operators filter for user mapping rules.
    zone str
    The zone to which the user mapping applies. Defaults to System.
    names List<String>
    Names filter for source user name or target user name.
    operators List<String>
    Operators filter for user mapping rules.
    zone String
    The zone to which the user mapping applies. Defaults to System.

    GetUserMappingRulesUserMappingRule

    Operator string
    Specifies the operator to make rules on specified users or groups.
    Options GetUserMappingRulesUserMappingRuleOptions
    Specifies the mapping options for this user mapping rule.
    SourceUser GetUserMappingRulesUserMappingRuleSourceUser
    Specifies the source user information that the rule can be applied from.
    TargetUser GetUserMappingRulesUserMappingRuleTargetUser
    Specifies the target user information that the rule can be applied to.
    Operator string
    Specifies the operator to make rules on specified users or groups.
    Options GetUserMappingRulesUserMappingRuleOptions
    Specifies the mapping options for this user mapping rule.
    SourceUser GetUserMappingRulesUserMappingRuleSourceUser
    Specifies the source user information that the rule can be applied from.
    TargetUser GetUserMappingRulesUserMappingRuleTargetUser
    Specifies the target user information that the rule can be applied to.
    operator String
    Specifies the operator to make rules on specified users or groups.
    options GetUserMappingRulesUserMappingRuleOptions
    Specifies the mapping options for this user mapping rule.
    sourceUser GetUserMappingRulesUserMappingRuleSourceUser
    Specifies the source user information that the rule can be applied from.
    targetUser GetUserMappingRulesUserMappingRuleTargetUser
    Specifies the target user information that the rule can be applied to.
    operator string
    Specifies the operator to make rules on specified users or groups.
    options GetUserMappingRulesUserMappingRuleOptions
    Specifies the mapping options for this user mapping rule.
    sourceUser GetUserMappingRulesUserMappingRuleSourceUser
    Specifies the source user information that the rule can be applied from.
    targetUser GetUserMappingRulesUserMappingRuleTargetUser
    Specifies the target user information that the rule can be applied to.
    operator str
    Specifies the operator to make rules on specified users or groups.
    options GetUserMappingRulesUserMappingRuleOptions
    Specifies the mapping options for this user mapping rule.
    source_user GetUserMappingRulesUserMappingRuleSourceUser
    Specifies the source user information that the rule can be applied from.
    target_user GetUserMappingRulesUserMappingRuleTargetUser
    Specifies the target user information that the rule can be applied to.
    operator String
    Specifies the operator to make rules on specified users or groups.
    options Property Map
    Specifies the mapping options for this user mapping rule.
    sourceUser Property Map
    Specifies the source user information that the rule can be applied from.
    targetUser Property Map
    Specifies the target user information that the rule can be applied to.

    GetUserMappingRulesUserMappingRuleOptions

    Break bool
    If true, and the rule was applied successfully, stop processing further.
    DefaultUser GetUserMappingRulesUserMappingRuleOptionsDefaultUser
    Specifies the default user information that can be applied if the final credentials do not have valid UID and GID information.
    Group bool
    If true, the primary GID and primary group SID should be copied to the existing credential.
    Groups bool
    If true, all additional identifiers should be copied to the existing credential.
    User bool
    If true, the primary UID and primary user SID should be copied to the existing credential.
    Break bool
    If true, and the rule was applied successfully, stop processing further.
    DefaultUser GetUserMappingRulesUserMappingRuleOptionsDefaultUser
    Specifies the default user information that can be applied if the final credentials do not have valid UID and GID information.
    Group bool
    If true, the primary GID and primary group SID should be copied to the existing credential.
    Groups bool
    If true, all additional identifiers should be copied to the existing credential.
    User bool
    If true, the primary UID and primary user SID should be copied to the existing credential.
    break_ Boolean
    If true, and the rule was applied successfully, stop processing further.
    defaultUser GetUserMappingRulesUserMappingRuleOptionsDefaultUser
    Specifies the default user information that can be applied if the final credentials do not have valid UID and GID information.
    group Boolean
    If true, the primary GID and primary group SID should be copied to the existing credential.
    groups Boolean
    If true, all additional identifiers should be copied to the existing credential.
    user Boolean
    If true, the primary UID and primary user SID should be copied to the existing credential.
    break boolean
    If true, and the rule was applied successfully, stop processing further.
    defaultUser GetUserMappingRulesUserMappingRuleOptionsDefaultUser
    Specifies the default user information that can be applied if the final credentials do not have valid UID and GID information.
    group boolean
    If true, the primary GID and primary group SID should be copied to the existing credential.
    groups boolean
    If true, all additional identifiers should be copied to the existing credential.
    user boolean
    If true, the primary UID and primary user SID should be copied to the existing credential.
    break_ bool
    If true, and the rule was applied successfully, stop processing further.
    default_user GetUserMappingRulesUserMappingRuleOptionsDefaultUser
    Specifies the default user information that can be applied if the final credentials do not have valid UID and GID information.
    group bool
    If true, the primary GID and primary group SID should be copied to the existing credential.
    groups bool
    If true, all additional identifiers should be copied to the existing credential.
    user bool
    If true, the primary UID and primary user SID should be copied to the existing credential.
    break Boolean
    If true, and the rule was applied successfully, stop processing further.
    defaultUser Property Map
    Specifies the default user information that can be applied if the final credentials do not have valid UID and GID information.
    group Boolean
    If true, the primary GID and primary group SID should be copied to the existing credential.
    groups Boolean
    If true, all additional identifiers should be copied to the existing credential.
    user Boolean
    If true, the primary UID and primary user SID should be copied to the existing credential.

    GetUserMappingRulesUserMappingRuleOptionsDefaultUser

    Domain string
    Specifies the domain of the user that is being mapped.
    User string
    Specifies the name of the user that is being mapped.
    Domain string
    Specifies the domain of the user that is being mapped.
    User string
    Specifies the name of the user that is being mapped.
    domain String
    Specifies the domain of the user that is being mapped.
    user String
    Specifies the name of the user that is being mapped.
    domain string
    Specifies the domain of the user that is being mapped.
    user string
    Specifies the name of the user that is being mapped.
    domain str
    Specifies the domain of the user that is being mapped.
    user str
    Specifies the name of the user that is being mapped.
    domain String
    Specifies the domain of the user that is being mapped.
    user String
    Specifies the name of the user that is being mapped.

    GetUserMappingRulesUserMappingRuleSourceUser

    Domain string
    Specifies the domain of the user that is being mapped.
    User string
    Specifies the name of the user that is being mapped.
    Domain string
    Specifies the domain of the user that is being mapped.
    User string
    Specifies the name of the user that is being mapped.
    domain String
    Specifies the domain of the user that is being mapped.
    user String
    Specifies the name of the user that is being mapped.
    domain string
    Specifies the domain of the user that is being mapped.
    user string
    Specifies the name of the user that is being mapped.
    domain str
    Specifies the domain of the user that is being mapped.
    user str
    Specifies the name of the user that is being mapped.
    domain String
    Specifies the domain of the user that is being mapped.
    user String
    Specifies the name of the user that is being mapped.

    GetUserMappingRulesUserMappingRuleTargetUser

    Domain string
    Specifies the domain of the user that is being mapped.
    User string
    Specifies the name of the user that is being mapped.
    Domain string
    Specifies the domain of the user that is being mapped.
    User string
    Specifies the name of the user that is being mapped.
    domain String
    Specifies the domain of the user that is being mapped.
    user String
    Specifies the name of the user that is being mapped.
    domain string
    Specifies the domain of the user that is being mapped.
    user string
    Specifies the name of the user that is being mapped.
    domain str
    Specifies the domain of the user that is being mapped.
    user str
    Specifies the name of the user that is being mapped.
    domain String
    Specifies the domain of the user that is being mapped.
    user String
    Specifies the name of the user that is being mapped.

    GetUserMappingRulesUserMappingRulesParameters

    DefaultUnixUser GetUserMappingRulesUserMappingRulesParametersDefaultUnixUser
    Specifies the default UNIX user information that can be applied if the final credentials do not have valid UID and GID information.
    DefaultUnixUser GetUserMappingRulesUserMappingRulesParametersDefaultUnixUser
    Specifies the default UNIX user information that can be applied if the final credentials do not have valid UID and GID information.
    defaultUnixUser GetUserMappingRulesUserMappingRulesParametersDefaultUnixUser
    Specifies the default UNIX user information that can be applied if the final credentials do not have valid UID and GID information.
    defaultUnixUser GetUserMappingRulesUserMappingRulesParametersDefaultUnixUser
    Specifies the default UNIX user information that can be applied if the final credentials do not have valid UID and GID information.
    default_unix_user GetUserMappingRulesUserMappingRulesParametersDefaultUnixUser
    Specifies the default UNIX user information that can be applied if the final credentials do not have valid UID and GID information.
    defaultUnixUser Property Map
    Specifies the default UNIX user information that can be applied if the final credentials do not have valid UID and GID information.

    GetUserMappingRulesUserMappingRulesParametersDefaultUnixUser

    Domain string
    Specifies the domain of the user that is being mapped.
    User string
    Specifies the name of the user that is being mapped.
    Domain string
    Specifies the domain of the user that is being mapped.
    User string
    Specifies the name of the user that is being mapped.
    domain String
    Specifies the domain of the user that is being mapped.
    user String
    Specifies the name of the user that is being mapped.
    domain string
    Specifies the domain of the user that is being mapped.
    user string
    Specifies the name of the user that is being mapped.
    domain str
    Specifies the domain of the user that is being mapped.
    user str
    Specifies the name of the user that is being mapped.
    domain String
    Specifies the domain of the user that is being mapped.
    user String
    Specifies the name of the user that is being mapped.

    Package Details

    Repository
    powerscale dell/terraform-provider-powerscale
    License
    Notes
    This Pulumi package is based on the powerscale Terraform Provider.
    powerscale logo
    powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell