Functions/Public/properties-service/Get-vRAPropertyDefinition.ps1

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
function Get-vRAPropertyDefinition {
<#
    .SYNOPSIS
    Get a property that the user is allowed to review.
    
    .DESCRIPTION
    API for property definitions that a system administrator can interact with. It allows the user to interact
    with property definitions that the user is permitted to review.

    .PARAMETER Id
    The id of the property definition

    .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-vRAPropertyDefinition
    
    .EXAMPLE
    Get-vRAPropertyDefinition -Limit 200

    .EXAMPLE
    Get-vRAPropertyDefinition -Id Hostname
    
#>

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

    Param (
    
        [Parameter(Mandatory=$true,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true,ParameterSetName="ById")]
        [ValidateNotNullOrEmpty()]
        [String[]]$Id,

        [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 property definition by id
                'ById' {

                    foreach ($PropertyDefinitionId in $Id) {
                
                        $URI = "/properties-service/api/propertydefinitions/$($PropertyDefinitionId)"

                        $PropertyDefinition = Invoke-vRARestMethod -Method GET -URI $URI -Verbose:$VerbosePreference

                        [PSCustomObject] @{

                            Id = $PropertyDefinition.id
                            Label = $PropertyDefinition.label
                            Description = $PropertyDefinition.description
                            Type = $PropertyDefinition.dataType.typeId
                            IsMultivalued = $PropertyDefinition.isMultiValued
                            Display = $PropertyDefinition.displayAdvice
                            TenantId = $PropertyDefinition.tenantId
                            DisplayIndex = $PropertyDefinition.orderIndex
                            PermittedValues = $PropertyDefinition.permissibleValues
                            Options = $PropertyDefinition.facets
                            Version = $PropertyDefinition.version
                            DateCreated = $PropertyDefinition.createdDate
                            LastUpdatedDate = $PropertyDefinition.lastUpdated      

                        }

                    }

                    break

                }

                # --- No parameters passed so return all property definitions
                'Standard' {

                    $URI = "/properties-service/api/propertydefinitions?limit=$($Limit)&page=$($Page)&`$orderby=id asc"

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

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

                    foreach ($PropertyDefinition in $Response.content) {

                        [PSCustomObject] @{

                            Id = $PropertyDefinition.id
                            Label = $PropertyDefinition.label
                            Description = $PropertyDefinition.description
                            Type = $PropertyDefinition.dataType.typeId
                            IsMultivalued = $PropertyDefinition.isMultiValued
                            Display = $PropertyDefinition.displayAdvice
                            TenantId = $PropertyDefinition.tenantId
                            DisplayIndex = $PropertyDefinition.orderIndex
                            PermittedValues = $PropertyDefinition.permissibleValues
                            Options = $PropertyDefinition.facets
                            Version = $PropertyDefinition.version
                            DateCreated = $PropertyDefinition.createdDate
                            LastUpdatedDate = $PropertyDefinition.lastUpdated     

                        }

                    }

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

                    break

                }

            }

        }
        catch [Exception]{

            throw

        }
    }

    End {

    }
}