Skip to content

Commit a662383

Browse files
committed
Fix docs
1 parent e32fcd9 commit a662383

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+2992
-1
lines changed

Generate-CmdletDocs.ps1

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ foreach($cmdlet in $cmdlets)
1212
{
1313
$file = "docs\$($cmdlet.Name).md"
1414
"``````PowerShell" | Out-File $file -Encoding utf8
15-
Get-Help $cmdlet.Name -example | Out-File $file -Encoding utf8 -Append
15+
Get-Help $cmdlet.Name -full | Out-File $file -Encoding utf8 -Append
1616
"``````" | Out-File $file -Encoding utf8 -Append
1717
}

docs/Add-UiPathAsset.md

+135
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,141 @@ SYNOPSIS
77
Adds an Asset into Orchestrator
88
99
10+
SYNTAX
11+
Add-UiPathAsset [-Name] <string> -TextValue <string> [-AuthToken <AuthToken>] [<CommonParameters>]
12+
13+
Add-UiPathAsset [-Name] <string> -IntValue <int> [-AuthToken <AuthToken>] [<CommonParameters>]
14+
15+
Add-UiPathAsset [-Name] <string> -DBConnectionString <string> [-AuthToken <AuthToken>] [<CommonParameters>]
16+
17+
Add-UiPathAsset [-Name] <string> -HttpConnectionString <string> [-AuthToken <AuthToken>] [<CommonParameters>]
18+
19+
Add-UiPathAsset [-Name] <string> -BoolValue <bool> [-AuthToken <AuthToken>] [<CommonParameters>]
20+
21+
Add-UiPathAsset [-Name] <string> -KeyValueList <Hashtable> [-AuthToken <AuthToken>] [<CommonParameters>]
22+
23+
Add-UiPathAsset [-Name] <string> -WindowsCredential <PSCredential> [-AuthToken <AuthToken>] [<CommonParameters>]
24+
25+
Add-UiPathAsset [-Name] <string> -Credential <PSCredential> [-AuthToken <AuthToken>] [<CommonParameters>]
26+
27+
Add-UiPathAsset [-Name] <string> -RobotValues <Hashtable> -ValueType <string> [-AuthToken <AuthToken>]
28+
[<CommonParameters>]
29+
30+
31+
DESCRIPTION
32+
This cmdlet can add global asset value or per-robot asset values.
33+
34+
35+
PARAMETERS
36+
-Name <string>
37+
The asset name.
38+
39+
Required? true
40+
Position? 0
41+
Default value
42+
Accept pipeline input? false
43+
Accept wildcard characters? false
44+
45+
-TextValue <string>
46+
47+
Required? true
48+
Position? named
49+
Default value
50+
Accept pipeline input? false
51+
Accept wildcard characters? false
52+
53+
-IntValue <int>
54+
55+
Required? true
56+
Position? named
57+
Default value
58+
Accept pipeline input? false
59+
Accept wildcard characters? false
60+
61+
-DBConnectionString <string>
62+
63+
Required? true
64+
Position? named
65+
Default value
66+
Accept pipeline input? false
67+
Accept wildcard characters? false
68+
69+
-HttpConnectionString <string>
70+
71+
Required? true
72+
Position? named
73+
Default value
74+
Accept pipeline input? false
75+
Accept wildcard characters? false
76+
77+
-BoolValue <bool>
78+
79+
Required? true
80+
Position? named
81+
Default value
82+
Accept pipeline input? false
83+
Accept wildcard characters? false
84+
85+
-KeyValueList <Hashtable>
86+
87+
Required? true
88+
Position? named
89+
Default value
90+
Accept pipeline input? false
91+
Accept wildcard characters? false
92+
93+
-WindowsCredential <PSCredential>
94+
95+
Required? true
96+
Position? named
97+
Default value
98+
Accept pipeline input? false
99+
Accept wildcard characters? false
100+
101+
-Credential <PSCredential>
102+
103+
Required? true
104+
Position? named
105+
Default value
106+
Accept pipeline input? false
107+
Accept wildcard characters? false
108+
109+
-ValueType <string>
110+
111+
Required? true
112+
Position? named
113+
Default value
114+
Accept pipeline input? false
115+
Accept wildcard characters? false
116+
117+
-RobotValues <Hashtable>
118+
119+
Required? true
120+
Position? named
121+
Default value
122+
Accept pipeline input? false
123+
Accept wildcard characters? false
124+
125+
-AuthToken <AuthToken>
126+
127+
Required? false
128+
Position? named
129+
Default value
130+
Accept pipeline input? false
131+
Accept wildcard characters? false
132+
133+
<CommonParameters>
134+
This cmdlet supports the common parameters: Verbose, Debug,
135+
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
136+
OutBuffer, PipelineVariable, and OutVariable. For more information, see
137+
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
138+
139+
INPUTS
140+
141+
OUTPUTS
142+
143+
144+
RELATED LINKS
10145
11146
12147

docs/Add-UiPathEnvironment.md

+53
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,59 @@ NAME
66
SYNOPSIS
77
88
9+
SYNTAX
10+
Add-UiPathEnvironment -Name <string> [-AuthToken <AuthToken>] [-Description <string>] [-Type <string>]
11+
[<CommonParameters>]
12+
13+
14+
DESCRIPTION
15+
16+
17+
PARAMETERS
18+
-Name <string>
19+
20+
Required? true
21+
Position? named
22+
Default value
23+
Accept pipeline input? false
24+
Accept wildcard characters? false
25+
26+
-Description <string>
27+
28+
Required? false
29+
Position? named
30+
Default value
31+
Accept pipeline input? false
32+
Accept wildcard characters? false
33+
34+
-Type <string>
35+
36+
Required? false
37+
Position? named
38+
Default value
39+
Accept pipeline input? false
40+
Accept wildcard characters? false
41+
42+
-AuthToken <AuthToken>
43+
44+
Required? false
45+
Position? named
46+
Default value
47+
Accept pipeline input? false
48+
Accept wildcard characters? false
49+
50+
<CommonParameters>
51+
This cmdlet supports the common parameters: Verbose, Debug,
52+
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
53+
OutBuffer, PipelineVariable, and OutVariable. For more information, see
54+
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
55+
56+
INPUTS
57+
58+
OUTPUTS
59+
60+
61+
RELATED LINKS
962
1063
1164

docs/Add-UiPathEnvironmentRobot.md

+44
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,50 @@ NAME
66
SYNOPSIS
77
88
9+
SYNTAX
10+
Add-UiPathEnvironmentRobot -Environment <Environment> -Robot <Robot> [-AuthToken <AuthToken>] [<CommonParameters>]
11+
12+
13+
DESCRIPTION
14+
15+
16+
PARAMETERS
17+
-Environment <Environment>
18+
19+
Required? true
20+
Position? named
21+
Default value
22+
Accept pipeline input? false
23+
Accept wildcard characters? false
24+
25+
-Robot <Robot>
26+
27+
Required? true
28+
Position? named
29+
Default value
30+
Accept pipeline input? false
31+
Accept wildcard characters? false
32+
33+
-AuthToken <AuthToken>
34+
35+
Required? false
36+
Position? named
37+
Default value
38+
Accept pipeline input? false
39+
Accept wildcard characters? false
40+
41+
<CommonParameters>
42+
This cmdlet supports the common parameters: Verbose, Debug,
43+
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
44+
OutBuffer, PipelineVariable, and OutVariable. For more information, see
45+
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
46+
47+
INPUTS
48+
49+
OUTPUTS
50+
51+
52+
RELATED LINKS
953
1054
1155

docs/Add-UiPathPackage.md

+36
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,42 @@ NAME
66
SYNOPSIS
77
88
9+
SYNTAX
10+
Add-UiPathPackage [-PackageFile] <string> [-AuthToken <AuthToken>] [<CommonParameters>]
11+
12+
13+
DESCRIPTION
14+
15+
16+
PARAMETERS
17+
-PackageFile <string>
18+
19+
Required? true
20+
Position? 0
21+
Default value
22+
Accept pipeline input? false
23+
Accept wildcard characters? false
24+
25+
-AuthToken <AuthToken>
26+
27+
Required? false
28+
Position? named
29+
Default value
30+
Accept pipeline input? false
31+
Accept wildcard characters? false
32+
33+
<CommonParameters>
34+
This cmdlet supports the common parameters: Verbose, Debug,
35+
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
36+
OutBuffer, PipelineVariable, and OutVariable. For more information, see
37+
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
38+
39+
INPUTS
40+
41+
OUTPUTS
42+
43+
44+
RELATED LINKS
945
1046
1147

docs/Add-UiPathProcess.md

+85
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,91 @@ NAME
66
SYNOPSIS
77
88
9+
SYNTAX
10+
Add-UiPathProcess -Name <string> [-AuthToken <AuthToken>] [-Description <string>] [-Environment <Environment>]
11+
[-EnvironmentId <long>] [-Package <Package>] [-PackageId <string>] [-PackageVersion <string>] [<CommonParameters>]
12+
13+
14+
DESCRIPTION
15+
16+
17+
PARAMETERS
18+
-Name <string>
19+
20+
Required? true
21+
Position? named
22+
Default value
23+
Accept pipeline input? false
24+
Accept wildcard characters? false
25+
26+
-EnvironmentId <long>
27+
28+
Required? false
29+
Position? named
30+
Default value 0
31+
Accept pipeline input? false
32+
Accept wildcard characters? false
33+
34+
-Environment <Environment>
35+
36+
Required? false
37+
Position? named
38+
Default value
39+
Accept pipeline input? false
40+
Accept wildcard characters? false
41+
42+
-PackageId <string>
43+
44+
Required? false
45+
Position? named
46+
Default value
47+
Accept pipeline input? false
48+
Accept wildcard characters? false
49+
50+
-PackageVersion <string>
51+
52+
Required? false
53+
Position? named
54+
Default value
55+
Accept pipeline input? false
56+
Accept wildcard characters? false
57+
58+
-Package <Package>
59+
60+
Required? false
61+
Position? named
62+
Default value
63+
Accept pipeline input? false
64+
Accept wildcard characters? false
65+
66+
-Description <string>
67+
68+
Required? false
69+
Position? named
70+
Default value
71+
Accept pipeline input? false
72+
Accept wildcard characters? false
73+
74+
-AuthToken <AuthToken>
75+
76+
Required? false
77+
Position? named
78+
Default value
79+
Accept pipeline input? false
80+
Accept wildcard characters? false
81+
82+
<CommonParameters>
83+
This cmdlet supports the common parameters: Verbose, Debug,
84+
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
85+
OutBuffer, PipelineVariable, and OutVariable. For more information, see
86+
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
87+
88+
INPUTS
89+
90+
OUTPUTS
91+
92+
93+
RELATED LINKS
994
1095
1196

0 commit comments

Comments
 (0)