Functions/Public/reservation-service/Get-vRAReservation.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 |
function Get-vRAReservation { <# .SYNOPSIS Get a reservation .DESCRIPTION Get a reservation .PARAMETER Id The id of the reservation .PARAMETER Name The name of the reservation .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. All pages are retuend by default .INPUTS System.String System.Int .OUTPUTS System.Management.Automation.PSObject System.Object[] .EXAMPLE Get-vRAReservation -Id 75ae3400-beb5-4b0b-895a-0484413c93b1 .EXAMPLE Get-vRAReservation -Name Reservation1 .EXAMPLE Get-vRAReservation #> [CmdletBinding(DefaultParameterSetName="Standard")][OutputType('System.Management.Automation.PSObject', 'System.Object[]')] Param ( [parameter(Mandatory=$true,ParameterSetName="ById")] [ValidateNotNullOrEmpty()] [String[]]$Id, [parameter(Mandatory=$true,ParameterSetName="ByName")] [ValidateNotNullOrEmpty()] [String[]]$Name, [parameter(Mandatory=$false,ParameterSetName="Standard")] [ValidateNotNullOrEmpty()] [Int]$Limit = "100", [parameter(Mandatory=$false,ParameterSetName="Standard")] [ValidateNotNullOrEmpty()] [Int]$Page = "1" ) try { switch ($PsCmdlet.ParameterSetName) { 'ById' { foreach ($ReservationId in $Id) { $URI = "/reservation-service/api/reservations/$($ReservationId)" Write-Verbose -Message "Preparing GET to $($URI)" $Response = Invoke-vRARestMethod -Method GET -URI "$($URI)" Write-Verbose -Message "SUCCESS" if ($Response.Count -eq 0) { throw "Could not find reservation $($ReservationId)" } [pscustomobject] @{ CreatedDate = $Response.createdDate LastUpdated = $Response.lastUpdated Version = $Response.version Id = $Response.id Name = $Response.name ReservationTypeId = $Response.reservationTypeId TenantId = $Response.tenantId SubTenantId = $Response.subtenantId Enabled = $Response.enabled Priority = $Response.Priority ReservationPolicyId = $Response.reservationPolicyId AlertPolicy = $Response.alertPolicy ExtensionData = $Response.extensionData } } break } 'ByName' { foreach ($ReservationName in $Name) { $URI = "/reservation-service/api/reservations?`$filter=name%20eq%20'$($ReservationName)'" Write-Verbose -Message "Preparing GET to $($URI)" $Response = Invoke-vRARestMethod -Method GET -URI "$($URI)" Write-Verbose -Message "SUCCESS" if ($Response.content.Count -eq 0) { throw "Could not find reservation $($ReservationName)" } [pscustomobject] @{ CreatedDate = $Response.content.createdDate LastUpdated = $Response.content.lastUpdated Version = $Response.content.version Id = $Response.content.id Name = $Response.content.name ReservationTypeId = $Response.content.reservationTypeId TenantId = $Response.content.tenantId SubTenantId = $Response.content.subtenantId Enabled = $Response.content.enabled Priority = $Response.content.Priority ReservationPolicyId = $Response.content.reservationPolicyId AlertPolicy = $Response.content.alertPolicy ExtensionData = $Response.content.extensionData } } break } 'Standard' { $URI = "/reservation-service/api/reservations?limit=$($Limit)" # --- Make the first request to determine the size of the request $Response = Invoke-vRARestMethod -Method GET -URI $URI if (!$PSBoundParameters.ContainsKey("Page")){ # --- Get every page back $TotalPages = $Response.metadata.totalPages.ToInt32($null) } else { # --- Set TotalPages to 1 $TotalPages = 1 } # --- Initialise an empty array $ResponseObject = @() while ($true){ Write-Verbose -Message "Getting response for page $($Page) of $($Response.metadata.totalPages)" $PagedUri = "$($URI)&page=$($Page)&`$orderby=name%20asc" Write-Verbose -Message "GET : $($PagedUri)" $Response = Invoke-vRARestMethod -Method GET -URI $PagedUri Write-Verbose -Message "Paged Response contains $($Response.content.Count) records" foreach ($Reservation in $Response.content) { $Object = [pscustomobject] @{ CreatedDate = $Reservation.createdDate LastUpdated = $Reservation.lastUpdated Version = $Reservation.version Id = $Reservation.id Name = $Reservation.name ReservationTypeId = $Reservation.reservationTypeId TenantId = $Reservation.tenantId SubTenantId = $Reservation.subtenantId Enabled = $Reservation.enabled Priority = $Reservation.Priority ReservationPolicyId = $Reservation.reservationPolicyId AlertPolicy = $Reservation.alertPolicy ExtensionData = $Reservation.extensionData } $ResponseObject += $Object } # --- Break loop if ($Page -ge $TotalPages) { break } # --- Increment the current page by 1 $Page++ } # --- Return reservations $ResponseObject break } } } catch [Exception]{ throw } } |