Functions/Public/catalog-service/Get-vRAResource.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
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
function Get-vRAResource {
<#
    .SYNOPSIS
    Get a deployed resource
    
    .DESCRIPTION
    A deployment represents a collection of deployed artifacts that have been provisioned by a provider.

    .PARAMETER Id
    The id of the resource
    
    .PARAMETER Name
    The Name of the resource

    .PARAMETER Type
    Show resources that match a certain type.

    Supported types ar:

        Deployment,
        Machine

    .PARAMETER WithExtendedData
    Populate the resources extended data by calling their provider

    .PARAMETER WithOperations
    Populate the resources operations attribute by calling the provider. This will force withExtendedData to true.

    .PARAMETER ManagedOnly
    Show resources owned by the users managed business groups, excluding any machines owned by the user in a non-managed
    business group
        
    .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
    Switch

    .OUTPUTS
    System.Management.Automation.PSObject.

    .EXAMPLE
    Get-vRAResource

    .EXAMPLE
    Get-vRADeployment -WithExtendedData

    .EXAMPLE
    Get-vRADeployment -WithOperations
    
    .EXAMPLE
    Get-vRADeployment -Id "6195fd70-7243-4dc9-b4f3-4b2300e15ef8"

    .EXAMPLE
    Get-vRADeployment -Name "CENTOS-555667"

#>

[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")]
        [ValidateSet("Deployment","Machine")]
        [String]$Type,

        [Parameter(Mandatory=$false,ParameterSetName="Standard")]
        [ValidateNotNullOrEmpty()]
        [Switch]$WithExtendedData,
        
        [Parameter(Mandatory=$false,ParameterSetName="Standard")]
        [ValidateNotNullOrEmpty()]
        [Switch]$WithOperations,

        [Parameter(Mandatory=$false,ParameterSetName="Standard")]
        [ValidateNotNullOrEmpty()]
        [Switch]$ManagedOnly, 
        
        [Parameter(Mandatory=$false,ParameterSetName="Standard")]
        [ValidateNotNullOrEmpty()]
        [Int]$Limit = 100,

        [Parameter(Mandatory=$false,ParameterSetName="Standard")]
        [ValidateNotNullOrEmpty()]
        [Int]$Page = 1

    )

    Begin {

        # --- Test for vRA API version
        xRequires -Version 7.0

    }

    Process {

        try {

            switch ($PsCmdlet.ParameterSetName) {

                # --- Get Resource by id
                'ById' {
                
                    foreach ($ResourceId in $Id) { 
                
                        $URI = "/catalog-service/api/consumer/resourceViews/$($ResourceId)?withExtendedData=true&withOperations=true"

                        $EscapedURI = [uri]::EscapeUriString($URI)

                        $Resource = Invoke-vRARestMethod -Method GET -URI $EscapedURI -Verbose:$VerbosePreference

                        [PSCustomObject] @{

                            ResourceId = $Resource.resourceId
                            Name = $Resource.name
                            Description = $Resource.description
                            Status = $Resource.status
                            CatalogItemLabel = $Resource.catalogItemLabel
                            RequestId = $Resource.requestId
                            ResourceType = $Resource.resourceType
                            Owners = $Resource.owners
                            BusinessGroupId = $Resource.businessGroupId
                            TenantId = $Resource.tenantId
                            DateCreated = $Resource.dateCreated
                            LastUpdated = $Resource.lastUpdated
                            Lease = $Resource.lease
                            Costs = $Resource.costs
                            CostToDate = $Resource.costToDate
                            TotalCost = $Resource.totalCost
                            ParentResourceId = $Resource.parentResourceId
                            HasChildren = $Resource.hasChildren
                            Data = $Resource.data
                            Links = $Resource.links
                            IconId = $Resource.iconId
                            
                        }

                    }

                    break

                }        
                # --- Get Resource by name
                'ByName' {

                    foreach ($ResourceName in $Name) {
                
                        $URI = "/catalog-service/api/consumer/resourceViews?`$filter=name eq '$($ResourceName)'&withExtendedData=true&withOperations=true"

                        $EscapedURI = [uri]::EscapeUriString($URI)

                        $Response = Invoke-vRARestMethod -Method GET -URI $EscapedURI -Verbose:$VerbosePreference

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

                            throw "Could not find resource item with name: $($ResourceName)"

                        }

                        $Resource = $Response.content

                        [PSCustomObject] @{

                            ResourceId = $Resource.resourceId
                            Name = $Resource.name
                            Description = $Resource.description
                            Status = $Resource.status
                            CatalogItemLabel = $Resource.catalogItemLabel
                            RequestId = $Resource.requestId
                            ResourceType = $Resource.resourceType
                            Owners = $Resource.owners
                            BusinessGroupId = $Resource.businessGroupId
                            TenantId = $Resource.tenantId
                            DateCreated = $Resource.dateCreated
                            LastUpdated = $Resource.lastUpdated
                            Lease = $Resource.lease
                            Costs = $Resource.costs
                            CostToDate = $Resource.costToDate
                            TotalCost = $Resource.totalCost
                            ParentResourceId = $Resource.parentResourceId
                            HasChildren = $Resource.hasChildren
                            Data = $Resource.data
                            Links = $Resource.links
                            IconId = $Resource.iconId
                            
                        }
                        
                    }
                    
                    break
                
                }
                # --- No parameters passed so return all resources
                'Standard' {

                    # --- Set the default URI with no filtering to return all resource types
                    $URI = "/catalog-service/api/consumer/resourceViews/?withExtendedData=$($WithExtendedData)&withOperations=$($WithOperations)&managedOnly=$($ManagedOnly)&`$orderby=name asc&limit=$($Limit)&page=$($page)"

                    # --- If type is passed set the filter
                    if ($PSBoundParameters.ContainsKey("Type")){

                        switch ($Type) {

                            'Deployment' {

                                $Filter = "resourceType/id eq 'composition.resource.type.deployment'"
                                $URI = "$($URI)&`$filter=$($filter)"

                                break

                            }

                            'Machine' {

                                $Filter = "resourceType/id eq 'Infrastructure.Machine' or `
                                resourceType/id eq 'Infrastructure.Virtual' or `
                                resourceType/id eq 'Infrastructure.Cloud' or `
                                resourceType/id eq 'Infrastructure.Physical'"


                                $URI = "$($URI)&`$filter=$($filter)"

                                break

                            }

                        }

                        Write-Verbose -Message "Type $($Type) selected"

                    }

                    $EscapedURI = [uri]::EscapeUriString($URI)

                    $Response = Invoke-vRARestMethod -Method GET -URI $EscapedURI -Verbose:$VerbosePreference

                    foreach ($Resource in $Response.content) {

                        [PSCustomObject] @{

                            ResourceId = $Resource.resourceId
                            Name = $Resource.name
                            Description = $Resource.description
                            Status = $Resource.status
                            CatalogItemLabel = $Resource.catalogItemLabel
                            RequestId = $Resource.requestId
                            ResourceType = $Resource.resourceType
                            Owners = $Resource.owners
                            BusinessGroupId = $Resource.businessGroupId
                            TenantId = $Resource.tenantId
                            DateCreated = $Resource.dateCreated
                            LastUpdated = $Resource.lastUpdated
                            Lease = $Resource.lease
                            Costs = $Resource.costs
                            CostToDate = $Resource.costToDate
                            TotalCost = $Resource.totalCost
                            ParentResourceId = $Resource.parentResourceId
                            HasChildren = $Resource.hasChildren
                            Data = $Resource.data
                            Links = $Resource.links
                            IconId = $Resource.iconId

                        }

                    }

                    Write-Verbose -Message "Total: $($Response.metadata.totalElements) | Page: $($Response.metadata.number) of $($Response.metadata.totalPages) | Size: $($Response.metadata.size)"

                    break

                }

            }

        }
        catch [Exception]{

            throw

        }

    }

    End {

    }

}