Get-StarrTagUsage

SYNOPSIS

Retrieves resources associated with application tags.

SYNTAX

Named (Default)

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

Explicit

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

DESCRIPTION

This function retrieves relationships between tags and resources. Use Get-StarrTag to retrieve tag definitions.

EXAMPLES

EXAMPLE 1

Get-StarrTagUsage -InstanceName RadarrMain

EXAMPLE 2

Get-StarrTagUsage -Url 'http://localhost:8989' -ApiKey 'example-api-key' -TagId 3

PARAMETERS

-ApiKey

The API key used to authenticate.

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 saved Starr instance name. The instance is inferred when omitted.

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 identifier used to limit usage records to one tag.

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

This function returns tag usage response objects.

NOTES

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

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