Remove-DSPamCheckoutPolicy

    2024-11-18

    Remove-DSPamCheckoutPolicy

    SYNOPSIS

    Delete a PAM checkout policy

    SYNTAX

    __AllParameterSets

    Remove-DSPamCheckoutPolicy -PolicyID <guid> [-AsLegacyResponse] [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Delete a checkout policy if it exists. If not, throws an error indicating that the policy was not found.

    EXAMPLES

    EXAMPLE

    PS C:> $response = Get-DSPamCheckoutPolicy; $policy = $reponse | Where Name -eq "Policy A"; Remove-DSPamCheckoutPolicy -PolicyID $policy.ID

    Delete the policy named "Policy A".

    PARAMETERS

    -AsLegacyResponse

    In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.

    Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -PolicyID

    ID of the policy to delete

    Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    CommonParameters

    This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

    INPUTS

    OUTPUTS

    RemoteDesktopManager.PowerShellModule.Private.ServerResponse

    NOTES

    For more information, type "Get-Help Remove-DSPamCheckoutPolicy -detailed". For technical information, type "Get-Help Remove-DSPamCheckoutPolicy -full".