Functions/Public/catalog-service/DEPRECATED-Get-vRAConsumerService.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
function Get-vRAConsumerService {
<#
    .SYNOPSIS
    Retrieve vRA services
    
    .DESCRIPTION
    A service represents a customer-facing/user friendly set of activities. In the context of this Service Catalog,
    these activities are the catalog items and resource actions.
    A service must be owned by a specific organization and all the activities it contains should belongs to the same organization.
    
    .PARAMETER Id
    The id of the service
    
    .PARAMETER Name
    The Name of the service

    .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-vRAConsumerService
    
    .EXAMPLE
    Get-vRAConsumerService -Id 332d38d5-c8db-4519-87a7-7ef9f358091a
    
    .EXAMPLE
    Get-vRAConsumerService -Name "Default Service"
    
#>

[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-vRAEntitledService instead."

    try {

        switch ($PsCmdlet.ParameterSetName) {

            # --- Get Service by id
            'ById' {
            
                foreach ($ServiceId in $Id) { 
            
                    $URI = "/catalog-service/api/consumer/services/$($ServiceId)"

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

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

                    Write-Verbose -Message "SUCCESS"

                    [pscustomobject] @{

                        Id = $Response.id
                        Name = $Response.name
                        Description = $Response.description
                        Status = $Response.status
                        StatusName = $Response.statusName
                        Version = $Response.version
                        Organization = $Response.organization
                        Hours = $Response.hours
                        Owner = $Response.owner
                        SupportTeam = $Response.supportTeam
                        ChangeWindow = $Response.changeWindow
                        NewDuration = $Response.newDuration
                        LastUpdatedDate = $Response.lastUpdatedDate
                        LastUpdatedBy = $Response.lastUpdatedBy
                        IconId = $Response.iconId

                    }

                }

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

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

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

                    }        
            
                    [pscustomobject] @{

                        Id = $Response.content.id
                        Name = $Response.content.name
                        Description = $Response.content.description
                        Status = $Response.content.status
                        StatusName = $Response.content.statusName
                        Version = $Response.content.version
                        Organization = $Response.content.organization
                        Hours = $Response.content.hours
                        Owner = $Response.content.owner
                        SupportTeam = $Response.content.supportTeam
                        ChangeWindow = $Response.content.changeWindow
                        NewDuration = $Response.content.newDuration
                        LastUpdatedDate = $Response.content.lastUpdatedDate
                        LastUpdatedBy = $Response.content.lastUpdatedBy
                        IconId = $Response.content.iconId

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

                    [pscustomobject] @{

                        Id = $Service.id
                        Name = $Service.name
                        Description = $Service.description
                        Status = $Service.status
                        StatusName = $Service.statusName
                        Version = $Service.version
                        Organization = $Service.organization
                        Hours = $Service.hours
                        Owner = $Service.owner
                        SupportTeam = $Service.supportTeam
                        ChangeWindow = $Service.changeWindow
                        NewDuration = $Service.newDuration
                        LastUpdatedDate = $Service.lastUpdatedDate
                        LastUpdatedBy = $Service.lastUpdatedBy
                        IconId = $Service.iconId

                    }

                }

                break

            }

        }
    }
    catch [Exception]{

        throw
    }
}