New-ADClaimTransformPolicy
Synopsis
Description
Parameters
-AllowAll
When this parameter is specified, the policy sets a claims transformation rule that would allow all claims to be sent or received.
Required? true
Position? named
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AllowAllExcept <ADClaimType[]>
When this parameter is specified, the policy sets a claims transformation rule that would allow all claims to be sent or received except for the specified claim types.
Required? true
Position? named
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AuthType <ADAuthType>
Specifies the authentication method to use. Possible values for this parameter include:
Required? false
Position? named
Default value Microsoft.ActiveDirectory.Management.AuthType.Negotiate
Accept pipeline input? false
Accept wildcard characters? false
-Credential <PSCredential>
Specifies a user account that has permission to perform this action. The default is the current user.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DenyAll <SwitchParameter>
When this parameter is specified, the policy sets a claims transformation rule that would deny all claims to be sent or received.
Required? true
Position? named
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DenyAllExcept <ADClaimType[]>
When this parameter is specified, the policy sets a claims transformation rule that would deny all claims to be sent or received except for the specified claim types.
Required? true
Position? named
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Description <String>
Specifies a description of the object. This parameter sets the value of the Description property for the object. The LDAP Display Name (ldapDisplayName) for this property is "description".
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Instance <ADClaimTransformPolicy>
Specifies an instance of an Active Directory object to use as a template for a new claims transformation policy object.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
Specifies the name of the object. This parameter sets the Name property of the Active Directory object. The LDAP Display Name (ldapDisplayName) of this property is "name".
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PassThru <SwitchParameter>
Returns the new or modified object. By default (i.e. if -PassThru is not specified), this cmdlet does not generate any output.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ProtectedFromAccidentalDeletion <Boolean>
Specifies whether to prevent the object from being deleted. When this property is set to true, you cannot delete the corresponding object without changing the value of the property. Possible values for this parameter include:
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Rule <String>
Represents the claims transformation rule. To specify the rule, you can either (1) type the rule in a text file, and then pass the file to the cmdlet (recommended), or (2) type the rule inline.
Required? true
Position? named
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Server <String>
Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm <SwitchParameter>
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf <SwitchParameter>
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? falseSyntax
New-ADClaimTransformPolicy [-WhatIf] [-Confirm] [-AllowAll] [-AuthType <ADAuthType>] [-Credential <PSCredential>] [-Description <String>] [-Name] <String> [-PassThru] [-ProtectedFromAccidentalDeletion <Boolean>] [-Server <String>] [<CommonParameters>]
New-ADClaimTransformPolicy [-WhatIf] [-Confirm] -AllowAllExcept <ADClaimType[]> [-AuthType <ADAuthType>] [-Credential <PSCredential>] [-Description <String>] [-Name] <String> [-PassThru] [-ProtectedFromAccidentalDeletion <Boolean>] [-Server <String>] [<CommonParameters>]
New-ADClaimTransformPolicy [-WhatIf] [-Confirm] [-AuthType <ADAuthType>] [-Credential <PSCredential>] [-DenyAll] [-Description <String>] [-Name] <String> [-PassThru] [-ProtectedFromAccidentalDeletion <Boolean>] [-Server <String>] [<CommonParameters>]
New-ADClaimTransformPolicy [-WhatIf] [-Confirm] [-AuthType <ADAuthType>] [-Credential <PSCredential>] -DenyAllExcept <ADClaimType[]> [-Description <String>] [-Name] <String> [-PassThru] [-ProtectedFromAccidentalDeletion <Boolean>] [-Server <String>] [<CommonParameters>]
New-ADClaimTransformPolicy [-WhatIf] [-Confirm] [-AuthType <ADAuthType>] [-Credential <PSCredential>] [-Description <String>] [-Instance <ADClaimTransformPolicy>] [-Name] <String> [-PassThru] [-ProtectedFromAccidentalDeletion <Boolean>] -Rule <String> [-Server <String>] [<CommonParameters>]
This cmdlet does not work with an Active Directory Snapshot.
C:\PS>New-ADClaimTransformPolicy DenyAllPolicy -DenyAll
Create a new claims transformation policy named ‘DenyAllPolicy’ that denies all claims, both those that are sent as well as those that are received.
C:\PS>New- ADClaimTransformPolicy AllowAllExceptCompanyAndDepartmentPolicy -AllowAllExcept Company,Department
Create a new claims transformation policy named ‘AllowAllExceptCompanyAndDepartmentPolicy’ that allows all claims to be sent or received except for the claims ‘Company’ and ‘Department’.
C:\PS>New- ADClaimTransformPolicy HumanResourcesToHrPolicy -Rule ‘C1:[Type==”ad://ext/Department:43ceb0fe67a125db”, Value==”Human Resources”, ValueType==”string”] => issue(Type=C1.Type, Value=”HR”, ValueType=C1.ValueType);’
Create a new claims transformation policy named ‘HumanResourcesToHrPolicy’ that transforms the value ‘Human Resources’ to ‘HR’ in the claim ‘Department’.
C:\PS>$rule = Get-Content C:\rule1.txt;
New- ADClaimTransformPolicy MyRule -Rule $rule
Create a new claims transformation policy named ‘MyRule’ with the rule specified in C:\rule1.txt.
Get-Command New-ADClaimTransformPolicy
