< Back
New-ADResourcePropertyList
Post
NAME New-ADResourcePropertyList
SYNOPSIS
Creates a new resource property list in Active Directory.
SYNTAX
New-ADResourcePropertyList [-Name] <String> [-AuthType {Negotiate | Basic}] [-Credential <PSCredential>]
[-Description <String>] [-Instance <ADResourcePropertyList>] [-PassThru] [-ProtectedFromAccidentalDeletion
<Boolean>] [-Server <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The New-ADResourcePropertyList cmdlet creates a resource property list in Active Directory.
PARAMETERS
-AuthType <ADAuthType>
Specifies the authentication method to use. Possible values for this parameter include:
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.
The following example shows how to set this parameter to Basic.
-AuthType Basic
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.
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 The following example shows how to create
credentials.
$AdminCredentials = Get-Credential "Domain01\\User01"
The following shows how to set the Credential parameter to these credentials.
-Credential $AdminCredentials
If the acting credentials do not have directory-level permission to perform the task, Active Directory
PowerShell returns a terminating error.
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".
The following example shows how to set this parameter to a sample description.
-Description "Description of the object"
Required? false
Position? named
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Instance <ADResourcePropertyList>
Specifies an instance of an resource property list object to use as a template for a new resource property
list object.
You can use an instance of an existing resource property list object as a template or you can construct a new
resource property list object by using the Windows PowerShell command line or by using a script. The following
examples show how to use these two methods to create a new resource property list object.
Method 1: Use an existing resource property list object as a template for a new object. To retrieve an
instance of an existing resource property list object, use a cmdlet such as Get-ADResourcePropertyList. Then
provide this object to the Instance parameter of the New-ADResourcePropertyList cmdlet to create a new
resource property list object. You can override property values of the new object by setting the appropriate
parameters.
$objectInstance = Get-ADResourcePropertyList -Identity "Global Resource Property List"
New-ADResourcePropertyList -Name "Finance Resource Property List" -Instance $ObjectInstance
Method 2: Create a new ADResourcePropertyList and set the property values by using the Windows PowerShell
command line interface. Then pass this object to the Instance parameter of the New-ADResourcePropertyList
cmdlet to create the new resource property list object.
$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADResourcePropertyList
$objectInstance.Description = "For finance use only."
New-ADResourcePropertyList -Name "Finance Resource Property List" -Instance $ObjectInstance
Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be
set will raise an error.
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".
The following example shows how to set this parameter to a name string.
-Name "SaraDavis"
Required? true
Position? 2
Default value
Accept pipeline input? True (ByPropertyName)
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:
$false or 0
$true or 1
The following example shows how to set this parameter to true.
-ProtectedFromAccidentalDeletion $true
Required? false
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.
Domain name values:
Fully qualified domain name
Examples: corp.contoso.com
NetBIOS name
Example: CORP
Directory server values:
Fully qualified directory server name
Example: corp-DC12.corp.contoso.com
NetBIOS name
Example: corp-DC12
Fully qualified directory server name and port
Example: corp-DC12.corp.contoso.com:3268
The default value for the Server parameter is determined by one of the following methods in the order that
they are listed:
-By using Server value from objects passed through the pipeline.
-By using the server information associated with the Active Directory PowerShell provider drive, when running
under that drive.
-By using the domain of the computer running Powershell.
The following example shows how to specify a full qualified domain name as the parameter value.
-Server "corp.contoso.com"
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? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None or Microsoft.ActiveDirectory.Management.ADResourcePropertyList
OUTPUTS
None or Microsoft.ActiveDirectory.Management.ADResourcePropertyList
NOTES
This cmdlet does not work with an Active Directory Snapshot.
This cmdlet does not work with a read-only domain controller.
-------------------------- EXAMPLE 1 --------------------------
C:\\PS>New-ADResourcePropertyList "Corporate Resource Property List"
Description
-----------
Creates a new resource property list named "Corporate Resource Property List".
-------------------------- EXAMPLE 2 --------------------------
C:\\PS>New-ADResourcePropertyList "Corporate Resource Property List" -Description "For corporate documents."
Description
-----------
Creates a new resource property list named "Corporate Resource Property List" with the description "For corporate
documents."
-------------------------- EXAMPLE 3 --------------------------
C:\\PS>Get-ADResourcePropertyList "Corporate Resource Property List" | New-ADResourcePropertyList "Finance Resource
Property List"
Description
-----------
Create a new resource property list using the property values from a 'Corporate Resource Property List'.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=291075
SYNOPSIS
Creates a new resource property list in Active Directory.
SYNTAX
New-ADResourcePropertyList [-Name] <String> [-AuthType {Negotiate | Basic}] [-Credential <PSCredential>]
[-Description <String>] [-Instance <ADResourcePropertyList>] [-PassThru] [-ProtectedFromAccidentalDeletion
<Boolean>] [-Server <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The New-ADResourcePropertyList cmdlet creates a resource property list in Active Directory.
PARAMETERS
-AuthType <ADAuthType>
Specifies the authentication method to use. Possible values for this parameter include:
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.
The following example shows how to set this parameter to Basic.
-AuthType Basic
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.
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 The following example shows how to create
credentials.
$AdminCredentials = Get-Credential "Domain01\\User01"
The following shows how to set the Credential parameter to these credentials.
-Credential $AdminCredentials
If the acting credentials do not have directory-level permission to perform the task, Active Directory
PowerShell returns a terminating error.
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".
The following example shows how to set this parameter to a sample description.
-Description "Description of the object"
Required? false
Position? named
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Instance <ADResourcePropertyList>
Specifies an instance of an resource property list object to use as a template for a new resource property
list object.
You can use an instance of an existing resource property list object as a template or you can construct a new
resource property list object by using the Windows PowerShell command line or by using a script. The following
examples show how to use these two methods to create a new resource property list object.
Method 1: Use an existing resource property list object as a template for a new object. To retrieve an
instance of an existing resource property list object, use a cmdlet such as Get-ADResourcePropertyList. Then
provide this object to the Instance parameter of the New-ADResourcePropertyList cmdlet to create a new
resource property list object. You can override property values of the new object by setting the appropriate
parameters.
$objectInstance = Get-ADResourcePropertyList -Identity "Global Resource Property List"
New-ADResourcePropertyList -Name "Finance Resource Property List" -Instance $ObjectInstance
Method 2: Create a new ADResourcePropertyList and set the property values by using the Windows PowerShell
command line interface. Then pass this object to the Instance parameter of the New-ADResourcePropertyList
cmdlet to create the new resource property list object.
$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADResourcePropertyList
$objectInstance.Description = "For finance use only."
New-ADResourcePropertyList -Name "Finance Resource Property List" -Instance $ObjectInstance
Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be
set will raise an error.
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".
The following example shows how to set this parameter to a name string.
-Name "SaraDavis"
Required? true
Position? 2
Default value
Accept pipeline input? True (ByPropertyName)
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:
$false or 0
$true or 1
The following example shows how to set this parameter to true.
-ProtectedFromAccidentalDeletion $true
Required? false
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.
Domain name values:
Fully qualified domain name
Examples: corp.contoso.com
NetBIOS name
Example: CORP
Directory server values:
Fully qualified directory server name
Example: corp-DC12.corp.contoso.com
NetBIOS name
Example: corp-DC12
Fully qualified directory server name and port
Example: corp-DC12.corp.contoso.com:3268
The default value for the Server parameter is determined by one of the following methods in the order that
they are listed:
-By using Server value from objects passed through the pipeline.
-By using the server information associated with the Active Directory PowerShell provider drive, when running
under that drive.
-By using the domain of the computer running Powershell.
The following example shows how to specify a full qualified domain name as the parameter value.
-Server "corp.contoso.com"
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? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None or Microsoft.ActiveDirectory.Management.ADResourcePropertyList
OUTPUTS
None or Microsoft.ActiveDirectory.Management.ADResourcePropertyList
NOTES
This cmdlet does not work with an Active Directory Snapshot.
This cmdlet does not work with a read-only domain controller.
-------------------------- EXAMPLE 1 --------------------------
C:\\PS>New-ADResourcePropertyList "Corporate Resource Property List"
Description
-----------
Creates a new resource property list named "Corporate Resource Property List".
-------------------------- EXAMPLE 2 --------------------------
C:\\PS>New-ADResourcePropertyList "Corporate Resource Property List" -Description "For corporate documents."
Description
-----------
Creates a new resource property list named "Corporate Resource Property List" with the description "For corporate
documents."
-------------------------- EXAMPLE 3 --------------------------
C:\\PS>Get-ADResourcePropertyList "Corporate Resource Property List" | New-ADResourcePropertyList "Finance Resource
Property List"
Description
-----------
Create a new resource property list using the property values from a 'Corporate Resource Property List'.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=291075