Functions/Public/Get-vRAGroupPrincipal.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
function Get-vRAGroupPrincipal {
<#
    .SYNOPSIS
    Finds groups.
    
    .DESCRIPTION
    Finds groups in one of the identity providers configured for the tenant.
    
    .PARAMETER Id
    The Id of the group
    
    .PARAMETER Tenant
    The tenant of the group
    
    .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-vRAGroupPrincipal
    
    .EXAMPLE
    Get-vRAGroupPrincipal -Id group@vsphere.local
    
    .EXAMPLE
    Get-vRAGroupPrincipal -PrincipalId group@vsphere.local

#>

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

    Param (

    [parameter(Mandatory=$true,ParameterSetName="ById")]    
    [ValidateNotNullOrEmpty()]
    [Alias("PrincipalId")]
    [String[]]$Id,
    
    [parameter(Mandatory=$false,ParameterSetName="Standard")]
    [parameter(Mandatory=$false,ParameterSetName="ById")]    
    [ValidateNotNullOrEmpty()]
    [String]$Tenant = $Global:vRAConnection.Tenant,          
          
    [parameter(Mandatory=$false,ParameterSetName="Standard")]
    [ValidateNotNullOrEmpty()]
    [String]$Limit = "100"
    
    )
    
    begin {}
    
    process {
                
        try {

            switch ($PsCmdlet.ParameterSetName) {
                
                'ById' {
                    
                    foreach ($GroupId in $Id){

                        $URI = "/identity/api/tenants/$($Tenant)/groups/$($GroupId)"

                        # --- Run vRA REST Request
                        $Response = Invoke-vRARestMethod -Method GET -URI $URI
                    
                        [pscustomobject] @{

                            GroupType = $Response.groupType
                            Name = $Response.name
                            Domain = $Response.domain
                            Description = $Response.description
                            PrincipalId = "$($Response.principalId.name)@$($Response.principalId.domain)"

                        }                                    

                    }
                    
                    break                
    
                }
                
                'Standard' {
    
                    $URI = "/identity/api/tenants/$($Tenant)/groups?limit=$($Limit)"
                    
                    # --- Run vRA REST Request
                    $Response = Invoke-vRARestMethod -Method GET -URI $URI
                    
                    foreach ($Principal in $Response.content) {
                    
                        [pscustomobject] @{

                            GroupType = $Principal.groupType
                            Name = $Principal.name
                            Domain = $Principal.domain
                            Description = $Principal.description
                            PrincipalId = "$($Principal.principalId.name)@$($Principal.principalId.domain)"

                        }

                    }
                    
                    break              
                                    
                }
                
            }
            
        }
        catch [Exception]{

            throw
            
        }
        
    }
    
    end {}
        
}