Update-SophosEndpointPolicyTypeSettingsKey
SYNOPSIS
Update a setting in the base policy.
SYNTAX
Update-SophosEndpointPolicyTypeSettingsKey [-Token] <String> [-TenantId] <String> [-ApiHost] <String>
[[-PolicyType] <String>] [-SettingKey] <String> [-RequestBody] <Hashtable>
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Update a setting in the base policy.
EXAMPLES
EXAMPLE 1
$token = Get-SophosAccessToken -ClientID "xxxxxxxxxxxxxxxx" -ClientS "xxxxxxxxxxxxxxxxx"
PS>$partnerId = Get-SophosPartnerId -Token $token
PS>$tenant = Get-SophosPartnerTenants -PartnerId $partnerId.PartnerId -Token $token | Where-Object {$_.Name -eq 'MyTenant'}
PS>$policy = Get-SophosEndpointPolicies -Token $token -TenantId $tenant.id -ApiHost $tenant.apiHost | where-object {$_.Name -eq "MyPolicy"}
PS>$body = @{
"value" = $true
}
PS>Update-SophosEndpointPolicyTypeSettingsKey -Token $token -TenantId $tenant.id -ApiHost $tenant.apiHost -PolicyType "threat-protection" -SettingKey "endpoint.device-encryption.encrypt-non-boot-volumes" -RequestBody $body
PARAMETERS
-Token
JWT Token from oauth API
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TenantId
Tenant ID
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ApiHost
API host location URL of the tenant
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PolicyType
Policy type
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SettingKey
Setting key
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RequestBody
Hashtable containing the correct values according to https://developer.sophos.com/docs/endpoint-v1/1/routes/policies/%7BpolicyType%7D/base/settings/%7BsettingKey%7D/patch
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: True
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.