-
Notifications
You must be signed in to change notification settings - Fork 51
Expand file tree
/
Copy pathNew-PSUVariable.txt
More file actions
247 lines (180 loc) · 9.25 KB
/
New-PSUVariable.txt
File metadata and controls
247 lines (180 loc) · 9.25 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
NAME
New-PSUVariable
SYNOPSIS
Creates a new variable in PSU.
SYNTAX
New-PSUVariable [-AppToken <String>] [-ComputerName <String>] [-Description <String>] [-DisableRunAsSupport] [-InputObject <Object>] [-Integrated] -Name <String> [-Type <String>] [-UseDefaultCredentials] [-Value <Object>] -Vault <String> [-Database] [-Force] [-Role <String[]>] [-Credential <PSCredential>] [-Scope <VariableScope>] [-Tag <Tag[]>] [-TrustCertificate] [-PasswordNotRequired] [<CommonParameters>]
New-PSUVariable [-AppToken <String>] [-ComputerName <String>] [-Description <String>] [-DisableRunAsSupport] [-InputObject <Object>] [-Integrated] -Name <String> [-Type <String>] [-UseDefaultCredentials] [-Database] [-Force] [-Role <String[]>] [-Credential <PSCredential>] [-Scope <VariableScope>] [-Tag <Tag[]>] [-TrustCertificate] [-PasswordNotRequired] [<CommonParameters>]
New-PSUVariable [-AppToken <String>] [-ComputerName <String>] [-Description <String>] [-DisableRunAsSupport] [-Integrated] -Name <String> [-Type <String>] [-UseDefaultCredentials] [-Value <Object>] [-Database] [-Force] [-Role <String[]>] [-Credential <PSCredential>] [-Scope <VariableScope>] [-Tag <Tag[]>] [-TrustCertificate] [-PasswordNotRequired] [<CommonParameters>]
DESCRIPTION
Creates a new variable in PSU. Variables are available in all scripts that run within PSU.
PARAMETERS
-AppToken <String>
An app token to access the PSU API.
Required? false
Position? named
Default value None
Accept pipeline input? False
Aliases none
Accept wildcard characters? false
-ComputerName <String>
The HTTP address of the PSU REST API server.
Required? false
Position? named
Default value None
Accept pipeline input? False
Aliases Uri
Accept wildcard characters? false
-Description <String>
A description for this variable.
Required? false
Position? named
Default value None
Accept pipeline input? False
Aliases none
Accept wildcard characters? false
-DisableRunAsSupport [<SwitchParameter>]
Prevents a credential from being used for Run As support.
Required? false
Position? named
Default value False
Accept pipeline input? False
Aliases none
Accept wildcard characters? false
-InputObject <Object>
An input object to store as a variable.
Required? false
Position? named
Default value None
Accept pipeline input? False
Aliases none
Accept wildcard characters? false
-Integrated [<SwitchParameter>]
Executes the command internally rather than using the Management API. Only works when running script from within PowerShell Universal.
Required? false
Position? named
Default value False
Accept pipeline input? False
Aliases none
Accept wildcard characters? false
-Name <String>
The name of the variable. You can reference this in your scripts just as you would with other variables.
Required? true
Position? named
Default value None
Accept pipeline input? False
Aliases none
Accept wildcard characters? false
-Type <String>
The .NET type of object .
Required? false
Position? named
Default value None
Accept pipeline input? False
Aliases none
Accept wildcard characters? false
-UseDefaultCredentials [<SwitchParameter>]
Use default credentials when connecting to the management API
Required? false
Position? named
Default value False
Accept pipeline input? False
Aliases none
Accept wildcard characters? false
-Value <Object>
The value of the variable.
Required? false
Position? named
Default value None
Accept pipeline input? False
Aliases none
Accept wildcard characters? false
-Vault <String>
The vault to store the variable within.
Required? true
Position? named
Default value None
Accept pipeline input? False
Aliases none
Accept wildcard characters? false
-Database [<SwitchParameter>]
Stores the variable value in the database.
Required? false
Position? named
Default value False
Accept pipeline input? False
Aliases none
Accept wildcard characters? false
-Force [<SwitchParameter>]
Overwrites existing variables with the same name.
Required? false
Position? named
Default value False
Accept pipeline input? False
Aliases none
Accept wildcard characters? false
-Role <String[]>
The roles that can access this variable.
Required? false
Position? named
Default value None
Accept pipeline input? False
Aliases none
Accept wildcard characters? false
-Credential <PSCredential>
Credentials to login to the PowerShell Universal Management API.
Required? false
Position? named
Default value None
Accept pipeline input? False
Aliases none
Accept wildcard characters? false
-Scope <VariableScope>
The variable scope for this variable. Global variable changes will cause resources to restart. Script scoped variables will not.
Required? false
Position? named
Default value None
Accept pipeline input? False
Aliases none
Accept wildcard characters? false
-Tag <Tag[]>
Tags for this variable.
Required? false
Position? named
Default value None
Accept pipeline input? False
Aliases none
Accept wildcard characters? false
-TrustCertificate [<SwitchParameter>]
Whether the cmdlet should ignore certificate issues.
Required? false
Position? named
Default value False
Accept pipeline input? False
Aliases none
Accept wildcard characters? false
-PasswordNotRequired [<SwitchParameter>]
Specifies that the password is not required for this variable. This is useful for accounts like Group Managed Service Accounts.
Required? false
Position? named
Default value False
Accept pipeline input? False
Aliases none
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
System.Object
NOTES
-------------------------- 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.
RELATED LINKS