[Index]

Model: device/exchangehybrid/RetentionPolicyTag

Model Details

Title Description Details
DistinguishedName
  • Field Name: DistinguishedName
  • Type: String
AdminDisplayName
  • Field Name: AdminDisplayName
  • Type: String
OrganizationId
  • Field Name: OrganizationId
  • Type: String
ManagedFolderToUpgrade This parameter is available only in on-premises Exchange 2013. The ManagedFolderToUpgrade parameter specifies the name of a managed folder to use as a template for a retention tag.
  • Field Name: ManagedFolderToUpgrade
  • Type: String
IgnoreDehydratedFlag This parameter is reserved for internal Microsoft use.
  • Field Name: IgnoreDehydratedFlag
  • Type: Boolean
OriginatingServer
  • Field Name: OriginatingServer
  • Type: String
WhenCreatedUTC
  • Field Name: WhenCreatedUTC
  • Type: String
  • Format: date-time
LocalizedComment The LocalizedComment parameter specifies localized comments and their languages. When the user's language setting matches a language specified for this parameter, Microsoft Outlook and Microsoft Office Outlook Web App display the corresponding localized comment. Comments are specified in the form of ISO Language Code:Comment, for example, LocalizedComment EN-US:"This is a localized comment in U.S. English".
  • Field Name: LocalizedComment.[n]
  • Type: Array
WhenChanged
  • Field Name: WhenChanged
  • Type: String
  • Format: date-time
Type The Type parameter specifies the type of retention tag being created. Valid values include: Calendar Contacts DeletedItems Drafts Inbox JunkEmail Journal Notes Outbox SentItems Tasks All RecoverableItems RssSubscriptions SyncIssues ConversationHistory Personal To create a default policy tag (DPT), specify type All. For tags of type RecoverableItems, the only valid retention action is MoveToArchive.
  • Field Name: Type
  • Type: String
Description
  • Field Name: Description
  • Type: String
ObjectClass
  • Field Name: ObjectClass.[n]
  • Type: Array
PSShowComputerName
  • Field Name: PSShowComputerName
  • Type: Boolean
PSComputerName
  • Field Name: PSComputerName
  • Type: String
RetentionId The RetentionId parameter specifies an alternate tag ID to make sure the retention tag found on mailbox items tagged in an on-premises deployment matches the tag when the mailbox is moved to the cloud, or mailbox items tagged in the cloud match the tag when the mailbox is moved to an on-premises Exchange server. The parameter is used in cross-premises deployments. You don't need to specify this parameter in on-premises-only deployments.
  • Field Name: RetentionId
  • Type: String
MessageFormatForJournaling This parameter isn't available in this release.
  • Field Name: MessageFormatForJournaling
  • Type: String
MustDisplayCommentEnabled The MustDisplayCommentEnabled parameter specifies whether the comment can be hidden. The default value is $true.
  • Field Name: MustDisplayCommentEnabled
  • Type: Boolean
MessageClass The MessageClass parameter specifies the message type to which the tag applies. If not specified, the default value is set to *. With the exception of a default policy tag (DPT) for voicemail, Exchange doesn't support retention tags for different message types. Only tags with a MessageClass of * are supported, and they apply to all message types. To create a DPT for voice mail messages, set the MessageClass parameter to voicemail and the Type parameter to All. A DPT for voice mail messages applies only to Microsoft Exchange Unified Messaging voice mail messages (identified by the PR_MESSAGE_CLASS MAPI property value IPM.Note.Microsoft.Voicemail*).
  • Field Name: MessageClass
  • Type: String
Identity The Identity parameter specifies the name of the tag.
  • Field Name: Identity
  • Type: String
MoveToDestinationFolder
  • Field Name: MoveToDestinationFolder
  • Type: String
IsDefaultAutoGroupPolicyTag This parameter is reserved for internal Microsoft use.
  • Field Name: IsDefaultAutoGroupPolicyTag
  • Type: Boolean
IsDefaultModeratedRecipientsPolicyTag This parameter is reserved for internal Microsoft use.
  • Field Name: IsDefaultModeratedRecipientsPolicyTag
  • Type: Boolean
Name * The Name parameter specifies the name of the tag.
  • Field Name: Name
  • Type: String
AgeLimitForRetention The AgeLimitForRetention parameter specifies the age at which retention is enforced on an item. The age limit corresponds to the number of days from the date the item was delivered, or the date an item was created if it wasn't delivered. If this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned.
  • Field Name: AgeLimitForRetention
  • Type: String
WhenCreated
  • Field Name: WhenCreated
  • Type: String
  • Format: date-time
SystemTag The SystemTag parameter specifies that the tag is created for internal Exchange functionality.
  • Field Name: SystemTag
  • Type: Boolean
RetentionEnabled The RetentionEnabled parameter specifies whether the tag is enabled. When set to $false, the tag is disabled, and no retention action is taken on messages that have the tag applied. Messages with a disabled tag are still considered tagged, so any default policy tags in the user's retention policy aren't applied to such messages. When you set the RetentionEnabled parameter to $false, the retention period for the tag is shown as Never. Users may apply this tag to items they want to indicate should never be deleted or should never be moved to the archive. Enabling the tag later may result in unintentional deletion or archiving of items. To avoid this situation, if a retention policy is disabled temporarily, it may be advisable to change the name of that tag so that users are discouraged from using it, such as DISABLED_<Original Name>.
  • Field Name: RetentionEnabled
  • Type: Boolean
Organization The Organization parameter is reserved for internal Microsoft use.
  • Field Name: Organization
  • Type: String
ExchangeVersion
  • Field Name: ExchangeVersion
  • Type: String
LegacyManagedFolder The LegacyManagedFolder parameter specifies the name of a managed folder. The retention tag is created by using retention settings from the managed folder and its managed content settings. You can use this parameter to create retention tags based on existing managed folders to migrate users from managed folder mailbox policies to retention policies.
  • Field Name: LegacyManagedFolder
  • Type: String
RunspaceId
  • Field Name: RunspaceId
  • Type: String
RetentionAction The RetentionAction parameter specifies one of the following actions: MarkAsPastRetentionLimit If you specify this action for a retention tag, messages that have the tag applied are marked as past the retention limit. MoveToFolder This action isn't available for retention tags. MoveToDeletedItems This action isn't available for retention tags. DeleteAndAllowRecovery This action deletes a message and allows recovery from the Recoverable Items folder. PermanentlyDelete This action permanently deletes a message. A message that has been permanently deleted can't be recovered using the Recoverable Items folder. Permanently deleted messages aren't returned in a Discovery search, unless litigation hold is enabled for the mailbox. MoveToArchive This action moves a message to the user's archive mailbox. You can use this action for retention tags of type All, Personal, and RecoverableItems. If this parameter isn't present and the RetentionEnabled parameter is set to $true, an error is returned.
  • Field Name: RetentionAction
  • Type: String
Comment The Comment parameter specifies a comment for the tag.
  • Field Name: Comment
  • Type: String
DomainController This parameter is available only in on-premises Exchange 2013. The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.
  • Field Name: DomainController
  • Type: String
ObjectCategory
  • Field Name: ObjectCategory
  • Type: String
LocalizedRetentionPolicyTagName The LocalizedRetentionPolicyTagName parameter specifies localized tag names and their languages. When the user's language setting matches a language specified for this parameter, Outlook and Outlook Web App display the corresponding localized tag name. Names are specified in the form of ISO Language Code:Name, for example, LocalizedRetentionPolicyTagName EN-US:"Business Critical".
  • Field Name: LocalizedRetentionPolicyTagName.[n]
  • Type: Array
AddressForJournaling This parameter isn't available in this release.
  • Field Name: AddressForJournaling
  • Type: String
IsValid
  • Field Name: IsValid
  • Type: Boolean
JournalingEnabled This parameter isn't available in this release.
  • Field Name: JournalingEnabled
  • Type: Boolean
WhenChangedUTC
  • Field Name: WhenChangedUTC
  • Type: String
  • Format: date-time
LabelForJournaling This parameter isn't available in this release.
  • Field Name: LabelForJournaling
  • Type: String
ObjectState
  • Field Name: ObjectState
  • Type: String
MessageClassDisplayName
  • Field Name: MessageClassDisplayName
  • Type: String
TriggerForRetention
  • Field Name: TriggerForRetention
  • Type: String
Guid
  • Field Name: Guid
  • Type: String
Id
  • Field Name: Id
  • Type: String
API reference for device/exchangehybrid/RetentionPolicyTag