Get-UAScript
SYNOPSIS
Returns scripts defined within UA.
SYNTAX
All (Default)
Get-UAScript [-ComputerName <String>] [-AppToken <String>] [-UseDefaultCredentials] [<CommonParameters>]
Id
Get-UAScript [-Id] <Int64> [-ComputerName <String>] [-AppToken <String>] [-UseDefaultCredentials]
[<CommonParameters>]
Identity
Get-UAScript [-Identity] <Identity> [-ComputerName <String>] [-AppToken <String>] [-UseDefaultCredentials]
[<CommonParameters>]
FolderId
Get-UAScript [-FolderId] <Int64> [-ComputerName <String>] [-AppToken <String>] [-UseDefaultCredentials]
[<CommonParameters>]
Name
Get-UAScript [-Name] <String> [-ComputerName <String>] [-AppToken <String>] [-UseDefaultCredentials]
[<CommonParameters>]
ByTagObject
Get-UAScript [-Tag <Tag>] [-ComputerName <String>] [-AppToken <String>] [-UseDefaultCredentials]
[<CommonParameters>]
DESCRIPTION
Returns scripts defined within UA.
EXAMPLES
Example 1
PS C:\> Get-UAScript
Returns all scripts defined within UA.
Example 2
PS C:\> Get-UAScript -Id 12
Returns the script with ID 12.
Example 3
PS C:\> $Identity = Get-UAIdentity -Name 'Adam'
PS C:\> Get-UAScript -Identity $Identity
Returns all scripts created or modified by the identity 'Adam'.
Example 4
PS C:\> Get-UAScript -FolderId 12
Returns all scripts with the folder with ID 12.
Example 4
PS C:\> Get-UAScript -Name 'Script1.ps1'
Returns script 'Script1.ps1'
Example 5
PS C:\> $Tag = Get-UATag -Name 'Release'
PS C:\> Get-UAScript -Tag $Tag
Returns all scripts with the 'Release' tag.
PARAMETERS
-AppToken
An app token to access the UA API.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ComputerName
The HTTP address of the UA REST API server.
Type: System.String
Parameter Sets: (All)
Aliases: Uri
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FolderId
The ID of the folder to return scripts from.
Type: System.Int64
Parameter Sets: FolderId
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Id
The ID of the script to return.
Type: System.Int64
Parameter Sets: Id
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Identity
Returns scripts based created or edited by this Identity.
Type: PowerShellUniversal.Identity
Parameter Sets: Identity
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Name
The name of the script to return.
Type: System.String
Parameter Sets: Name
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Tag
Returns scripts based on this tag. Use Get-UATag to retrieve tags.
Type: PowerShellUniversal.Tag
Parameter Sets: ByTagObject
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-UseDefaultCredentials
Use default credentials when connecting to the management API
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.