Functions/Public/catalog-service/Get-vRAResourceType.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
function Get-vRAResourceType {
<#
    .SYNOPSIS
    Get a 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.

    .PARAMETER Page
    The index of the page to display.

    .INPUTS
    System.String
    System.Int

    .OUTPUTS
    System.Management.Automation.PSObject.

    .EXAMPLE
    Get-vRAResourceType
    
    .EXAMPLE
    Get-vRAResourceType -Id "Infrastructure.Machine"
    
    .EXAMPLE
    Get-vRAResourceType -Name "Machine"
    
#>

[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()]
        [Int]$Page = 1,

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

    )

    Begin {

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

    }

    Process {

        try {

            switch ($PsCmdlet.ParameterSetName) {

                # --- Get Resource Type by id
                'ById' {
                
                    foreach ($ResourceTypeId in $Id) { 

                        $URI = "/catalog-service/api/resourceTypes?`$filter=id eq '$($ResourceTypeId)'"

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

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

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

                            throw "Could not find Resource Type with Id: $($ResourceTypeId)"

                        }

                        $ResourceType = $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

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

                    foreach ($ResourceTypeName in $Name) {

                        $URI = "/catalog-service/api/resourceTypes?`$filter=name eq '$($ResourceTypeName)'"

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

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

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

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

                        }

                        $ResourceType = $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

                }
                # --- No parameters passed so return all resource types
                'Standard' {
                
                    $URI = "/catalog-service/api/resourceTypes?limit=$($Limit)&page=$($Page)&`$orderby=name asc"

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

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

                    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

                        }

                    }

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

                    break

                }

            }

        }
        catch [Exception]{

            throw

        }

    }

    End {

    }

}