Share via


Set-PAMGroup

Updates a PAM group in the MIM Service.

Syntax

Default (Default)

Set-PAMGroup
    [-Group] <PAMGroup>
    [[-SourceAccountName] <String>]
    [[-SourceDomain] <String>]
    [[-SourceAccountSID] <String>]
    [[-PrivAccountName] <String>]
    [[-PrivDisplayName] <String>]
    [[-PrivDescription] <String>]
    [[-Active] <Boolean>]
    [[-Session] <PAMSession>]
    [<CommonParameters>]

Description

The Set-PAMGroup cmdlet updates a PAM group in the MIM Service and the PAM domain. The group in the source domain is not modified.

Examples

EXAMPLE 1

Set-PAMGroup -Group (Get-PAMGroup -PrivDisplayName "contoso.corpadmins") -PrivDescription "For IT Use"

This command changes the description of a group with a specified display name in the MIM Service and the PAM domain.

Parameters

-Active

Whether the group is active for activation.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:8
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Group

The group to be updated, returned by Get-PAMGroup.

Parameter properties

Type:PAMGroup
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-PrivAccountName

Account name of the group in the PAM domain.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:5
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PrivDescription

Description of the group in the PAM domain.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:7
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PrivDisplayName

Display Name of the group in the PAM domain.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:6
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Session

Session with the PAM domain and MIM Service.

Parameter properties

Type:PAMSession
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:9
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SourceAccountName

Overrides the account name of the group in the source domain.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SourceAccountSID

Overrides the security identifier of the group in the source domain.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:4
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SourceDomain

NetBIOS name of the domain in which the source group is located.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:3
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

Microsoft.IdentityManagement.PamCmdlets.Model.PAMGroup

Modified PAM group.