Functions/Public/catalog-service/Get-vRARequest.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 345 346 347 348 349 350 351 352 353 |
function Get-vRARequest { <# .SYNOPSIS Get information about vRA requests .DESCRIPTION Get information about vRA requests. These are the same services that you will see via the service tab .PARAMETER Id The Id of the request to query .PARAMETER RequestNumber The reqest number of the request to query .PARAMETER RequestedFor Show requests that were submitted on behalf of a certain user .PARAMETER RequestedBy Show requests that were submitted by a certain user .PARAMETER State Show request that match a certain state Supported states are: UNSUBMITTED, SUBMITTED, DELETED, PENDING_PRE_APPROVAL, PRE_APPROVAL_SEND_ERROR, PRE_APPROVED, PRE_REJECTED, PROVIDER_DELETION_ERROR, IN_PROGRESS, PROVIDER_SEND_ERROR, PROVIDER_COMPLETED, PROVIDER_FAILED, PENDING_POST_APPROVAL, POST_APPROVAL_SEND_ERROR, POST_APPROVED, POST_REJECTION_RECEIVED, ROLLBACK_ERROR, POST_REJECTED, SUCCESSFUL, PARTIALLY_SUCCESSFUL, FAILED .PARAMETER Limit The number of entries returned per page from the API. This has a default value of 100. .PARAMETER Page The page of response to return .INPUTS System.String System.Int .OUTPUTS System.Management.Automation.PSObject .EXAMPLE Get-vRARequest .EXAMPLE Get-vRARequest -Limit 9999 .EXAMPLE Get-vRARequest -RequestedFor user@vsphere.local .EXAMPLE Get-vRARequest -RequestedBy user@vsphere.local .EXAMPLE Get-vRARequest -Id 697db588-b706-4836-ae38-35e0c7221e3b .EXAMPLE Get-vRARequest -RequestNumber 3 #> [CmdletBinding(DefaultParameterSetName="Standard")][OutputType('System.Management.Automation.PSObject', 'System.Object[]')] Param ( [Parameter(Mandatory=$true,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true,ParameterSetName="ById")] [ValidateNotNullOrEmpty()] [String[]]$Id, [Parameter(Mandatory=$true,ParameterSetName="ByRequestNumber")] [ValidateNotNullOrEmpty()] [String[]]$RequestNumber, [Parameter(Mandatory=$false,ParameterSetName="RequestedFor")] [ValidateNotNullOrEmpty()] [String]$RequestedFor, [Parameter(Mandatory=$false,ParameterSetName="RequestedBy")] [ValidateNotNullOrEmpty()] [String]$RequestedBy, [Parameter(Mandatory=$false,ParameterSetName="State")] [ValidateSet( "UNSUBMITTED", "SUBMITTED", "DELETED", "PENDING_PRE_APPROVAL", "PRE_APPROVAL_SEND_ERROR", "PRE_APPROVED", "PRE_REJECTED", "PROVIDER_DELETION_ERROR", "IN_PROGRESS", "PROVIDER_SEND_ERROR", "PROVIDER_COMPLETED", "PROVIDER_FAILED", "PENDING_POST_APPROVAL", "POST_APPROVAL_SEND_ERROR", "POST_APPROVED", "POST_REJECTION_RECEIVED", "ROLLBACK_ERROR", "POST_REJECTED", "SUCCESSFUL", "PARTIALLY_SUCCESSFUL", "FAILED" )] [String]$State, [Parameter(Mandatory=$false,ParameterSetName="Standard")] [Parameter(Mandatory=$false,ParameterSetName="RequestedFor")] [Parameter(Mandatory=$false,ParameterSetName="RequestedBy")] [Parameter(Mandatory=$false,ParameterSetName="State")] [ValidateNotNullOrEmpty()] [Int]$Limit = 100, [Parameter(Mandatory=$false,ParameterSetName="Standard")] [Parameter(Mandatory=$false,ParameterSetName="RequestedFor")] [Parameter(Mandatory=$false,ParameterSetName="RequestedBy")] [Parameter(Mandatory=$false,ParameterSetName="State")] [ValidateNotNullOrEmpty()] [int]$Page = 1 ) Begin { } Process { try { switch ($PsCmdlet.ParameterSetName) { # --- If the id parameter is passed returned detailed information about the request 'ById' { foreach ($RequestId in $Id) { $URI = "/catalog-service/api/consumer/requests/$($RequestId)" $Request = Invoke-vRARestMethod -Method GET -URI $URI -Verbose:$VerbosePreference [PSCustomObject] @{ Id = $Request.id RequestNumber = $Request.RequestNumber State = $Request.state Description = $Request.description CatalogItem = $Request.catalogItemRef.label RequestedItemName = $Request.requestedItemName RequestedItemDescription = $Request.requestedItemDescription Reasons = $Request.reasons RequestedFor = $Request.requestedFor RequestedBy = $Request.requestedBy DateCreated = $Request.dateCreated LastUpdated = $Request.lastUpdated DateSubmitted = $Request.dateSubmitted DateApproved = $Request.dateApproved DateCompleted = $Request.dateCompleted WaitingStatus = $Request.waitingStatus ExecutionStatus = $Request.executionStatus ApprovalStatus = $Request.approvalStatus Phase = $Request.phase IconId = $Request.iconId Version = $Request.version Organization = $Request.organization RequestorEntitlementId = $Request.requestorEntitlementId PreApprovalId = $Request.preApprovalId PostApprovalId = $Request.postApprovalId Quote = $Request.quote RequestCompletion = $Request.requestCompletion RequestData = $Request.requestData RetriesRemaining = $Request.retriesRemaining Components = $Request.components StateName = $Request.stateName CatalogItemProviderBinding = $Request.catalogItemProviderBinding } } break } # --- If the requestnumber parameter is passed returned detailed information about the request 'ByRequestNumber' { foreach ($RequestN in $RequestNumber) { $URI = "/catalog-service/api/consumer/requests?`$filter=requestNumber eq '$($RequestN)'" $EscapedURI = [uri]::EscapeUriString($URI) $Response = Invoke-vRARestMethod -Method GET -URI $EscapedURI -Verbose:$VerbosePreference if ($Response.content.Count -eq 0) { throw "Could not find request number $($RequestN)" } $Request = $Response.content [PSCustomObject] @{ Id = $Request.id RequestNumber = $Request.RequestNumber State = $Request.state Description = $Request.description CatalogItem = $Request.catalogItemRef.label RequestedItemName = $Request.requestedItemName RequestedItemDescription = $Request.requestedItemDescription Reasons = $Request.reasons RequestedFor = $Request.requestedFor RequestedBy = $Request.requestedBy DateCreated = $Request.dateCreated LastUpdated = $Request.lastUpdated DateSubmitted = $Request.dateSubmitted DateApproved = $Request.dateApproved DateCompleted = $Request.dateCompleted WaitingStatus = $Request.waitingStatus ExecutionStatus = $Request.executionStatus ApprovalStatus = $Request.approvalStatus Phase = $Request.phase IconId = $Request.iconId Version = $Request.version Organization = $Request.organization RequestorEntitlementId = $Request.requestorEntitlementId PreApprovalId = $Request.preApprovalId PostApprovalId = $Request.postApprovalId Quote = $Request.quote RequestCompletion = $Request.requestCompletion RequestData = $Request.requestData RetriesRemaining = $Request.retriesRemaining Components = $Request.components StateName = $Request.stateName CatalogItemProviderBinding = $Request.catalogItemProviderBinding } } break } {('Standard') -or ('RequestedFor') -or ('RequestedBy') -or ('State')} { $URI = "/catalog-service/api/consumer/requests?limit=$($Limit)&page=$($Page)&`$orderby=dateSubmitted desc" if ($PSBoundParameters.ContainsKey("RequestedFor")) { $URI = "$($URI)&`$filter=requestedFor eq '$($RequestedFor)'" } if ($PSBoundParameters.ContainsKey("RequestedBy")) { $URI = "$($URI)&`$filter=requestedBy eq '$($RequestedBy)'" } if ($PSBoundParameters.ContainsKey("State")) { $URI = "$($URI)&`$filter=state eq '$($State)'" } $EscapedURI = [uri]::EscapeUriString($URI) # --- Make the first request to determine the size of the request $Response = Invoke-vRARestMethod -Method GET -URI $EscapedURI -Verbose:$VerbosePreference foreach ($Request in $Response.content) { [PSCustomObject] @{ Id = $Request.id RequestNumber = $Request.RequestNumber State = $Request.state Description = $Request.description CatalogItem = $Request.catalogItemRef.label RequestedItemName = $Request.requestedItemName RequestedItemDescription = $Request.requestedItemDescription Reasons = $Request.reasons RequestedFor = $Request.requestedFor RequestedBy = $Request.requestedBy DateCreated = $Request.dateCreated LastUpdated = $Request.lastUpdated DateSubmitted = $Request.dateSubmitted DateApproved = $Request.dateApproved DateCompleted = $Request.dateCompleted WaitingStatus = $Request.waitingStatus ExecutionStatus = $Request.executionStatus ApprovalStatus = $Request.approvalStatus Phase = $Request.phase IconId = $Request.iconId Version = $Request.version Organization = $Request.organization RequestorEntitlementId = $Request.requestorEntitlementId PreApprovalId = $Request.preApprovalId PostApprovalId = $Request.postApprovalId Quote = $Request.quote RequestCompletion = $Request.requestCompletion RequestData = $Request.requestData RetriesRemaining = $Request.retriesRemaining Components = $Request.components StateName = $Request.stateName CatalogItemProviderBinding = $Request.catalogItemProviderBinding } } Write-Verbose -Message "Total: $($Response.metadata.totalElements) | Page: $($Response.metadata.number) of $($Response.metadata.totalPages) | Size: $($Response.metadata.size)" break } } } catch [Exception]{ throw } } End { } } |