Functions/Public/Get-vRACatalogItem.psm1

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
function Get-vRACatalogItem {
<#
    .SYNOPSIS
    Get a catalog item that the user is allowed to review.
    
    .DESCRIPTION
    API for catalog items that a system administrator can interact with. It allows the user to interact
    with catalog items that the user is permitted to review, even if they were not published or entitled to them.

    .PARAMETER Id
    The id of the catalog item
    
    .PARAMETER Name
    The name of the catalog item

    .PARAMETER Limit
    The number of entries returned per page from the API. This has a default value of 100.

    .INPUTS
    System.String

    .OUTPUTS
    System.Management.Automation.PSObject

    .EXAMPLE
    Get-vRACatalogItem
    
    .EXAMPLE
    Get-vRACatalogItem -Limit 9999

    .EXAMPLE
    Get-vRACatalogItem -Id dab4e578-57c5-4a30-b3b7-2a5cefa52e9e

    .EXAMPLE
    Get-vRACatalogItem -Name Centos_Template
    
#>

[CmdletBinding(DefaultParameterSetName="Standard")][OutputType('System.Management.Automation.PSObject')]

    Param (
        
    [parameter(Mandatory=$true,ValueFromPipeline=$false,ParameterSetName="ById")]
    [ValidateNotNullOrEmpty()]
    [String[]]$Id,         

    [parameter(Mandatory=$true,ValueFromPipeline=$false,ParameterSetName="ByName")]
    [ValidateNotNullOrEmpty()]
    [String[]]$Name, 
    
    [parameter(Mandatory=$false,ValueFromPipeline=$false)]
    [ValidateNotNullOrEmpty()]
    [String]$Limit = "100" 
    
    )      

    try {

        switch ($PsCmdlet.ParameterSetName) {

            # --- Get catalog item by id
            'ById' {

                foreach ($CatalogItemId in $Id) {
            
                    $URI = "/catalog-service/api/catalogItems/$($CatalogItemId)"

                    Write-Verbose -Message "Preparing GET to $($URI)"
            
                    $Response = Invoke-vRARestMethod -Method GET -URI $URI

                    Write-Verbose -Message "SUCCESS"
                      
                    [pscustomobject] @{

                        Callbacks = $Response.callbacks
                        CatalogItemTypeRef = $Response.catalogItemTypeRef
                        DateCreated = $Response.dateCreated
                        Description = $Response.description
                        Forms = $Response.forms
                        IconId = $Response.iconId
                        Id = $Response.id
                        IsNoteworthy = $Response.isNoteworthy
                        LastUpdatedDate = $Response.lastUpdatedDate
                        Name = $Response.name
                        Organization = $Response.organization
                        OutputResourceTypeRef = $Response.outputResourceTypeRef
                        ProviderBinding = $Response.providerBinding
                        ServiceRef = $Response.serviceRef
                        Status = $Response.status
                        StatusName = $Response.statusName
                        Quota = $Response.quota
                        Version = $Response.version
                        Requestable = $Response.requestable

                    }
                }

                break
             
            }       
            # --- Get catalog item by name
            'ByName' {
        
                foreach ($CatalogItemName in $Name) { 
            
                    $URI = "/catalog-service/api/catalogItems?`$filter=name%20eq%20'$($CatalogItemName)'"            
            
                    Write-Verbose -Message "Preparing GET to $($URI)"                

                    $Response = Invoke-vRARestMethod -Method GET -URI "$($URI)"

                    Write-Verbose -Message "SUCCESS"

                    if ($Response.content.Length -eq 0) {

                        throw "Could not find catalog item with name: $($CatalogItemName)"

                    }

                    [pscustomobject] @{

                        Callbacks = $Response.content.callbacks
                        CatalogItemTypeRef = $Response.content.catalogItemTypeRef
                        DateCreated = $Response.content.dateCreated
                        Description = $Response.content.description
                        Forms = $Response.content.forms
                        IconId = $Response.content.iconId
                        Id = $Response.content.id
                        IsNoteworthy = $Response.content.isNoteworthy
                        LastUpdatedDate = $Response.content.lastUpdatedDate
                        Name = $Response.content.name
                        Organization = $Response.content.organization
                        OutputResourceTypeRef = $Response.content.outputResourceTypeRef
                        ProviderBinding = $Response.content.providerBinding
                        ServiceRef = $Response.content.serviceRef
                        Status = $Response.content.status
                        StatusName = $Response.content.statusName
                        Quota = $Response.content.quota
                        Version = $Response.content.version
                        Requestable = $Response.content.requestable

                    }

                }

                break

            }
            # --- No parameters passed so return all catalog items
            'Standard' {
            
                $URI = "/catalog-service/api/catalogItems?limit=$($Limit)&`$orderby=name%20asc"        
                
                Write-Verbose -Message "Preparing GET to $($URI)"   

                $Response = Invoke-vRARestMethod -Method GET -URI $URI

                Write-Verbose -Message "SUCCESS"

                Write-Verbose -Message "Response contains $($Response.content.Length) records"

                foreach ($CatalogItem in $Response.content) {

                    [pscustomobject] @{

                        Callbacks = $CatalogItem.callbacks
                        CatalogItemTypeRef = $CatalogItem.catalogItemTypeRef
                        DateCreated = $CatalogItem.dateCreated
                        Description = $CatalogItem.description
                        Forms = $CatalogItem.forms
                        IconId = $CatalogItem.iconId
                        Id = $CatalogItem.id
                        IsNoteworthy = $CatalogItem.isNoteworthy
                        LastUpdatedDate = $CatalogItem.lastUpdatedDate
                        Name = $CatalogItem.name
                        Organization = $CatalogItem.organization
                        OutputResourceTypeRef = $CatalogItem.outputResourceTypeRef
                        ProviderBinding = $CatalogItem.providerBinding
                        ServiceRef = $CatalogItem.serviceRef
                        Status = $CatalogItem.status
                        StatusName = $CatalogItem.statusName
                        Quota = $CatalogItem.quota
                        Version = $CatalogItem.version
                        Requestable = $CatalogItem.requestable

                    }
                
                }

                break
            
            }
           
        }

    }
    catch [Exception]{
        
            throw

     }                  
}