Skip to content

Get-StarrTagDetail

SYNOPSIS

Retrieves tag usage records using the legacy command name.

SYNTAX

Named (Default)

Get-StarrTagDetail [-InstanceName <string>] [-Application <string>] [-TagId <int>]

Explicit

Get-StarrTagDetail -Url <string> -ApiKey <string> [-Application <string>] [-TagId <int>]

DESCRIPTION

This function retrieves relationships between tags and resources. The command name remains available for compatibility. Use Get-StarrTagUsage in new code.

EXAMPLES

EXAMPLE 1

Get-StarrTagDetail

EXAMPLE 2

Get-StarrTagDetail -InstanceName 'Main'

EXAMPLE 3

Get-StarrTagDetail -Url 'http://localhost:7878' -ApiKey 'example-api-key'

PARAMETERS

-ApiKey

The API key used to authenticate with the Starr instance.

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

-Application

The expected application type. Specify Prowlarr with explicit credentials to use API v1.

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

-InstanceName

The optional name of a saved Starr instance. When omitted, the only matching instance is used.

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: ''

-TagId

The positive Tag resource identifier used for an individual lookup.

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 base URL of the Starr instance.

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.TagUsage

This function returns response objects retrieved from the Starr API.

NOTES

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

https://github.com/angrycuban13/PSStarr/blob/main/PSStarr/Source/Public/General/Get-StarrTagDetail.ps1