Get-DetailsTemplate

 

Applies to: Exchange Server 2016

This cmdlet is available only in on-premises Exchange Server 2016.

Use the Get-DetailsTemplate cmdlet to retrieve the attributes for details templates.

For information about the parameter sets in the Syntax section below, see Syntax.

Get-DetailsTemplate [-Identity <DetailsTemplateIdParameter>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]

This example retrieves all attributes for the User details template for the English language.

Get-DetailsTemplate -Identity en-us\User

This example retrieves all attributes for all details template types in all languages.

Get-DetailsTemplate -Identity *\*

This example retrieves all attributes for all User details template types in all languages.

Get-DetailsTemplate -Identity *\User

The Get-DetailsTemplate cmdlet retrieves the attributes for one or more details templates. Wildcard characters can be used when specifying the type and language of the details templates.

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 "Details templates" entry in the Email address and address book permissions topic.

 

Parameter Required Type Description

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.DetailsTemplateIdParameter

The Identity parameter specifies the GUID of the details template or specifies the details template type and language separated by a backslash, for example, en-us\User. Details template types are:

  • User

  • Group

  • PublicFolder

  • SearchDialog

  • MailboxAgent

  • Contact

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

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.

 
Show: