Get-ADClaim
Transform
Policy
Syntax
Get-ADClaimTransformPolicy
[-AuthType <ADAuthType>]
[-Credential <PSCredential>]
-Filter <String>
[-Properties <String[]>]
[-Server <String>]
[<CommonParameters>]
Get-ADClaimTransformPolicy
[-AuthType <ADAuthType>]
[-Credential <PSCredential>]
[[-Identity] <ADClaimTransformPolicy>]
[-Properties <String[]>]
[-Server <String>]
[<CommonParameters>]
Get-ADClaimTransformPolicy
[-AuthType <ADAuthType>]
[-Credential <PSCredential>]
-LDAPFilter <String>
[-Properties <String[]>]
[-Server <String>]
[<CommonParameters>]
Description
The Get-ADClaimTransformPolicy cmdlet returns one or more Active Directory claim transform objects based on a specified filter.
Examples
Example 1: Get a list of all claims transformation policies
PS C:\> Get-ADClaimTransformPolicy -Filter *
This command retrieves a list of all claims transformation policies.
Example 2: Get all the claims transformation policies that are applied to a specific trust
PS C:\> $Contoso = Get-ADTrust -Identity "corp.contoso.com"
PS C:\> Get-ADClaimTransformPolicy -Filter {IncomingTrust -eq $Contoso -or OutgoingTrust -eq $Contoso}
This example gets all the claims transformation policies that are applied to trusts made with corp.contoso.com.
Example 3: Get the claims transformation policy with a specify policy name
PS C:\> Get-ADClaimTransformPolicy -Identity DenyAllPolicy
This command gets the claims transformation policy with the name DenyAllPolicy.
Example 4: Get information on claims using a LDAP based query filter
PS C:\> Get-ADClaimTransformPolicy -LDAPFilter "(name=DenyAll*)"
This command gets information on any claims transformation policies using an LDAP-based query filter that looks for matches where policies have a name that starts with the word DenyAll.
Required Parameters
Specifies a query string that retrieves Active Directory objects.
This string uses the Windows PowerShell Expression Language syntax.
The Windows PowerShell Expression Language syntax provides rich type-conversion support for value types received by the
Filter
parameter.
The syntax uses an in-order representation, which means that the operator is placed between the operand and the value.
For more information about the
Filter
parameter, type
Get-Help about_ActiveDirectory_Filter
.
Syntax:
The following syntax uses Backus-Naur form to show how to use the Windows PowerShell Expression Language for this parameter.
<filter> ::= "{" <FilterComponentList> "}"
<FilterComponentList> ::= <FilterComponent> | <FilterComponent> <JoinOperator> <FilterComponent> | <NotOperator> <FilterComponent>
<FilterComponent> ::= <attr> <FilterOperator> <value> | "(" <FilterComponent> ")"
<FilterOperator> ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike"
<JoinOperator> ::= "-and" | "-or"
<NotOperator> ::= "-not"
<attr> ::= <PropertyName> | <LDAPDisplayName of the attribute>
<value>::= <compare this value with an <attr> by using the specified <FilterOperator>>
For a list of supported types for <value>, see about_ActiveDirectory_ObjectModel.
Note: To query using Lightweight Directory Access Protocol (LDAP) query strings, use the LDAPFilter parameter.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies an LDAP query string that is used to filter Active Directory objects.
You can use this parameter to run your existing LDAP queries.
The
Filter
parameter syntax supports the same functionality as the LDAP syntax.
For more information, see the
Filter
parameter description or type
Get-Help about_ActiveDirectory_Filter
.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Optional Parameters
Specifies the authentication method to use. The acceptable values for this parameter are:
- Negotiate or 0
- Basic or 1
The default authentication method is Negotiate.
A Secure Sockets Layer (SSL) connection is required for the Basic authentication method.
Type: | ADAuthType |
Parameter Sets: | Negotiate, Basic |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the user account credentials to use to perform this task. The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the account associated with the drive is the default.
To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a PSCredential object. If you specify a user name for this parameter, the cmdlet prompts for a password.
You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. You can then set the Credential parameter to the PSCredential object.
If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error.
Type: | PSCredential |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies an Active Directory object by providing one of the following property values. The identifier in parentheses is the LDAP display name for the attribute. The acceptable values for this parameter are:
- A distinguished name
The cmdlet searches the default naming context or partition to find the object. If two or more objects are found, the cmdlet returns a non-terminating error.
This parameter can also get this object through the pipeline or you can set this parameter to an object instance.
Type: | ADClaimTransformPolicy |
Position: | 0 |
Default value: | None |
Accept pipeline input: | True (ByValue) |
Accept wildcard characters: | False |
Specifies the properties of the output object to retrieve from the server. Use this parameter to retrieve properties that are not included in the default set.
Specify properties for this parameter as a comma-separated list of names. To display all of the attributes that are set on the object, specify * (asterisk).
To specify an individual extended property, use the name of the property. For properties that are not default or extended properties, you must specify the LDAP display name of the attribute.
To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the Get-Member cmdlet.
Type: | String[] |
Aliases: | Property |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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.
Specify the Active Directory Domain Services instance in one of the following ways:
Domain name values:
- Fully qualified domain name
- NetBIOS name
Directory server values:
- Fully qualified directory server name
- NetBIOS name
- Fully qualified directory server name and port
The default value for this parameter is determined by one of the following methods in the order that they are listed:
- By using the Server value from objects passed through the pipeline
- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive
- By using the domain of the computer running Windows PowerShell
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
None or Microsoft.ActiveDirectory.Management.ADClaimTransformPolicy
A claim transform policy object is received by the Identity parameter.
Outputs
Microsoft.ActiveDirectory.Management.ADClaimTransformPolicy