Get-StarrRadarrQueueDetail

SYNOPSIS

Retrieves Radarr queue details.

SYNTAX

Named (Default)

Get-StarrRadarrQueueDetail [-InstanceName <string>] [-MovieId <int>] [-IncludeMovie <bool>]

Explicit

Get-StarrRadarrQueueDetail -Url <string> -ApiKey <string> [-MovieId <int>] [-IncludeMovie <bool>]

DESCRIPTION

This function retrieves Radarr queue details.

EXAMPLES

EXAMPLE 1

Get-StarrRadarrQueueDetail -InstanceName RadarrMain

EXAMPLE 2

Get-StarrRadarrQueueDetail -InstanceName RadarrMain -MovieId 42 -IncludeMovie $true

PARAMETERS

-ApiKey

The API key used to authenticate with Radarr.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Explicit
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-IncludeMovie

Includes movie resources in queue-detail records.

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

-InstanceName

The optional saved Radarr instance name.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases:
- Name
ParameterSets:
- Name: Named
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-MovieId

Limits results to one movie identifier.

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

-Url

The absolute Radarr base URL.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Explicit
  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

None.

You cannot pipe objects to this function.

OUTPUTS

PSStarr.Radarr.QueueDetail

This function returns Radarr queue-detail records.

NOTES

https://psstarr.xyz/command-reference/commands/Get-StarrRadarrQueueDetail/

https://github.com/angrycuban13/PSStarr/blob/main/PSStarr/Source/Public/Radarr/Get-StarrRadarrQueueDetail.ps1