Set-ADResourceProperty

  ActiveDirectory
Module Version:

1.0.0.0

NAME:
Set-ADResourceProperty
DESCRIPTION:

The Set-ADResourceProperty cmdlet can be used to modify a resource property in Active Directory.

EXAMPLES:

SYNTAX:

SYNOPSIS:
Modifies a resource property in Active Directory.
INPUTS:

None or Microsoft.ActiveDirectory.Management.ADResourceProperty

OUTPUTS:

None or Microsoft.ActiveDirectory.Management.ADResourceProperty

PARAMETERS:

-Add
Specifies values to add to an object property. Use this parameter to add one or more values to a property that cannot be modified using a cmdlet
parameter. To modify an object property, you must use the LDAP display name. You can specify multiple values to a property by specifying a
comma-separated list of values and more than one property by separating them using a semicolon.. The format for this parameter is

-Add @{Attribute1LDAPDisplayName=value1, value2, …; Attribute2LDAPDisplayName=value1, value2, …; AttributeNLDAPDisplayName=value1, value2, …}

For example, if you want to remove the value “555-222-2222” and add the values “555-222-1111” and “555-222-3333” to Phone-Office-Other attribute (LDAP
display name ‘otherTelephone’), and add the value “555-222-9999” to Phone-Mobile-Other (LDAP display name ‘otherMobile’), set the Add and Remove
parameters as follows.

-Add @{otherTelephone=’555-222-1111′, ‘555-222-3333′; otherMobile=’555-222-9999′ } -Remove @{otherTelephone=’555-222-2222’}

When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order:

..Remove

..Add

..Replace

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-AppliesToResourceTypes
Specifies the list of resource types that this property applies to. For Set-ADResourceProperty operations, you can add or include new resource types
within an existing property by specifying them using this parameter. You do not have to specify all previously listed resource types already within this
property.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

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

-Clear
Specifies an array of object properties that will be cleared in the directory. Use this parameter to clear one or more values of a property that cannot
be modified using a cmdlet parameter. To modify an object property, you must use the LDAP display name. You can modify more than one property by
specifying a comma-separated list. The format for this parameter is

-Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName

For example, if you want to clear the value for the Phone-Office-Other attribute (LDAP display name ‘otherTelephone’) set the Clear parameter as follows.

-Clear otherTelephone

When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order:

..Remove

..Add

..Replace

..Clear

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Credential
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
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? false
Accept wildcard characters? false

-DisplayName
Displays the name of the resource property. The display name of the resource property must be unique.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Enabled
Specifies if the resource property is enabled.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Identity
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.

Distinguished Name

Example: CN=saradavis,OU=users,OU=asia,DC=corp,DC=contoso,DC=com

GUID (objectGUID)

Example: 599c3d2e-f72d-4d20-8a88-030d99495f20

This parameter can also get this object through the pipeline or you can set this parameter to an object instance.

This example shows how to set this parameter to an ADObject object instance named “ADObjectInstance”.

-Identity $ADObjectInstance

Required? true
Position? 1
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? false

-Instance
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.

Required? true
Position? named
Default value
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.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-ProtectedFromAccidentalDeletion
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? false
Accept wildcard characters? false

-Remove
Specifies that the cmdlet remove values of an object property. Use this parameter to remove one or more values of a property that cannot be modified
using a cmdlet parameter. To remove an object property, you must use the LDAP display name. You can remove more than one property by specifying a
semicolon-separated list. The format for this parameter is

-Remove @{Attribute1LDAPDisplayName=value[]; Attribute2LDAPDisplayName=value[]}

For example, if you want to add the values blue and green and remove the value pink from a property with a LDAP display name of FavColors, set the Add
and Remove parameters as follows.

-Add @{FavColors=Blue,Green} -Remove {FavColors=Pink}

When you use the Add, Remove, Replace and Clear parameters together, the parameters will be applied in the following sequence:

..Remove

..Add

..Replace

..Clear

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Replace
Specifies values for an object property that will replace the current values. Use this parameter to replace one or more values of a property that cannot
be modified using a cmdlet parameter. To modify an object property, you must use the LDAP display name. You can modify more than one property by
specifying a comma-separated list. The format for this parameter is

-Replace @{Attribute1LDAPDisplayName=value[], Attribute2LDAPDisplayName=value[]}

For example, if you want to replace the value “555-222-2222” with the values “555-222-1111” for Phone-Office-Other attribute (LDAP display name
‘otherTelephone’) set the Replace parameter as follows.

-Replace @{otherTelephone=’555-222-2222′, ‘555-222-1111’}

When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order:

..Remove

..Add

..Replace

..Clear

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

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

-SharesValuesWith
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 be always valid for comparisons with the
referred claim type in a central access rule.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

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

Required? false
Position? named
Default value
Accept pipeline input? false
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


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).

LEAVE A COMMENT