Functions/Public/catalog-service/DEPRECATED-Get-vRAConsumerResourceType.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
function Get-vRAConsumerResourceType {
<#
    .SYNOPSIS
    Get a consumer resource type
    
    .DESCRIPTION
    A Resource type is a type assigned to resources. The types are defined by the provider types.
    It allows similar resources to be grouped together.
    
    .PARAMETER Id
    The id of the resource type
    
    .PARAMETER Name
    The Name of the resource type

    .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-vRAConsumerResourceType
    
    .EXAMPLE
    Get-vRAConsumerResourceType -Id "Infrastructure.Machine"
    
    .EXAMPLE
    Get-vRAConsumerResourceType -Name "Machine"
    
#>

[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)]
    [ValidateNotNullOrEmpty()]
    [String]$Limit = "100"
    )

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

    try {

        switch ($PsCmdlet.ParameterSetName) {

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

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

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

                    Write-Verbose -Message "SUCCESS"

                    [pscustomobject] @{

                        Id = $Response.id
                        Callbacks = $Response.callbacks
                        CostFeatures = $Response.costFeatures
                        Description = $Response.description
                        Forms = $Response.forms
                        ListView = $Response.listView
                        Name = $Response.name
                        PluralizedName = $Response.pluralizedName
                        Primary = $Response.primary
                        ProviderTypeId = $Response.providerTYpeId
                        Schema = $Response.schema
                        ListDescendantTypesSeparately = $Response.listDescendantTypesSeparately
                        ShowChildrenOutsideParent = $Response.ShowChildrenOutsideParent
                        Status = $Response.status

                    }

                }

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

                foreach ($ResourceTypeName in $Name) {
            
                    $URI = "/catalog-service/api/consumer/resourceTypes?`$filter=name%20eq%20'$($ResourceTypeName)'"

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

                    }        
            
                    [pscustomobject] @{

                        Id = $Response.content.id
                        Callbacks = $Response.content.callbacks
                        CostFeatures = $Response.content.costFeatures
                        Description = $Response.content.description
                        Forms = $Response.content.forms
                        ListView = $Response.content.listView
                        Name = $Response.content.name
                        PluralizedName = $Response.content.pluralizedName
                        Primary = $Response.content.primary
                        ProviderTypeId = $Response.content.providerTYpeId
                        Schema = $Response.content.schema
                        ListDescendantTypesSeparately = $Response.content.listDescendantTypesSeparately
                        ShowChildrenOutsideParent = $Response.content.ShowChildrenOutsideParent
                        Status = $Response.content.status

                    }
                    
                }
                
                break                                
            
            }        
            # --- No parameters passed so return all resource types
            'Standard' {
            
                $URI = "/catalog-service/api/consumer/resourceTypes?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 ($ResourceType in $Response.content) {

                    [pscustomobject] @{

                        Id = $ResourceType.id
                        Callbacks = $ResourceType.callbacks
                        CostFeatures = $ResourceType.costFeatures
                        Description = $ResourceType.description
                        Forms = $ResourceType.forms
                        ListView = $ResourceType.listView
                        Name = $ResourceType.name
                        PluralizedName = $ResourceType.pluralizedName
                        Primary = $ResourceType.primary
                        ProviderTypeId = $ResourceType.providerTYpeId
                        Schema = $ResourceType.schema
                        ListDescendantTypesSeparately = $ResourceType.listDescendantTypesSeparately
                        ShowChildrenOutsideParent = $ResourceType.ShowChildrenOutsideParent
                        Status = $ResourceType.status

                    }

                }

                break

            }

        }
    }
    catch [Exception]{

        throw
    }
}