Skip to content

Commit 62de74a

Browse files
author
SimonDeeb
committed
add docs
1 parent c9b6857 commit 62de74a

4 files changed

Lines changed: 667 additions & 0 deletions

File tree

‎docs/en-US/Get-AzDoWorkItem.md‎

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
---
2+
external help file: AzureDevOpsPowerShell-help.xml
3+
Module Name: AzureDevOpsPowerShell
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Get-AzDoWorkItem
9+
10+
## SYNOPSIS
11+
Gets information about work items in Azure DevOps.
12+
13+
## SYNTAX
14+
15+
```
16+
Get-AzDoWorkItem [-CollectionUri] <String> [-ProjectName] <String> [-WorkItemIds] <Int32[]>
17+
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
Gets information about specified work items in Azure DevOps.
22+
23+
## EXAMPLES
24+
25+
### EXAMPLE 1
26+
```
27+
$Params = @{
28+
CollectionUri = "https://dev.azure.com/contoso"
29+
ProjectName = "Project1"
30+
WorkItemIds = @(1, 2, 3)
31+
}
32+
Get-AzDoWorkItem @Params
33+
```
34+
This command retrieves information about the work items with IDs 1, 2, and 3 in the specified project.
35+
36+
## PARAMETERS
37+
38+
### -CollectionUri
39+
The URI of the Azure DevOps organization.
40+
41+
```yaml
42+
Type: String
43+
Parameter Sets: (All)
44+
Aliases:
45+
46+
Required: True
47+
Position: Named
48+
Default value: None
49+
Accept pipeline input: True (ByPropertyName)
50+
Accept wildcard characters: False
51+
```
52+
53+
### -ProjectName
54+
The name of the project where the work items are located.
55+
56+
```yaml
57+
Type: String
58+
Parameter Sets: (All)
59+
Aliases:
60+
61+
Required: True
62+
Position: Named
63+
Default value: None
64+
Accept pipeline input: True (ByPropertyName)
65+
Accept wildcard characters: False
66+
```
67+
68+
### -WorkItemIds
69+
The IDs of the work items to retrieve.
70+
71+
```yaml
72+
Type: Int32[]
73+
Parameter Sets: (All)
74+
Aliases:
75+
76+
Required: True
77+
Position: Named
78+
Default value: None
79+
Accept pipeline input: True (ByPropertyName, ByValue)
80+
Accept wildcard characters: False
81+
```
82+
83+
### -ProgressAction
84+
Determines how the cmdlet responds to progress updates.
85+
86+
```yaml
87+
Type: ActionPreference
88+
Parameter Sets: (All)
89+
Aliases:
90+
91+
Required: False
92+
Position: Named
93+
Default value: None
94+
Accept pipeline input: False
95+
Accept wildcard characters: False
96+
```
97+
98+
### -WhatIf
99+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
100+
101+
```yaml
102+
Type: SwitchParameter
103+
Parameter Sets: (All)
104+
Aliases: wi
105+
106+
Required: False
107+
Position: Named
108+
Default value: None
109+
Accept pipeline input: False
110+
Accept wildcard characters: False
111+
```
112+
113+
### -Confirm
114+
Prompts you for confirmation before running the cmdlet.
115+
116+
```yaml
117+
Type: SwitchParameter
118+
Parameter Sets: (All)
119+
Aliases: cf
120+
121+
Required: False
122+
Position: Named
123+
Default value: None
124+
Accept pipeline input: False
125+
Accept wildcard characters: False
126+
```
127+
128+
### <CommonParameters>
129+
This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
130+
131+
## INPUTS
132+
133+
### System.String
134+
135+
## OUTPUTS
136+
137+
### System.Object

‎docs/en-US/New-AzDoWorkItem.md‎

Lines changed: 218 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,218 @@
1+
---
2+
external help file: AzureDevOpsPowerShell-help.xml
3+
Module Name: AzureDevOpsPowerShell
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# New-AzDoWorkItem
9+
10+
## SYNOPSIS
11+
Creates a new work item in Azure DevOps.
12+
13+
## SYNTAX
14+
15+
```
16+
New-AzDoWorkItem [-CollectionUri] <String> [-ProjectName] <String> [-WorkItemType] <String>
17+
[-Title] <String> [-Description] <String> [-AssignedTo] <String> [-AreaPath] <String> [-IterationPath] <String>
18+
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
19+
```
20+
21+
## DESCRIPTION
22+
Creates a new work item of the specified type in Azure DevOps.
23+
24+
## EXAMPLES
25+
26+
### EXAMPLE 1
27+
```
28+
$Params = @{
29+
CollectionUri = "https://dev.azure.com/contoso"
30+
ProjectName = "Project1"
31+
WorkItemType = "Bug"
32+
Title = "Sample Bug"
33+
Description = "This is a sample bug description."
34+
AssignedTo = "user@contoso.com"
35+
AreaPath = "Project1\\Area1"
36+
IterationPath = "Project1\\Iteration1"
37+
}
38+
New-AzDoWorkItem @Params
39+
```
40+
This command creates a new work item of type "Bug" with the specified details in the specified project.
41+
42+
## PARAMETERS
43+
44+
### -CollectionUri
45+
The URI of the Azure DevOps organization.
46+
47+
```yaml
48+
Type: String
49+
Parameter Sets: (All)
50+
Aliases:
51+
52+
Required: True
53+
Position: Named
54+
Default value: None
55+
Accept pipeline input: True (ByPropertyName)
56+
Accept wildcard characters: False
57+
```
58+
59+
### -ProjectName
60+
The name of the project where the work item will be created.
61+
62+
```yaml
63+
Type: String
64+
Parameter Sets: (All)
65+
Aliases:
66+
67+
Required: True
68+
Position: Named
69+
Default value: None
70+
Accept pipeline input: True (ByPropertyName)
71+
Accept wildcard characters: False
72+
```
73+
74+
### -WorkItemType
75+
The type of the work item to be created (e.g., Bug, Task, User Story).
76+
77+
```yaml
78+
Type: String
79+
Parameter Sets: (All)
80+
Aliases:
81+
82+
Required: True
83+
Position: Named
84+
Default value: None
85+
Accept pipeline input: True (ByPropertyName, ByValue)
86+
Accept wildcard characters: False
87+
```
88+
89+
### -Title
90+
The title of the work item.
91+
92+
```yaml
93+
Type: String
94+
Parameter Sets: (All)
95+
Aliases:
96+
97+
Required: True
98+
Position: Named
99+
Default value: None
100+
Accept pipeline input: True (ByPropertyName, ByValue)
101+
Accept wildcard characters: False
102+
```
103+
104+
### -Description
105+
The description of the work item.
106+
107+
```yaml
108+
Type: String
109+
Parameter Sets: (All)
110+
Aliases:
111+
112+
Required: True
113+
Position: Named
114+
Default value: None
115+
Accept pipeline input: True (ByPropertyName, ByValue)
116+
Accept wildcard characters: False
117+
```
118+
119+
### -AssignedTo
120+
The user to whom the work item is assigned.
121+
122+
```yaml
123+
Type: String
124+
Parameter Sets: (All)
125+
Aliases:
126+
127+
Required: False
128+
Position: Named
129+
Default value: None
130+
Accept pipeline input: True (ByPropertyName, ByValue)
131+
Accept wildcard characters: False
132+
```
133+
134+
### -AreaPath
135+
The area path of the work item.
136+
137+
```yaml
138+
Type: String
139+
Parameter Sets: (All)
140+
Aliases:
141+
142+
Required: False
143+
Position: Named
144+
Default value: None
145+
Accept pipeline input: True (ByPropertyName, ByValue)
146+
Accept wildcard characters: False
147+
```
148+
149+
### -IterationPath
150+
The iteration path of the work item.
151+
152+
```yaml
153+
Type: String
154+
Parameter Sets: (All)
155+
Aliases:
156+
157+
Required: False
158+
Position: Named
159+
Default value: None
160+
Accept pipeline input: True (ByPropertyName, ByValue)
161+
Accept wildcard characters: False
162+
```
163+
164+
### -ProgressAction
165+
Determines how the cmdlet responds to progress updates.
166+
167+
```yaml
168+
Type: ActionPreference
169+
Parameter Sets: (All)
170+
Aliases:
171+
172+
Required: False
173+
Position: Named
174+
Default value: None
175+
Accept pipeline input: False
176+
Accept wildcard characters: False
177+
```
178+
179+
### -WhatIf
180+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
181+
182+
```yaml
183+
Type: SwitchParameter
184+
Parameter Sets: (All)
185+
Aliases: wi
186+
187+
Required: False
188+
Position: Named
189+
Default value: None
190+
Accept pipeline input: False
191+
Accept wildcard characters: False
192+
```
193+
194+
### -Confirm
195+
Prompts you for confirmation before running the cmdlet.
196+
197+
```yaml
198+
Type: SwitchParameter
199+
Parameter Sets: (All)
200+
Aliases: cf
201+
202+
Required: False
203+
Position: Named
204+
Default value: None
205+
Accept pipeline input: False
206+
Accept wildcard characters: False
207+
```
208+
209+
### <CommonParameters>
210+
This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
211+
212+
## INPUTS
213+
214+
### System.String
215+
216+
## OUTPUTS
217+
218+
### System.Object

0 commit comments

Comments
 (0)