Functions/Public/Get-vRATenantDirectoryStatus.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
function Get-vRATenantDirectoryStatus {
<#
    .SYNOPSIS
    Retrieve vRA Tenant Directory Status
    
    .DESCRIPTION
    Retrieve vRA Tenant Directory Status
    
    .PARAMETER Id
    Specify the ID of a Tenant

    .PARAMETER Domain
    Specify the Domain of a Tenant Directory

    .INPUTS
    System.String

    .OUTPUTS
    System.Management.Automation.PSObject.
    
    .EXAMPLE
    Get-vRATenantDirectoryStatus -Id Tenant01 -Domain vrademo.local

    .EXAMPLE
    Get-vRATenantDirectoryStatus -Id Tenant01 -Domain vrademo.local,test.local
#>

[CmdletBinding()][OutputType('System.Management.Automation.PSObject')]

    Param (

    [parameter(Mandatory=$true)]
    [ValidateNotNullOrEmpty()]
    [String]$Id,    
    
    [parameter(Mandatory=$false)]
    [ValidateNotNullOrEmpty()]
    [String[]]$Domain
    )

    # --- Test for vRA API version
    xRequires -Version 7.0
                
try {
        
    foreach ($TenantDomain in $Domain){

        $URI = "/identity/api/tenants/$($Id)/directories/$($TenantDomain)/status"

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

            Tenant = $Id
            Directory = $TenantDomain
            Status = $Response.syncStatus.status
            Message = $Response.syncStatus.message
        }
    }
}
catch [Exception]{

    throw
}
}