| external help file | online version | applicable | title | schema | author | ms.author | ms.reviewer |
|---|---|---|---|---|---|---|---|
Microsoft.Exchange.TransportMailflow-Help.xml |
Security & Compliance |
Set-DlpKeywordDictionary |
2.0.0 |
chrisda |
chrisda |
This cmdlet is available only in Security & Compliance PowerShell. For more information, see Security & Compliance PowerShell.
Use the Set-DlpKeywordDictionary cmdlet to modify data loss prevention (DLP) keyword dictionaries in the Microsoft Purview compliance portal.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Set-DlpKeywordDictionary [-Identity] <SensitiveInformationTypeIdParameter>
[-Confirm]
[-Description <String>]
[-DoNotPersistKeywords]
[-FileData <Byte[]>]
[-Name <String>]
[-WhatIf]
[<CommonParameters>]
To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see Permissions in the Microsoft Purview compliance portal.
$Keywords = "Aarskog's syndrome, Abandonment, Abasia, Abderhalden-Kaufmann-Lignac, Abdominalgia, Abduction contracture, Abetalipo proteinemia, Abiotrophy, Ablatio, ablation, Ablepharia, Abocclusion, Abolition, Aborter, Abortion, Abortus, Aboulomania, Abrami's disease, Abramo"
$EncodedKeywords = [System.Text.Encoding]::Unicode.GetBytes($keywords)
Set-DlpKeywordDictionary -Identity "Diseases" -FileData $EncodedKeywordsThis example replaces the existing terms in the DLP keyword dictionary named Diseases with the specified values.
$Dictionary = Get-DlpKeywordDictionary -Name "Diseases"
$Terms = $Dictionary.KeywordDictionary.split(',').trim()
$Terms += "Achylia","Acidemia","Acidocytopenia","Acidocytosis","Acidopenia","Acidosis","Aciduria","Acladiosis","Aclasis"
$Keywords = $Terms -Join ", "
$EncodedKeywords = [System.Text.Encoding]::Unicode.GetBytes($Keywords)
Set-DlpKeywordDictionary -Identity "Diseases" -FileData $EncodedKeywordsThis example adds the specified terms to the DLP keyword dictionary named Diseases without affecting other existing terms.
$Dictionary = Get-DlpKeywordDictionary -Name "Diseases"
$Terms = $Dictionary.KeywordDictionary.split(',').trim()
$TermsToRemove = @('abandonment', 'ablatio')
$UpdatedTerms = $Terms | Where-Object {$_ -NotIn $TermsToRemove}
$Keywords = $UpdatedTerms -Join ", "
$EncodedKeywords = [System.Text.Encoding]::Unicode.GetBytes($Keywords)
Set-DlpKeywordDictionary -Identity "Diseases" -FileData $EncodedKeywordsThis example removes the specified terms from the DLP keyword dictionary named Diseases without affecting other existing terms.
$Dictionary = Get-DlpKeywordDictionary -Name "Inappropriate Language"
$Terms = $Dictionary.KeywordDictionary.split(',').trim()
Set-Content $Terms -Path "C:\My Documents\InappropriateTerms.txt"
$UpdatedTerms = Get-Content -Path "C:\My Documents\InappropriateTerms.txt"
$Keywords = $UpdatedTerms -Join ", "
$EncodedKeywords = [System.Text.Encoding]::Unicode.GetBytes($Keywords)
Set-DlpKeywordDictionary -Identity "Inappropriate Language" -FileData $EncodedKeywordsThe first three commands export the terms from the existing keyword dictionary named Inappropriate Language to the file C:\My Documents\InappropriateTerms.txt, where each term is on a separate line.
After you use Notepad to modify the terms and save the file, the last four commands use the file to replace the terms in the keyword dictionary.
The Identity parameter specifies the name of the DLP keyword dictionary that you want to modify. If the value contains spaces, enclose the value in quotation marks.
Type: SensitiveInformationTypeIdParameter
Parameter Sets: (All)
Aliases:
Applicable: Security & Compliance
Required: True
Position: 1
Default value: None
Accept pipeline input: True
Accept wildcard characters: FalseThe 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.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Applicable: Security & Compliance
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe Description parameter specifies descriptive text for the DLP keyword dictionary. If the value contains spaces, enclose the value in quotation marks.
Type: String
Parameter Sets: (All)
Aliases:
Applicable: Security & Compliance
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False{{ Fill DoNotPersistKeywords Description }}
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Applicable: Security & Compliance
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe FileData parameter specifies the terms that are used in the DLP keyword dictionary. This parameter requires a comma-separated list of values that's binary encoded in UTF-16. For more information, see the examples in this topic.
The maximum file size is up to 1 MB of terms after compression. The organization limit for all dictionaries is also 1 MB after compression.
Type: Byte[]
Parameter Sets: (All)
Aliases:
Applicable: Security & Compliance
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe Name parameter specifies a unique name for the DLP keyword dictionary. If the value contains spaces, enclose the value in quotation marks.
Type: String
Parameter Sets: (All)
Aliases:
Applicable: Security & Compliance
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe WhatIf switch doesn't work in Security & Compliance PowerShell.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Applicable: Security & Compliance
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.