Export (0) Print
Expand All
Related Help Topics
Loading
No resources found.
Related Blog Articles
Loading
No resources found.
Expand Minimize

Set-Contact

 

Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2012-11-16

Use the Set-Contact cmdlet to modify the settings of an existing contact.


Set-Contact -Identity <ContactIdParameter> [-AllowUMCallsFromNonUsers <None | SearchEnabled>] [-AssistantName <String>] [-City <String>] [-Company <String>] [-Confirm [<SwitchParameter>]] [-CountryOrRegion <CountryInfo>] [-CreateDTMFMap <$true | $false>] [-Department <String>] [-DisplayName <String>] [-DomainController <Fqdn>] [-Fax <String>] [-FirstName <String>] [-HomePhone <String>] [-IgnoreDefaultScope <SwitchParameter>] [-Initials <String>] [-LastName <String>] [-Manager <UserContactIdParameter>] [-MobilePhone <String>] [-Name <String>] [-Notes <String>] [-Office <String>] [-OtherFax <MultiValuedProperty>] [-OtherHomePhone <MultiValuedProperty>] [-OtherTelephone <MultiValuedProperty>] [-Pager <String>] [-Phone <String>] [-PhoneticDisplayName <String>] [-PostalCode <String>] [-PostOfficeBox <MultiValuedProperty>] [-SeniorityIndex <Int32>] [-SimpleDisplayName <String>] [-StateOrProvince <String>] [-StreetAddress <String>] [-TelephoneAssistant <String>] [-Title <String>] [-UMCallingLineIds <MultiValuedProperty>] [-UMDtmfMap <MultiValuedProperty>] [-WebPage <String>] [-WhatIf [<SwitchParameter>]] [-WindowsEmailAddress <SmtpAddress>]

You can use the Set-Contact cmdlet to modify the settings of contact objects that are visible in Active Directory Users and Computers. If the contact is mail-enabled, use the Set-MailContact cmdlet to modify the contact's e-mail settings that aren't available by using the Set-Contact cmdlet.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Recipient Provisioning Permissions" section in the Mailbox Permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.ContactIdParameter

The Identity parameter specifies the object that you want to modify.

This parameter accepts the following values:

  • Alias
    Example: JPhillips
  • Canonical DN
    Example: Atlanta.Corp.Contoso.Com/Users/JPhillips
  • Display Name
    Example: Jeff Phillips
  • Distinguished Name (DN)
    Example: CN=JPhillips,CN=Users,DC=Atlanta,DC=Corp,DC=contoso,DC=com
  • Domain\Account
    Example: Atlanta\JPhillips
  • GUID
    Example: fb456636-fe7d-4d58-9d15-5af57d0354c2
  • Immutable ID
    Example: fb456636-fe7d-4d58-9d15-5af57d0354c2@contoso.com
  • Legacy Exchange DN
    Example: /o=Contoso/ou=AdministrativeGroup/cn=Recipients/cn=JPhillips
  • SMTP Address
    Example: Jeff.Phillips@contoso.com
  • User Principal Name
    Example: JPhillips@contoso.com

AllowUMCallsFromNonUsers

Optional

Microsoft.Exchange.Data.Directory.Recipient.AllowUMCallsFromNonUsersFlags

The AllowUMCallsFromNonUsers parameter specifies whether to exclude the contact from directory searches.

AssistantName

Optional

System.String

The AssistantName parameter specifies the name of the contact's assistant.

City

Optional

System.String

The City parameter specifies the contact's city.

Company

Optional

System.String

The Company parameter specifies the contact's company.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch can be used to suppress the confirmation prompt that appears by default when this cmdlet is run. To suppress the confirmation prompt, use the syntax -Confirm:$False. You must include a colon ( : ) in the syntax.

CountryOrRegion

Optional

Microsoft.Exchange.Data.Directory.CountryInfo

The CountryOrRegion parameter specifies the contact's country or region.

CreateDTMFMap

Optional

System.Boolean

The CreateDTMFMap parameter specifies that a dual tone multi-frequency (DTMF) map be created for the contact.

Department

Optional

System.String

The Department parameter specifies the contact's department.

DisplayName

Optional

System.String

The DisplayName parameter specifies the contact's name in the Exchange Management Console and in the Exchange global address list (GAL). The DisplayName parameter has meaning only for mail-enabled objects.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

Fax

Optional

System.String

The Fax parameter specifies the contact's fax number.

FirstName

Optional

System.String

The FirstName parameter specifies the contact's first name.

HomePhone

Optional

System.String

The HomePhone parameter specifies the contact's home telephone number.

IgnoreDefaultScope

Optional

System.Management.Automation.SwitchParameter

The IgnoreDefaultScope parameter instructs the command to ignore the default recipient scope setting for the Exchange Management Shell session and use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently in the default scope. Using the IgnoreDefaultScope parameter introduces the following restrictions:

  • You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically.
  • You can only use the DN for the Identity parameter. Other forms of identification, such as GUID, aren't accepted.

Initials

Optional

System.String

The Initials parameter specifies the initials for the contact's name.

LastName

Optional

System.String

The LastName parameter specifies the contact's surname.

Manager

Optional

Microsoft.Exchange.Configuration.Tasks.UserContactIdParameter

The Manager parameter specifies the contact's manager.

MobilePhone

Optional

System.String

The MobilePhone parameter specifies the contact's primary mobile phone number.

Name

Optional

System.String

The Name parameter specifies the contact's name in Active Directory Users and Computers, and also in the Group Name field in the Exchange Management Console if the group is mail-enabled.

The Name value can't exceed 64 characters.

Notes

Optional

System.String

The Notes parameter specifies additional information about the contact.

Office

Optional

System.String

The Office parameter specifies the contact's physical office name or number.

OtherFax

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The OtherFax parameter specifies the contact's alternative fax number.

OtherHomePhone

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The OtherHomePhone parameter specifies the contact's alternative home telephone number.

OtherTelephone

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The OtherTelephone parameter specifies the contact's alternative office telephone number.

Pager

Optional

System.String

The Pager parameter specifies the contact's pager number.

Phone

Optional

System.String

The Phone parameter specifies the contact's office telephone number.

PhoneticDisplayName

Optional

System.String

The PhoneticDisplayName parameter specifies a phonetic pronunciation of the DisplayName parameter.

The maximum length of this parameter value is 255 characters. For more information about the PhoneticDisplayName parameter and speech recognition, see Understanding Automatic Speech Recognition Directory Lookups.

PostalCode

Optional

System.String

The PostalCode parameter specifies the contact's postal code.

PostOfficeBox

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The PostOfficeBox parameter specifies the contact's post office box number.

SeniorityIndex

Optional

System.Int32

The SeniorityIndex parameter specifies the order in which this contact will display in a hierarchical address book. A contact with a value of 2 will display higher in an address book than a contact with a value of 1.

SimpleDisplayName

Optional

System.String

The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. This limited set of characters consists of ASCII characters 26 through 126, inclusively.

The SimpleDisplayName parameter has meaning only for mail-enabled objects.

StateOrProvince

Optional

System.String

The StateOrProvince parameter specifies the contact's state or province.

StreetAddress

Optional

System.String

The StreetAddress parameter specifies the contact's physical address.

TelephoneAssistant

Optional

System.String

The TelephoneAssistant parameter specifies the telephone number of the contact's assistant.

Title

Optional

System.String

The Title parameter specifies the contact's title.

UMCallingLineIds

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The UMCallingLineIds parameter specifies telephone numbers or extensions that can be mapped to a Unified Messaging (UM)-enabled user. You can specify more than one telephone number for each user, separated by a comma. Values for this parameter must be less than 128 characters in length and may include an optional plus sign (+) that precedes the numbers. Each UM-enabled user must have a unique UMCallingLineIds parameter value.

UMDtmfMap

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The UMDtmfMap parameter specifies whether you want to create a user-defined DTMF map for the UM-enabled contact.

WebPage

Optional

System.String

The WebPage parameter specifies the contact's Web page.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

WindowsEmailAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

The WindowsEmailAddress parameter specifies the contact's e-mail address stored in Active Directory.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

This example makes the following changes to the existing contact Arlene Huff in the Users container in the Active Directory domain contoso.com:

  • Change the City parameter value to Seattle.
  • Change the Company parameter value to Contoso.
Set-Contact -Identity "contoso.com/Users/Arlene Huff" -City "Seattle" -Company "Contoso"
 © 2010 Microsoft Corporation. All rights reserved.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft