< Back
Set-AdminDlpPolicy
Post
NAME Set-AdminDlpPolicy
SYNOPSIS
Updates a policy's environment and default api group settings. Upserts the environment list input (does not
append).
SYNTAX
Set-AdminDlpPolicy -PolicyName <String> [-FilterType <String>] [-Environments <String>] [-DefaultGroup <String>]
[-SetNonBusinessDataGroupState <String>] [-ApiVersion <String>] [-SchemaVersion <String>] [<CommonParameters>]
Set-AdminDlpPolicy -PolicyName <String> [-DefaultGroup <String>] -EnvironmentName <String>
[-SetNonBusinessDataGroupState <String>] [-ApiVersion <String>] [-SchemaVersion <String>] [<CommonParameters>]
DESCRIPTION
Set-AdminDlpPolicy cmdlet updates details on the policy, such as environment filter and default api group.
Use Get-Help Set-AdminDlpPolicy -Examples for more detail.
PARAMETERS
-PolicyName <String>
Policy name that will be updated.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-FilterType <String>
Identifies which filter type the policy will have, none, include or exclude.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Environments <String>
Comma seperated string list used as input environments to either include or exclude, depending on the
FilterType.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DefaultGroup <String>
The default group setting, hbi or lbi.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EnvironmentName <String>
The Environment's identifier.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SetNonBusinessDataGroupState <String>
Set non business data group(lbi) to Block or Unblock state.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ApiVersion <String>
Specifies the Api version that is called.
Required? false
Position? named
Default value 2016-11-01
Accept pipeline input? false
Accept wildcard characters? false
-SchemaVersion <String>
Specifies the schema version to use, 2016-11-01-preview or 2018-11-01 (HTTP connectors included).
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Set-AdminDlpPolicy -PolicyName 78d6c98c-aaa0-4b2b-91c3-83d211754d8a -FilterType None
Clears the environment filter for the policy 78d6c98c-aaa0-4b2b-91c3-83d211754d8a.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Set-AdminDlpPolicy -PolicyName 78d6c98c-aaa0-4b2b-91c3-83d211754d8a -FilterType Include -Environments
"febb5387-84d7-4717-8345-334a34402f3d,83d98843-bfd7-47ef-bfcd-dc628810ae7b"
Only applies the policy to the environments febb5387-84d7-4717-8345-334a34402f3d and
83d98843-bfd7-47ef-bfcd-dc628810ae7b.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Set-AdminDlpPolicy -PolicyName 78d6c98c-aaa0-4b2b-91c3-83d211754d8a -FilterType Exclude -Environments
"febb5387-84d7-4717-8345-334a34402f3d,83d98843-bfd7-47ef-bfcd-dc628810ae7b"
Applies the policy to all environments except febb5387-84d7-4717-8345-334a34402f3d and
83d98843-bfd7-47ef-bfcd-dc628810ae7b.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Set-AdminDlpPolicy -PolicyName 78d6c98c-aaa0-4b2b-91c3-83d211754d8a -DefaultGroup hbi
Sets the default data group attribute to be hbi (Business data only).
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>Set-AdminDlpPolicy -PolicyName 78d6c98c-aaa0-4b2b-91c3-83d211754d8a -SchemaVersion 2018-11-01
Sets the DLP Policy to schema version '2018-11-01', allowing for the use of HTTP connectors.
-------------------------- EXAMPLE 6 --------------------------
PS C:\\>Set-AdminDlpPolicy -PolicyName 78d6c98c-aaa0-4b2b-91c3-83d211754d8a -SetNonBusinessDataGroupState "Block"
Sets non business data(lbi) to block state.
RELATED LINKS
SYNOPSIS
Updates a policy's environment and default api group settings. Upserts the environment list input (does not
append).
SYNTAX
Set-AdminDlpPolicy -PolicyName <String> [-FilterType <String>] [-Environments <String>] [-DefaultGroup <String>]
[-SetNonBusinessDataGroupState <String>] [-ApiVersion <String>] [-SchemaVersion <String>] [<CommonParameters>]
Set-AdminDlpPolicy -PolicyName <String> [-DefaultGroup <String>] -EnvironmentName <String>
[-SetNonBusinessDataGroupState <String>] [-ApiVersion <String>] [-SchemaVersion <String>] [<CommonParameters>]
DESCRIPTION
Set-AdminDlpPolicy cmdlet updates details on the policy, such as environment filter and default api group.
Use Get-Help Set-AdminDlpPolicy -Examples for more detail.
PARAMETERS
-PolicyName <String>
Policy name that will be updated.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-FilterType <String>
Identifies which filter type the policy will have, none, include or exclude.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Environments <String>
Comma seperated string list used as input environments to either include or exclude, depending on the
FilterType.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DefaultGroup <String>
The default group setting, hbi or lbi.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EnvironmentName <String>
The Environment's identifier.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SetNonBusinessDataGroupState <String>
Set non business data group(lbi) to Block or Unblock state.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ApiVersion <String>
Specifies the Api version that is called.
Required? false
Position? named
Default value 2016-11-01
Accept pipeline input? false
Accept wildcard characters? false
-SchemaVersion <String>
Specifies the schema version to use, 2016-11-01-preview or 2018-11-01 (HTTP connectors included).
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Set-AdminDlpPolicy -PolicyName 78d6c98c-aaa0-4b2b-91c3-83d211754d8a -FilterType None
Clears the environment filter for the policy 78d6c98c-aaa0-4b2b-91c3-83d211754d8a.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Set-AdminDlpPolicy -PolicyName 78d6c98c-aaa0-4b2b-91c3-83d211754d8a -FilterType Include -Environments
"febb5387-84d7-4717-8345-334a34402f3d,83d98843-bfd7-47ef-bfcd-dc628810ae7b"
Only applies the policy to the environments febb5387-84d7-4717-8345-334a34402f3d and
83d98843-bfd7-47ef-bfcd-dc628810ae7b.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Set-AdminDlpPolicy -PolicyName 78d6c98c-aaa0-4b2b-91c3-83d211754d8a -FilterType Exclude -Environments
"febb5387-84d7-4717-8345-334a34402f3d,83d98843-bfd7-47ef-bfcd-dc628810ae7b"
Applies the policy to all environments except febb5387-84d7-4717-8345-334a34402f3d and
83d98843-bfd7-47ef-bfcd-dc628810ae7b.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Set-AdminDlpPolicy -PolicyName 78d6c98c-aaa0-4b2b-91c3-83d211754d8a -DefaultGroup hbi
Sets the default data group attribute to be hbi (Business data only).
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>Set-AdminDlpPolicy -PolicyName 78d6c98c-aaa0-4b2b-91c3-83d211754d8a -SchemaVersion 2018-11-01
Sets the DLP Policy to schema version '2018-11-01', allowing for the use of HTTP connectors.
-------------------------- EXAMPLE 6 --------------------------
PS C:\\>Set-AdminDlpPolicy -PolicyName 78d6c98c-aaa0-4b2b-91c3-83d211754d8a -SetNonBusinessDataGroupState "Block"
Sets non business data(lbi) to block state.
RELATED LINKS