Get-DSPamCheckoutPolicy

    2025-02-17

    Get-DSPamCheckoutPolicy

    SYNOPSIS

    Return checkout policies

    SYNTAX

    __AllParameterSets

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

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    If a policy ID is supplied, it will try to fetch and return the policy matching the ID. If no ID is supplied, it will return a list of all policies in place.

    EXAMPLES

    EXAMPLE 1

    PS C:> $response = Get-DSPamCheckoutPolicy

    Return all checkout policies currently in place.

    EXAMPLE 2

    PS C:> $response = Get-DSPamCheckoutPolicy $PolicyID

    Return the checkout policy, if found.

    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 get

    Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  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

    NOTES

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