Export (0) Print
Expand All
Expand Minimize

New-ADResourceProperty

Windows Server 2012 and Windows 8

Applies To: Windows Server 2012

New-ADResourceProperty

Creates a new resource property in Active Directory.

Syntax

Parameter Set: Default
New-ADResourceProperty [-DisplayName] <String> -ResourcePropertyValueType <ADResourcePropertyValueType> [-AppliesToResourceTypes <String[]> ] [-AuthType <ADAuthType> ] [-Credential <PSCredential> ] [-Description <String> ] [-Enabled <Boolean> ] [-ID <String> ] [-Instance <ADResourceProperty> ] [-IsSecured <Boolean> ] [-OtherAttributes <Hashtable> ] [-PassThru] [-ProtectedFromAccidentalDeletion <Boolean> ] [-Server <String> ] [-SharesValuesWith <ADClaimType> ] [-SuggestedValues <ADSuggestedValueEntry[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The New-ADResourceProperty cmdlet creates a new resource property in the directory.

Parameters

-AppliesToResourceTypes<String[]>

Specifies the resource types to which this resource property is applied.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-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


Aliases

none

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

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"


Aliases

none

Required?

false

Position?

named

Default Value

none

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.

The display name of a resource property can be used as an identity in other Active Directory cmdlets. For example, if the display name of a resource property is "Country", then you can use 'Get-ADResourceProperty -Identity "Country"' to retrieve the resource property.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Enabled<Boolean>

Specifies if the resource property is enabled.


Aliases

none

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.

The ID should only be set manually in a multi-forest environment where the same resource properties need to work across forests. For resource properties to be considered identical across forests, their ID must be the same.

To specify the ID, the ID string must conform to the following format:

1. Start with a prefix string of 1 to 15 characters in length.

2. The prefix string must be followed by an underscore.

3. The prefix string and underscore must be followed by a suffix string of 1 to 16 characters in length.

4. All characters contained in either prefix or suffix strings must contain only valid filename characters.


Aliases

none

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.

You can use an instance of an existing resource property object as a template or you can construct a new resource property 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 object.

Method 1: Use an existing resource property object as a template for a new object. To retrieve an instance of an existing resource property object, use a cmdlet such as Get-ADResourceProperty. Then provide this object to the Instance parameter of the New-ADResourceProperty cmdlet to create a new resource property object. You can override property values of the new object by setting the appropriate parameters.

$objectInstance = Get-ADResourceProperty -Identity "Country"

New-ADResourceProperty -Name "Region" -Instance $ObjectInstance

Method 2: Create a new ADResourceProperty and set the property values by using the Windows PowerShell command line interface. Then pass this object to the Instance parameter of the New-ADResourceProperty cmdlet to create the new resource property object.

$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADResourceProperty

$objectInstance.Description = "Non-Disclosure Agreement (NDA)"

New-ADResourceProperty -Name "NDA" -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.


Aliases

none

Required?

false

Position?

named

Default Value

none

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.


Aliases

none

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.

Syntax:

To specify a single value for an attribute:

-OtherAttributes @{'AttributeLDAPDisplayName'=value}

To specify multiple values for an attribute

-OtherAttributes @{'AttributeLDAPDisplayName'=value1,value2,...}

You can specify values for more than one attribute by using semicolons to separate attributes. The following syntax shows how to set values for multiple attributes:

-OtherAttributes @{'Attribute1LDAPDisplayName'=value; 'Attribute2LDAPDisplayName'=value1,value2;...}

The following examples show how to use this parameter.

To set the value of a custom attribute called favColors that takes a set of Unicode strings, use the following syntax:

-OtherAttributes @{'favColors'="pink","purple"}

To set values for favColors and dateOfBirth simultaneously, use the following syntax:

-OtherAttributes @{'favColors'="pink","purple"; 'dateOfBirth'=" 01/01/1960"}


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PassThru

Returns the new or modified object. By default (i.e. if -PassThru is not specified), this cmdlet does not generate any output.


Aliases

none

Required?

false

Position?

named

Default Value

none

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


Aliases

none

Required?

false

Position?

named

Default Value

none

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.

The full list of resource property value types can be retrieved by calling the Get-ADResourcePropertyValueType cmdlet.

Example: Get-ADResourcePropertyValueType -Filter * | ft Name

Below is a list of the built-in resource property value types available in Active Directory:

- MS-DS-SinglevaluedChoice

- MS-DS-YesNo

- MS-DS-Number

- MS-DS-DateTime

- MS-DS-OrderedList

- MS-DS-Text

- MS-DS-MultivaluedText

- MS-DS-MultivaluedChoice


Aliases

none

Required?

true

Position?

named

Default Value

none

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"


Aliases

none

Required?

false

Position?

named

Default Value

none

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

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.

Example:

$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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None or Microsoft.ActiveDirectory.Management.ADResourceProperty

Outputs

The output type is the type of the objects that the cmdlet emits.

  • None or Microsoft.ActiveDirectory.Management.ADResourceProperty

Notes

  • This cmdlet does not work with an Active Directory Snapshot.

    This cmdlet does not work with a read-only domain controller.

Examples

-------------------------- EXAMPLE 1 --------------------------

Description

-----------

Create a new resource property with display name 'Authors'. The resource property allows the names of multiple authors to be specified.


C:\PS>New-ADResourceProperty Authors -ResourcePropertyValueType MS-DS-MultivaluedText

-------------------------- EXAMPLE 2 --------------------------

Description

-----------

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>$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

-------------------------- EXAMPLE 3 --------------------------

Description

-----------

Create a new reference resource property with display name 'Country'. 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 Country -ResourcePropertyValueType MS-DS-MultivaluedChoice  -SharesValuesWith Country

-------------------------- EXAMPLE 4 --------------------------

Description

-----------

Create a new resource property with display name 'Authors', and set its ID to 'Authors_60DB20331638'.

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.


C:\PS>New-ADResourceProperty Authors -ResourcePropertyValueType MS-DS-MultivaluedText -ID Authors_60DB20331638

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft