lib/Teams.ps1
|
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 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 |
function Get-TMTeam { <# .SYNOPSIS Retrieves one or more Teams from TransitionManager .DESCRIPTION This function will retrieve one or more Teams from TransitonManager, optionally filtering by Code or Description .PARAMETER TMSession The name of the TM Session to use when retrieving Teams .PARAMETER Code One or more Team codes to filter by .PARAMETER Description One or more Team descriptions to filter by .EXAMPLE Get-TMTeam -TMSession TMAD60 -Description 'System*' .EXAMPLE Get-TMTeam -TMSession TMAD60 -Code 'SYS_ADMIN', 'AUTO' .OUTPUTS A list of TMTeam objects #> [CmdletBinding(DefaultParameterSetName = 'All')] param ( [Parameter(Mandatory = $false, Position = 1)] [String]$TMSession = "Default", [Parameter(Mandatory = $false, ParameterSetName = 'ByCode')] [ValidateLength(1, 32)] [String[]]$Code, [Parameter(Mandatory = $false, ParameterSetName = 'ByDescription')] [String[]]$Description ) # Get the session configuration Write-Verbose "Checking for cached TMSession" $TMSessionConfig = $global:TMSessions[$TMSession] Write-Debug "TMSessionConfig:" Write-Debug ($TMSessionConfig | ConvertTo-Json -Depth 5) if (-not $TMSessionConfig) { throw "TMSession '$TMSession' not found. Use New-TMSession command before using features." } $Teams = [System.Collections.Generic.List[TMTeam]]::new() try { Write-Verbose "Forming web request parameters" $WebRequestSplat = @{ Uri = "https://$($TMSessionConfig.TMServer)/tdstm/ws/team/list" WebSession = $TMSessionConfig.TMWebSession Method = 'GET' } Write-Debug "Web Request Parameters:" Write-Debug ($WebRequestSplat | ConvertTo-Json -Depth 10) Write-Verbose "Invoking web request" $Response = Invoke-WebRequest @WebRequestSplat Write-Debug "Response Content:" Write-Debug ($Response.Content | ConvertTo-Json) if ($Response.StatusCode -in 200, 204) { ($Response.Content | ConvertFrom-Json).data | ForEach-Object { $Teams.Add([TMTeam]::new($_)) } } } catch { throw "Error when gettting Teams: $($_.Exception.Message)" } ## Sort the Teams $Teams = $Teams | Sort-Object -Property 'CODE' if ($PSCmdlet.ParameterSetName -eq 'ByCode') { foreach ($Item in $Code) { $Teams | Where-Object { $_.Code -match $Item } } } elseif ($PSCmdlet.ParameterSetName -eq 'ByDescription') { foreach ($Item in $Description) { $Teams | Where-Object { $_.Description -like $Item } } } else { $Teams } } function New-TMTeam { <# .SYNOPSIS Creates a Team in TransitionManager .DESCRIPTION This function will create a new Team in TransitionManager using the specified properties .PARAMETER TMSession The name of the TM Session to use when creating a Team .PARAMETER Code The Code to use for the new Team .PARAMETER Description The description of the new Team .PARAMETER Level The level of the new Team .PARAMETER Help The help text for the new Team .EXAMPLE New-TMTeam -TMSession TMAD60 -Code 'TEST_TEAM2' -Description 'Test Team 2' -Help 'This is the second test team' .EXAMPLE Get-TMTeam -TMSession TMAD60 -Code 'SYS_ADMIN', 'AUTO' | ForEach-Object { $_.Code += "2" $_.Description += "2" $_ } | New-TMTeam -TMSession TMAD60 .OUTPUTS None #> [CmdletBinding()] param ( [Parameter(Mandatory = $false, Position = 1)] [String]$TMSession = "Default", [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)] [ValidateLength(1, 32)] [String]$Code, [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)] [String]$Description, [Parameter(Mandatory = $false, ValueFromPipelineByPropertyName = $true)] [ValidateRange(0, 100)] [Int]$Level = 0, [Parameter(Mandatory = $false, ValueFromPipelineByPropertyName = $true)] [String]$Help ) begin { # Get the session configuration Write-Verbose "Checking for cached TMSession" $TMSessionConfig = $global:TMSessions[$TMSession] Write-Debug "TMSessionConfig:" Write-Debug ($TMSessionConfig | ConvertTo-Json -Depth 5) if (-not $TMSessionConfig) { throw "TMSession '$TMSession' not found. Use New-TMSession command before using features." } } process { try { $WebRequestSplat = @{ Uri = "https://$($TMSessionConfig.TMServer)/tdstm/ws/team" WebSession = $TMSessionConfig.TMWebSession Method = 'POST' Body = (@{ id = $Code help = $Help description = $Description level = $Level prevId = "" } | ConvertTo-Json -Compress) } $Response = Invoke-WebRequest @WebRequestSplat if ($Response.StatusCode -notin 200, 204) { throw "The status code $($Response.StatusCode) does not indicate success" } } catch { throw "Error when creating Team: $($_.Exception.Message)" } } } function Update-TMTeam { <# .SYNOPSIS Updates a Team in TransitionManager .DESCRIPTION This function will update the Description and/or Help text on a Team record in TransitionManager .PARAMETER TMSession The name of the TM Session to use when updating a Team .PARAMETER Team A TMTeam object representing the Updates required on the Team .PARAMETER Code The Code of the Team to update .PARAMETER Description The Description to place on the Team record .PARAMETER Help The Help text to place on the Team record .EXAMPLE Update-TMTeam -TMSession TMAD60 -Code 'DB_ADMIN' -Description 'Database Administrator' -Help "Whatever" .EXAMPLE $Team = Get-TMTeam -TMSession TMAD60 -Code 'SYS_ADMIN' $Team.Help = 'System Administrator' Update-TMTeam -TMSession TMAD60 -Team $Team .OUTPUTS None #> [CmdletBinding(DefaultParameterSetName = 'ByProperty')] param ( [Parameter(Mandatory = $false, Position = 1)] [String]$TMSession = "Default", [Parameter(Mandatory = $true, ParameterSetName = 'ByObject')] [Alias('InputObject')] [TMTeam]$Team, [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'ByProperty')] [ValidateLength(1, 32)] [String]$Code, [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'ByProperty')] [String]$Description, [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'ByProperty')] [String]$Help ) begin { # Get the session configuration Write-Verbose "Checking for cached TMSession" $TMSessionConfig = $global:TMSessions[$TMSession] Write-Debug "TMSessionConfig:" Write-Debug ($TMSessionConfig | ConvertTo-Json -Depth 5) if (-not $TMSessionConfig) { throw "TMSession '$TMSession' not found. Use New-TMSession command before using features." } } process { try { $WebRequestSplat = @{ Uri = "https://$($TMSessionConfig.TMServer)/tdstm/ws/team/$([System.Web.HttpUtility]::UrlEncode($Code))" WebSession = $TMSessionConfig.TMWebSession Method = 'PUT' Body = (@{ prevId = $Code description = $Description help = $Help } | ConvertTo-Json -Compress) } $Response = Invoke-WebRequest @WebRequestSplat if ($Response.StatusCode -notin 200, 204) { throw "The status code $($Response.StatusCode) does not indicate success" } } catch { throw "Error when updating Team: $($_.Exception.Message)" } } } Set-Alias -Name 'Set-TMTeam' -Value 'Update-TMTeam' function Remove-TMTeam { <# .SYNOPSIS Deletes a Team record from TransitionManager .DESCRIPTION This function will delete the specified Team record from TransitionManager .PARAMETER TMSession The name of the TM Session to use when removing a Team .PARAMETER Code The Code of the Team to delete .EXAMPLE Get-TMTeam -TMSession TMAD60 -Code 'AUTO*' | Remove-TMTeam -TMSession TMAD60 .EXAMPLE Remove-TMTeam -TMSession TMAD60 -Code 'SYS_ADMIN' .OUTPUTS None #> [CmdletBinding()] param ( [Parameter(Mandatory = $false, Position = 1)] [String]$TMSession = "Default", [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)] [ValidateLength(1, 32)] [String]$Code ) begin { # Get the session configuration Write-Verbose "Checking for cached TMSession" $TMSessionConfig = $global:TMSessions[$TMSession] Write-Debug "TMSessionConfig:" Write-Debug ($TMSessionConfig | ConvertTo-Json -Depth 5) if (-not $TMSessionConfig) { throw "TMSession '$TMSession' not found. Use New-TMSession command before using features." } } process { try { $WebRequestSplat = @{ Uri = "https://$($TMSessionConfig.TMServer)/tdstm/ws/team/$([System.Web.HttpUtility]::UrlEncode($Code))" WebSession = $TMSessionConfig.TMWebSession Method = 'DELETE' } $Response = Invoke-WebRequest @WebRequestSplat if ($Response.StatusCode -notin 200, 204) { throw "The status code $($Response.StatusCode) does not indicate success" } } catch { throw "Error when gettting Teams: $($_.Exception.Message)" } } } |