Functions/Public/Get-vRAEntitlement.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
function Get-vRAEntitlement {
<#
    .SYNOPSIS
    Retrieve vRA entitlements
    
    .DESCRIPTION
    Retrieve vRA entitlement either by id or name. Passing no parameters will return all entitlements
    
    .PARAMETER Id
    The id of the entitlement
    
    .PARAMETER Name
    The Name of the entitlement

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

[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"
    )
                
    try {

        switch ($PsCmdlet.ParameterSetName) {

            # --- Get Entitlement by id
            'ById'{
        
                foreach ($EntitlementId in $Id ) { 
            
                    $URI = "/catalog-service/api/entitlements/$($Id)"

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

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

                    Write-Verbose -Message "SUCCESS"

                    [pscustomobject] @{

                        Description = $Response.description
                        EntitledCatalogItems = $Response.entitledCatalogItems
                        EntitledResourceOperations = $Response.entitledResourceOperations
                        EntitledServices = $Response.entitledServices
                        ExpiryDate = $Response.expiryDate
                        Id = $Response.id
                        LastUpdatedBy = $Response.lastUpdatedBy
                        LastUpdatedDate = $Response.lastUpdatedDate
                        Name = $Response.name
                        Organization = $Response.organization
                        Principals = $Response.principals
                        PriorityOrder = $Response.priorityOrder
                        Status = $Response.status
                        StatusName = $Response.statusName
                        LocalScopeForActions = $Response.localScopeForActions
                        Version = $Response.version
                    }

                }

                break

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

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

                    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"
            
                    if ($Response.content.Length -eq 0) {

                        throw "Could not find entitlement item with name: $($Name)"

                    }        
            
                    [pscustomobject] @{

                        Description = $Response.content.description
                        EntitledCatalogItems = $Response.content.entitledCatalogItems
                        EntitledResourceOperations = $Response.content.entitledResourceOperations
                        EntitledServices = $Response.content.entitledServices
                        ExpiryDate = $Response.content.expiryDate
                        Id = $Response.content.id
                        LastUpdatedBy = $Response.content.lastUpdatedBy
                        LastUpdatedDate = $Response.content.lastUpdatedDate
                        Name = $Response.content.name
                        Organization = $Response.content.organization
                        Principals = $Response.content.principals
                        PriorityOrder = $Response.content.priorityOrder
                        Status = $Response.content.status
                        StatusName = $Response.content.statusName
                        LocalScopeForActions = $Response.content.localScopeForActions
                        Version = $Response.content.version
                    }             
                }

                break

            }
                
            # --- No parameters passed so return all entitlements
            'Standard' {
            
                $URI = "/catalog-service/api/entitlements?limit=$($Limit)&`$orderby=name%20asc"

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

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

                Write-Verbose -Message "SUCCESS"

                foreach ($Entitlement in $Response.content) {

                    [pscustomobject] @{

                        Description = $Entitlement.description
                        EntitledCatalogItems = $Entitlement.entitledCatalogItems
                        EntitledResourceOperations = $Entitlement.entitledResourceOperations
                        EntitledServices = $Entitlement.entitledServices
                        ExpiryDate = $Entitlement.expiryDate
                        Id = $Entitlement.id
                        LastUpdatedBy = $Entitlement.lastUpdatedBy
                        LastUpdatedDate = $Entitlement.lastUpdatedDate
                        Name = $Entitlement.name
                        Organization = $Entitlement.organization
                        Principals = $Entitlement.principals
                        PriorityOrder = $Entitlement.priorityOrder
                        Status = $Entitlement.status
                        StatusName = $Entitlement.statusName
                        LocalScopeForActions = $Entitlement.localScopeForActions
                        Version = $Entitlement.version
                    }
                }

                break

            }

        }

    }
    catch [Exception]{

        throw
    }

}