Skip to content

Commit 9a9bfa3

Browse files
SebastianSchuetzeSebastian S Schütze
authored andcommitted
1 parent 39f26cf commit 9a9bfa3

10 files changed

Lines changed: 134 additions & 36 deletions

.docs/Add-VSTeamGitRepositoryPermission.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,55 +64,71 @@ This example grants read and contribute permissions to the "release" branch of t
6464

6565
### RepositoryId
6666

67+
ID of the repository for which the permissions are to be set.
68+
6769
```yaml
6870
Type: String
6971
Required: True
7072
```
7173
7274
### RepositoryName
7375
76+
Name of the repository for which the permissions are to be set.
77+
7478
```yaml
7579
Type: String
7680
Required: True
7781
```
7882
7983
### BranchName
8084
85+
Name of the branch for which the permissions are to be set.
86+
8187
```yaml
8288
Type: String
8389
Required: True
8490
```
8591
8692
### Descriptor
8793
94+
Descriptor of the user or group for which the permissions are to be set.
95+
8896
```yaml
8997
Type: String
9098
Required: True
9199
```
92100
93101
### User
94102
103+
User descriptor for which the permissions are to be set.
104+
95105
```yaml
96106
Type: VSTeamUser
97107
Required: True
98108
```
99109
100110
### Group
101111
112+
Group descriptor for which the permissions are to be set.
113+
102114
```yaml
103115
Type: VSTeamGroup
104116
Required: True
105117
```
106118
107119
### Allow
108120
121+
Allow permissions to be set.
122+
109123
```yaml
110124
Type: VSTeamGitRepositoryPermissions
111125
Required: True
112126
```
113127
114128
### Deny
115129
130+
Deny permissions to be set.
131+
116132
```yaml
117133
Type: VSTeamGitRepositoryPermissions
118134
Required: True

.docs/Add-VSTeamProfile.md

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -38,24 +38,7 @@ On Windows, allows you use to use Windows authentication against a local TFS ser
3838

3939
## PARAMETERS
4040

41-
### Account
42-
43-
The Azure DevOps (AzD) account name to use.
44-
DO NOT enter the entire URL.
45-
46-
Just the portion after dev.azure.com. For example in the
47-
following url mydemos is the account name.
48-
<https://dev.azure.com/mydemos>
49-
or
50-
The full Team Foundation Server (TFS) url including the collection.
51-
<http://localhost:8080/tfs/DefaultCollection>
52-
53-
```yaml
54-
Type: String
55-
Parameter Sets: Secure, Plain, Windows
56-
Required: True
57-
Position: 1
58-
```
41+
<!-- #include "./params/account.md" -->
5942

6043
### SecurePersonalAccessToken
6144

.docs/Add-VSTeamProjectPermission.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,34 +66,44 @@ This command allows the user "robert.jones@example.net" to "EditDesigns" and den
6666

6767
### Descriptor
6868

69+
Descriptor of the user or group to add permissions for.
70+
6971
```yaml
7072
Type: String
7173
Required: True
7274
```
7375
7476
### User
7577
78+
User descriptor to add permissions for.
79+
7680
```yaml
7781
Type: VSTeamUser
7882
Required: True
7983
```
8084
8185
### Group
8286
87+
Group descriptor to add permissions for.
88+
8389
```yaml
8490
Type: VSTeamGroup
8591
Required: True
8692
```
8793
8894
### Allow
8995
96+
Allow permissions to add.
97+
9098
```yaml
9199
Type: VSTeamProjectPermissions
92100
Required: True
93101
```
94102
95103
### Deny
96104
105+
Deny permissions to add.
106+
97107
```yaml
98108
Type: VSTeamProjectPermissions
99109
Required: True

.docs/Add-VSTeamWorkItemAreaPermission.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,48 +62,62 @@ This command prompts for confirmation before adding read and write permissions a
6262

6363
### AreaID
6464

65+
Area ID of the work item area for which the permissions are to be set.
66+
6567
```yaml
6668
Type: Int32
6769
Required: True
6870
```
6971
7072
### AreaPath
7173
74+
Area path of the work item area for which the permissions are to be set.
75+
7276
```yaml
7377
Type: String
7478
Required: True
7579
```
7680
7781
### Descriptor
7882
83+
Descriptor of the user or group to add permissions for.
84+
7985
```yaml
8086
Type: String
8187
Required: True
8288
```
8389
8490
### User
8591
92+
User descriptor to add permissions for.
93+
8694
```yaml
8795
Type: VSTeamUser
8896
Required: True
8997
```
9098
9199
### Group
92100
101+
Group descriptor to add permissions for.
102+
93103
```yaml
94104
Type: VSTeamGroup
95105
Required: True
96106
```
97107
98108
### Allow
99109
110+
Allow permissions to add.
111+
100112
```yaml
101113
Type: VSTeamWorkItemAreaPermissions
102114
Required: True
103115
```
104116
105117
### Deny
106118
119+
Deny permissions to add.
120+
107121
```yaml
108122
Type: VSTeamWorkItemAreaPermissions
109123
Required: True

.docs/Add-VSTeamWorkItemIterationPermission.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,48 +67,62 @@ This command prompts for confirmation before adding read and write permissions a
6767

6868
### IterationID
6969

70+
Iteration ID for which the permissions are to be set.
71+
7072
```yaml
7173
Type: Int32
7274
Required: True
7375
```
7476
7577
### IterationPath
7678
79+
Iteration path for which the permissions are to be set.
80+
7781
```yaml
7882
Type: String
7983
Required: True
8084
```
8185
8286
### Descriptor
8387
88+
Descriptor of the user or group to add permissions for.
89+
8490
```yaml
8591
Type: String
8692
Required: True
8793
```
8894
8995
### User
9096
97+
User descriptor to add permissions for.
98+
9199
```yaml
92100
Type: VSTeamUser
93101
Required: True
94102
```
95103
96104
### Group
97105
106+
Group descriptor to add permissions for.
107+
98108
```yaml
99109
Type: VSTeamGroup
100110
Required: True
101111
```
102112
103113
### Allow
104114
115+
Allow permissions to add.
116+
105117
```yaml
106118
Type: VSTeamWorkItemIterationPermissions
107119
Required: True
108120
```
109121
110122
### Deny
111123
124+
Deny permissions to add.
125+
112126
```yaml
113127
Type: VSTeamWorkItemIterationPermissions
114128
Required: True
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
<!-- #include "./common/header.md" -->
2+
3+
# Get-VSTeamAgentPoolMaintenance
4+
5+
## SYNOPSIS
6+
7+
Gets the agent pool maintenance job
8+
9+
## SYNTAX
10+
11+
## DESCRIPTION
12+
13+
Gets the agent pool maintenance job
14+
15+
## EXAMPLES
16+
17+
### Example 1
18+
```powershell
19+
PS C:\> Get-VSTeamAgentPoolMaintenance -Id 1
20+
```
21+
22+
Gets the agent pool maintenance job with id 1
23+
24+
## PARAMETERS
25+
26+
### Id
27+
Id of the pool to maintain
28+
29+
```yaml
30+
Type: Int32
31+
Parameter Sets: (All)
32+
Aliases: PoolID
33+
Required: True
34+
```
35+
36+
<!-- #include "./params/projectName.md" -->
37+
38+
## INPUTS
39+
40+
## OUTPUTS
41+
42+
### System.Object
43+
44+
## NOTES
45+
46+
<!-- #include "./common/prerequisites.md" -->
47+
48+
## RELATED LINKS

.docs/Get-VSTeamPullRequest.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,8 @@ Type: Switch
176176
Parameter Sets: IncludeCommits
177177
```
178178
179+
<!-- #include "./params/projectName.md" -->
180+
179181
## INPUTS
180182
181183
## OUTPUTS

.docs/Get-VSTeamRelease.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,34 +114,44 @@ Default value: 0
114114
115115
### CreatedBy
116116
117+
Creator of the release.
118+
117119
```yaml
118120
Type: String
119121
Parameter Sets: List
120122
```
121123
122124
### MinCreatedTime
123125
126+
Minimum creation time of releases to be returned.
127+
124128
```yaml
125129
Type: DateTime
126130
Parameter Sets: List
127131
```
128132
129133
### MaxCreatedTime
130134
135+
Maximum creation time of releases to be returned.
136+
131137
```yaml
132138
Type: DateTime
133139
Parameter Sets: List
134140
```
135141
136142
### QueryOrder
137143
144+
Order of the results.
145+
138146
```yaml
139147
Type: String
140148
Parameter Sets: List
141149
```
142150
143151
### ContinuationToken
144152
153+
ContinuationToken is used when retrieving more results than can be returned in one response.
154+
145155
```yaml
146156
Type: String
147157
Parameter Sets: List

.docs/Set-VSTeamAccount.md

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -80,24 +80,7 @@ Will add the account and use the OAuth Token provided by AzD when you check the
8080

8181
## PARAMETERS
8282

83-
### Account
84-
85-
The Azure DevOps (AzD) account name to use.
86-
DO NOT enter the entire URL.
87-
88-
Just the portion after dev.azure.com. For example in the
89-
following url mydemos is the account name.
90-
<https://dev.azure.com/mydemos>
91-
or
92-
The full Team Foundation Server (TFS) url including the collection.
93-
<http://localhost:8080/tfs/DefaultCollection>
94-
95-
```yaml
96-
Type: String
97-
Parameter Sets: Secure, Plain, Windows
98-
Required: True
99-
Position: 1
100-
```
83+
<!-- #include "./params/account.md" -->
10184

10285
### SecurePersonalAccessToken
10386

0 commit comments

Comments
 (0)