New-ADResourceProperty
Synopsis
Description
Parameters
-AppliesToResourceTypes
Specifies the resource types to which this resource property is applied.
Required? false
Position? named
Default value
Accept pipeline input? false
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 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 PowerShell provider drive. If the cmdlet is run from such a provider drive, the account associated with the drive is the default.
Required? false
Position? named
Default value
Accept pipeline input? false
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? True (ByPropertyName)
Accept wildcard characters? false
-DisplayName <String>
Specifies the display name of the resource property. The display name of the resource property must be unique.
Required? true
Position? 1
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Enabled <Boolean>
Specifies if the resource property is enabled.
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ID <String>
Specifies the resource property ID. This is an optional parameter. By default, New-ADResourceProperty generates the ID automatically.
Required? false
Position? named
Default value Auto-generated
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Instance <ADResourceProperty>
Specifies an instance of a resource property object to use as a template for a new resource property object.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IsSecured <Boolean>
Used to configure whether the resource property is secure or not. Only secure resource properties can be used for authorization decisions or used within central access rules. Unsecured resource properties cannot be used for these purposes.
Required? false
Position? named
Default value True
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-OtherAttributes <Hashtable>
Specifies object attribute values for attributes that are not represented by cmdlet parameters. You can set one or more parameters at the same time with this parameter. If an attribute takes more than one value, you can assign multiple values. To identify an attribute, specify the LDAPDisplayName (ldapDisplayName) defined for it in the Active Directory schema.
Required? false
Position? named
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? True (ByPropertyName)
Accept wildcard characters? false
-ResourcePropertyValueType <ADResourcePropertyValueType>
The parameter specifies the value type for this resource property. When a resource property is passed to a resource manager (e.g., File Server), the resource manager leverages the resource property value type to determine how the resource property should be handled.
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
-SharesValuesWith <ADClaimType>
Use this parameter to create a reference resource property. Reference resource properties do not provide their own suggested values, but rather use the suggested values from the claim type object specified in this parameter. This enables the resource property to always remain valid for use in comparisons to its referred claim type within a central access rule.
Required? false
Position? named
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SuggestedValues <ADSuggestedValueEntry[]>
Specifies one or more suggested values for the resource property. An application may choose to present this list of suggested values for the user to choose from. When RestrictValues is set to true, the application should restrict the user to pick values from this list only.
Required? false
Position? named
Default value
Accept pipeline input? True (ByPropertyName)
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-ADResourceProperty [-WhatIf] [-Confirm] [-AppliesToResourceTypes <String[]>] [-AuthType <ADAuthType>] [-Credential <PSCredential>] [-Description <String>] [-DisplayName] <String> [-Enabled <Boolean>] [-ID <String>] [-Instance <ADResourceProperty>] [-IsSecured <Boolean>] [-OtherAttributes <Hashtable>] [-PassThru] [-ProtectedFromAccidentalDeletion <Boolean>] -ResourcePropertyValueType <ADResourcePropertyValueType> [-Server <String>] [-SharesValuesWith <ADClaimType>] [-SuggestedValues <ADSuggestedValueEntry[]>] [<CommonParameters>]
This cmdlet does not work with an Active Directory Snapshot.
C:\PS>New-ADResourceProperty Authors -ResourcePropertyValueType MS-DS-MultivaluedText
Create a new resource property with display name ‘Authors’. The resource property allows the names of multiple authors to be specified.
C:\PS>$us = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry(“US”, “United States of America”, “United States of America”);
$jp = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry(“JP”, “Japan”, “Japan”);
New-ADResourceProperty Country -ResourcePropertyValueType MS-DS-MultivaluedChoice -SuggestedValues $us,$jp
Create a new resource property with display name ‘Country’. The suggested values are set to ‘US’ and ‘JP’. Applications using this resource property would allow their users to specify one of the suggested values as this resource property’s value.
C:\PS>New-ADResourceProperty Region -ResourcePropertyValueType MS-DS-MultivaluedChoice -SharesValuesWith Country
Create a new reference resource property with display name ‘Region’. It uses an existing claim type named ‘Country’ for its suggested values. This enables the resource property to be always valid for comparisons with the referenced claim type in a central access rule.
C:\PS>New-ADResourceProperty Authors -ResourcePropertyValueType MS-DS-MultivaluedText -ID A9KS8989
Create a new resource property with display name ‘Authors’, and set its ID to ‘A9KS8989’.
The ID should only be set manually in a multi-forest environment where the same resource property needs to work across forests. By default, New-ADResourceProperty generates the ID automatically. For resource properties to be considered identical across forests, their ID must be the same.
Get-Command New-ADResourceProperty
. Get-ADResourceProperty
