Skip to content

Get-SophosEndpointPolicySettingsKey

SYNOPSIS

Get the value of a setting key in a policy

SYNTAX

Get-SophosEndpointPolicySettingsKey [-Token] <String> [-TenantId] <String> [-ApiHost] <String>
 [-PolicyId] <String> [-SettingKey] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Get the value of a setting key in a policy

EXAMPLES

EXAMPLE 1

$ClientId = "xxxxxxxxxxxxxxxxxxxx"
PS> $ClientSecret = "xxxxxxxxxxxxxxxxxxxx"
PS> $Credential = [pscredential]::new($ClientId,$(ConvertTo-SecureString -String $ClientSecret -AsPlainText -Force))
PS> $token = Get-SophosAccessToken -Credential $Credential
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>Get-SophosEndpointPolicySettingsKey -Token $token -TenantId $tenant.id -ApiHost $tenant.apiHost -PolicyId $policy.id -SettingKey "endpoint.device-encryption.encrypt-non-boot-volumes"

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

-PolicyId

Target policy ID

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SettingKey

Policy Setting Key

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 5
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.

INPUTS

OUTPUTS

NOTES