Remove-PSUVariable
SYNOPSIS
Removes a variable.
SYNTAX
All (Default)
Remove-PSUVariable [-RemoveSecret] [-ComputerName <String>] [-AppToken <String>] [-Credential <PSCredential>]
[-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
[<CommonParameters>]Variable
Remove-PSUVariable [-Variable] <Variable> [-RemoveSecret] [-ComputerName <String>] [-AppToken <String>]
[-Credential <PSCredential>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
[<CommonParameters>]Name
Remove-PSUVariable -Name <String> [-RemoveSecret] [-ComputerName <String>] [-AppToken <String>]
[-Credential <PSCredential>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
[<CommonParameters>]DESCRIPTION
Removes a variable. This also deletes the variable from the variables.psd1 file in the git repo.
EXAMPLES
Example 1
Removes the username variable.
PARAMETERS
-AppToken
An app token to access the PSU API.
-ComputerName
The HTTP address of the PSU REST API server.
-Integrated
Executes the command internally rather than using the Management API. Only works when running script from within PowerShell Universal.
-UseDefaultCredentials
Use default credentials when connecting to the management API
-Variable
The variable to remove. Use Get-UAVariable to retrieve a variable object.
-RemoveSecret
Removes the secret from the containing vault.
-Name
Specifies the name of the resource.
-Credential
Credentials to login to the PowerShell Universal Management API.
-TrustCertificate
Whether the cmdlet should ignore certificate issues.
-Cookies
Reuses and persists authentication cookies for the current PowerShell session.
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable, and -ProgressAction. For more information, see about_CommonParameters.
INPUTS
UniversalAutomation.Variable
OUTPUTS
System.Object
NOTES
RELATED LINKS
PERMISSIONS
The access token requires platform.variables/delete to run this cmdlet remotely.
Last updated
Was this helpful?