Functions/Public/catalog-service/DEPRECATED-Get-vRAConsumerResource.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
function Get-vRAConsumerResource {
<#
    .SYNOPSIS
    Get a provisioned resource
    
    .DESCRIPTION
    A Resource represents a deployed artifact that has been provisioned by a provider.

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

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

    .PARAMETER WithOperations
    Populate resources' operations attribute by calling the provider. This will force withExtendedData to true.
        
    .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-vRAConsumerResource

    .EXAMPLE
    Get-vRAConsumerResource -WithExtendedData

    .EXAMPLE
    Get-vRAConsumerResource -WithOperations
    
    .EXAMPLE
    Get-vRAConsumerResource -Id "6195fd70-7243-4dc9-b4f3-4b2300e15ef8"
    
    .EXAMPLE
    Get-vRAConsumerResource -Name "vm-01"
    
#>

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

    Param (

    [parameter(Mandatory=$false, ParameterSetName="ById")]
    [ValidateNotNullOrEmpty()]
    [String[]]$Id,
    
    [parameter(Mandatory=$false, ParameterSetName="ByName")]
    [ValidateNotNullOrEmpty()]
    [String[]]$Name, 

    [parameter(Mandatory=$false, ParameterSetName="Standard")]
    [ValidateNotNullOrEmpty()]
    [Switch]$WithExtendedData,
    
    [parameter(Mandatory=$false, ParameterSetName="Standard")]
    [ValidateNotNullOrEmpty()]
    [Switch]$WithOperations,                
    
    [parameter(Mandatory=$false)]
    [ValidateNotNullOrEmpty()]
    [String]$Limit = "100"
    )

    Write-Warning -Message "This command is deprecated and will be removed in a future release. Please use Get-vRAResorce instead."

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

        switch ($PsCmdlet.ParameterSetName) {

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

                    Write-Verbose -Message "Preparing GET to $($URI)"

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

                    Write-Verbose -Message "SUCCESS"

                    [pscustomobject] @{

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

                }

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

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

                    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 resource item with name: $($ResourceName)"

                    }        
            
                    [pscustomobject] @{

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

            
                $URI = "/catalog-service/api/consumer/resourceViews?limit=$($Limit)&`$orderby=name%20asc"

                if ($PSBoundParameters.ContainsKey('WithExtendedData')){

                    $URI = $URI + "&withExtendedData=true"

                    Write-Verbose -Message "WithExtendedData switch passed. New request uri is: $($URI)"

                }

                if ($PSBoundParameters.ContainsKey('WithOperations')){

                    $URI = $URI + "&withOperations=true"

                    Write-Verbose -Message "WithOperations switch passed. New request uri is: $($URI)"

                }


                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 ($Resource in $Response.content) {

                      [pscustomobject] @{

                        ResourceId = $Resource.resourceId
                        IconId = $Resource.iconId
                        Name = $Resource.name
                        Description = $Resource.description
                        Status = $Resource.status
                        CatalogItemId = $Resource.catalogItemId
                        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
                        
                    }

                }

                break

            }

        }
    }
    catch [Exception]{

        throw
    }
}