Functions/Public/catalog-service/Get-vRAEntitledCatalogItem.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 |
function Get-vRAEntitledCatalogItem { <# .SYNOPSIS Get a catalog item that the user is entitled to see .DESCRIPTION Get catalog items that are entitled to. Consumer Entitled CatalogItem(s) are basically catalog items: - in an active state. - the current user has the right to consume. - the current user is entitled to consume. - associated to a service. .PARAMETER Id The id of the catalog item .PARAMETER Name The name of the catalog item .PARAMETER Service Return catalog items in a specific service .PARAMETER Limit The number of entries returned per page from the API. This has a default value of 100 .PARAMETER Page The index of the page to display .INPUTS System.String System.Int .OUTPUTS System.Management.Automation.PSObject .EXAMPLE Get-vRAEntitledCatalogItem .EXAMPLE Get-vRAEntitledCatalogItem -Limit 9999 .EXAMPLE Get-vRAEntitledCatalogItem -Service "Default Service" .EXAMPLE Get-vRAEntitledCatalogItem -Id dab4e578-57c5-4a30-b3b7-2a5cefa52e9e .EXAMPLE Get-vRAEntitledCatalogItem -Name Centos_Template #> [CmdletBinding(DefaultParameterSetName="Standard")][OutputType('System.Management.Automation.PSObject')] Param ( [Parameter(Mandatory=$true,ValueFromPipeline=$true, ValueFromPipelineByPropertyName=$true,ParameterSetName="ByID")] [ValidateNotNullOrEmpty()] [String[]]$Id, [Parameter(Mandatory=$true,ParameterSetName="ByName")] [ValidateNotNullOrEmpty()] [String[]]$Name, [Parameter(Mandatory=$false,ParameterSetName="Standard")] [ValidateNotNullOrEmpty()] [String]$Service, [Parameter(Mandatory=$false,ParameterSetName="Standard")] [ValidateNotNullOrEmpty()] [Int]$Page = 1, [Parameter(Mandatory=$false,ParameterSetName="Standard")] [ValidateNotNullOrEmpty()] [Int]$Limit = 100 ) Begin { } Process { try { switch ($PsCmdlet.ParameterSetName) { # --- Get catalog item by id 'ById' { foreach ($EntitledCatalogItemId in $Id) { $URI = "/catalog-service/api/consumer/entitledCatalogItems/$($EntitledCatalogItemId)" $Response = Invoke-vRARestMethod -Method GET -URI $URI -Verbose:$VerbosePreference $CatalogItem = $Response.catalogItem [PSCustomObject] @{ Id = $CatalogItem.id Name = $CatalogItem.name Description = $CatalogItem.description Service = $CatalogItem.serviceRef.label Status = $CatalogItem.status Quota = $CatalogItemquota Version = $CatalogItem.version DateCreated = $CatalogItem.dateCreated LastUpdatedDate = $CatalogItem.lastUpdatedDate Requestable = $CatalogItem.requestable IsNoteworthy = $CatalogItem.isNoteworthy Organization = $CatalogItem.organization CatalogItemType = $CatalogItem.catalogitemTypeRef.label OutputResourceType = $CatalogItem.outputResourceTypeRef.label Callbacks = $CatalogItem.callbacks Forms = $CatalogItem.forms IconId = $CatalogItem.iconId ProviderBinding = $CatalogItem.providerBinding EntitledOrganizations = $Response.entitledOrganizations } } break } # --- Get catalog item by name 'ByName' { foreach ($EntitledCatalogItemName in $Name) { $URI = "/catalog-service/api/consumer/entitledCatalogItems?`$filter=name eq '$($EntitledCatalogItemName)'" $EscapedURI = [uri]::EscapeUriString($URI) $Response = Invoke-vRARestMethod -Method GET -URI $EscapedURI -Verbose:$VerbosePreference if ($Response.content.Count -eq 0) { throw "Could not find catalog item with name: $($EntitledCatalogItemName)" } $CatalogItem = $Response.content.catalogItem [PSCustomObject] @{ Id = $CatalogItem.id Name = $CatalogItem.name Description = $CatalogItem.description Service = $CatalogItem.serviceRef.label Status = $CatalogItem.status Quota = $CatalogItemquota Version = $CatalogItem.version DateCreated = $CatalogItem.dateCreated LastUpdatedDate = $CatalogItem.lastUpdatedDate Requestable = $CatalogItem.requestable IsNoteworthy = $CatalogItem.isNoteworthy Organization = $CatalogItem.organization CatalogItemType = $CatalogItem.catalogitemTypeRef.label OutputResourceType = $CatalogItem.outputResourceTypeRef.label Callbacks = $CatalogItem.callbacks Forms = $CatalogItem.forms IconId = $CatalogItem.iconId ProviderBinding = $CatalogItem.providerBinding EntitledOrganizations = $Response.content.entitledOrganizations } } break } # --- No parameters passed so return all catalog items 'Standard' { $URI = "/catalog-service/api/consumer/entitledCatalogItems?limit=$($Limit)&`page=$($Page)&`$orderby=name asc" if ($PSBoundParameters.ContainsKey("Service")) { $ServiceId = (Get-vRAService -Name $Service).Id $URI = "$($URI)&serviceId=$($ServiceId)" } $EscapedURI = [uri]::EscapeUriString($URI) $Response = Invoke-vRARestMethod -Method GET -URI $EscapedURI -Verbose:$VerbosePreference foreach ($Item in $Response.content) { $CatalogItem = $Item.catalogItem [PSCustomObject] @{ Id = $CatalogItem.id Name = $CatalogItem.name Description = $CatalogItem.description Service = $CatalogItem.serviceRef.label Status = $CatalogItem.status Quota = $CatalogItemquota Version = $CatalogItem.version DateCreated = $CatalogItem.dateCreated LastUpdatedDate = $CatalogItem.lastUpdatedDate Requestable = $CatalogItem.requestable IsNoteworthy = $CatalogItem.isNoteworthy Organization = $CatalogItem.organization CatalogItemType = $CatalogItem.catalogitemTypeRef.label OutputResourceType = $CatalogItem.outputResourceTypeRef.label Callbacks = $CatalogItem.callbacks Forms = $CatalogItem.forms IconId = $CatalogItem.iconId ProviderBinding = $CatalogItem.providerBinding EntitledOrganizations = $CatalogItem.entitledOrganizations } } Write-Verbose -Message "Total: $($Response.metadata.totalElements) | Page: $($Response.metadata.number) of $($Response.metadata.totalPages) | Size: $($Response.metadata.size)" break } } } catch [Exception]{ throw } } End { } } |