New-PSUVariable

Creates a new variable in PSU.

SYNOPSIS

Creates a new variable in PSU.

SYNTAX

Value (Default)

New-PSUVariable -Name <String> [-Value <Object>] [-Type <String>] [-Description <String>]
 [-DisableRunAsSupport] [-Database] [-Role <String[]>] [-Force] [-Scope <VariableScope>] [-Tag <Tag[]>]
 [-PasswordNotRequired] [-ComputerName <String>] [-AppToken <String>] [-Credential <PSCredential>]
 [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
 [<CommonParameters>]

Secret

New-PSUVariable -Name <String> [-Value <Object>] [-InputObject <Object>] -Vault <String> [-Type <String>]
 [-Description <String>] [-DisableRunAsSupport] [-Database] [-Role <String[]>] [-Force]
 [-Scope <VariableScope>] [-Tag <Tag[]>] [-PasswordNotRequired] [-ComputerName <String>] [-AppToken <String>]
 [-Credential <PSCredential>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
 [<CommonParameters>]

InputObject

New-PSUVariable -Name <String> [-InputObject <Object>] [-Type <String>] [-Description <String>]
 [-DisableRunAsSupport] [-Database] [-Role <String[]>] [-Force] [-Scope <VariableScope>] [-Tag <Tag[]>]
 [-PasswordNotRequired] [-ComputerName <String>] [-AppToken <String>] [-Credential <PSCredential>]
 [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
 [<CommonParameters>]

DESCRIPTION

Creates a new variable in PSU. Variables are available in all scripts that run within PSU.

EXAMPLES

Example 1

PS C:\> New-UAVariable -Name 'UserName' -Value 'Adam'

Creates a new variable in PSU named `UserName`. You can use the $UserName variable in all your scripts.

Example 2

PS C:\> New-UAVariable -Name 'UserName' -Value 'Adam' -Vault "Vault"

Creates a new variable in the vault named `Vault`. The variable's value is not stored in PSU and will only be retrieved when running scripts.

PARAMETERS

-AppToken

An app token to access the PSU API.

Type: 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 PSU REST API server.

Type: String
Parameter Sets: (All)
Aliases: Uri

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Description

A description for this variable.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DisableRunAsSupport

Prevents a credential from being used for Run As support.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-InputObject

An input object to store as a variable.

Type: Object
Parameter Sets: Secret, InputObject
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Integrated

Executes the command internally rather than using the Management API. Only works when running script from within PowerShell Universal.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

The name of the variable. You can reference this in your scripts just as you would with other variables.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Type

The .NET type of object .

Type: String
Parameter Sets: (All)
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: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Value

The value of the variable.

Type: Object
Parameter Sets: Value, Secret
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Vault

The vault to store the variable within.

Type: String
Parameter Sets: Secret
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Database

Stores the variable value in the database.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Force

Overwrites existing variables with the same name.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Role

The roles that can access this variable.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Credential

Credentials to login to the PowerShell Universal Management API.

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Scope

The variable scope for this variable. Global variable changes will cause resources to restart. Script scoped variables will not.

Type: VariableScope
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Tag

Tags for this variable.

Type: Tag[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TrustCertificate

Whether the cmdlet should ignore certificate issues.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PasswordNotRequired

Specifies that the password is not required for this variable. This is useful for accounts like Group Managed Service Accounts.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Cookies

Reuses and persists authentication cookies for the current PowerShell session.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

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

None

OUTPUTS

System.Object

NOTES

RELATED LINKS